MeVisLab Toolbox Reference
Skeleton Class Reference

Skeleton objects represent centerline voxels stored in a VesselEdge object. More...

#include <mlSkeleton.h>

Inheritance diagram for Skeleton:
PropertyContainer

Public Types

Color type of member Skeleton::label
enum  LABELTYPE { TRACECOLOR , CONTINUOUS }
 
- Public Types inherited from PropertyContainer
typedef PropertyManager::Pointer ManagerPointer
 
typedef PropertyManager::ConstPointer ConstManagerPointer
 
typedef PropertyManager::PropertyMap PropertyMap
 

Public Member Functions

 Skeleton (const PropertyManager::Pointer &manager, const Vector3 &pos=Vector3(0), double minDistance=0, double maxDistance=0)
 Constructor. More...
 
 Skeleton (const Skeleton &other)
 Copy Constructor. More...
 
Skeletonoperator= (const Skeleton &other)
 
void copyProperties (const Skeleton *other)
 
bool operator== (const Skeleton &other) const
 
bool operator!= (const Skeleton &other) const
 
 STATIC_GRAPH_PROPERTY (double, area, Area)
 
 STATIC_GRAPH_PROPERTY (double, distanceLabel, DistanceLabel)
 
 STATIC_GRAPH_PROPERTY (double, freeLabel, FreeLabel)
 
 STATIC_GRAPH_PROPERTY (double, label, Label)
 
void addStateToTree (TreeNode *parent) const override
 Attaches the object state as children of the given parent node. More...
 
 ML_SET_ADDSTATE_VERSION (5)
 Set current addStateToTree() version number: More...
 
void readStateFromTree (TreeNode *parent) override
 Reads the object state from the children of the given parent node. More...
 
Skeleton Position
ImageVector voxelPos ()
 Make it easer to access world-position as class ImageVector (int) position, if positions are in fact in voxel-coordinates. More...
 
void transform (const Matrix4 &m)
 Apply a 4x4 homogeneous transformation matrix to the skeleton position. More...
 
void convertToVoxel (Matrix4 *mat)
 convert all coordinates of the skeleton, including its vessel voxels More...
 
void convertToWorld (Matrix4 *mat)
 
Default Measurements
 STATIC_GRAPH_PROPERTY (double, minDistance, MinDistance)
 
Encapsulate std::vector<Vector3>: container of vessel voxels coordinates.
size_t getVoxelNum () const
 
size_t numVesselPos () const
 
void addVesselPos (const Vector3 &position)
 
void addVesselPos (const ImageVector &v)
 
const Vector3 & vesselPos (size_t index) const
 
Vector3 & vesselPos (size_t index)
 
ImageVector vesselVoxelPos (size_t index)
 
void clearVesselPos ()
 
Default Labels

decide whether label is a trace color or continuous gray value.

 STATIC_CASTED_GRAPH_PROPERTY (LABELTYPE, MLuint64, labelType, LabelType)
 
 STATIC_GRAPH_PROPERTY (MLuint64, enumLabel, EnumLabel)
 label to enumerate the skeleton within a graph. not enumerated value is 0. not persistent. More...
 
void setRGBA (float r, float g, float b, float a)
 
void setRGBA (float *rgba)
 
void getRGBA (float *r, float *g, float *b, float *a) const
 
float * getRGBA (void)
 
- Public Member Functions inherited from PropertyContainer
 PropertyContainer (const ManagerPointer &manager)
 
 PropertyContainer (const PropertyContainer &other)
 
 ~PropertyContainer () override
 
bool operator== (const PropertyContainer &other) const
 Check for equality (managers and values). More...
 
bool operator!= (const PropertyContainer &other) const
 Check for inequality (managers and values). More...
 
void copyProperties (const PropertyContainer &other)
 Copy all properties from the given container to this object. More...
 
const PropertyManagergetPropertyManager () const
 Get read-only access to the associated property manager. More...
 
