aimsdata  5.1.2
Neuroimaging data handling
aims::RoiIterator Class Referenceabstract

#include <aims/roi/roiIterator.h>

Inheritance diagram for aims::RoiIterator:
Collaboration diagram for aims::RoiIterator:

Public Member Functions

virtual ~RoiIterator ()
 
virtual bool isValid () const =0
 
virtual void restart ()=0
 
virtual size_t count () const =0
 
virtual void next ()=0
 
virtual carto::rc_ptr< MaskIteratormaskIterator () const =0
 
const Point3d volumeDimension () const
 
const Point3df voxelSize () const
 
float voxelVolume () const
 
virtual std::string regionName () const =0
 
virtual void setRegionNameAttributes (const std::vector< std::string > &)
 Set region name attribute in graph. More...
 
virtual void setRegionNameAttributes (const std::string &)
 Set region name attribute in graph. More...
 
virtual carto::rc_ptr< ROILabelMapcreateLabelMap ()
 
- Public Member Functions inherited from carto::RCObject
 RCObject ()
 
 RCObject (const RCObject &)
 
RCObjectoperator= (const RCObject &)
 
virtual ~RCObject ()
 

Additional Inherited Members

- Public Types inherited from carto::RCObject
typedef int RefCounterType
 

Detailed Description

Definition at line 91 of file roiIterator.h.

Constructor & Destructor Documentation

◆ ~RoiIterator()

virtual aims::RoiIterator::~RoiIterator ( )
inlinevirtual

Definition at line 94 of file roiIterator.h.

Member Function Documentation

◆ count()

virtual size_t aims::RoiIterator::count ( ) const
pure virtual

◆ createLabelMap()

virtual carto::rc_ptr< ROILabelMap > aims::RoiIterator::createLabelMap ( )
virtual

Reimplemented in aims::MotionedRoiIterator.

◆ isValid()

virtual bool aims::RoiIterator::isValid ( ) const
pure virtual

◆ maskIterator()

virtual carto::rc_ptr< MaskIterator > aims::RoiIterator::maskIterator ( ) const
pure virtual

◆ next()

virtual void aims::RoiIterator::next ( )
pure virtual

◆ regionName()

virtual std::string aims::RoiIterator::regionName ( ) const
pure virtual

◆ restart()

◆ setRegionNameAttributes() [1/2]

virtual void aims::RoiIterator::setRegionNameAttributes ( const std::string &  )
virtual

Set region name attribute in graph.

Same as above, for a single attribute.

◆ setRegionNameAttributes() [2/2]

virtual void aims::RoiIterator::setRegionNameAttributes ( const std::vector< std::string > &  )
inlinevirtual

Set region name attribute in graph.

Normally "name" or "label". If several values are provided, attributes are searched in each graph vertex, in that order. If the attributes list is empty, then the graph "label_property" attribute will be used, and if it is not specified there, the default search list ("name", "label") will be used.

Reimplemented in aims::RoiIteratorOf< Graph >, and aims::MotionedRoiIterator.

Definition at line 113 of file roiIterator.h.

◆ volumeDimension()

const Point3d aims::RoiIterator::volumeDimension ( ) const
inline

Definition at line 153 of file roiIterator.h.

References maskIterator().

◆ voxelSize()

const Point3df aims::RoiIterator::voxelSize ( ) const
inline

Definition at line 159 of file roiIterator.h.

References maskIterator().

◆ voxelVolume()

float aims::RoiIterator::voxelVolume ( ) const
inline

Definition at line 165 of file roiIterator.h.

References maskIterator().


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