PlotHeatmapConfig
Configuration object for controlling the aesthetics of xmris Heatmap Plots.
Modify these attributes to customize the publication-ready output.
Parameters¶
| Parameter | Type | Default | Description |
|---|
figsize | tuple | (8, 5) | 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. |
Colormap¶
| Parameter | Type | Default | Description |
|---|
cmap | str | magma | Matplotlib colormap used for the 2D intensity. |
cmap_start | float | 0.1 | Lower color boundary from the colormap (0 to 1) to avoid extremes. |
cmap_end | float | 0.8 | Upper color boundary from the colormap (0 to 1) to avoid extremes. |
Labels & Fonts¶
| Parameter | Type | Default | Description |
|---|
labelsize | int | 12 | Font size applied to the axis labels. |
ticklabelsize | int | 10 | Font size applied to the axis tick marks. |
xlabel | str | None | None | x-axis label. If None (default), uses the xarray dimension name. |
ylabel | str | None | None | y-axis label. If None (default), uses the stacking dimension name. |
Ticks & Grid¶
| Parameter | Type | Default | Description |
|---|
tick_color | str | lightgray | Color of the inward-facing tick marks. |
tick_len_major | float | 5.0 | No description provided. |
tick_wid_major | float | 1.0 | No description provided. |
tick_len_minor | float | 2.0 | No description provided. |
tick_wid_minor | float | 0.8 | No description provided. |
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 grid. |
grid_color | str | lightgray | No description provided. |
grid_alpha | float | 0.2 | No description provided. |
grid_linewidth | float | 0.6 | No description provided. |
Colorbar¶
| Parameter | Type | Default | Description |
|---|
cbar_on | bool | True | Toggle the visibility of the colorbar. |
cbar_label | str | None | Signal Intensity (a.u.) | Label appended to the side of the colorbar. |