PlotRidgeConfig
Configuration object for controlling the aesthetics of xmris Ridge Plots.
Modify these attributes to customize the publication-ready output.
Parameters¶
| Parameter | Type | Default | Description |
|---|
figsize | tuple | (8, 6) | Dimensions of the figure (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. |
Stacking & Colors¶
| Parameter | Type | Default | Description |
|---|
offset_step | float | 1.5 | Vertical shift between consecutive stacked spectra. |
cmap | str | magma | Matplotlib colormap used for the stack gradient. |
cmap_start | float | 0.8 | Top color boundary from the colormap (0 to 1). |
cmap_end | float | 0.1 | Bottom color boundary from the colormap (0 to 1). |
fill_alpha | float | 0.75 | Transparency of the colored filled area under spectra. |
Line Aesthetics¶
| Parameter | Type | Default | Description |
|---|
linewidth | float | 0.8 | Thickness of standard spectrum outlines. |
linewidth_highlight | float | 1.3 | Thickness for labeled/highlighted spectrum outlines. |
Stack Labels¶
| Parameter | Type | Default | Description |
|---|
label_every_n | int | 10 | Interval at which to add a stack label (every Nth spectrum). |
label_x_nudge | float | -0.25 | Horizontal adjustment/offset for stack labels. |
label_y_nudge_frac | float | 0.0 | Vertical adjustment for stack labels (fraction of offset_step). |
labelsize | int | 12 | Font size applied to the axis labels. |
ticklabelsize | int | 10 | Font size applied to the axis tick marks. |
x-Axis¶
| Parameter | Type | Default | Description |
|---|
xlabel | str | None | None | x-axis label. If None (default), uses the xarray dimension name. |
Axes Padding & Ticks¶
| Parameter | Type | Default | Description |
|---|
pad_left | float | 0.0 | Empty padding space on the high-value (left) side. |
pad_right | float | 0.0 | Empty padding space on the low-value (right) side. |
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. |