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

#include <itkLesionSegmentationMethod.h>

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

Detailed Description

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

Class for coordinating components of a segmentation framework.

This class was designed to facilitate the segmentation of lung lesions, but yet to be useful for other segmentation tasks.

SpatialObjects are used as inputs and outputs of this class.

Definition at line 43 of file itkLesionSegmentationMethod.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef FeatureGenerator
< Dimension
FeatureGeneratorType
 
typedef SmartPointer< SelfPointer
 
typedef
SegmentationModuleType::Pointer 
SegmentationModulePointer
 
typedef SegmentationModule
< Dimension
SegmentationModuleType
 
typedef LesionSegmentationMethod 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

void AddFeatureGenerator (FeatureGeneratorType *generator)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual void SetSegmentationModule (SegmentationModuleType *_arg)
 
virtual void SetRegionOfInterest (SpatialObjectType *_arg)
 
virtual const SpatialObjectTypeGetRegionOfInterest () const
 
virtual void SetInitialSegmentation (const SpatialObjectType *_arg)
 
virtual const SpatialObjectTypeGetInitialSegmentation () 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 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 Member Functions

static Pointer New ()
 
- 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 ()
 

Static Public Attributes

static const unsigned int Dimension = NDimension
 

Protected Member Functions

void GenerateData ()
 
 LesionSegmentationMethod ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~LesionSegmentationMethod ()
 
- 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 Types

typedef std::vector
< FeatureGeneratorPointer
FeatureGeneratorArrayType
 
typedef
FeatureGeneratorArrayType::const_iterator 
FeatureGeneratorConstIterator
 
typedef
FeatureGeneratorArrayType::iterator 
FeatureGeneratorIterator
 
typedef
FeatureGeneratorType::Pointer 
FeatureGeneratorPointer
 

Private Member Functions

void ConnectFeaturesToSegmentationModule ()
 
void ExecuteSegmentationModule ()
 
 LesionSegmentationMethod (const Self &)
 
void operator= (const Self &)
 
void UpdateAllFeatureGenerators ()
 
void VerifyNumberOfAvailableFeaturesMatchedExpectations () const
 

Private Attributes

FeatureGeneratorArrayType m_FeatureGenerators
 
SpatialObjectConstPointer m_InitialSegmentation
 
ProgressAccumulator::Pointer m_ProgressAccumulator
 
SpatialObjectConstPointer m_RegionOfInterest
 
SegmentationModulePointer m_SegmentationModule
 

Additional Inherited Members

- 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::LesionSegmentationMethod< NDimension >::ConstPointer

Definition at line 50 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
typedef std::vector< FeatureGeneratorPointer > itk::LesionSegmentationMethod< NDimension >::FeatureGeneratorArrayType
private

Definition at line 119 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
typedef FeatureGeneratorArrayType::const_iterator itk::LesionSegmentationMethod< NDimension >::FeatureGeneratorConstIterator
private

Definition at line 121 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
typedef FeatureGeneratorArrayType::iterator itk::LesionSegmentationMethod< NDimension >::FeatureGeneratorIterator
private

Definition at line 120 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
typedef FeatureGeneratorType::Pointer itk::LesionSegmentationMethod< NDimension >::FeatureGeneratorPointer
private

Definition at line 118 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
typedef FeatureGenerator< Dimension > itk::LesionSegmentationMethod< NDimension >::FeatureGeneratorType

Type of the class that will generate input features in the form of spatial objects.

Definition at line 76 of file itkLesionSegmentationMethod.h.

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

Definition at line 49 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
typedef SegmentationModuleType::Pointer itk::LesionSegmentationMethod< NDimension >::SegmentationModulePointer

Definition at line 92 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
typedef SegmentationModule< Dimension > itk::LesionSegmentationMethod< NDimension >::SegmentationModuleType

Type of the segmentation module that encapsulate the actual segmentation algorithm.

Definition at line 91 of file itkLesionSegmentationMethod.h.

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

Standard class typedefs.

Definition at line 47 of file itkLesionSegmentationMethod.h.

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

