MeVisLabToolboxReference
ml::CSOVoxelSetList Class Reference

#include <CSOVoxelSetList.h>

Inheritance diagram for ml::CSOVoxelSetList:
ml::Base

List of all members.

Public Member Functions

 CSOVoxelSetList ()
 Standard constructor.
virtual ~CSOVoxelSetList ()
 Standard destructor.
void destroy ()
 Deletes internal structures.
void setupInternalStructureAsCSOList (CSOList *csoList, PagedImage *image=NULL)
 Establishes the internal structure as the given CSOList.
void setupInternalStructureAsImage (PagedImage *image)
 Establishes the internal structure fitting to the given image.
int numCSOVoxelSet () const
 Returns the number of CSOVoxelSets.
CSOVoxelSetcsoVoxelSetAt (size_t index) const
 Returns the pointer to a CSOVoxelSet at a given index.
CSOVoxelSetcsoVoxelSetWithId (int id)
 Returns the pointer to a CSOVoxelSet with a given id. NULL if it does not exist.
CSOVoxelSetaddCSOVoxelSet ()
 Adds and returns a new CSOVoxelSet.
int numCSOVoxelSetGroup () const
 Returns the number of CSOVoxelSetGroups.
CSOVoxelSetGroupcsoVoxelSetGroupAt (size_t index) const
 Returns the pointer to a CSOVoxelSetGroup at a given index.
CSOVoxelSetGroupcsoVoxelSetGroupWithId (int id)
 Returns the pointer to a CSOVoxelSetGroup with a given id. NULL if it does not exist.
CSOVoxelSetGroupaddCSOVoxelSetGroup ()
 Adds and returns a new CSOVoxelSetGroup.
int getMaxTimepointIndex ()
 Computes and returns the maximum timepoint index.
bool isInsideImage (const Vector3 &position)
 Returns whether a given position is inside the association image.
const SubImageBoxgetImageBox () const
 Returns the image box (which is empty if no valid PagedImage was available).
void setSubImageBox (const SubImageBox &subImageBox)
 Sets the SubImageBox.
virtual void addStateToTree (TreeNode *parent) const
 Implements export functionality (as used by the SaveBase module):
 ML_SET_ADDSTATE_VERSION (2)
virtual void readStateFromTree (TreeNode *parent)
 Implements import functionality (as used by the LoadBase module):

Detailed Description

Definition at line 28 of file CSOVoxelSetList.h.


Constructor & Destructor Documentation

ml::CSOVoxelSetList::CSOVoxelSetList ( )

Standard constructor.

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

Standard destructor.


Member Function Documentation

CSOVoxelSet* ml::CSOVoxelSetList::addCSOVoxelSet ( )

Adds and returns a new CSOVoxelSet.

CSOVoxelSetGroup* ml::CSOVoxelSetList::addCSOVoxelSetGroup ( )

Adds and returns a new CSOVoxelSetGroup.

virtual void ml::CSOVoxelSetList::addStateToTree ( TreeNode parent) const [virtual]

Implements export functionality (as used by the SaveBase module):

Reimplemented from ml::Base.

CSOVoxelSet* ml::CSOVoxelSetList::csoVoxelSetAt ( size_t  index) const [inline]

Returns the pointer to a CSOVoxelSet at a given index.

Definition at line 54 of file CSOVoxelSetList.h.

CSOVoxelSetGroup* ml::CSOVoxelSetList::csoVoxelSetGroupAt ( size_t  index) const [inline]

Returns the pointer to a CSOVoxelSetGroup at a given index.

Definition at line 63 of file CSOVoxelSetList.h.

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

Returns the pointer to a CSOVoxelSetGroup with a given id. NULL if it does not exist.

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

Returns the pointer to a CSOVoxelSet with a given id. NULL if it does not exist.

void ml::CSOVoxelSetList::destroy ( )

Deletes internal structures.

const SubImageBox& ml::CSOVoxelSetList::getImageBox ( ) const [inline]

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

Definition at line 75 of file CSOVoxelSetList.h.

int ml::CSOVoxelSetList::getMaxTimepointIndex ( )

Computes and returns the maximum timepoint index.

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

Returns whether a given position is inside the association image.

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

ml::CSOVoxelSetList::ML_SET_ADDSTATE_VERSION ( )
int ml::CSOVoxelSetList::numCSOVoxelSet ( ) const [inline]

Returns the number of CSOVoxelSets.

Definition at line 52 of file CSOVoxelSetList.h.

int ml::CSOVoxelSetList::numCSOVoxelSetGroup ( ) const [inline]

Returns the number of CSOVoxelSetGroups.

Definition at line 61 of file CSOVoxelSetList.h.

virtual void ml::CSOVoxelSetList::readStateFromTree ( TreeNode parent) [virtual]

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

Reimplemented from ml::Base.

void ml::CSOVoxelSetList::setSubImageBox ( const SubImageBox subImageBox) [inline]

Sets the SubImageBox.

Definition at line 77 of file CSOVoxelSetList.h.

void ml::CSOVoxelSetList::setupInternalStructureAsCSOList ( CSOList csoList,
PagedImage image = NULL 
)

Establishes the internal structure as the given CSOList.

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

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

Establishes the internal structure fitting to the given image.

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


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