Skip to content

Conversation

@AlFontal
Copy link
Owner

@AlFontal AlFontal commented Dec 19, 2025

Summary

This PR fixes and improves the combi_plot functionality:

Changes

Refactoring:

  • Move combi_plot from SDCAnalysis class to standalone function in plotting.py
  • Remove deprecated plot_two_way_sdc function
  • SDCAnalysis.combi_plot() is now a thin wrapper calling plotting.combi_plot()

New features:

  • Fontsize hierarchy: fontsize (base), tick_fontsize, label_fontsize, colorbar_fontsize
  • Dynamic spacing: wspace/hspace auto-calculated from figsize (can be overridden)
  • n_ticks parameter: Control number of axis ticks (uses MaxNLocator)
  • Integer index support: Works with both datetime and simple integer indexes (addresses Feature: make the analysis agnostic to the indexing of the time series #4)
  • No default title: Title is opt-in via title= parameter

Visual fixes:

  • ts2/mc2 x-axis ticks moved to top (no clash with mc1)
  • Consistent fontsize across all subplot labels
  • Improved default spacing for various figure sizes

Documentation:

  • Added Usage section to README with synthetic tc_signal example
  • Added examples/basic_usage.py with transient correlation demo
  • Added example plot image

Fixes visual issues in combi_plot.

Closes #4 #10 #13

- Move combi_plot from SDCAnalysis to plotting.py as standalone function
- Add fontsize hierarchy: fontsize, tick_fontsize, label_fontsize, colorbar_fontsize
- Add dynamic wspace/hspace calculation based on figsize
- Add n_ticks parameter for controlling axis tick count
- Add dpi parameter with 150 default
- Support both datetime and integer indexes
- Remove auto-generated title (now opt-in)
- Move ts2/mc2 x-axis ticks to top to avoid mc1 clash
- Remove plot_two_way_sdc (replaced by combi_plot)
- Inline two_way_plot method in SDCAnalysis

Fixes combi_plot visual issues and improves modularity.
- Add Usage section to README with tc_signal example
- Add examples/basic_usage.py with transient correlation demo
- Add sdc_example.png showing combi_plot output
@AlFontal AlFontal merged commit 2f3914a into master Dec 19, 2025
4 checks passed
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.

Feature: make the analysis agnostic to the indexing of the time series

2 participants