ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel > Class Template Referenceabstract

#include <itkShapePriorMAPCostFunctionBase.h>

+ Inheritance diagram for itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >:
+ Collaboration diagram for itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >:

Detailed Description

template<typename TFeatureImage, typename TOutputPixel>
class itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >

Represents the base class of maximum aprior (MAP) cost function used ShapePriorSegmentationLevelSetImageFilter to estimate the shape paramaeters.

This class follows the shape and pose parameters estimation developed in [1].

This class has two template parameters, the feature image type representing the edge potential map and the pixel type used to represent the output level set in the ShapePriorSegmentationLevelSetImageFilter.

See Also
ShapePriorSegmentationLevelSetImageFilter
REFERENCES
[1] Leventon, M.E. et al. "Statistical Shape Influence in Geodesic Active Contours", CVPR 2000.

Definition at line 48 of file itkShapePriorMAPCostFunctionBase.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
FeatureImageType::ConstPointer 
FeatureImagePointer
 
typedef TFeatureImage FeatureImageType
 
typedef Superclass::MeasureType MeasureType
 
typedef
NodeContainerType::ConstPointer 
NodeContainerPointer
 
typedef VectorContainer
< unsigned int, NodeType
NodeContainerType
 
typedef LevelSetNode
< PixelType,
itkGetStaticConstMacro(ImageDimension) > 
NodeType
 
typedef Superclass::ParametersType ParametersType
 
typedef TOutputPixel PixelType
 
typedef SmartPointer< SelfPointer
 
typedef
ShapePriorMAPCostFunctionBase 
Self
 
typedef ShapeFunctionType::Pointer ShapeFunctionPointer
 
typedef
ShapeSignedDistanceFunction
< double,
itkGetStaticConstMacro(ImageDimension) > 
ShapeFunctionType
 
typedef SingleValuedCostFunction Superclass
 
- Public Types inherited from itk::SingleValuedCostFunction
typedef SmartPointer< const SelfConstPointer
 
typedef Array
< ParametersValueType
DerivativeType
 
typedef double MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef SingleValuedCostFunction Self
 
typedef CostFunction Superclass
 
- Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< TInternalComputationValueType > 
ParametersType
 
typedef
TInternalComputationValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef CostFunctionTemplate 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 MeasureType ComputeLogGradientTerm (const ParametersType &) const =0
 
virtual MeasureType ComputeLogInsideTerm (const ParametersType &) const =0
 
virtual MeasureType ComputeLogPosePriorTerm (const ParametersType &) const =0
 
virtual MeasureType ComputeLogShapePriorTerm (const ParametersType &) const =0
 
virtual void GetDerivative (const ParametersType &, DerivativeType &) const override
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfParameters (void) const override
 
virtual MeasureType GetValue (const ParametersType &parameters) const override
 
virtual void Initialize (void) throw ( ExceptionObject )
 
virtual void SetShapeFunction (ShapeFunctionType *_arg)
 
virtual ShapeFunctionTypeGetModifiableShapeFunction ()
 
virtual const ShapeFunctionTypeGetShapeFunction () const
 
virtual void SetActiveRegion (const NodeContainerType *_arg)
 
virtual const NodeContainerTypeGetActiveRegion () const
 
virtual void SetFeatureImage (const FeatureImageType *_arg)
 
virtual const FeatureImageTypeGetFeatureImage () const
 
- Public Member Functions inherited from itk::SingleValuedCostFunction
virtual void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) 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 override
 
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 Attributes

static const unsigned int ImageDimension = TFeatureImage::ImageDimension
 

Protected Member Functions

virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 ShapePriorMAPCostFunctionBase ()
 
virtual ~ShapePriorMAPCostFunctionBase ()
 
- Protected Member Functions inherited from itk::SingleValuedCostFunction
 SingleValuedCostFunction ()
 
virtual ~SingleValuedCostFunction ()
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()
 
virtual ~CostFunctionTemplate ()
 
- 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 ()
 

Protected Attributes

NodeContainerPointer m_ActiveRegion
 
FeatureImagePointer m_FeatureImage
 
ShapeFunctionPointer m_ShapeFunction
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

void operator= (const Self &) ITK_DELETE_FUNCTION
 
 ShapePriorMAPCostFunctionBase (const Self &) ITK_DELETE_FUNCTION
 

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 ()
 

Member Typedef Documentation

template<typename TFeatureImage , typename TOutputPixel >
typedef SmartPointer< const Self > itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ConstPointer

Definition at line 56 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef Superclass::DerivativeType itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::DerivativeType

DerivativeType typedef. It defines a type used to return the cost function derivative.

Definition at line 67 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef FeatureImageType::ConstPointer itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::FeatureImagePointer

Definition at line 75 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef TFeatureImage itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::FeatureImageType

Type of the feature image representing the edge potential map.

Definition at line 74 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef Superclass::MeasureType itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::MeasureType

MeasureType typedef. It defines a type used to return the cost function value.

Definition at line 59 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef NodeContainerType::ConstPointer itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::NodeContainerPointer

Definition at line 88 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef VectorContainer< unsigned int, NodeType > itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::NodeContainerType

Type of container used to store the level set nodes.

Definition at line 87 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef LevelSetNode< PixelType, itkGetStaticConstMacro(ImageDimension) > itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::NodeType

Type of node used to represent the active region around the zero set.

