MeVisLab Toolbox Reference
ml::ClusterRefType Class Reference

Container class derived from ClusterInfo. More...

#include <mlClusterRefCollection.h>

Inheritance diagram for ml::ClusterRefType:
ml::ClusterInfo

Public Member Functions

 ClusterRefType ()
 
ML_FORCE_INLINE void setIndexId (MLuint newIndex)
 Sets a table index. More...
 
ML_FORCE_INLINE void setNumVoxels (MLuint newNumVoxels)
 Sets the cluster size in voxel. More...
 
ML_FORCE_INLINE void setRank (MLuint newRank)
 Sets the rank of the cluster. More...
 
- Public Member Functions inherited from ml::ClusterInfo
 ClusterInfo ()
 Default constructor. More...
 
virtual ~ClusterInfo ()
 Default destructor. More...
 
ML_FORCE_INLINE MLuint getId () const
 Returns a unique id; default is 0. More...
 
ML_FORCE_INLINE MLuint numVoxels () const
 Returns the cluster size in voxel; default is 0. More...
 
ML_FORCE_INLINE MLuint rank () const
 Returns the rank of the cluster size compared to the other clusters; default is 0. More...
 
ML_FORCE_INLINE MLdouble userData () const
 Returns the user data value. More...
 
ML_FORCE_INLINE void setUserData (MLdouble userData)
 Sets the user data. More...
 
ML_FORCE_INLINE MLdouble imageValue () const
 Returns the image value associated with this cluster. More...
 
ML_FORCE_INLINE void setImageValue (MLdouble imageValue)
 Sets the image value associated with this cluster. More...
 
ML_FORCE_INLINE void addPositionToBoundingBox (MLint x, MLint y, MLint z)
 Adds the given position to this cluster's bounding box. More...
 
ML_FORCE_INLINE Vector3 getBoundingBoxMin () const
 Returns the min bounding box position. More...
 
ML_FORCE_INLINE Vector3 getBoundingBoxMax () const
 Returns the max bounding box position. More...
 

Public Attributes

ClusterRefTypelink
 Holds pointer to another element in array stored in ClusterRefCollection. More...
 

Additional Inherited Members

- Protected Attributes inherited from ml::ClusterInfo
MLuint _indexId
 Unique cluster id; default is 0. More...
 
MLuint _numVoxels
 Cluster size in voxel; default is 0. More...
 
MLuint _rank
 Rank of the cluster size compared to other cluster; default is 0. More...
 
MLdouble _userData
 User data, by default its value is set to the rank or original voxel value. More...
 
MLdouble _imageValue
 Image value, only meaningful if Identical Intensities is used in the clustering algorithm. More...
 
ClusterBoundingBox _boundingBox
 

Detailed Description

Container class derived from ClusterInfo.

ONLY for use in ClusterRefCollection.

Definition at line 42 of file mlClusterRefCollection.h.

Constructor & Destructor Documentation

◆ ClusterRefType()

ml::ClusterRefType::ClusterRefType ( )
inline

Definition at line 46 of file mlClusterRefCollection.h.

Member Function Documentation

◆ setIndexId()

ML_FORCE_INLINE void ml::ClusterRefType::setIndexId ( MLuint  newIndex)
inline

Sets a table index.

Definition at line 56 of file mlClusterRefCollection.h.

◆ setNumVoxels()

ML_FORCE_INLINE void ml::ClusterRefType::setNumVoxels ( MLuint  newNumVoxels)
inline

Sets the cluster size in voxel.

Definition at line 58 of file mlClusterRefCollection.h.

◆ setRank()

ML_FORCE_INLINE void ml::ClusterRefType::setRank ( MLuint  newRank)
inline

Sets the rank of the cluster.

Definition at line 60 of file mlClusterRefCollection.h.

Member Data Documentation

◆ link

ClusterRefType* ml::ClusterRefType::link

Holds pointer to another element in array stored in ClusterRefCollection.

Is intentionally public to get faster access. DON'T use it except you really know what you do!

Definition at line 65 of file mlClusterRefCollection.h.


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