mds::seg::CTetraFeatures Class Reference

#include <mdsTetraFeatures.h>

Inheritance diagram for mds::seg::CTetraFeatures:

[legend]List of all members.

---

Detailed Description

Class encapsulating all triangle features.

Public Types
enum	{ NUM_OF_FEATURES = TetraFeatures::NUM_OF_FEATURES }
	The number of features. More...
enum	{ MEAN_VALUE = 0, VARIANCE }
	Indexes of the most important features. More...
enum	{ ERROR_NOT_EVALUATED = 1, ERROR_CANNOT_EVALUATE = 2 }
	Error codes. More...
typedef double	tFeature
	Type of a value representing some feature.
typedef mds::math::CStaticVector< double, TetraFeatures::NUM_OF_FEATURES >	tVector
	Type of the used static vector.
Public Member Functions
	CTetraFeatures ()
	Default constructor.
int	getError () const
	Returns current error code.
const tFeature &	getFeature (tSize i) const
tFeature &	getFeature (mds::tSize i)
	Returns value of the i-th feature.
int	getNumOfVoxels () const
	Returns the number of voxels taken into account.
const tFeature &	getVoxelMean () const
tFeature &	getVoxelMean ()
	Returns mean value of all voxels in the tetrahedron.
const tFeature &	getVoxelVariance () const
tFeature &	getVoxelVariance ()
	Returns variance of all voxels in the tetrahedron.
bool	isError () const
	Returns true if the previous evaluation of features failed.
void	setError (int iError)
	Sets the error code.
void	setFeature (tSize i, tFeature Value)
	Sets value of the i-th feature.
void	setNumOfVoxels (int iValue)
	Sets the number of voxels.
void	setVoxelMean (tFeature Value)
	Sets the voxel mean.
void	setVoxelVariance (tFeature Value)
	Sets the voxel variance.
	~CTetraFeatures ()
	Destructor.
Protected Attributes
int	m_iError
	Errors while evaluating the features.
int	m_iNumOfVoxels
	Total number of voxels.
tFeature	m_VoxelVariance
	Variance of the voxel values.

---

Member Typedef Documentation

typedef double mds::seg::CTetraFeatures::tFeature

Type of a value representing some feature.

typedef mds::math::CStaticVector<double, TetraFeatures::NUM_OF_FEATURES> mds::seg::CTetraFeatures::tVector

Type of the used static vector.

---

Member Enumeration Documentation

anonymous enum

The number of features. Enumerator: NUM_OF_FEATURES

anonymous enum

Indexes of the most important features. Enumerator: MEAN_VALUE  VARIANCE

anonymous enum

Error codes. Enumerator: ERROR_NOT_EVALUATED  ERROR_CANNOT_EVALUATE

---

Constructor & Destructor Documentation

mds::seg::CTetraFeatures::CTetraFeatures (   )  [inline]

Default constructor.

mds::seg::CTetraFeatures::~CTetraFeatures (   )  [inline]

Destructor.

---

Member Function Documentation

int mds::seg::CTetraFeatures::getError (   )  const [inline]

Returns current error code.

const tFeature& mds::seg::CTetraFeatures::getFeature (  tSize  i  )  const [inline]

tFeature& mds::seg::CTetraFeatures::getFeature (  mds::tSize  i  )  [inline]

Returns value of the i-th feature.

int mds::seg::CTetraFeatures::getNumOfVoxels (   )  const [inline]

Returns the number of voxels taken into account.

const tFeature& mds::seg::CTetraFeatures::getVoxelMean (   )  const [inline]

tFeature& mds::seg::CTetraFeatures::getVoxelMean (   )  [inline]

Returns mean value of all voxels in the tetrahedron.

const tFeature& mds::seg::CTetraFeatures::getVoxelVariance (   )  const [inline]

tFeature& mds::seg::CTetraFeatures::getVoxelVariance (   )  [inline]

Returns variance of all voxels in the tetrahedron.

bool mds::seg::CTetraFeatures::isError (   )  const [inline]

Returns true if the previous evaluation of features failed.

void mds::seg::CTetraFeatures::setError (  int  iError  )  [inline]

Sets the error code.

void mds::seg::CTetraFeatures::setFeature (  tSize  i, tFeature  Value )  [inline]

Sets value of the i-th feature.

void mds::seg::CTetraFeatures::setNumOfVoxels (  int  iValue  )  [inline]

Sets the number of voxels.

void mds::seg::CTetraFeatures::setVoxelMean (  tFeature  Value  )  [inline]

Sets the voxel mean.

void mds::seg::CTetraFeatures::setVoxelVariance (  tFeature  Value  )  [inline]

Sets the voxel variance.

---

Member Data Documentation

int mds::seg::CTetraFeatures::m_iError [protected]

Errors while evaluating the features.

int mds::seg::CTetraFeatures::m_iNumOfVoxels [protected]

Total number of voxels.

tFeature mds::seg::CTetraFeatures::m_VoxelVariance [protected]

Variance of the voxel values.

---

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

• mdsTetraFeatures.h

---