pulsatrix::HeatmapColorScale Struct Reference

The color-scale range and colormap family a heatmap's values call for. More...

#include <plot_data.hpp>

Public Attributes
float	scale_min
	Value mapped to the colormap's low end.
float	scale_max
	Value mapped to the colormap's high end.
bool	is_signed
	True iff the grid has any negative value: the caller must then use a diverging colormap (DivergingColormap) centred on zero, since scale_min == -scale_max. When false, values are unsigned magnitudes and a sequential colormap (Viridis) over [0, scale_max] is correct.

Detailed Description

The color-scale range and colormap family a heatmap's values call for.

Member Data Documentation

is_signed

bool pulsatrix::HeatmapColorScale::is_signed

True iff the grid has any negative value: the caller must then use a diverging colormap (DivergingColormap) centred on zero, since scale_min == -scale_max. When false, values are unsigned magnitudes and a sequential colormap (Viridis) over [0, scale_max] is correct.

scale_max

float pulsatrix::HeatmapColorScale::scale_max

Value mapped to the colormap's high end.

scale_min

float pulsatrix::HeatmapColorScale::scale_min

Value mapped to the colormap's low end.

---

The documentation for this struct was generated from the following file:

• include/pulsatrix/viz/plot_data.hpp