ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
itk::SegmentationVolumeEstimator< NDimension > Class Template Reference

#include <itkSegmentationVolumeEstimator.h>

+ Inheritance diagram for itk::SegmentationVolumeEstimator< NDimension >:
+ Collaboration diagram for itk::SegmentationVolumeEstimator< NDimension >:

Detailed Description

template<unsigned int NDimension>
class itk::SegmentationVolumeEstimator< NDimension >

Class for estimating the volume of a segmentation stored in a SpatialObject.

This class is the base class for specific implementation of volume estimators.

SpatialObjects are used as input of this class.

Definition at line 38 of file itkSegmentationVolumeEstimator.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef
SimpleDataObjectDecorator
< RealType
RealObjectType
 
typedef double RealType
 
typedef SegmentationVolumeEstimator Self
 
typedef
SpatialObjectType::ConstPointer 
SpatialObjectConstPointer
 
typedef SpatialObjectType::Pointer SpatialObjectPointer
 
typedef SpatialObject< NDimension > SpatialObjectType
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
void SetInput (const SpatialObjectType *inputSpatialObject)
 
RealType GetVolume () const
 
const RealObjectTypeGetVolumeOutput () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
NameArray GetInputNames () const
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const ITK_OVERRIDE
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

static const unsigned int Dimension = NDimension
 

Protected Member Functions

void GenerateData ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
 SegmentationVolumeEstimator ()
 
virtual ~SegmentationVolumeEstimator ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

void operator= (const Self &)
 
 SegmentationVolumeEstimator (const Self &)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

template<unsigned int NDimension>
typedef SmartPointer<const Self> itk::SegmentationVolumeEstimator< NDimension >::ConstPointer

Definition at line 45 of file itkSegmentationVolumeEstimator.h.

template<unsigned int NDimension>
typedef SmartPointer<Self> itk::SegmentationVolumeEstimator< NDimension >::Pointer

Definition at line 44 of file itkSegmentationVolumeEstimator.h.

template<unsigned int NDimension>
typedef SimpleDataObjectDecorator< RealType > itk::SegmentationVolumeEstimator< NDimension >::RealObjectType

Definition at line 68 of file itkSegmentationVolumeEstimator.h.

template<unsigned int NDimension>
typedef double itk::SegmentationVolumeEstimator< NDimension >::RealType

Type of DataObjects used for scalar outputs

Definition at line 67 of file itkSegmentationVolumeEstimator.h.

template<unsigned int NDimension>
typedef SegmentationVolumeEstimator itk::SegmentationVolumeEstimator< NDimension >::Self

Standard class typedefs.

Definition at line 42 of file itkSegmentationVolumeEstimator.h.

template<unsigned int NDimension>
typedef SpatialObjectType::ConstPointer itk::SegmentationVolumeEstimator< NDimension >::SpatialObjectConstPointer

Definition at line 59 of file itkSegmentationVolumeEstimator.h.

template<unsigned int NDimension>
typedef SpatialObjectType::Pointer itk::SegmentationVolumeEstimator< NDimension >::SpatialObjectPointer

Definition at line 58 of file itkSegmentationVolumeEstimator.h.

template<unsigned int NDimension>
typedef SpatialObject< NDimension > itk::SegmentationVolumeEstimator< NDimension >::SpatialObjectType

Type of spatialObject that will be passed as input and output of this segmentation method.

Definition at line 57 of file itkSegmentationVolumeEstimator.h.

template<unsigned int NDimension>
typedef ProcessObject itk::SegmentationVolumeEstimator< NDimension >::Superclass

Definition at line 43 of file itkSegmentationVolumeEstimator.h.

Constructor & Destructor Documentation

template<unsigned int NDimension>
itk::SegmentationVolumeEstimator< NDimension >::SegmentationVolumeEstimator ( )
protected
template<unsigned int NDimension>
virtual itk::SegmentationVolumeEstimator< NDimension >::~SegmentationVolumeEstimator ( )
protectedvirtual
template<unsigned int NDimension>
itk::SegmentationVolumeEstimator< NDimension >::SegmentationVolumeEstimator ( const Self )
private

Member Function Documentation

template<unsigned int NDimension>
void itk::SegmentationVolumeEstimator< NDimension >::GenerateData ( )
protectedvirtual

Method invoked by the pipeline in order to trigger the computation of the segmentation.

Reimplemented from itk::ProcessObject.

template<unsigned int NDimension>
virtual const char* itk::SegmentationVolumeEstimator< NDimension >::GetNameOfClass ( ) const
virtual

This is an abstract class, therefore it doesn't need the itkNewMacro() Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

Reimplemented in itk::GrayscaleImageSegmentationVolumeEstimator< NDimension >.

template<unsigned int NDimension>
RealType itk::SegmentationVolumeEstimator< NDimension >::GetVolume ( ) const

Return the computed Volume. The volume units will be relative to the spacing units used by the input spatial object. For example, if the input spatial object is using millimeters as the units of spacing then the units of the volume computed in this class will be cubic millimeters.

template<unsigned int NDimension>
const RealObjectType* itk::SegmentationVolumeEstimator< NDimension >::GetVolumeOutput ( ) const

Return the computed Volume. The volume units will be relative to the spacing units used by the input spatial object. For example, if the input spatial object is using millimeters as the units of spacing then the units of the volume computed in this class will be cubic millimeters.

template<unsigned int NDimension>
void itk::SegmentationVolumeEstimator< NDimension >::operator= ( const Self )
private
template<unsigned int NDimension>
void itk::SegmentationVolumeEstimator< NDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

template<unsigned int NDimension>
void itk::SegmentationVolumeEstimator< NDimension >::SetInput ( const SpatialObjectType inputSpatialObject)

Member Data Documentation

template<unsigned int NDimension>
const unsigned int itk::SegmentationVolumeEstimator< NDimension >::Dimension = NDimension
static

Dimension of the space

Definition at line 53 of file itkSegmentationVolumeEstimator.h.


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