ITK  4.8.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::SigmoidFeatureGenerator< NDimension > Class Template Reference

#include <itkSigmoidFeatureGenerator.h>

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

Detailed Description

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

Generates a feature image by computing the Sigmoid intensity transformation.

The typical use of this class would be to generate the feature image needed by a Level Set filter to internally compute its speed image. This transformation is very close to a simply thresholding selection on the input image, but with the advantage of a smooth transition of intensities.

SpatialObjects are used as inputs and outputs of this class.

Definition at line 43 of file itkSigmoidFeatureGenerator.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageSpatialObjectType::Pointer 
InputImageSpatialObjectPointer
 
typedef ImageSpatialObject
< NDimension, InputPixelType
InputImageSpatialObjectType
 
typedef Image< InputPixelType,
Dimension
InputImageType
 
typedef signed short InputPixelType
 
typedef SmartPointer< SelfPointer
 
typedef SigmoidFeatureGenerator Self
 
typedef
Superclass::SpatialObjectType 
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 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 ::itk::LightObject::Pointer CreateAnother () const
 
const SpatialObjectTypeGetFeature () const
 
virtual const char * GetNameOfClass () const
 
void SetInput (const SpatialObjectType *input)
 
const SpatialObjectTypeGetInput () const
 
virtual void SetAlpha (double _arg)
 
virtual double GetAlpha ()
 
virtual void SetBeta (double _arg)
 
virtual double GetBeta ()
 
- Public Member Functions inherited from itk::FeatureGenerator< NDimension >
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 ()
 
MultiThreader * GetMultiThreader () 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 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 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 Member Functions

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

Static Public Attributes

static const unsigned int Dimension = NDimension
 
- Static Public Attributes inherited from itk::FeatureGenerator< NDimension >
static const unsigned int Dimension = NDimension
 

Protected Member Functions

void GenerateData ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
 SigmoidFeatureGenerator ()
 
virtual ~SigmoidFeatureGenerator ()
 
- Protected Member Functions inherited from itk::FeatureGenerator< NDimension >
 FeatureGenerator ()
 
SpatialObjectTypeGetInternalFeature ()
 
virtual ~FeatureGenerator ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
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 ()
 
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 ()
 
- 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 ImageSpatialObject
< NDimension, OutputPixelType
OutputImageSpatialObjectType
 
typedef Image< OutputPixelType,
Dimension
OutputImageType
 
typedef float OutputPixelType
 
typedef SigmoidFilterType::Pointer SigmoidFilterPointer
 
typedef SigmoidImageFilter
< InputImageType,
OutputImageType
SigmoidFilterType
 

Private Member Functions

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

Private Attributes

double m_Alpha
 
double m_Beta
 
SigmoidFilterPointer m_SigmoidFilter
 

Additional Inherited Members

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

Member Typedef Documentation

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

Definition at line 50 of file itkSigmoidFeatureGenerator.h.

Definition at line 66 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
typedef ImageSpatialObject< NDimension, InputPixelType > itk::SigmoidFeatureGenerator< NDimension >::InputImageSpatialObjectType

Definition at line 65 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
typedef Image< InputPixelType, Dimension > itk::SigmoidFeatureGenerator< NDimension >::InputImageType

Definition at line 64 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
typedef signed short itk::SigmoidFeatureGenerator< NDimension >::InputPixelType

Type of spatialObject that will be passed as input to this feature generator.

Definition at line 63 of file itkSigmoidFeatureGenerator.h.

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

Definition at line 105 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
typedef Image< OutputPixelType, Dimension > itk::SigmoidFeatureGenerator< NDimension >::OutputImageType
private

Definition at line 103 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
typedef float itk::SigmoidFeatureGenerator< NDimension >::OutputPixelType
private

Definition at line 102 of file itkSigmoidFeatureGenerator.h.

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

Definition at line 49 of file itkSigmoidFeatureGenerator.h.

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

Standard class typedefs.

Definition at line 47 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
typedef SigmoidFilterType::Pointer itk::SigmoidFeatureGenerator< NDimension >::SigmoidFilterPointer
private

Definition at line 109 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
typedef SigmoidImageFilter< InputImageType, OutputImageType > itk::SigmoidFeatureGenerator< NDimension >::SigmoidFilterType
private

Definition at line 108 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
typedef Superclass::SpatialObjectType itk::SigmoidFeatureGenerator< NDimension >::SpatialObjectType

Definition at line 67 of file itkSigmoidFeatureGenerator.h.

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

Definition at line 48 of file itkSigmoidFeatureGenerator.h.

Constructor & Destructor Documentation

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

Member Function Documentation

template<unsigned int NDimension>
virtual::itk::LightObject::Pointer itk::SigmoidFeatureGenerator< NDimension >::CreateAnother ( ) 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::FeatureGenerator< NDimension >.

template<unsigned int NDimension>
void itk::SigmoidFeatureGenerator< 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 double itk::SigmoidFeatureGenerator< NDimension >::GetAlpha ( )
virtual

Alpha value to be used in the Sigmoid filter.

template<unsigned int NDimension>
virtual double itk::SigmoidFeatureGenerator< NDimension >::GetBeta ( )
virtual

Beta value to be used in the Sigmoid filter.

template<unsigned int NDimension>
const SpatialObjectType* itk::SigmoidFeatureGenerator< NDimension >::GetFeature ( ) const

Output data that carries the feature in the form of a SpatialObject.

template<unsigned int NDimension>
const SpatialObjectType* itk::SigmoidFeatureGenerator< NDimension >::GetInput ( ) const
template<unsigned int NDimension>
virtual const char* itk::SigmoidFeatureGenerator< NDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::FeatureGenerator< NDimension >.

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

Method for creation through the object factory.

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

template<unsigned int NDimension>
virtual void itk::SigmoidFeatureGenerator< NDimension >::SetAlpha ( double  _arg)
virtual

Alpha value to be used in the Sigmoid filter.

template<unsigned int NDimension>
virtual void itk::SigmoidFeatureGenerator< NDimension >::SetBeta ( double  _arg)
virtual

Beta value to be used in the Sigmoid filter.

template<unsigned int NDimension>
void itk::SigmoidFeatureGenerator< NDimension >::SetInput ( const SpatialObjectType input)

Member Data Documentation

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

Dimension of the space

Definition at line 59 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
double itk::SigmoidFeatureGenerator< NDimension >::m_Alpha
private

Definition at line 113 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
double itk::SigmoidFeatureGenerator< NDimension >::m_Beta
private

Definition at line 114 of file itkSigmoidFeatureGenerator.h.

template<unsigned int NDimension>
SigmoidFilterPointer itk::SigmoidFeatureGenerator< NDimension >::m_SigmoidFilter
private

Definition at line 111 of file itkSigmoidFeatureGenerator.h.


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