ImFusion SDK 4.3
StereoSharedImageSet Class Reference

#include <ImFusion/Vision/StereoSharedImageSet.h>

This class is the main high-level container for stereo image data set. More...

+ Inheritance diagram for StereoSharedImageSet:

Detailed Description

This class is the main high-level container for stereo image data set.

It contains a pair of shared image sets. A stereo image set could be generated from a pair of image sets which have the same size or recorded from a stereo camera. It is mainly used in stereo-image-based algorithms and visualization classes It should have a StereoCalibrationDataComponent

Public Member Functions

void add (std::shared_ptr< StereoImage > img)
 
void add (const std::vector< std::shared_ptr< StereoImage > > &images)
 
std::shared_ptr< StereoImageget (const int id) const
 
std::shared_ptr< SharedImageSetleftImageSet () const
 
std::shared_ptr< SharedImageSetrightImageSet () const
 
std::optional< CameraCalibrationDataComponentleftCalibration () const
 
std::optional< CameraCalibrationDataComponentrightCalibration () const
 
std::optional< StereoCalibrationDataComponentregistration () const
 
std::unique_ptr< StereoSharedImageSetclone (Flags< SharedImageSet::CloneOptions > cloneOptions=SharedImageSet::Everything) const
 
int size () const override
 
std::string describe () const override
 Short description of the stereo image set.
 
virtual DataList children () const override
 Returns the list of direct children of this group.
 
virtual Kind kind () const override
 Return the kind of this data.
 
virtual Pose::TransformationConvention matrixConvention () const override
 Defines whether the internally stored matrices in derived classes map from or to the world coordinate system.
 
virtual Geometry::AlignedBox bounds () const override
 Returns the axis-aligned bounding box of this data in world space.
 
void linkSelections ()
 
- Public Member Functions inherited from Data
 Data (const std::string &name="")
 
 Data (const Data &other)
 
Dataoperator= (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 Selectable
 Selectable (const Selectable &)
 
 Selectable (Selectable &&)
 
Selectableoperator= (const Selectable &)
 
Selectableoperator= (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.
 

Static Public Member Functions

static std::unique_ptr< StereoSharedImageSetcreate (std::unique_ptr< SharedImageSet > &&left, std::unique_ptr< SharedImageSet > &&right)
 
- Static Public Member Functions inherited from 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.
 

Additional Inherited Members

- Public Types inherited from 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...
 
- Public Attributes inherited from CompoundData
Signal< Data * > signalChildAdded
 Signal emitted when a new Data instance has been added to children()
 
Signal< Data * > signalChildMoved
 Signal emitted when a Data instance has changed its position in children()
 
Signal< Data * > signalChildAboutToBeRemoved
 Signal emitted when a Data instance is about to be removed or taken from children()
 
- Public Attributes inherited from 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 Selectable
ProtectedSignal signalSelectionChanged
 Signals that the selection or size might have changed.
 
- Protected Member Functions inherited from Data
void swapWith (Data &other)
 Swaps the data and emits a matrix and name changed signal for both.
 
- Protected Attributes inherited from 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 Selectable
std::mutex m_selectionMutex
 Mutex protecting the selection.
 
Selection m_sel
 

Member Function Documentation

◆ size()

int size ( ) const
inlineoverridevirtual
Returns
Total number of elements.

Implements Selectable.

◆ describe()

std::string describe ( ) const
overridevirtual

Short description of the stereo image set.

Reimplemented from Data.

◆ children()

virtual DataList children ( ) const
overridevirtual

Returns the list of direct children of this group.

Implements CompoundData.

◆ kind()

virtual Kind kind ( ) const
inlineoverridevirtual

Return the kind of this data.

Implements Data.

◆ matrixConvention()

virtual Pose::TransformationConvention 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 Data.

◆ bounds()

virtual Geometry::AlignedBox 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 Data.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close