ImFusion C++ SDK 4.4.0
ImFusion::ML::TensorSet Class Reference

#include <ImFusion/ML/TensorSet.h>

Class for managing sets of tensors, one for each frame in the set. More...

Inheritance diagram for ImFusion::ML::TensorSet:

Detailed Description

Class for managing sets of tensors, one for each frame in the set.

See the ML::Tensor class for more information.

Public Member Functions

 TensorSet (std::vector< std::shared_ptr< ML::Tensor > > data={})
 TensorSet (std::shared_ptr< ML::Tensor > data)
 TensorSet (const TensorSet &other)=default
TensorSet & operator= (const TensorSet &other)=default
 TensorSet (TensorSet &&other) noexcept
TensorSet & operator= (TensorSet &&other) noexcept
bool operator== (const TensorSet &other) const
bool operator!= (const TensorSet &other) const
int size () const override
int dimension () const
Kind kind () const override
 Return the kind of this data.
Pose::TransformationConvention matrixConvention () const override
 Defines whether the internally stored matrices in derived classes map from or to the world coordinate system.
Geometry::AlignedBox bounds () const override
 Returns the axis-aligned bounding box of this data in world space.
std::string describe () const override
 Human readable description of the data for showing in the info bar.
std::shared_ptr< ML::TensorgetShared (size_t n=0)
void add (std::shared_ptr< ML::Tensor > tensor)
std::vector< std::shared_ptr< ML::Tensor > > & tensors ()
Public Member Functions inherited from ImFusion::Data
 Data (const std::string &name="")
 Data (const Data &other)
Data & operator= (const Data &other)
virtual ~Data ()
 Mandatory virtual destructor.
virtual Modality modality () const
 Return the modality of this data.
const std::stringname () const
 Return the name of this data.
void setName (const std::string &name)
 Sets the name of this data.
virtual bool isAnnotationType () const
 Return whether this data type is visualized through an annotation (e.g. mesh).
const DataComponentListcomponents () const
 Returns the list of DataComponents for this data.
DataComponentListcomponents ()
virtual void setMatrixFromWorld (const mat4 &m)
 Set matrix mapping from the world coordinate system to the data coordinate system.
virtual void setMatrixToWorld (const mat4 &m)
 Set matrix mapping from the data coordinate system to the world coordinate system.
virtual mat4 matrixFromWorld () const
 Get matrix mapping from the world coordinate system to the data coordinate system.
virtual mat4 matrixToWorld () const
 Get matrix mapping from the data coordinate system to the world coordinate system.
virtual mat4 matrix () const
 Return the transformation matrix.
virtual void setMatrix (const mat4 &m)
 Set the transformation matrix.
Public Member Functions inherited from ImFusion::Selectable
 Selectable (const Selectable &)
 Selectable (Selectable &&)
Selectable & operator= (const Selectable &)
Selectable & operator= (Selectable &&)
virtual Selection selection () const
virtual int focus () const
virtual void setSelection (const Selection &sel)
 Set the underlying selection.
virtual void setFocus (int index)
 Set focus of the selection.

Additional Inherited Members

Public Types inherited from ImFusion::Data
enum  Kind {
  UNKNOWN = 0 , IMAGE = 1 , VOLUME = 2 , IMAGESET = 3 ,
  VOLUMESET = 4 , IMAGESTREAM = 5 , VOLUMESTREAM = 6 , POINTSET = 7 ,
  SURFACE = 8 , TRACKINGSTREAM = 9 , LIVETRACKINGSTREAM = TRACKINGSTREAM , TRACKINGDATA = 10 ,
  TREE = 11 , TENSOR = 12 , POLYDATASTREAM = 13 , STEREOIMAGESET = 14 ,
  STEREOIMAGESTREAM = 15 , VOLUMETRICMESH = 16
}
 Kind of data. More...
enum  Modality {
  NA = 0 , XRAY = 1 , CT = 2 , MRI = 3 ,
  ULTRASOUND = 4 , VIDEO = 5 , NM = 6 , OCT = 7 ,
  LABEL = 8 , DISTANCE = 9
}
 Image modality of the data. More...
Static Public Member Functions inherited from ImFusion::Data
static std::string modalityString (Data::Modality m)
 Return the name of an image modality.
static Data::Modality stringToModality (const std::string &s)
 Returns the modality corresponding to a modality string or NA if nothing matches.
Public Attributes inherited from ImFusion::Data
Signal< const Data * > signalDeleted
 Signal emitted when this instance is deleted.
Signal< const Data * > signalMatrixChanged
 Signal emitted when the transformation of this Data has changed.
Signal< std::stringsignalNameChanged
 Signal emitted when the name changed.
Public Attributes inherited from ImFusion::Selectable
ProtectedSignal signalSelectionChanged
 Signals that the selection or size might have changed.
Protected Member Functions inherited from ImFusion::Data
void swapWith (Data &other)
 Swaps the data and emits a matrix and name changed signal for both.
Protected Attributes inherited from ImFusion::Data
mat4 m_matrix
 Transformation matrix.
std::recursive_mutexm_matrixMutex
 Used to internally synchronize access to the matrix of data.
DataComponentList m_dataComponentList
 The list of DataComponents for this data.
Protected Attributes inherited from ImFusion::Selectable
std::mutex m_selectionMutex
 Mutex protecting the selection.
Selection m_sel

Member Function Documentation

◆ size()

int ImFusion::ML::TensorSet::size ( ) const
overridevirtual
Returns
Total number of elements.

Implements ImFusion::Selectable.

◆ kind()

Kind ImFusion::ML::TensorSet::kind ( ) const
overridevirtual

Return the kind of this data.

Implements ImFusion::Data.

◆ matrixConvention()

Pose::TransformationConvention ImFusion::ML::TensorSet::matrixConvention ( ) const
inlineoverridevirtual

Defines whether the internally stored matrices in derived classes map from or to the world coordinate system.

Changes the behavior of the default implementations of matrixToWorld and matrixFromWorld.

Implements ImFusion::Data.

◆ bounds()

Geometry::AlignedBox ImFusion::ML::TensorSet::bounds ( ) const
overridevirtual

Returns the axis-aligned bounding box of this data in world space.

Warning
Depending on the underlying data type this calling function may be computationally expensive! Do not call this method more often than needed, unless it is known that the caching behavior is implemented.

Implements ImFusion::Data.

◆ describe()

std::string ImFusion::ML::TensorSet::describe ( ) const
inlineoverridevirtual

Human readable description of the data for showing in the info bar.

Reimplemented from ImFusion::Data.


The documentation for this class was generated from the following file:
  • ImFusion/ML/TensorSet.h
Search Tab / S to search, Esc to close