visualization.plot.plot_waterfall

visualization.plot.plot_waterfall

Classes¶

Name	Description
WaterfallConfig	Configuration object for controlling the aesthetics of xmris Waterfall Plots.

Name	Description
plot_waterfall	Generate a publication-ready waterfall plot (2D stacked series) of 1D spectra.

visualization.plot.plot_waterfall.plot_waterfall(
    da,
    x_dim=None,
    stack_dim=None,
    ax=None,
    config=None,
)

Generate a publication-ready waterfall plot (2D stacked series) of 1D spectra.

This function automatically normalizes the array amplitude, applies configured styling, and safely resolves missing dimensions.

Name	Type	Description	Default
da	xr.DataArray	The N-dimensional DataArray containing the spectroscopic data.	required
x_dim	str	The dimension to plot along the horizontal axis. If None, attempts to auto-resolve (prefers ‘chemical_shift’ or ‘frequency’).	`None`
stack_dim	str	The dimension to stack vertically. If None, attempts to auto-resolve based on remaining dimensions.	`None`
ax	plt.Axes	A pre-existing matplotlib Axes object to plot onto. If None, a new Figure and Axes will be created.	`None`
config	PlotWaterfallConfig	A configuration dataclass defining all aesthetic parameters. If None, default styling is applied.	`None`

Name	Type	Description
	plt.Axes	The matplotlib Axes object containing the rendered waterfall plot.