PropertyManagergetPropertyManager ()
 Get access to the associated property manager. More...
 
PropertyMap getPropertyMap () const
 Get a map of the contained properties, can be useful for comparison. More...
 
size_t numberOfProperties () const
 Return the number of properties currently available. More...
 
const PropertyValueproperty (size_t index) const
 Get the property with index index as PropertyValue. More...
 
template<typename T >
Tproperty (size_t index)
 Get the property with index index with type T. Throws boost::bad_get exception if the currently stored property has a different type. More...
 
template<typename T >
const Tproperty (size_t index) const
 Get the property with index index with type T, const version. Throws boost::bad_get exception if the currently stored property has a different type. More...
 
const PropertyValueproperty (const std::string &name) const
 Get the property with name name. More...
 
template<typename T >
Tproperty (const std::string &name)
 
template<typename T >
const Tproperty (const std::string &name) const
 
virtual void reset ()
 Set all properties to default values. More...
 
 ML_ABSTRACT_CLASS_HEADER (PropertyContainer)
 
void addStateToTree (TreeNode *parent) const override
 
 ML_SET_ADDSTATE_VERSION (1)
 Set current addStateToTree() version number: More...
 
void readStateFromTree (TreeNode *parent) override
 Reads the object state from the children of the given parent node. More...
 

Static Public Member Functions

static void setCopyVesselVoxels (bool flag)
 Set global parameter for skeleton copy. More...
 
static void setCopyVesselVoxelsDefault (void)
 

Friends

class Graph
 
class VesselEdge
 

Additional Inherited Members

- Protected Attributes inherited from PropertyContainer
std::vector< PropertyValue_values
 
ManagerPointer _manager
 

Detailed Description

Skeleton objects represent centerline voxels stored in a VesselEdge object.

class Skeleton

Definition at line 34 of file mlSkeleton.h.

Member Enumeration Documentation

◆ LABELTYPE

Enumerator
TRACECOLOR 
CONTINUOUS 

Definition at line 96 of file mlSkeleton.h.

Constructor & Destructor Documentation

◆ Skeleton() [1/2]

Skeleton::Skeleton ( const PropertyManager::Pointer manager,
const Vector3 &  pos = Vector3(0),
double  minDistance = 0,
double  maxDistance = 0 
)

Constructor.

◆ Skeleton() [2/2]

Skeleton::Skeleton ( const Skeleton other)

Copy Constructor.

Member Function Documentation

◆ addStateToTree()

void Skeleton::addStateToTree ( TreeNode *  parent) const
override

Attaches the object state as children of the given parent node.

◆ addVesselPos() [1/2]

void Skeleton::addVesselPos ( const ImageVector &  v)
inline

Definition at line 80 of file mlSkeleton.h.

◆ addVesselPos() [2/2]

void Skeleton::addVesselPos ( const Vector3 &  position)
inline

Definition at line 79 of file mlSkeleton.h.

◆ clearVesselPos()

void Skeleton::clearVesselPos ( )
inline

Definition at line 84 of file mlSkeleton.h.

◆ convertToVoxel()

void Skeleton::convertToVoxel ( Matrix4 *  mat)

convert all coordinates of the skeleton, including its vessel voxels

◆ convertToWorld()

void Skeleton::convertToWorld ( Matrix4 *  mat)

◆ copyProperties()

void Skeleton::copyProperties ( const Skeleton other)

◆ getRGBA() [1/2]

void Skeleton::getRGBA ( float *  r,
float *  g,
float *  b,
float *  a 
) const
inline

Definition at line 122 of file mlSkeleton.h.

◆ getRGBA() [2/2]

float* Skeleton::getRGBA ( void  )
inline

Definition at line 129 of file mlSkeleton.h.

◆ getVoxelNum()

size_t Skeleton::getVoxelNum ( ) const
inline

Definition at line 77 of file mlSkeleton.h.

◆ ML_SET_ADDSTATE_VERSION()

