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 (double).

void	addVoxelValuePositions (const std::vector< VoxelPosition > &positions, const std::vector< MLdouble > &values)
	Adds a vector of positions at once (MLint).

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 specified index.

const VoxelValueVector &	getValuesAt (size_t index) const
	Returns the list of values at a specified index.

unsigned int	numVoxelsOnSliceAt (size_t sliceIndex) const
	Returns the number of voxels for the specified slice.

Vector3	getVoxelPositionAtSlice (size_t sliceIndex, size_t voxelIndex) const
	Returns a voxel position for a specified slice at a specified index.

void	getVoxelPositionAtSlice (size_t sliceIndex, size_t voxelIndex, int &x, int &y)
	Fills up the specified x and y variables by a voxel position on a specified slice at a specified index.

bool	getVoxelValueAtSlice (size_t sliceIndex, size_t voxelIndex, double &val) const
	Returns a voxel value for a specified slice at a specified index.

Vector3	getBoundingBoxV1 () const
	Returns the minimum bounding box corner.

Vector3	getBoundingBoxV2 () const
	Returns the maximum bounding box corner.

MLdouble	getMinVoxelValue () const
	Returns the minimum voxel value.

MLdouble	getMaxVoxelValue () const
	Returns the maximum voxel value.

void	setCSOVoxelSetList (CSOVoxelSetList *list)
	Sets the CSOVoxelSetList pointer.

CSOVoxelSetList *	csoVoxelSetList () const
	Returns the CSOVoxelSetList pointer.

unsigned int	numGroups () const
	Returns the number of CSOVoxelSetGroups this is in.

int	groupIdAt (size_t index) const
	Returns the ID of a CSOVoxelSetGroup at the specified index.

void	addCSOVoxelSetGroupId (int groupId)
	Adds an ID of a CSOVoxelSetGroup.

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 49 of file CSOVoxelSet.h.

Constructor & Destructor Documentation

◆ CSOVoxelSet() [1/2]

ml::CSOVoxelSet::CSOVoxelSet ( )

Standard constructor. The unique ID is initialized with 0.

◆ CSOVoxelSet() [2/2]

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

Copy constructor. The unique ID is initialized with 0.

◆ ~CSOVoxelSet()

virtual ml::CSOVoxelSet::~CSOVoxelSet ( )

virtual

Standard destructor.

Member Function Documentation

◆ addCSOVoxelSetGroupId()

void ml::CSOVoxelSet::addCSOVoxelSetGroupId ( int groupId )

inline

Adds an ID of a CSOVoxelSetGroup.

Definition at line 115 of file CSOVoxelSet.h.

◆ addVoxelValuePositions() [1/2]

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

Adds a vector of positions at once (double).

◆ addVoxelValuePositions() [2/2]

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

Adds a vector of positions at once (MLint).

◆ creator()

const std::string & ml::CSOVoxelSet::creator ( ) const

inline

Returns the creator.

Definition at line 124 of file CSOVoxelSet.h.

◆ csoVoxelSetList()

CSOVoxelSetList * ml::CSOVoxelSet::csoVoxelSetList ( ) const

inline

Returns the CSOVoxelSetList pointer.

Definition at line 109 of file CSOVoxelSet.h.

◆ description()

const std::string & ml::CSOVoxelSet::description ( ) const

inline

Returns the description.

Definition at line 132 of file CSOVoxelSet.h.

◆ endingSlice()

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

Returns the ending slice.

◆ getBoundingBoxV1()

Vector3 ml::CSOVoxelSet::getBoundingBoxV1 ( ) const

inline

Returns the minimum bounding box corner.

Definition at line 98 of file CSOVoxelSet.h.

◆ getBoundingBoxV2()

Vector3 ml::CSOVoxelSet::getBoundingBoxV2 ( ) const

inline

Returns the maximum bounding box corner.

Definition at line 100 of file CSOVoxelSet.h.

◆ getMaxVoxelValue()

MLdouble ml::CSOVoxelSet::getMaxVoxelValue ( ) const

inline

Returns the maximum voxel value.

Definition at line 104 of file CSOVoxelSet.h.

◆ getMinVoxelValue()

MLdouble ml::CSOVoxelSet::getMinVoxelValue ( ) const

inline

Returns the minimum voxel value.

Definition at line 102 of file CSOVoxelSet.h.

◆ getPositionsAt()

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

Returns the list of positions at a specified index.

◆ getValuesAt()

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

Returns the list of values at a specified index.

◆ getVoxelPositionAtSlice() [1/2]

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

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

◆ getVoxelPositionAtSlice() [2/2]

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

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

◆ getVoxelPositionOfTotal()

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

Returns a voxel position regardless of its slice.

◆ getVoxelToWorldMatrix()

const Matrix4 & ml::CSOVoxelSet::getVoxelToWorldMatrix ( ) const

inline

Returns the voxel-to-world matrix.

Definition at line 77 of file CSOVoxelSet.h.

◆ getVoxelValueAtSlice()

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

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

◆ getVoxelValueOfTotal()

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

Returns a voxel value regardless of its slice.

◆ groupIdAt()

int ml::CSOVoxelSet::groupIdAt ( size_t index ) const

inline

Returns the ID of a CSOVoxelSetGroup at the specified index.

Definition at line 113 of file CSOVoxelSet.h.

◆ label()

const std::string & ml::CSOVoxelSet::label ( ) const

inline

Returns the label.

Definition at line 120 of file CSOVoxelSet.h.

◆ numGroups()

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

inline

Returns the number of CSOVoxelSetGroups this is in.

Definition at line 111 of file CSOVoxelSet.h.

◆ numSlices()

size_t ml::CSOVoxelSet::numSlices ( ) const

Returns the number of slices the voxels are spread over.

◆ numTotalVoxels()

size_t ml::CSOVoxelSet::numTotalVoxels ( ) const

Returns the number of total voxel positions.

◆ numVoxelsOnSliceAt()

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

Returns the number of voxels for the specified slice.

◆ setCreator()

void ml::CSOVoxelSet::setCreator ( const std::string & creatorArg )

inline

Sets the creator.

Definition at line 122 of file CSOVoxelSet.h.

◆ setCSOVoxelSetList()

void ml::CSOVoxelSet::setCSOVoxelSetList ( CSOVoxelSetList * list )

inline

Sets the CSOVoxelSetList pointer.

Definition at line 107 of file CSOVoxelSet.h.

◆ setDescription()

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

inline

Sets the description.

Definition at line 130 of file CSOVoxelSet.h.

◆ setLabel()

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

inline

Sets the label.

Definition at line 118 of file CSOVoxelSet.h.

◆ setTimepoint()

void ml::CSOVoxelSet::setTimepoint ( int timepointArg )

inline

Sets the timepoint.

Definition at line 126 of file CSOVoxelSet.h.

◆ setUniqueId()

void ml::CSOVoxelSet::setUniqueId ( int ID )

inline

Sets the unique ID.

Definition at line 136 of file CSOVoxelSet.h.

◆ setVoxelToWorldMatrix()

void ml::CSOVoxelSet::setVoxelToWorldMatrix ( const Matrix4 & voxelToWorldMatrix )

inline

Sets the voxel-to-world matrix.

Definition at line 75 of file CSOVoxelSet.h.

◆ startingSlice()

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

Returns the starting slice.

◆ timepoint()

int ml::CSOVoxelSet::timepoint ( ) const

inline

Returns the timepoint.

Definition at line 128 of file CSOVoxelSet.h.

◆ uniqueId()

int ml::CSOVoxelSet::uniqueId ( ) const

inline

Returns the unique ID.

Definition at line 138 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

◆ CSOVoxelSet() [1/2]

◆ CSOVoxelSet() [2/2]

◆ ~CSOVoxelSet()

Member Function Documentation

◆ addCSOVoxelSetGroupId()

◆ addVoxelValuePositions() [1/2]

◆ addVoxelValuePositions() [2/2]

◆ creator()

◆ csoVoxelSetList()

◆ description()

◆ endingSlice()

◆ getBoundingBoxV1()

◆ getBoundingBoxV2()

◆ getMaxVoxelValue()

◆ getMinVoxelValue()

◆ getPositionsAt()

◆ getValuesAt()

◆ getVoxelPositionAtSlice() [1/2]

◆ getVoxelPositionAtSlice() [2/2]

◆ getVoxelPositionOfTotal()

◆ getVoxelToWorldMatrix()

◆ getVoxelValueAtSlice()

◆ getVoxelValueOfTotal()

◆ groupIdAt()

◆ label()

◆ numGroups()

◆ numSlices()

◆ numTotalVoxels()

◆ numVoxelsOnSliceAt()

◆ setCreator()

◆ setCSOVoxelSetList()

◆ setDescription()

◆ setLabel()

◆ setTimepoint()

◆ setUniqueId()

◆ setVoxelToWorldMatrix()

◆ startingSlice()

◆ timepoint()

◆ uniqueId()