Skip to content

A bunch of long overdue updates to the plotting system - #72

Merged
allevitan merged 24 commits into
masterfrom
feature/betterplots
Apr 3, 2026
Merged

A bunch of long overdue updates to the plotting system#72
allevitan merged 24 commits into
masterfrom
feature/betterplots

Conversation

@allevitan

@allevitan allevitan commented Mar 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Changes

  • Added the ability for CDIModels to define panel-style multi-figure layouts, with an automatic fallback option to single-figure layouts. This is much more manageable for e.g. live work at a beamline.
  • Switched to a dictionary-based definition for registered plots, as the old system was quite hard to read
  • Created a nice panel layouts for FancyPtycho and RPI using the new system.
  • Updated all remaining models to the new system, leaving their current plotting behavior intact.
  • Added a "plot_level" tag to each plot so users can control the level of detail in plotting. plot_level=0 turns off all plots, and larger numbers add progressively more plots.
  • Added a "min_interval" argument to model.inspect() to make it easier to plot occasionally during reconstructions.
  • Improved the handling of figures being closed during live reconstructions. Now, a closed figure will not render on subsequent calls to inspect(), improving speed. A new argument, "replot_all", can be used to force a replot at the end.
  • Tested in Jupyter and developed a workaround pattern to make it more manageable to work in a notebook environment
  • Updated example scripts to use the new features, and made minor changes to improve useability of the scripts on devices without CUDA.

Remaining Todos

  • Update image stack plotting with a slider instead of current ad-hoc system
  • Update documentation with new plotting approach
  • Identify key tests which need to be added to test the system
  • Final re-check of the example scripts

allevitan and others added 23 commits March 20, 2026 09:47
@allevitan
A first prototype from claude to test on Ra
f3581b8
@allevitan
Kill a bunch of bugs and make the flow more sensible by hand
44fe36d
@allevitan @claude
Improve plotting infrastructure and fix various bugs
dd744a0 
- Switch panel plots to use subfigures with constrained_layout for better layout management
- Add plot_loss_history method to CDIModel base class
- Fix matplotlib compatibility for older versions (interactive backend detection)
- Make CUDA usage conditional in examples
- Add panel_plot_mode and plot_level params to FancyPtycho constructor
- Default plot_level filtering to 1 instead of 0

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@allevitan @claude
Add title option to plot_image and wrappers; misc fixes
f426083 
- Add title parameter to plot_image, plot_real, plot_imag, plot_amplitude,
  plot_phase, and plot_colorized
- Various fixes to base.py and fancy_ptycho.py

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@allevitan
Made a few more updates to some example scripts, to show the panel pl…
e7f943e 
…ot mode
@allevitan
Update remaining models to new plot registration system
91db5b3
@allevitan
Check that all the models work (all but Multislice2DPtycho, which was…
f35141d 
… already broken, and make necessary tweaks
@allevitan
Added a minimum plotting interval to model.inspect(dataset) to make i…
bef907c 
…t easier to not plot so much without manual intervention
@allevitan
Fix a bug where closed windows wouldn't reopen at the original size
dafb204
@allevitan
Add example patterns for jupyter notebooks
f8ff525
@allevitan
Update the plot_image functions to show sliders
a4a3853
@allevitan
Make the colorized plot look nicer, with a more perceptually uniform …
f04ac9f 
…mapping and a colorbar for accurate reading of phases
@allevitan
Improve the colorized plotting further, and add a colorbar which will…
29656fd 
… be useful for publishing figures now that it's not just a simple hsv lookup. Also fix a bug with nonresponsive windows when all model plots are closed, but the dataset plots are still showing.
@allevitan
Fix an annoying warning coming from double-setting the figsize
f979388
@allevitan
Made more adjustments to the plotting system to avoid using constaine…
4201b41 
…d_layout, which was causing hangups during live plotting and didn't look as nice
@allevitan @claude
Reformat plotting function signatures to one-parameter-per-line style
5c5c0be 
All public functions in plotting.py now use the expanded multi-line
signature format with trailing commas for consistency and readability.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@allevitan
Do a final review of all the examples to ensure they work and are wel…
25c7b66 
…l structured
@allevitan @claude
Add test coverage for plot_translations, plot_nanomap, and plot_nanom…
29e9fdd 
…ap_with_images

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@allevitan
Update the tests to work better when checking the model plotting, and…
ad2b09f 
… make sure to cover panel_plot_mode=False
@allevitan
Change the default colormap for exponentiated objects to match that f…
603486e 
…or un-exponentiated objects, and also update test_fancy_ptycho to show all the plots (not just plot level 2)
@allevitan
Stop stopping at each plot to show it
f55b35f
@allevitan
A few small changes to revert unimportant edits and fix linting issues
4172a9a
@allevitan
Updated the documentation to reflect the changes to the plotting system
0bd8df4
@allevitan
allevitan marked this pull request as ready for review March 24, 2026 20:56
allevitan
allevitan commented Apr 3, 2026
View reviewed changes

@allevitan allevitan left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Overall looks good, but there were some mistakes that really need to be corrected

Comment thread src/cdtools/models/base.py Outdated
Comment thread src/cdtools/models/base.py Outdated
Comment thread src/cdtools/models/base.py Outdated
Comment thread src/cdtools/models/base.py Outdated
Comment thread src/cdtools/models/base.py
Comment thread src/cdtools/tools/plotting/plotting.py Outdated
Comment thread src/cdtools/tools/plotting/plotting.py Outdated
@allevitan
allevitan merged commit 3f028e2 into master Apr 3, 2026
9 checks passed
@allevitan
allevitan deleted the feature/betterplots branch April 3, 2026 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@allevitan