Definition at line 65 of file itkLesionSegmentationMethod.h.

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

Definition at line 64 of file itkLesionSegmentationMethod.h.

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

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

Definition at line 63 of file itkLesionSegmentationMethod.h.

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

Definition at line 48 of file itkLesionSegmentationMethod.h.

Constructor & Destructor Documentation

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

Member Function Documentation

template<unsigned int NDimension>
void itk::LesionSegmentationMethod< NDimension >::AddFeatureGenerator ( FeatureGeneratorType generator)

Method for adding a feature generator that will compute the Nth feature to be passed to the segmentation module.

template<unsigned int NDimension>
void itk::LesionSegmentationMethod< NDimension >::ConnectFeaturesToSegmentationModule ( )
private

Connect the outputs of feature generators as input to the segmentation module

template<unsigned int NDimension>
virtual::itk::LightObject::Pointer itk::LesionSegmentationMethod< NDimension >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<unsigned int NDimension>
void itk::LesionSegmentationMethod< NDimension >::ExecuteSegmentationModule ( )
private
template<unsigned int NDimension>
void itk::LesionSegmentationMethod< 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 SpatialObjectType* itk::LesionSegmentationMethod< NDimension >::GetInitialSegmentation ( ) const
virtual

SpatialObject that defines the initial segmentation. This will be used to initialize the segmentation process driven by the LesionSegmentationMethod.

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

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<unsigned int NDimension>
virtual const SpatialObjectType* itk::LesionSegmentationMethod< NDimension >::GetRegionOfInterest ( ) const
virtual

SpatialObject that defines the Region of Interest in the input data

template<unsigned int NDimension>
static Pointer itk::LesionSegmentationMethod< NDimension >::New ( )
static

Method for creation through the object factory.

template<unsigned int NDimension>
void itk::LesionSegmentationMethod< NDimension >::operator= ( const Self )
private
template<unsigned int NDimension>
void itk::LesionSegmentationMethod< 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>
virtual void itk::LesionSegmentationMethod< NDimension >::SetInitialSegmentation ( const SpatialObjectType _arg)
virtual

SpatialObject that defines the initial segmentation. This will be used to initialize the segmentation process driven by the LesionSegmentationMethod.

template<unsigned int NDimension>
virtual void itk::LesionSegmentationMethod< NDimension >::SetRegionOfInterest ( SpatialObjectType _arg)
virtual

SpatialObject that defines the Region of Interest in the input data

template<unsigned int NDimension>
virtual void itk::LesionSegmentationMethod< NDimension >::SetSegmentationModule ( SegmentationModuleType _arg)
virtual

Method for setting the class that encapsulates the actual segmentation algorithm.

template<unsigned int NDimension>
void itk::LesionSegmentationMethod< NDimension >::UpdateAllFeatureGenerators ( )
private

This method calls the Update() method of each one of the feature generators

template<unsigned int NDimension>
void itk::LesionSegmentationMethod< NDimension >::VerifyNumberOfAvailableFeaturesMatchedExpectations ( ) const
private

This method compares the number of available features against the number of expected features, and it will throw an exception if they do not match.

Member Data Documentation

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

Dimension of the space

Definition at line 59 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
FeatureGeneratorArrayType itk::LesionSegmentationMethod< NDimension >::m_FeatureGenerators
private

Definition at line 123 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
SpatialObjectConstPointer itk::LesionSegmentationMethod< NDimension >::m_InitialSegmentation
private

Definition at line 116 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
ProgressAccumulator::Pointer itk::LesionSegmentationMethod< NDimension >::m_ProgressAccumulator
private

Definition at line 127 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
SpatialObjectConstPointer itk::LesionSegmentationMethod< NDimension >::m_RegionOfInterest
private

Definition at line 115 of file itkLesionSegmentationMethod.h.

template<unsigned int NDimension>
SegmentationModulePointer itk::LesionSegmentationMethod< NDimension >::m_SegmentationModule
private

Definition at line 125 of file itkLesionSegmentationMethod.h.


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