ml::ClusterRefVolume Class Reference

A stack of slices where each entry encodes an id of a ClusterRef. More...

#include <mlClusterRefVolume.h>

Public Member Functions
	ClusterRefVolume ()
	Constructor.
	~ClusterRefVolume ()
	Destructor, cleanup.
MLErrorCode	init (MLuint x, MLuint y, MLuint z)
	Init volume, reserve memory.
ML_FORCE_INLINE bool	isInitialized () const
	Returns whether the volume is initialized.
ML_FORCE_INLINE MLuint	getClusterRef (MLuint x, MLuint y, MLuint z) const
	Returns the cluster reference for the volume position.
ML_FORCE_INLINE void	setClusterRef (MLuint x, MLuint y, MLuint z, MLuint clusterRef)
	Sets a cluster reference for volume position.
MLuint	sizeX () const
MLuint	sizeY () const
MLuint	sizeZ () const
MLuint	getSize () const
	For backward compatibility in ConnectComp.

Protected Member Functions
void	_deleteArrays ()
	Deletes all allocated structures.

Detailed Description

A stack of slices where each entry encodes an id of a ClusterRef.

There are as many slices as the input image has and each slices has the same size as the input image's slice. In short, this structure holds a reference id for each voxel of the input image.

Definition at line 27 of file mlClusterRefVolume.h.

Constructor & Destructor Documentation

ClusterRefVolume()

ml::ClusterRefVolume::ClusterRefVolume

(

)

Constructor.

~ClusterRefVolume()

ml::ClusterRefVolume::~ClusterRefVolume

(

)

Destructor, cleanup.

Member Function Documentation

_deleteArrays()

void ml::ClusterRefVolume::_deleteArrays ( )

protected

Deletes all allocated structures.

getClusterRef()

MLuint ml::ClusterRefVolume::getClusterRef ( MLuint  x, MLuint  y, MLuint  z  ) const

inline

Returns the cluster reference for the volume position.

Definition at line 71 of file mlClusterRefVolume.h.

getSize()

MLuint ml::ClusterRefVolume::getSize

(

)

const

For backward compatibility in ConnectComp.

Deprecated!

init()

MLErrorCode ml::ClusterRefVolume::init	(	MLuint	x,
		MLuint	y,
		MLuint	z
	)

Init volume, reserve memory.

isInitialized()

ML_FORCE_INLINE bool ml::ClusterRefVolume::isInitialized ( ) const

inline

Returns whether the volume is initialized.

Definition at line 40 of file mlClusterRefVolume.h.

setClusterRef()

void ml::ClusterRefVolume::setClusterRef ( MLuint  x, MLuint  y, MLuint  z, MLuint  clusterRef  )

inline

Sets a cluster reference for volume position.

Definition at line 78 of file mlClusterRefVolume.h.

sizeX()

MLuint ml::ClusterRefVolume::sizeX ( ) const

inline

Definition at line 48 of file mlClusterRefVolume.h.

sizeY()

MLuint ml::ClusterRefVolume::sizeY ( ) const

inline

Definition at line 49 of file mlClusterRefVolume.h.

sizeZ()

MLuint ml::ClusterRefVolume::sizeZ ( ) const

inline

Definition at line 50 of file mlClusterRefVolume.h.

---

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

• MeVisLab/Standard/Sources/Shared/MLClusterAlgorithm/mlClusterRefVolume.h