The CSOVoxelSet represents a contour segmentation object in discrete voxel coordinates. More...

#include <CSOVoxelSet.h>

Public Member Functions
	CSOVoxelSet ()
	Standard constructor. The unique id is initialized with 0.
	CSOVoxelSet (const CSOVoxelSet &csoVoxelSet)
	Copy constructor; the unique id is initialized with 0.
virtual	~CSOVoxelSet ()
	Standard destructor.
void	addVoxelValuePositions (const std::vector< Vector3 > &positions, const std::vector< MLdouble > &values)
	Adds a vector of positions at once.
size_t	numTotalVoxels () const
	Returns the number of total voxel positions.
Vector3	getVoxelPositionOfTotal (size_t index) const
	Returns a voxel position regardless of its slice.
double	getVoxelValueOfTotal (size_t index) const
	Returns a voxel value regardless of its slice.
void	setVoxelToWorldMatrix (const Matrix4 &voxelToWorldMatrix)
	Sets the voxel-to-world matrix.
const Matrix4 &	getVoxelToWorldMatrix () const
	Returns the voxel-to-world matrix.
size_t	numSlices () const
	Returns the number of slices the voxels are spread over.
unsigned int	startingSlice () const
	Returns the starting slice.
unsigned int	endingSlice () const
	Returns the ending slice.
const VoxelVector &	getPositionsAt (size_t index) const
	Returns the list of positions at a given index.
const VoxelValueVector &	getValuesAt (size_t index) const
	Returns the list of values at a given index.
unsigned int	numVoxelsOnSliceAt (size_t sliceIndex) const
	Returns the number of voxels for the given slice.
Vector3	getVoxelPositionAtSlice (size_t sliceIndex, size_t voxelIndex) const
	Returns a voxel position for a given slice at a given index.
void	getVoxelPositionAtSlice (size_t sliceIndex, size_t voxelIndex, int &x, int &y)
	Fills up the given x and y variables by a voxel position on a certain slice at a certain index.
bool	getVoxelValueAtSlice (size_t sliceIndex, size_t voxelIndex, double &val) const
	Returns a voxel value for a given slice at a given index.
void	setCSOVoxelSetList (CSOVoxelSetList *list)
	Sets the CSOVoxelSetList pointer.
CSOVoxelSetList *	csoVoxelSetList () const
	Returns the CSOVoxelSetList pointer.
unsigned int	numGroups () const
	Returns the number of Groups this is in.
int	groupIdAt (size_t index) const
	Returns the id of a Group at the given index.
void	addCSOVoxelSetGroupId (int groupId)
	Adds an id of a Group.
void	setLabel (const std::string &labelArg)
	Sets the label.
const std::string &	label () const
	Returns the label.
void	setCreator (const std::string creatorArg)
	Sets the creator.
const std::string &	creator () const
	Returns the creator.
void	setTimepoint (int timepointArg)
	Sets the timepoint.
int	timepoint () const
	Returns the timepoint.
void	setDescription (const std::string &descriptionArg)
	Sets the description.
const std::string &	description () const
	Returns the description.
void	setUniqueId (int id)
	Sets the unique id.
int	uniqueId () const
	Returns the unique id.

Detailed Description

The CSOVoxelSet represents a contour segmentation object in discrete voxel coordinates.

The voxel positions are arranged in internal lists of slices, and a list of voxel positions for each slice.

Definition at line 44 of file CSOVoxelSet.h.

Constructor & Destructor Documentation

ml::CSOVoxelSet::CSOVoxelSet ( )

Standard constructor. The unique id is initialized with 0.

ml::CSOVoxelSet::CSOVoxelSet ( const CSOVoxelSet & csoVoxelSet )

Copy constructor; the unique id is initialized with 0.

virtual ml::CSOVoxelSet::~CSOVoxelSet ( ) [virtual]

Standard destructor.

Member Function Documentation

void ml::CSOVoxelSet::addCSOVoxelSetGroupId ( int groupId ) [inline]

Adds an id of a Group.

Definition at line 101 of file CSOVoxelSet.h.

void ml::CSOVoxelSet::addVoxelValuePositions	(	const std::vector< Vector3 > &	positions,
		const std::vector< MLdouble > &	values
	)

Adds a vector of positions at once.

const std::string& ml::CSOVoxelSet::creator ( ) const [inline]

Returns the creator.

Definition at line 110 of file CSOVoxelSet.h.

CSOVoxelSetList* ml::CSOVoxelSet::csoVoxelSetList ( ) const [inline]

