✨ Add coherent artifact plot functionality

[s-weigand]

This change adds a new plot function plot_coherent_artifact which implements #33.

Here are some example plots for the DOAS example (currently our only example that uses the coherent artifact):

Change summary

• ✨ Added abs_max helper function
• ♻️ Refactored add_cycler_if_not_none to also work on multiple axes
• ✨ Added plot_coherent_artifact function

Checklist

• ✔️ Passing the tests (mandatory for all PR's)
• 🧪 Adds new tests for the feature (mandatory for ✨ feature and 🩹 bug fix PR's)

Closes issues

Not sure for which other plots #33 applies, so we might want to factor out the scaling and normalization into another helper function thus I'm not marking it as closed.

[sourcery-ai]

Sourcery Code Quality Report

✅  Merging this PR will increase code quality in the affected files by 0.56%.

Quality metrics	Before	After	Change
Complexity	2.66 ⭐	2.56 ⭐	-0.10 👍
Method Length	70.00 🙂	75.88 🙂	5.88 👎
Working memory	7.44 🙂	7.21 🙂	-0.23 👍
Quality	75.69% ⭐	76.25% ⭐	0.56% 👍

Other metrics	Before	After	Change
Lines	394	454	60

Changed files	Quality Before	Quality After	Quality Change
pyglotaran_extras/__init__.py	86.21% ⭐	84.86% ⭐	-1.35% 👎
pyglotaran_extras/plotting/utils.py	74.88% 🙂	75.07% ⭐	0.19% 👍
tests/plotting/test_utils.py	85.39% ⭐	82.08% ⭐	-3.31% 👎

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
pyglotaran_extras/plotting/utils.py	select_plot_wavelengths	3 ⭐	136 😞	11 😞	59.58% 🙂	Try splitting into smaller methods. Extract out complex expressions
tests/plotting/test_utils.py	test_abs_max	0 ⭐	136 😞	5 ⭐	76.11% ⭐	Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

[github-actions]

👈 Launch a binder notebook on branch s-weigand/pyglotaran-extras/plot-irfas

[codecov]

Codecov Report

Base: 40.61% // Head: 40.20% // Decreases project coverage by -0.40% ⚠️

Coverage data is based on head (b808f0c) compared to base (6894d63).
Patch coverage: 37.03% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #123      +/-   ##
==========================================
- Coverage   40.61%   40.20%   -0.41%     
==========================================
  Files          24       25       +1     
  Lines         719      771      +52     
  Branches       98      108      +10     
==========================================
+ Hits          292      310      +18     
- Misses        427      460      +33     
- Partials        0        1       +1     

Impacted Files	Coverage Δ
...glotaran_extras/plotting/plot_coherent_artifact.py	23.80% <23.80%> (ø)
pyglotaran_extras/plotting/utils.py	25.74% <81.81%> (+5.09%)	⬆️
pyglotaran_extras/__init__.py	100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[jsnel]

Looks good, corrected some small imperfections in doc strings.

[ism200]

thanks a lot sebastian. this function is key to the Lego-paper. indeed (the concept of) this function should also work with different input, e.g. concentrations and SA(D)S, or damped oscillations and DOAS. let us give that a try when we zoom again. if indeed we can generalize, then the name can become more generic. we will of course then need arguments to indicate what we want to plot. i foresee now three types of input: (1) IRF derivatives and IRFAS, (2) damped oscillations and DOAS, (3) concentrations and SA(D)S. Since these are all fixed pairs, one named arguments suffices.

[s-weigand]

Since factoring out the scaling would be just an internal change and affect the user facing API this could be done in a l8er PR.