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

#include <itkFeatureAggregator.h>

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

Detailed Description

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

Class for combining multiple features into a single one.

This class is the base class for specific implementation of feature mixing strategies.

SpatialObjects are used as inputs and outputs of this class.

Definition at line 40 of file itkFeatureAggregator.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef FeatureGenerator
< Dimension
FeatureGeneratorType
 
typedef ImageSpatialObject
< NDimension, OutputPixelType
OutputImageSpatialObjectType
 
typedef Image< OutputPixelType,
NDimension > 
OutputImageType
 
typedef float OutputPixelType
 
typedef SmartPointer< SelfPointer
 
typedef FeatureAggregator Self
 
typedef
SpatialObjectType::ConstPointer 
SpatialObjectConstPointer
 
typedef SpatialObjectType::Pointer SpatialObjectPointer
 
typedef SpatialObject< NDimension > SpatialObjectType
 
typedef FeatureGenerator
< NDimension > 
Superclass
 
- Public Types inherited from itk::FeatureGenerator< NDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef FeatureGenerator Self
 
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 MultiThreader MultiThreaderType
 
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 unsigned long GetMTime () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::FeatureGenerator< NDimension >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
const SpatialObjectTypeGetFeature () const
 
void SetInput (const SpatialObjectType *input)
 
const SpatialObjectTypeGetInput () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
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)
 
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 ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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 override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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
 
- Static Public Attributes inherited from itk::FeatureGenerator< NDimension >
static const unsigned int Dimension = NDimension
 

Protected Types

typedef
FeatureGeneratorType::SpatialObjectType 
InputFeatureType
 

Protected Member Functions

 FeatureAggregator ()
 
void GenerateData ()
 
const InputFeatureTypeGetInputFeature (unsigned int featureId) const
 
unsigned int GetNumberOfInputFeatures () const
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~FeatureAggregator ()
 
- Protected Member Functions inherited from itk::FeatureGenerator< NDimension >
 FeatureGenerator ()
 
SpatialObjectTypeGetInternalFeature ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~FeatureGenerator ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (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
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
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 SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
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 () override
 
- 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 ()
 

Protected Attributes

ProgressAccumulator::Pointer m_ProgressAccumulator
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Types

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

Private Member Functions

virtual void ConsolidateFeatures ()=0
 
 FeatureAggregator (const Self &)
 
void operator= (const Self &)
 
void UpdateAllFeatureGenerators ()
 

Private Attributes

FeatureGeneratorArrayType m_FeatureGenerators
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::FeatureGenerator< NDimension >
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 ()
 

Member Typedef Documentation

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

Definition at line 47 of file itkFeatureAggregator.h.

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

Definition at line 103 of file itkFeatureAggregator.h.

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

Definition at line 105 of file itkFeatureAggregator.h.

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

Definition at line 104 of file itkFeatureAggregator.h.

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

Definition at line 102 of file itkFeatureAggregator.h.

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

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

Definition at line 70 of file itkFeatureAggregator.h.

template<unsigned int NDimension>
typedef FeatureGeneratorType::SpatialObjectType itk::FeatureAggregator< NDimension >::InputFeatureType
protected

Definition at line 92 of file itkFeatureAggregator.h.

template<unsigned int NDimension>
typedef ImageSpatialObject< NDimension, OutputPixelType > itk::FeatureAggregator< NDimension >::OutputImageSpatialObjectType

Definition at line 66 of file itkFeatureAggregator.h.

template<unsigned int NDimension>
typedef Image< OutputPixelType, NDimension > itk::FeatureAggregator< NDimension >::OutputImageType

Definition at line 65 of file itkFeatureAggregator.h.

template<unsigned int NDimension>
typedef float itk::FeatureAggregator< NDimension >::OutputPixelType

Type of the image and specific SpatialObject produced as output

Definition at line 64 of file itkFeatureAggregator.h.

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

Definition at line 46 of file itkFeatureAggregator.h.

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

Standard class typedefs.

Definition at line 44 of file itkFeatureAggregator.h.

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

Definition at line 61 of file itkFeatureAggregator.h.

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

Definition at line 60 of file itkFeatureAggregator.h.

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

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

Definition at line 59 of file itkFeatureAggregator.h.

template<unsigned int NDimension>
typedef FeatureGenerator<NDimension> itk::FeatureAggregator< NDimension >::Superclass

Definition at line 45 of file itkFeatureAggregator.h.

Constructor & Destructor Documentation

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

Member Function Documentation

template<unsigned int NDimension>
void itk::FeatureAggregator< 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>
virtual void itk::FeatureAggregator< NDimension >::ConsolidateFeatures ( )
privatepure virtual
template<unsigned int NDimension>
void itk::FeatureAggregator< 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>
const InputFeatureType* itk::FeatureAggregator< NDimension >::GetInputFeature ( unsigned int  featureId) const
protected
template<unsigned int NDimension>
virtual unsigned long itk::FeatureAggregator< NDimension >::GetMTime ( ) const
virtual

Check all feature generators and return consolidate MTime

Reimplemented from itk::Object.

template<unsigned int NDimension>
virtual const char* itk::FeatureAggregator< 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::FeatureGenerator< NDimension >.

Reimplemented in itk::WeightedSumFeatureAggregator< NDimension >, itk::MaximumFeatureAggregator< NDimension >, and itk::MinimumFeatureAggregator< NDimension >.

template<unsigned int NDimension>
unsigned int itk::FeatureAggregator< NDimension >::GetNumberOfInputFeatures ( ) const
protected
template<unsigned int NDimension>
void itk::FeatureAggregator< NDimension >::operator= ( const Self )
private
template<unsigned int NDimension>
void itk::FeatureAggregator< 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.

Reimplemented in itk::WeightedSumFeatureAggregator< NDimension >, itk::MaximumFeatureAggregator< NDimension >, and itk::MinimumFeatureAggregator< NDimension >.

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

Member Data Documentation

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

Dimension of the space

Definition at line 55 of file itkFeatureAggregator.h.

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

Definition at line 107 of file itkFeatureAggregator.h.

template<unsigned int NDimension>
ProgressAccumulator::Pointer itk::FeatureAggregator< NDimension >::m_ProgressAccumulator
protected

Definition at line 96 of file itkFeatureAggregator.h.


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