CarpetConfig - xmris

Configuration object for controlling the aesthetics of xmris Carpet Plots.

Parameters¶

Figure Setup¶

Parameter	Type	Default	Description
`figsize`	`tuple`	`(8, 5)`	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’).

Colormap Aesthetics¶

Parameter	Type	Default	Description
`cmap`	`str`	`magma`	Matplotlib colormap string used for the 2D intensity.
`cmap_start`	`float`	`0.1`	Lower color boundary sampled from the colormap (0.0 to 1.0) to avoid extremes.
`cmap_end`	`float`	`0.8`	Upper color boundary sampled from the colormap (0.0 to 1.0) to avoid extremes.

Axes & Labels¶

Parameter	Type	Default	Description
`xlabel`	`str \| None`	`None`	Explicit x-axis string label. If None, uses the formatted xarray dimension name.
`ylabel`	`str \| None`	`None`	Explicit y-axis string label. If None, uses the stacking 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.

Ticks & Grid¶

Parameter	Type	Default	Description
`tick_color`	`str`	`lightgray`	Color string for the inward-facing tick marks.
`tick_len_major`	`float`	`5.0`	Length of major ticks in points.
`tick_wid_major`	`float`	`1.0`	Width of major ticks in points.
`tick_len_minor`	`float`	`2.0`	Length of minor ticks in points.
`tick_wid_minor`	`float`	`0.8`	Width of minor ticks in points.
`xminor_locator`	`int`	`5`	Number of sub-intervals between major x-axis ticks.
`yminor_locator`	`int`	`4`	Number of sub-intervals between major y-axis ticks.
`grid_on`	`bool`	`True`	Toggle the visibility of the overlay coordinate grid.
`grid_color`	`str`	`lightgray`	Color of the overlay grid lines.
`grid_alpha`	`float`	`0.2`	Transparency of the overlay grid lines.
`grid_linewidth`	`float`	`0.6`	Thickness of the overlay grid lines.

Colorbar¶

Parameter	Type	Default	Description
`cbar_on`	`bool`	`True`	Toggle the visibility of the colorbar legend.
`cbar_label`	`str \| None`	`Signal Intensity (a.u.)`	Text label appended to the side of the colorbar.