✨ Shift irf derivatives in plot_coherent_artifact by irf position

[s-weigand]

This PR adds main_irf_nr to plot_coherent_artifact which defaults to 0 and shifts the IRF derivatives to by the position of the IRF component with index 0. If main_irf_nr is set to None the IRF shifting is deactivated.

Change summary

• ✨ Shift irf derivatives in plot_coherent_artifact by irf position

Checklist

• ✔️ Passing the tests (mandatory for all PR's)

[sourcery-ai]

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 1.35%.

Quality metrics	Before	After	Change
Complexity	6.83 ⭐	6.84 ⭐	0.01 👎
Method Length	221.50 ⛔	237.50 ⛔	16.00 👎
Working memory	15.71 ⛔	16.70 ⛔	0.99 👎
Quality	37.16% 😞	35.81% 😞	-1.35% 👎

Other metrics	Before	After	Change
Lines	127	134	7

Changed files	Quality Before	Quality After	Quality Change
pyglotaran_extras/plotting/plot_coherent_artifact.py	37.16% 😞	35.81% 😞	-1.35% 👎

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
pyglotaran_extras/plotting/plot_coherent_artifact.py	plot_coherent_artifact	7 ⭐	366 ⛔	17 ⛔	34.69% 😞	Try splitting into smaller methods. Extract out complex expressions

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/improve-plot_coherent_artifact

[s-weigand]

This PR is a draft since it depends on #135, after #135 is merged I will rebase it and remove the draft status.

[codecov]

Codecov Report

Base: 44.97% // Head: 44.97% // No change to project coverage 👍

Coverage data is based on head (137ad2a) compared to base (137ad2a).
Patch has no changes to coverable lines.

❗ Current head 137ad2a differs from pull request most recent head 6f337b5. Consider uploading reports for the commit 6f337b5 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #136   +/-   ##
=======================================
  Coverage   44.97%   44.97%           
=======================================
  Files          29       29           
  Lines         916      916           
  Branches      133      133           
=======================================
  Hits          412      412           
  Misses        497      497           
  Partials        7        7           

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.