Returns the CSOVoxelSetList pointer.

Definition at line 95 of file CSOVoxelSet.h.

const std::string& ml::CSOVoxelSet::description ( ) const [inline]

Returns the description.

Definition at line 118 of file CSOVoxelSet.h.

unsigned int ml::CSOVoxelSet::endingSlice ( ) const

Returns the ending slice.

const VoxelVector& ml::CSOVoxelSet::getPositionsAt ( size_t index ) const

Returns the list of positions at a given index.

const VoxelValueVector& ml::CSOVoxelSet::getValuesAt ( size_t index ) const

Returns the list of values at a given index.

Vector3 ml::CSOVoxelSet::getVoxelPositionAtSlice	(	size_t	sliceIndex,
		size_t	voxelIndex
	)		const

Returns a voxel position for a given slice at a given index.

void ml::CSOVoxelSet::getVoxelPositionAtSlice	(	size_t	sliceIndex,
		size_t	voxelIndex,
		int &	x,
		int &	y
	)

Fills up the given x and y variables by a voxel position on a certain slice at a certain index.

Vector3 ml::CSOVoxelSet::getVoxelPositionOfTotal ( size_t index ) const

Returns a voxel position regardless of its slice.

const Matrix4& ml::CSOVoxelSet::getVoxelToWorldMatrix ( ) const [inline]

Returns the voxel-to-world matrix.

Definition at line 70 of file CSOVoxelSet.h.

bool ml::CSOVoxelSet::getVoxelValueAtSlice	(	size_t	sliceIndex,
		size_t	voxelIndex,
		double &	val
	)		const

Returns a voxel value for a given slice at a given index.

double ml::CSOVoxelSet::getVoxelValueOfTotal ( size_t index ) const

Returns a voxel value regardless of its slice.

int ml::CSOVoxelSet::groupIdAt ( size_t index ) const [inline]

Returns the id of a Group at the given index.

Definition at line 99 of file CSOVoxelSet.h.

const std::string& ml::CSOVoxelSet::label ( ) const [inline]

Returns the label.

Definition at line 106 of file CSOVoxelSet.h.

unsigned int ml::CSOVoxelSet::numGroups ( ) const [inline]

Returns the number of Groups this is in.

Definition at line 97 of file CSOVoxelSet.h.

size_t ml::CSOVoxelSet::numSlices ( ) const

Returns the number of slices the voxels are spread over.

size_t ml::CSOVoxelSet::numTotalVoxels ( ) const

Returns the number of total voxel positions.

unsigned int ml::CSOVoxelSet::numVoxelsOnSliceAt ( size_t sliceIndex ) const

Returns the number of voxels for the given slice.

void ml::CSOVoxelSet::setCreator ( const std::string creatorArg ) [inline]

Sets the creator.

Definition at line 108 of file CSOVoxelSet.h.

void ml::CSOVoxelSet::setCSOVoxelSetList ( CSOVoxelSetList * list ) [inline]

Sets the CSOVoxelSetList pointer.

Definition at line 93 of file CSOVoxelSet.h.

void ml::CSOVoxelSet::setDescription ( const std::string & descriptionArg ) [inline]

Sets the description.

Definition at line 116 of file CSOVoxelSet.h.

void ml::CSOVoxelSet::setLabel ( const std::string & labelArg ) [inline]

Sets the label.

Definition at line 104 of file CSOVoxelSet.h.

void ml::CSOVoxelSet::setTimepoint ( int timepointArg ) [inline]

Sets the timepoint.

Definition at line 112 of file CSOVoxelSet.h.

void ml::CSOVoxelSet::setUniqueId ( int id ) [inline]

Sets the unique id.

Definition at line 122 of file CSOVoxelSet.h.

void ml::CSOVoxelSet::setVoxelToWorldMatrix ( const Matrix4 & voxelToWorldMatrix ) [inline]

Sets the voxel-to-world matrix.

Definition at line 68 of file CSOVoxelSet.h.

unsigned int ml::CSOVoxelSet::startingSlice ( ) const

Returns the starting slice.

int ml::CSOVoxelSet::timepoint ( ) const [inline]

Returns the timepoint.

Definition at line 114 of file CSOVoxelSet.h.

int ml::CSOVoxelSet::uniqueId ( ) const [inline]

Returns the unique id.

Definition at line 124 of file CSOVoxelSet.h.

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

MeVisLab/Standard/Sources/ML/MLCSO/CSOBase/CSOVoxelSet/CSOVoxelSet.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation