mmcfilters::SampledNodeAttributeData< Real > Struct Template Reference

Owning result for one sampled node-attribute layout and buffer. More...

#include <AttributeResultTypes.hpp>

Collaboration diagram for mmcfilters::SampledNodeAttributeData< Real >:

Public Member Functions
	SampledNodeAttributeData (NodeAttributeSampleLayout attrNames, std::vector< Real > buffer, NodeIdSpace outputSpace=NodeIdSpace::MorphologicalTree)
	Takes ownership of a sample layout and its flat buffer.
	SampledNodeAttributeData (const SampledNodeAttributeData &)=delete
	Disables copy construction.
SampledNodeAttributeData &	operator= (const SampledNodeAttributeData &)=delete
	Disables copy assignment.
	SampledNodeAttributeData (SampledNodeAttributeData &&) noexcept=default
	Transfers ownership of the layout, buffer, and node-id-space marker.
SampledNodeAttributeData &	operator= (SampledNodeAttributeData &&)=delete
	Disables move assignment.
NodeAttributeSampleLayout &	attributeNames () noexcept
	Returns the mutable sampled-attribute layout.
const NodeAttributeSampleLayout &	attributeNames () const noexcept
	Returns the immutable sampled-attribute layout.
std::vector< Real > &	values () noexcept
	Returns the mutable flat attribute buffer.
const std::vector< Real > &	values () const noexcept
	Returns the immutable flat attribute buffer.

Public Attributes
NodeAttributeSampleLayout	first
	Sample layout used to interpret second.
std::vector< Real >	second
	Flat per-node, per-sample attribute buffer indexed through first.
NodeIdSpace	nodeIdSpace = NodeIdSpace::MorphologicalTree
	Node-id domain used by the rows of second.

Detailed Description

template<std::floating_point Real = float>
struct mmcfilters::SampledNodeAttributeData< Real >

Owning result for one sampled node-attribute layout and buffer.

This result is used when one logical node attribute is sampled at several ancestor/current/representative-descendant offsets.

Definition at line 107 of file AttributeResultTypes.hpp.

Constructor & Destructor Documentation

SampledNodeAttributeData()

template<std::floating_point Real = float>

mmcfilters::SampledNodeAttributeData< Real >::SampledNodeAttributeData ( NodeAttributeSampleLayout  attrNames, std::vector< Real >  buffer, NodeIdSpace  outputSpace = NodeIdSpace::MorphologicalTree  )

inline

Takes ownership of a sample layout and its flat buffer.

Parameters

attrNames	Layout that maps (attribute, sampleOffset) keys to offsets.
buffer	Attribute values stored in node-major order.
outputSpace	Node-id domain used by the buffer rows.

Definition at line 124 of file AttributeResultTypes.hpp.

Member Function Documentation

attributeNames() [1/2]

template<std::floating_point Real = float>

const NodeAttributeSampleLayout & mmcfilters::SampledNodeAttributeData< Real >::attributeNames ( ) const

inlinenoexcept

Returns the immutable sampled-attribute layout.

Returns

The immutable sampled-attribute layout.

Definition at line 159 of file AttributeResultTypes.hpp.

attributeNames() [2/2]

template<std::floating_point Real = float>

NodeAttributeSampleLayout & mmcfilters::SampledNodeAttributeData< Real >::attributeNames ( )

inlinenoexcept

Returns the mutable sampled-attribute layout.

Returns

The mutable sampled-attribute layout.

Definition at line 152 of file AttributeResultTypes.hpp.

values() [1/2]

template<std::floating_point Real = float>

const std::vector< Real > & mmcfilters::SampledNodeAttributeData< Real >::values ( ) const

inlinenoexcept

Returns the immutable flat attribute buffer.

Returns

The immutable flat attribute buffer.

Definition at line 173 of file AttributeResultTypes.hpp.

values() [2/2]

template<std::floating_point Real = float>

std::vector< Real > & mmcfilters::SampledNodeAttributeData< Real >::values ( )

inlinenoexcept

Returns the mutable flat attribute buffer.

Returns

The mutable flat attribute buffer.

Definition at line 166 of file AttributeResultTypes.hpp.

Member Data Documentation

first

template<std::floating_point Real = float>

NodeAttributeSampleLayout mmcfilters::SampledNodeAttributeData< Real >::first

Sample layout used to interpret second.

Definition at line 109 of file AttributeResultTypes.hpp.

nodeIdSpace

template<std::floating_point Real = float>

NodeIdSpace mmcfilters::SampledNodeAttributeData< Real >::nodeIdSpace = NodeIdSpace::MorphologicalTree

Node-id domain used by the rows of second.

Definition at line 115 of file AttributeResultTypes.hpp.

second

template<std::floating_point Real = float>

std::vector<Real> mmcfilters::SampledNodeAttributeData< Real >::second

Flat per-node, per-sample attribute buffer indexed through first.

Definition at line 112 of file AttributeResultTypes.hpp.

---

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

• mmcfilters/attributes/AttributeResultTypes.hpp