beamax.plotter
Optional Matplotlib helpers for example styling and MSWPT coefficient plots.
beamax.plotter
Optional Matplotlib helpers for Beamax examples.
use_beamax_style() -> None
Apply the Matplotlib style used by Beamax examples.
plot_mswpt_coeffs(ax: Axes, coeffs_array, dyadic_decomp: DyadicDecomposition, cutoff_freq: float | None = None, box_corners: np.ndarray | tuple[int, int] | None = None, asymptote: bool = False, asymptote_slope: float | None = None, normalized_frequency_axes: bool = False, log_scale: bool = False)
Plot 2D MSWPT coefficient magnitudes and their dyadic boxes.
cutoff_freq or box_corners highlights the coefficient region used
by a low-frequency solve. Frequency axes can be Fourier-bin coordinates or
cycles per sample in \([-0.5, 0.5]\).
Returns:
| Type | Description |
|---|---|
AxesImage
|
The image returned by :meth: |
plot_mswpt_coeffs_3d(ax: Axes, coeffs_array, dyadic_decomp: DyadicDecomposition, cutoff_freq: float | None = None, box_corners: np.ndarray | tuple[int, int] | None = None, asymptote: bool = False)
Plot a 2D projection of 3D MSWPT coefficients and dyadic boxes.