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

#include <itkShapePriorMAPCostFunctionBase.h>

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 parameters.

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.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FeatureImagePointer = typename FeatureImageType::ConstPointer
 
using FeatureImageType = TFeatureImage
 
using NodeContainerPointer = typename NodeContainerType::ConstPointer
 
using NodeContainerType = VectorContainer< unsigned int, NodeType >
 
using NodeType = LevelSetNode< PixelType, Self::ImageDimension >
 
using PixelType = TOutputPixel
 
using Pointer = SmartPointer< Self >
 
using Self = ShapePriorMAPCostFunctionBase
 
using ShapeFunctionPointer = typename ShapeFunctionType::Pointer
 
using ShapeFunctionType = ShapeSignedDistanceFunction< double, Self::ImageDimension >
 
using Superclass = SingleValuedCostFunction
 
- Public Types inherited from itk::SingleValuedCostFunction
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array< ParametersValueType >
 
using MeasureType = double
 
using ParametersType = Superclass::ParametersType
 
using ParametersValueType = Superclass::ParametersValueType
 
using Pointer = SmartPointer< Self >
 
using Self = SingleValuedCostFunction
 
using Superclass = CostFunction
 
- Public Types inherited from itk::CostFunctionTemplate< double >
using ConstPointer = SmartPointer< const Self >
 
using ParametersType = OptimizerParameters< double >
 
using ParametersValueType = double
 
using Pointer = SmartPointer< Self >
 
using Self = CostFunctionTemplate
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

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
 
void GetDerivative (const ParametersType &, DerivativeType &) const override
 
const char * GetNameOfClass () const override
 
unsigned int GetNumberOfParameters () const override
 
MeasureType GetValue (const ParametersType &parameters) const override
 
virtual void Initialize ()
 
virtual void SetShapeFunction (ShapeFunctionType *_arg)
 
virtual ShapeFunctionTypeGetModifiableShapeFunction ()
 
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 GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
 
const char * GetNameOfClass () const override
 
virtual MeasureType GetValue (const ParametersType &parameters) const =0
 
virtual void GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
 
- Public Member Functions inherited from itk::CostFunctionTemplate< double >
const char * GetNameOfClass () const override
 
virtual unsigned int GetNumberOfParameters () const=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
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
 
const char * GetNameOfClass () const override
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TFeatureImage::ImageDimension
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 ShapePriorMAPCostFunctionBase ()
 
 ~ShapePriorMAPCostFunctionBase () override=default
 
- Protected Member Functions inherited from itk::SingleValuedCostFunction
 SingleValuedCostFunction ()=default
 
 ~SingleValuedCostFunction () override
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< double >
 CostFunctionTemplate ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~CostFunctionTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 PrintSelf (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
std::atomic< int > m_ReferenceCount {}
 

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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 57 of file itkShapePriorMAPCostFunctionBase.h.

◆ FeatureImagePointer

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

Definition at line 76 of file itkShapePriorMAPCostFunctionBase.h.

◆ FeatureImageType

template<typename TFeatureImage , typename TOutputPixel >
using itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::FeatureImageType = TFeatureImage

Type of the feature image representing the edge potential map.

Definition at line 75 of file itkShapePriorMAPCostFunctionBase.h.

◆ NodeContainerPointer

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

Definition at line 89 of file itkShapePriorMAPCostFunctionBase.h.

◆ NodeContainerType

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

Type of container used to store the level set nodes.

Definition at line 88 of file itkShapePriorMAPCostFunctionBase.h.

◆ NodeType

template<typename TFeatureImage , typename TOutputPixel >
using itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::NodeType = LevelSetNode<PixelType, Self::ImageDimension>

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

Definition at line 85 of file itkShapePriorMAPCostFunctionBase.h.

◆ PixelType

template<typename TFeatureImage , typename TOutputPixel >
using itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::PixelType = TOutputPixel

Type of pixel used to represent the level set.

Definition at line 82 of file itkShapePriorMAPCostFunctionBase.h.

◆ Pointer

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

Definition at line 56 of file itkShapePriorMAPCostFunctionBase.h.

◆ Self

template<typename TFeatureImage , typename TOutputPixel >
using itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::Self = ShapePriorMAPCostFunctionBase

Standard class type aliases.

Definition at line 54 of file itkShapePriorMAPCostFunctionBase.h.

◆ ShapeFunctionPointer

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

Definition at line 93 of file itkShapePriorMAPCostFunctionBase.h.

◆ ShapeFunctionType

template<typename TFeatureImage , typename TOutputPixel >
using itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ShapeFunctionType = ShapeSignedDistanceFunction<double, Self::ImageDimension>

Type of the shape signed distance function.

Definition at line 92 of file itkShapePriorMAPCostFunctionBase.h.

◆ Superclass

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

Definition at line 55 of file itkShapePriorMAPCostFunctionBase.h.

Constructor & Destructor Documentation

◆ ShapePriorMAPCostFunctionBase()

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

◆ ~ShapePriorMAPCostFunctionBase()

template<typename TFeatureImage , typename TOutputPixel >
itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::~ShapePriorMAPCostFunctionBase ( )
overrideprotecteddefault

Member Function Documentation

◆ ComputeLogGradientTerm()

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 >.

◆ ComputeLogInsideTerm()

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 >.

◆ ComputeLogPosePriorTerm()

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 >.

◆ ComputeLogShapePriorTerm()

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 >.

◆ GetActiveRegion()

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

Set/Get the active region.

◆ GetDerivative()

template<typename TFeatureImage , typename TOutputPixel >
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 118 of file itkShapePriorMAPCostFunctionBase.h.

◆ GetFeatureImage()

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

Set/Get the feature image.

◆ GetModifiableShapeFunction()

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

Set/Get the shape distance function.

◆ GetNameOfClass()

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

◆ GetNumberOfParameters()

template<typename TFeatureImage , typename TOutputPixel >
unsigned int itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::GetNumberOfParameters ( ) const
inlineoverridevirtual

Return the number of parameters.

Implements itk::CostFunctionTemplate< double >.

Definition at line 125 of file itkShapePriorMAPCostFunctionBase.h.

◆ GetValue()

template<typename TFeatureImage , typename TOutputPixel >
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.

◆ Initialize()

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

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

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

◆ PrintSelf()

template<typename TFeatureImage , typename TOutputPixel >
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::Object.

◆ SetActiveRegion()

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

Set/Get the active region.

◆ SetFeatureImage()

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

Set/Get the feature image.

◆ SetShapeFunction()

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

Set/Get the shape distance function.

Member Data Documentation

◆ ImageDimension

template<typename TFeatureImage , typename TOutputPixel >
constexpr unsigned int itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >::ImageDimension = TFeatureImage::ImageDimension
staticconstexpr

Dimension constant.

Definition at line 79 of file itkShapePriorMAPCostFunctionBase.h.

◆ m_ActiveRegion

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

Definition at line 163 of file itkShapePriorMAPCostFunctionBase.h.

◆ m_FeatureImage

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

Definition at line 165 of file itkShapePriorMAPCostFunctionBase.h.

◆ m_ShapeFunction

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

Definition at line 162 of file itkShapePriorMAPCostFunctionBase.h.


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