Definition at line 84 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef Superclass::ParametersType itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ParametersType

ParametersType typedef. It defines a position in the optimization search space.

Definition at line 71 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef TOutputPixel itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::PixelType

Type of pixel used to represent the level set.

Definition at line 81 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef SmartPointer< Self > itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::Pointer

Definition at line 55 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef ShapePriorMAPCostFunctionBase itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::Self

Standard class typedefs.

Definition at line 53 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef ShapeFunctionType::Pointer itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ShapeFunctionPointer

Definition at line 93 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef ShapeSignedDistanceFunction< double, itkGetStaticConstMacro(ImageDimension) > itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ShapeFunctionType

Type of the shape signed distance function.

Definition at line 92 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
typedef SingleValuedCostFunction itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::Superclass

Definition at line 54 of file itkShapePriorMAPCostFunctionBase.h.

Constructor & Destructor Documentation

template<typename TFeatureImage , typename TOutputPixel >
itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ShapePriorMAPCostFunctionBase ( )
protected
template<typename TFeatureImage , typename TOutputPixel >
virtual itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::~ShapePriorMAPCostFunctionBase ( )
inlineprotectedvirtual

Definition at line 146 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ShapePriorMAPCostFunctionBase ( const Self )
private

Member Function Documentation

template<typename TFeatureImage , typename TOutputPixel >
virtual MeasureType itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ComputeLogGradientTerm ( const ParametersType ) const
pure virtual

Compute the gradient term component of the MAP cost function. Subclasses should override this function

Implemented in itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >.

template<typename TFeatureImage , typename TOutputPixel >
virtual MeasureType itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ComputeLogInsideTerm ( const ParametersType ) const
pure virtual

Compute the inside term component of the MAP cost function. Subclasses should override this function

Implemented in itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >.

template<typename TFeatureImage , typename TOutputPixel >
virtual MeasureType itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ComputeLogPosePriorTerm ( const ParametersType ) const
pure virtual

Compute the pose prior component of the MAP cost function. Subclasses should override this function

Implemented in itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >.

template<typename TFeatureImage , typename TOutputPixel >
virtual MeasureType itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ComputeLogShapePriorTerm ( const ParametersType ) const
pure virtual

Compute the shape prior component of the MAP cost function. Subclasses should override this function

Implemented in itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >.

template<typename TFeatureImage , typename TOutputPixel >
virtual const NodeContainerType* itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::GetActiveRegion ( ) const
virtual

Set/Get the active region.

template<typename TFeatureImage , typename TOutputPixel >
virtual void itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::GetDerivative ( const ParametersType ,
DerivativeType  
) const
inlineoverridevirtual

This method returns the derivative of the cost function corresponding to the specified parameters.

Implements itk::SingleValuedCostFunction.

Definition at line 116 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
virtual const FeatureImageType* itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::GetFeatureImage ( ) const
virtual

Set/Get the feature image.

template<typename TFeatureImage , typename TOutputPixel >
virtual ShapeFunctionType* itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::GetModifiableShapeFunction ( )
virtual

Set/Get the shape distance function.

template<typename TFeatureImage , typename TOutputPixel >
virtual const char* itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedCostFunction.

Reimplemented in itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >.

template<typename TFeatureImage , typename TOutputPixel >
virtual unsigned int itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::GetNumberOfParameters ( void  ) const
inlineoverridevirtual
template<typename TFeatureImage , typename TOutputPixel >
virtual const ShapeFunctionType* itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::GetShapeFunction ( ) const
virtual

Set/Get the shape distance function.

template<typename TFeatureImage , typename TOutputPixel >
virtual MeasureType itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::GetValue ( const ParametersType parameters) const
overridevirtual

This method returns the value of the cost function corresponding to the specified parameters.

Implements itk::SingleValuedCostFunction.

template<typename TFeatureImage , typename TOutputPixel >
virtual void itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::Initialize ( void  )
throw (ExceptionObject
)
virtual

Initialize the cost function by making sure that all the components are present.

Reimplemented in itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >.

template<typename TFeatureImage , typename TOutputPixel >
void itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::operator= ( const Self )
private
template<typename TFeatureImage , typename TOutputPixel >
virtual void itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::CostFunctionTemplate< TInternalComputationValueType >.

Reimplemented in itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >.

template<typename TFeatureImage , typename TOutputPixel >
virtual void itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::SetActiveRegion ( const NodeContainerType _arg)
virtual

Set/Get the active region.

template<typename TFeatureImage , typename TOutputPixel >
virtual void itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::SetFeatureImage ( const FeatureImageType _arg)
virtual

Set/Get the feature image.

template<typename TFeatureImage , typename TOutputPixel >
virtual void itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::SetShapeFunction ( ShapeFunctionType _arg)
virtual

Set/Get the shape distance function.

Member Data Documentation

template<typename TFeatureImage , typename TOutputPixel >
const unsigned int itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ImageDimension = TFeatureImage::ImageDimension
static

Dimension constant.

Definition at line 78 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
NodeContainerPointer itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::m_ActiveRegion
protected

Definition at line 151 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
FeatureImagePointer itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::m_FeatureImage
protected

Definition at line 153 of file itkShapePriorMAPCostFunctionBase.h.

template<typename TFeatureImage , typename TOutputPixel >
ShapeFunctionPointer itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::m_ShapeFunction
protected

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