Rerun C++ SDK
Loading...
Searching...
No Matches
rerun::blueprint::archetypes::TensorSliceSelection Struct Reference

Archetype: Specifies a 2D slice of a tensor. More...

#include <rerun/blueprint/archetypes/tensor_slice_selection.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

 TensorSliceSelection (TensorSliceSelection &&other)=default
 
TensorSliceSelection with_width (rerun::components::TensorWidthDimension _width) &&
 Which dimension to map to width.
 
TensorSliceSelection with_height (rerun::components::TensorHeightDimension _height) &&
 Which dimension to map to height.
 
TensorSliceSelection with_indices (Collection< rerun::components::TensorDimensionIndexSelection > _indices) &&
 Selected indices for all other dimensions.
 
TensorSliceSelection with_slider (Collection< rerun::blueprint::components::TensorDimensionIndexSlider > _slider) &&
 Any dimension listed here will have a slider for the index.
 

Public Attributes

std::optional< rerun::components::TensorWidthDimensionwidth
 Which dimension to map to width.
 
std::optional< rerun::components::TensorHeightDimensionheight
 Which dimension to map to height.
 
std::optional< Collection< rerun::components::TensorDimensionIndexSelection > > indices
 Selected indices for all other dimensions.
 
std::optional< Collection< rerun::blueprint::components::TensorDimensionIndexSlider > > slider
 Any dimension listed here will have a slider for the index.
 

Static Public Attributes

static constexpr const char IndicatorComponentName []
 

Detailed Description

Archetype: Specifies a 2D slice of a tensor.

Member Function Documentation

◆ with_width()

TensorSliceSelection rerun::blueprint::archetypes::TensorSliceSelection::with_width ( rerun::components::TensorWidthDimension  _width) &&
inline

Which dimension to map to width.

If not specified, the height will be determined automatically based on the name and index of the dimension.

◆ with_height()

TensorSliceSelection rerun::blueprint::archetypes::TensorSliceSelection::with_height ( rerun::components::TensorHeightDimension  _height) &&
inline

Which dimension to map to height.

If not specified, the height will be determined automatically based on the name and index of the dimension.

◆ with_indices()

TensorSliceSelection rerun::blueprint::archetypes::TensorSliceSelection::with_indices ( Collection< rerun::components::TensorDimensionIndexSelection _indices) &&
inline

Selected indices for all other dimensions.

If any of the here listed dimensions is equal to width or height, it will be ignored.

◆ with_slider()

TensorSliceSelection rerun::blueprint::archetypes::TensorSliceSelection::with_slider ( Collection< rerun::blueprint::components::TensorDimensionIndexSlider _slider) &&
inline

Any dimension listed here will have a slider for the index.

Edits to the sliders will directly manipulate dimensions on the indices list. If any of the here listed dimensions is equal to width or height, it will be ignored. If not specified, adds slides for any dimension in indices.

Member Data Documentation

◆ width

std::optional<rerun::components::TensorWidthDimension> rerun::blueprint::archetypes::TensorSliceSelection::width

Which dimension to map to width.

If not specified, the height will be determined automatically based on the name and index of the dimension.

◆ height

std::optional<rerun::components::TensorHeightDimension> rerun::blueprint::archetypes::TensorSliceSelection::height

Which dimension to map to height.

If not specified, the height will be determined automatically based on the name and index of the dimension.

◆ indices

std::optional<Collection<rerun::components::TensorDimensionIndexSelection> > rerun::blueprint::archetypes::TensorSliceSelection::indices

Selected indices for all other dimensions.

If any of the here listed dimensions is equal to width or height, it will be ignored.

◆ slider

std::optional<Collection<rerun::blueprint::components::TensorDimensionIndexSlider> > rerun::blueprint::archetypes::TensorSliceSelection::slider

Any dimension listed here will have a slider for the index.

Edits to the sliders will directly manipulate dimensions on the indices list. If any of the here listed dimensions is equal to width or height, it will be ignored. If not specified, adds slides for any dimension in indices.

◆ IndicatorComponentName

constexpr const char rerun::blueprint::archetypes::TensorSliceSelection::IndicatorComponentName[]
staticconstexpr
Initial value:
=
"rerun.blueprint.components.TensorSliceSelectionIndicator"

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