WaterfallConfig - xmris

Configuration object for controlling the aesthetics of xmris Waterfall Plots.

Parameters¶

Figure Setup¶

Parameter	Type	Default	Description
`figsize`	`tuple`	`(8, 6)`	Dimensions of the figure in inches (width, height).
`style`	`str`	`seaborn-v0_8-white`	Matplotlib style sheet used for the underlying canvas.
`fontfamily`	`str`	`sans-serif`	Font family used for all plot text (e.g., ‘sans-serif’, ‘serif’).

Stack Geometry¶

Parameter	Type	Default	Description
`stack_offset`	`float`	`0.5`	Vertical baseline shift between stacked spectra(in normalized amplitude units).
`stack_scale`	`float`	`10.0`	Height multiplier for individual spectra to control visual overlap (baseline max is 1.0).
`stack_skew`	`float`	`-20.0`	Horizontal skew angle in degrees (strictly between -89.0 and 89.0). 0 is vertically straight.

Stack Aesthetics¶

Parameter	Type	Default	Description
`cmap`	`str \| None`	`magma`	Matplotlib colormap string. Set to None to disable filled areas.
`cmap_start`	`float`	`0.8`	Top color boundary sampled from the colormap (0.0 to 1.0).
`cmap_end`	`float`	`0.1`	Bottom color boundary sampled from the colormap (0.0 to 1.0).
`alpha`	`float`	`0.75`	Transparency (alpha) of the colored filled area under spectra.
`linewidth`	`float`	`0.8`	Thickness in points of standard spectrum outlines.
`linewidth_highlight`	`float`	`1.3`	Thickness in points for labeled/highlighted spectrum outlines.

Stack Labels¶

Parameter	Type	Default	Description
`stack_label_step`	`int`	`10`	Interval at which to add a stack y-axis label (e.g., every 10th spectrum).
`stack_label_x_offset`	`float`	`-0.25`	Horizontal adjustment for stack labels (in x-axis data units).
`stack_label_y_offset`	`float`	`0.0`	Vertical adjustment for stack labels (as a fraction of stack_offset).

Axes & Ticks¶

Parameter	Type	Default	Description
`xlabel`	`str \| None`	`None`	Explicit x-axis string label. If None, uses the formatted xarray dimension name.
`labelsize`	`int`	`12`	Font size in points applied to the primary axis labels.
`ticklabelsize`	`int`	`10`	Font size in points applied to the axis tick marks and stack labels.
`pad_left`	`float`	`0.0`	Empty padding space on the high-value (left) side in x-axis data units.
`pad_right`	`float`	`0.0`	Empty padding space on the low-value (right) side in x-axis data units.
`xminor_locator`	`int`	`5`	Number of sub-intervals between major x-axis ticks.

Annotations¶

Parameter	Type	Default	Description
`annotation`	`str \| None`	`Absorption Mode`	Text annotation placed in the top left corner. Set to None to hide entirely.