rerun::blueprint::archetypes::TensorScalarMapping Struct Reference

Archetype: Configures how tensor scalars are mapped to color. More...

#include <rerun/blueprint/archetypes/tensor_scalar_mapping.hpp>

Public Types
using	IndicatorComponent = rerun::components::IndicatorComponent< IndicatorComponentName >
	Indicator component, used to identify the archetype when converting to a list of components.

Public Member Functions
	TensorScalarMapping (TensorScalarMapping &&other)=default
TensorScalarMapping	with_mag_filter (rerun::components::MagnificationFilter _mag_filter) &&
	Filter used when zooming in on the tensor.
TensorScalarMapping	with_colormap (rerun::components::Colormap _colormap) &&
	How scalar values map to colors.
TensorScalarMapping	with_gamma (rerun::components::GammaCorrection _gamma) &&
	Gamma exponent applied to normalized values before mapping to color.

Public Attributes
std::optional< rerun::components::MagnificationFilter >	mag_filter
	Filter used when zooming in on the tensor.
std::optional< rerun::components::Colormap >	colormap
	How scalar values map to colors.
std::optional< rerun::components::GammaCorrection >	gamma
	Gamma exponent applied to normalized values before mapping to color.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

Detailed Description

Archetype: Configures how tensor scalars are mapped to color.

Member Function Documentation

with_mag_filter()

TensorScalarMapping rerun::blueprint::archetypes::TensorScalarMapping::with_mag_filter ( rerun::components::MagnificationFilter  _mag_filter ) &&

inline

Filter used when zooming in on the tensor.

Note that the filter is applied to the scalar values before they are mapped to color.

with_gamma()

TensorScalarMapping rerun::blueprint::archetypes::TensorScalarMapping::with_gamma ( rerun::components::GammaCorrection  _gamma ) &&

inline

Gamma exponent applied to normalized values before mapping to color.

Raises the normalized values to the power of this value before mapping to color. Acts like an inverse brightness. Defaults to 1.0.

Member Data Documentation

mag_filter

std::optional<rerun::components::MagnificationFilter> rerun::blueprint::archetypes::TensorScalarMapping::mag_filter

Filter used when zooming in on the tensor.

Note that the filter is applied to the scalar values before they are mapped to color.

gamma

std::optional<rerun::components::GammaCorrection> rerun::blueprint::archetypes::TensorScalarMapping::gamma

Gamma exponent applied to normalized values before mapping to color.

Raises the normalized values to the power of this value before mapping to color. Acts like an inverse brightness. Defaults to 1.0.

IndicatorComponentName

constexpr const char rerun::blueprint::archetypes::TensorScalarMapping::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.blueprint.components.TensorScalarMappingIndicator"

---

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

• rerun/blueprint/archetypes/tensor_scalar_mapping.hpp