visualization.plot.plot_carpet

visualization.plot.plot_carpet

Classes¶

Name	Description
CarpetConfig	Configuration object for controlling the aesthetics of xmris Carpet Plots.

Functions¶

Name	Description
plot_carpet	Generate a publication-ready 2D carpet plot of stacked 1D spectra.

plot_carpet¶

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

Generate a publication-ready 2D carpet plot of stacked 1D spectra.

This function automatically resolves missing dimensions, applies a truncated colormap to avoid print saturation, and overlays a highly readable measurement grid.

Parameters¶

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, auto-resolves.	`None`
stack_dim	str	The dimension to plot along the vertical axis. If None, auto-resolves.	`None`
ax	plt.Axes	A pre-existing matplotlib Axes object to plot onto.	`None`
config	CarpetConfig	A configuration dataclass defining all aesthetic parameters.	`None`

Returns¶

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