Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Add plot_pfid plot function #283

Merged
merged 6 commits into from
Aug 21, 2024
Merged

Conversation

jsnel
Copy link
Member

@jsnel jsnel commented Aug 21, 2024

Module containing PFID (Perturbed Free Induction Decay) plotting functionality

Change summary

  • ✨Added plot_pfid - a plot module to plot data related to modelling PFID (Perturbed Free Induction Decay)
  • 🎨 Inverse plot order (zorder) of spectra
  • 👌Added condense_numbered_strings utility function to condense plot labels (e.g. osc1,osc2 -> osc1-2)

Checklist

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

Example screenshots

plot_pfid with show_clps=False
image

plot_pfid with show_clps=True
image

jsnel added 3 commits August 21, 2024 08:11
Module containing PFID (Perturbed Free Induction Decay) plotting functionality
Was introduced in `b66f2f2fb0f658b3d105bb6ab40e0e046ffdf28e` "inverse plot order of spectra"
@jsnel jsnel requested a review from a team as a code owner August 21, 2024 06:26
Copy link
Contributor

sourcery-ai bot commented Aug 21, 2024

🧙 Sourcery has finished reviewing your pull request!


Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

Copy link
Contributor

Binder 👈 Launch a binder notebook on branch jsnel/pyglotaran-extras/plot_pfid_function

Copy link

codecov bot commented Aug 21, 2024

Codecov Report

Attention: Patch coverage is 15.15152% with 84 lines in your changes missing coverage. Please review.

Project coverage is 42.84%. Comparing base (b880df9) to head (6ded80e).
Report is 27 commits behind head on main.

Files with missing lines Patch % Lines
pyglotaran_extras/plotting/plot_pfid.py 0.00% 79 Missing ⚠️
pyglotaran_extras/plotting/plot_spectra.py 0.00% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #283      +/-   ##
==========================================
- Coverage   44.77%   42.84%   -1.94%     
==========================================
  Files          27       28       +1     
  Lines        1043     1146     +103     
  Branches      162      184      +22     
==========================================
+ Hits          467      491      +24     
- Misses        568      647      +79     
  Partials        8        8              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

s-weigand and others added 2 commits August 21, 2024 22:20
- Remove unused offset
- Remove legend by default, only add back to top left by default
- More sensible figsize
- Improve util function
Copy link
Member

@s-weigand s-weigand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We did a peer review in a call and LGTM
Ship it 🚀

@jsnel jsnel merged commit 5e893d6 into glotaran:main Aug 21, 2024
31 checks passed
@jsnel jsnel deleted the plot_pfid_function branch August 21, 2024 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants