#include <CSOVoxelSetList.h>

Inheritance diagram for ml::CSOVoxelSetList:

Public Member Functions
	CSOVoxelSetList ()
	Standard constructor.

	~CSOVoxelSetList () override
	Standard destructor.

void	destroy ()
	Deletes internal structures.

void	setupInternalStructureAsCSOList (CSOList csoList, PagedImage image=nullptr)
	Establishes the internal structure as the specified CSOList.

void	setupInternalStructureAsImage (const PagedImage *image)
	Establishes the internal structure fitting to the specified image.

int	numCSOVoxelSet () const
	Returns the number of CSOVoxelSets.

CSOVoxelSet *	csoVoxelSetAt (size_t index) const
	Returns the pointer to a CSOVoxelSet at a specified index.

CSOVoxelSet *	csoVoxelSetWithId (int id)
	Returns the pointer to a CSOVoxelSet with a specified ID. The nullptr is returned if the voxel set does not exist.

CSOVoxelSet *	addCSOVoxelSet ()
	Adds and returns a new CSOVoxelSet.

void	addOrReplaceCSOVoxelSetWithId (int id, const CSOVoxelSet &other)
	Adds or replaces an existing CSOVoxelSet with the specified ID in this list.

void	removeCSOVoxelSetWithId (int id)
	Removes a CSOVoxelSet with a specifed ID.

int	numCSOVoxelSetGroup () const
	Returns the number of CSOVoxelSetGroups.

CSOVoxelSetGroup *	csoVoxelSetGroupAt (size_t index) const
	Returns the pointer to a CSOVoxelSetGroup at a specified index.

CSOVoxelSetGroup *	csoVoxelSetGroupWithId (int id)
	Returns the pointer to a CSOVoxelSetGroup with a specified ID. The nullptr is returned if the CSOVoxelSetGroup does not exist.

CSOVoxelSetGroup *	addCSOVoxelSetGroup ()
	Adds and returns a new CSOVoxelSetGroup.

int	getMaxTimepointIndex () const
	Computes and returns the maximum time point index.

MLdouble	getMinVoxelValue () const
	Computes and returns the minimum voxel value.

MLdouble	getMaxVoxelValue () const
	Computes and returns the maximum voxel value.

bool	isInsideImage (const Vector3 &position)
	Returns whether a specified position is inside the association image.

const SubImageBox &	getImageBox () const
	Returns the image box (the box is empty if no valid PagedImage was available).

void	setSubImageBox (const SubImageBox &subImageBox)
	Sets the SubImageBox.

Matrix4	getVoxelToWorldMatrix () const
	Returns the image matrix if a valid PagedImage was set. Otherwise, it returns the identity matrix.

void	setVoxelToWorldMatrix (const Matrix4 &voxelToWorldMatrix)
	Sets the voxelToWorldMatrix.

Public Member Functions inherited from ml::Base
	Base ()
	Constructor.

virtual	~Base ()
	Destructor.

virtual Base *	deepCopy () const
	Creates a deep copy of the given object.

bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Checks whether this object's type is equal to or derived from one of the types given in the argument.

virtual bool	isRefCountedBase () const
	Returns whether the instance is derived from RefCountedBase.

virtual std::string	detailString () const
	Returns a string describing this object.

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class.

virtual std::string	persistentState () const
	Returns a string describing the object's internal state.

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using persistentState().

virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Writes the objects state to the data stream object.

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Reads the objects state from the data stream object.

void	addStateToTree (TreeNode *parent) const override

	ML_SET_ADDSTATE_VERSION (2)

void	readStateFromTree (TreeNode *parent) override
	Implements import functionality (as used by the LoadBase module).

Additional Inherited Members
Public Types inherited from ml::Base
enum	PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
	This enum describes the different persistence interfaces available. More...

Detailed Description

Definition at line 31 of file CSOVoxelSetList.h.

Constructor & Destructor Documentation

◆ CSOVoxelSetList()

ml::CSOVoxelSetList::CSOVoxelSetList ( )

Standard constructor.

◆ ~CSOVoxelSetList()

ml::CSOVoxelSetList::~CSOVoxelSetList ( )

override

Standard destructor.

Member Function Documentation

◆ addCSOVoxelSet()

CSOVoxelSet * ml::CSOVoxelSetList::addCSOVoxelSet ( )

Adds and returns a new CSOVoxelSet.

◆ addCSOVoxelSetGroup()

CSOVoxelSetGroup * ml::CSOVoxelSetList::addCSOVoxelSetGroup ( )

Adds and returns a new CSOVoxelSetGroup.

◆ addOrReplaceCSOVoxelSetWithId()

void ml::CSOVoxelSetList::addOrReplaceCSOVoxelSetWithId	(	int	id,
		const CSOVoxelSet &	other
	)

Adds or replaces an existing CSOVoxelSet with the specified ID in this list.

◆ addStateToTree()

void ml::CSOVoxelSetList::addStateToTree ( TreeNode * parent ) const

overridevirtual

Persistence Implements export functionality (as used by the SaveBase module).

Reimplemented from ml::Base.

◆ csoVoxelSetAt()

CSOVoxelSet * ml::CSOVoxelSetList::csoVoxelSetAt ( size_t index ) const

inline

Returns the pointer to a CSOVoxelSet at a specified index.

Definition at line 57 of file CSOVoxelSetList.h.

◆ csoVoxelSetGroupAt()

CSOVoxelSetGroup * ml::CSOVoxelSetList::csoVoxelSetGroupAt ( size_t index ) const

inline

Returns the pointer to a CSOVoxelSetGroup at a specified index.

Definition at line 72 of file CSOVoxelSetList.h.

◆ csoVoxelSetGroupWithId()

CSOVoxelSetGroup * ml::CSOVoxelSetList::csoVoxelSetGroupWithId ( int id )

Returns the pointer to a CSOVoxelSetGroup with a specified ID. The nullptr is returned if the CSOVoxelSetGroup does not exist.

◆ csoVoxelSetWithId()

CSOVoxelSet * ml::CSOVoxelSetList::csoVoxelSetWithId ( int id )

Returns the pointer to a CSOVoxelSet with a specified ID. The nullptr is returned if the voxel set does not exist.

◆ destroy()

void ml::CSOVoxelSetList::destroy ( )

Deletes internal structures.

◆ getImageBox()

const SubImageBox & ml::CSOVoxelSetList::getImageBox ( ) const

inline

Returns the image box (the box is empty if no valid PagedImage was available).

Definition at line 88 of file CSOVoxelSetList.h.

◆ getMaxTimepointIndex()

int ml::CSOVoxelSetList::getMaxTimepointIndex ( ) const

Computes and returns the maximum time point index.

◆ getMaxVoxelValue()

MLdouble ml::CSOVoxelSetList::getMaxVoxelValue ( ) const

Computes and returns the maximum voxel value.

◆ getMinVoxelValue()

MLdouble ml::CSOVoxelSetList::getMinVoxelValue ( ) const

Computes and returns the minimum voxel value.

◆ getVoxelToWorldMatrix()

Matrix4 ml::CSOVoxelSetList::getVoxelToWorldMatrix ( ) const

inline

Returns the image matrix if a valid PagedImage was set. Otherwise, it returns the identity matrix.

Definition at line 92 of file CSOVoxelSetList.h.

◆ isInsideImage()

bool ml::CSOVoxelSetList::isInsideImage ( const Vector3 & position )

Returns whether a specified position is inside the association image.

If there is no associated image, the method always returns true.

◆ ML_SET_ADDSTATE_VERSION()

ml::CSOVoxelSetList::ML_SET_ADDSTATE_VERSION ( 2 )

◆ numCSOVoxelSet()

int ml::CSOVoxelSetList::numCSOVoxelSet ( ) const

inline

Returns the number of CSOVoxelSets.

Definition at line 55 of file CSOVoxelSetList.h.

◆ numCSOVoxelSetGroup()

int ml::CSOVoxelSetList::numCSOVoxelSetGroup ( ) const

inline

Returns the number of CSOVoxelSetGroups.

Definition at line 70 of file CSOVoxelSetList.h.

◆ readStateFromTree()

void ml::CSOVoxelSetList::readStateFromTree ( TreeNode * parent )

overridevirtual

Implements import functionality (as used by the LoadBase module).

Reimplemented from ml::Base.

◆ removeCSOVoxelSetWithId()

void ml::CSOVoxelSetList::removeCSOVoxelSetWithId ( int id )

Removes a CSOVoxelSet with a specifed ID.

◆ setSubImageBox()

void ml::CSOVoxelSetList::setSubImageBox ( const SubImageBox & subImageBox )

inline

Sets the SubImageBox.

Definition at line 90 of file CSOVoxelSetList.h.

◆ setupInternalStructureAsCSOList()

void ml::CSOVoxelSetList::setupInternalStructureAsCSOList	(	CSOList *	csoList,
		PagedImage *	image = `nullptr`
	)

Establishes the internal structure as the specified CSOList.

If a PagedImage is specified, only the voxel positions that are actually inside that image are stored.

◆ setupInternalStructureAsImage()

void ml::CSOVoxelSetList::setupInternalStructureAsImage ( const PagedImage * image )

Establishes the internal structure fitting to the specified image.

There will be one CSOVoxelSet per z-slice (and c/t/u).

◆ setVoxelToWorldMatrix()

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

inline

Sets the voxelToWorldMatrix.

Definition at line 94 of file CSOVoxelSetList.h.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSOVoxelSetList()

◆ ~CSOVoxelSetList()

Member Function Documentation

◆ addCSOVoxelSet()

◆ addCSOVoxelSetGroup()

◆ addOrReplaceCSOVoxelSetWithId()

◆ addStateToTree()

◆ csoVoxelSetAt()

◆ csoVoxelSetGroupAt()

◆ csoVoxelSetGroupWithId()

◆ csoVoxelSetWithId()

◆ destroy()

◆ getImageBox()

◆ getMaxTimepointIndex()

◆ getMaxVoxelValue()

◆ getMinVoxelValue()

◆ getVoxelToWorldMatrix()

◆ isInsideImage()

◆ ML_SET_ADDSTATE_VERSION()

◆ numCSOVoxelSet()

◆ numCSOVoxelSetGroup()

◆ readStateFromTree()

◆ removeCSOVoxelSetWithId()

◆ setSubImageBox()

◆ setupInternalStructureAsCSOList()

◆ setupInternalStructureAsImage()

◆ setVoxelToWorldMatrix()