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 (const TensorSliceSelection &other)=default

TensorSliceSelection &	operator= (const TensorSliceSelection &other)=default

TensorSliceSelection &	operator= (TensorSliceSelection &&other)=default

TensorSliceSelection	with_width (const rerun::components::TensorWidthDimension &_width) &&
	Which dimension to map to width.

TensorSliceSelection	with_height (const rerun::components::TensorHeightDimension &_height) &&
	Which dimension to map to height.

TensorSliceSelection	with_indices (const Collection< rerun::components::TensorDimensionIndexSelection > &_indices) &&
	Selected indices for all other dimensions.

TensorSliceSelection	with_slider (const Collection< rerun::blueprint::components::TensorDimensionIndexSlider > &_slider) &&
	Any dimension listed here will have a slider for the index.

Collection< ComponentColumn >	columns (const Collection< uint32_t > &lengths_)
	Partitions the component data into multiple sub-batches.

Collection< ComponentColumn >	columns ()
	Partitions the component data into unit-length sub-batches.

Static Public Member Functions
static TensorSliceSelection	update_fields ()
	Update only some specific fields of a `TensorSliceSelection`.

static TensorSliceSelection	clear_fields ()
	Clear all the fields of a `TensorSliceSelection`.

Public Attributes
std::optional< ComponentBatch >	width
	Which dimension to map to width.

std::optional< ComponentBatch >	height
	Which dimension to map to height.

std::optional< ComponentBatch >	indices
	Selected indices for all other dimensions.

std::optional< ComponentBatch >	slider
	Any dimension listed here will have a slider for the index.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

static constexpr const char	ArchetypeName []
	The name of the archetype as used in `ComponentDescriptor`s.

static constexpr auto	Descriptor_width
	`ComponentDescriptor` for the `width` field.

static constexpr auto	Descriptor_height
	`ComponentDescriptor` for the `height` field.

static constexpr auto	Descriptor_indices
	`ComponentDescriptor` for the `indices` field.

static constexpr auto	Descriptor_slider
	`ComponentDescriptor` for the `slider` field.

Detailed Description

Archetype: Specifies a 2D slice of a tensor.

⚠ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

Member Function Documentation

◆ with_width()

TensorSliceSelection rerun::blueprint::archetypes::TensorSliceSelection::with_width ( const 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 ( const 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 ( const 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 ( const 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.

◆ columns() [1/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::TensorSliceSelection::columns ( const Collection< uint32_t > & lengths_ )

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing ComponentBatch data into ComponentColumns instead, via ComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

◆ columns() [2/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::TensorSliceSelection::columns ( )

Partitions the component data into unit-length sub-batches.

This is semantically similar to calling columns with std::vector<uint32_t>(n, 1), where n is automatically guessed.

Member Data Documentation

◆ width

std::optional<ComponentBatch> 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<ComponentBatch> 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<ComponentBatch> 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<ComponentBatch> 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"

◆ ArchetypeName

constexpr const char rerun::blueprint::archetypes::TensorSliceSelection::ArchetypeName[]

staticconstexpr

Initial value:

=

"rerun.blueprint.archetypes.TensorSliceSelection"

The name of the archetype as used in ComponentDescriptors.

◆ Descriptor_width

constexpr auto rerun::blueprint::archetypes::TensorSliceSelection::Descriptor_width

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "width",
            Loggable<rerun::components::TensorWidthDimension>::Descriptor.component_name
        )

ComponentDescriptor for the width field.

◆ Descriptor_height

constexpr auto rerun::blueprint::archetypes::TensorSliceSelection::Descriptor_height

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "height",
            Loggable<rerun::components::TensorHeightDimension>::Descriptor.component_name
        )

ComponentDescriptor for the height field.

◆ Descriptor_indices

constexpr auto rerun::blueprint::archetypes::TensorSliceSelection::Descriptor_indices

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "indices",
            Loggable<rerun::components::TensorDimensionIndexSelection>::Descriptor.component_name
        )

ComponentDescriptor for the indices field.

◆ Descriptor_slider

constexpr auto rerun::blueprint::archetypes::TensorSliceSelection::Descriptor_slider

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "slider",
            Loggable<rerun::blueprint::components::TensorDimensionIndexSlider>::Descriptor
                .component_name
        )

ComponentDescriptor for the slider field.

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

rerun/blueprint/archetypes/tensor_slice_selection.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ with_width()

◆ with_height()

◆ with_indices()

◆ with_slider()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ width

◆ height

◆ indices

◆ slider

◆ IndicatorComponentName

◆ ArchetypeName

◆ Descriptor_width

◆ Descriptor_height

◆ Descriptor_indices

◆ Descriptor_slider