Skeleton::ML_SET_ADDSTATE_VERSION ( )

Set current addStateToTree() version number:

◆ numVesselPos()

size_t Skeleton::numVesselPos ( ) const
inline

Definition at line 78 of file mlSkeleton.h.

◆ operator!=()

bool Skeleton::operator!= ( const Skeleton other) const
inline

Definition at line 51 of file mlSkeleton.h.

◆ operator=()

Skeleton& Skeleton::operator= ( const Skeleton other)

◆ operator==()

bool Skeleton::operator== ( const Skeleton other) const

◆ readStateFromTree()

void Skeleton::readStateFromTree ( TreeNode *  parent)
override

Reads the object state from the children of the given parent node.

◆ setCopyVesselVoxels()

static void Skeleton::setCopyVesselVoxels ( bool  flag)
inlinestatic

Set global parameter for skeleton copy.

Definition at line 142 of file mlSkeleton.h.

◆ setCopyVesselVoxelsDefault()

static void Skeleton::setCopyVesselVoxelsDefault ( void  )
inlinestatic

Definition at line 143 of file mlSkeleton.h.

◆ setRGBA() [1/2]

void Skeleton::setRGBA ( float *  rgba)
inline

Definition at line 118 of file mlSkeleton.h.

◆ setRGBA() [2/2]

void Skeleton::setRGBA ( float  r,
float  g,
float  b,
float  a 
)
inline

Definition at line 111 of file mlSkeleton.h.

◆ STATIC_CASTED_GRAPH_PROPERTY()

Skeleton::STATIC_CASTED_GRAPH_PROPERTY ( LABELTYPE  ,
MLuint64  ,
labelType  ,
LabelType   
)

◆ STATIC_GRAPH_PROPERTY() [1/6]

Skeleton::STATIC_GRAPH_PROPERTY ( double  ,
area  ,
Area   
)

◆ STATIC_GRAPH_PROPERTY() [2/6]

Skeleton::STATIC_GRAPH_PROPERTY ( double  ,
distanceLabel  ,
DistanceLabel   
)

◆ STATIC_GRAPH_PROPERTY() [3/6]

Skeleton::STATIC_GRAPH_PROPERTY ( double  ,
freeLabel  ,
FreeLabel   
)

◆ STATIC_GRAPH_PROPERTY() [4/6]

Skeleton::STATIC_GRAPH_PROPERTY ( double  ,
label  ,
Label   
)

◆ STATIC_GRAPH_PROPERTY() [5/6]

Skeleton::STATIC_GRAPH_PROPERTY ( double  ,
minDistance  ,
MinDistance   
)

◆ STATIC_GRAPH_PROPERTY() [6/6]

Skeleton::STATIC_GRAPH_PROPERTY ( MLuint64  ,
enumLabel  ,
EnumLabel   
)

label to enumerate the skeleton within a graph. not enumerated value is 0. not persistent.

◆ transform()

void Skeleton::transform ( const Matrix4 &  m)

Apply a 4x4 homogeneous transformation matrix to the skeleton position.

◆ vesselPos() [1/2]

Vector3& Skeleton::vesselPos ( size_t  index)
inline

Definition at line 82 of file mlSkeleton.h.

◆ vesselPos() [2/2]

const Vector3& Skeleton::vesselPos ( size_t  index) const
inline

Definition at line 81 of file mlSkeleton.h.

◆ vesselVoxelPos()

ImageVector Skeleton::vesselVoxelPos ( size_t  index)

◆ voxelPos()

ImageVector Skeleton::voxelPos ( )

Make it easer to access world-position as class ImageVector (int) position, if positions are in fact in voxel-coordinates.

Friends And Related Function Documentation

◆ Graph

friend class Graph
friend

Definition at line 36 of file mlSkeleton.h.

◆ VesselEdge

friend class VesselEdge
friend

Definition at line 37 of file mlSkeleton.h.


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