scimesh 0.3.2
Headless CPU-only 3D software renderer for scientific mesh visualization
Loading...
Searching...
No Matches
scimesh::ApplyColormapResult Struct Reference

Result of apply_colormap() for a single dataset. More...

#include <colormap.h>

Public Attributes

std::vector< Colorcolors
 Per-element RGBA colours, same order and length as the input data vector.
 
float data_min = NAN
 The actual data range used for mapping (after winsorizing, or as explicitly set).
 
float data_max = NAN
 The actual data range used for mapping (after winsorizing, or as explicitly set).
 
float raw_min = NAN
 Raw finite minimum of the input data (before winsorizing).
 
float raw_max = NAN
 Raw finite maximum of the input data (before winsorizing).
 
float winsor_lo = NAN
 Lower percentile cutoff used for winsorizing.
 
float winsor_hi = NAN
 Upper percentile cutoff used for winsorizing.
 
size_t nan_count = 0
 Number of NaN / Inf values in the input data.
 

Detailed Description

Result of apply_colormap() for a single dataset.

Contains the mapped colours plus metadata about the effective data range, so that a matching colourbar can be created.

See also
apply_colormap(), MultiApplyColormapResult

Definition at line 187 of file colormap.h.

Member Data Documentation

◆ colors

std::vector<Color> scimesh::ApplyColormapResult::colors

Per-element RGBA colours, same order and length as the input data vector.

Definition at line 190 of file colormap.h.

◆ data_max

float scimesh::ApplyColormapResult::data_max = NAN

The actual data range used for mapping (after winsorizing, or as explicitly set).

Use this for colourbar scale limits.

Definition at line 198 of file colormap.h.

◆ data_min

float scimesh::ApplyColormapResult::data_min = NAN

The actual data range used for mapping (after winsorizing, or as explicitly set).

Use this for colourbar scale limits.

Definition at line 194 of file colormap.h.

◆ nan_count

size_t scimesh::ApplyColormapResult::nan_count = 0

Number of NaN / Inf values in the input data.

Definition at line 217 of file colormap.h.

◆ raw_max

float scimesh::ApplyColormapResult::raw_max = NAN

Raw finite maximum of the input data (before winsorizing).

NAN if all values were NaN/Inf.

Definition at line 206 of file colormap.h.

◆ raw_min

float scimesh::ApplyColormapResult::raw_min = NAN

Raw finite minimum of the input data (before winsorizing).

NAN if all values were NaN/Inf.

Definition at line 202 of file colormap.h.

◆ winsor_hi

float scimesh::ApplyColormapResult::winsor_hi = NAN

Upper percentile cutoff used for winsorizing.

NAN if no upper winsorizing was applied.

Definition at line 214 of file colormap.h.

◆ winsor_lo

float scimesh::ApplyColormapResult::winsor_lo = NAN

Lower percentile cutoff used for winsorizing.

NAN if no lower winsorizing was applied.

Definition at line 210 of file colormap.h.


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