itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType > Class Template Reference

A base class which defines the API for implementing a level set segmentation filter with statistical shape influence. More...

#include <itkShapePriorSegmentationLevelSetImageFilter.h>

Inheritance diagram for itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >:

[legend]Collaboration diagram for itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >:

[legend]List of all members.

Public Types
typedef ShapePriorSegmentationLevelSetImageFilter	Self
typedef SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ValueType	ValueType
typedef Superclass::OutputImageType	OutputImageType
typedef Superclass::FeatureImageType	FeatureImageType
typedef TOutputPixelType	OutputPixelType
typedef ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >	ShapePriorSegmentationFunctionType
typedef ShapePriorSegmentationFunctionType::ShapeFunctionType	ShapeFunctionType
typedef ShapeFunctionType::Pointer	ShapeFunctionPointer
typedef ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixelType >	CostFunctionType
typedef CostFunctionType::Pointer	CostFunctionPointer
typedef CostFunctionType::ParametersType	ParametersType
typedef CostFunctionType::NodeType	NodeType
typedef CostFunctionType::NodeContainerType	NodeContainerType
typedef NodeContainerType::Pointer	NodeContainerPointer
typedef SingleValuedNonLinearOptimizer	OptimizerType
typedef OptimizerType::Pointer	OptimizerPointer
Public Member Functions
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual const char *	GetNameOfClass () const
virtual const ParametersType &	GetCurrentParameters ()
virtual void	SetShapeFunction (ShapeFunctionType *s)
virtual ShapeFunctionType *	GetShapeFunction ()
virtual void	SetCostFunction (CostFunctionType *_arg)
virtual CostFunctionType *	GetCostFunction ()
virtual void	SetOptimizer (OptimizerType *_arg)
virtual OptimizerType *	GetOptimizer ()
virtual void	SetInitialParameters (ParametersType _arg)
virtual ParametersType	GetInitialParameters ()
void	SetShapePriorScaling (ValueType v)
ValueType	GetShapePriorScaling () const
virtual void	SetShapePriorSegmentationFunction (ShapePriorSegmentationFunctionType *s)
virtual ShapePriorSegmentationFunctionType *	GetShapePriorSegmentationFunction ()
Protected Member Functions
virtual	~ShapePriorSegmentationLevelSetImageFilter ()
	ShapePriorSegmentationLevelSetImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	InitializeIteration ()
void	GenerateData ()
void	ExtractActiveRegion (NodeContainerType *ptr)

---

Detailed Description

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float>
class itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >

A base class which defines the API for implementing a level set segmentation filter with statistical shape influence.

OVERVIEW

This class extends the functionality of SegmentationLevelSetImageFilter with an additional statistical shape influence term in the level set evolution as developed in [1].

TEMPLATE PARAMETERS

There are two required and one optional template parameter for these filters.

TInputImage is the image type of the initial model you will input to the filter using SetInput() or SetInitialImage().

TFeatureImage is the image type of the image from which the filter will calculate the speed term for segmentation (see INPUTS).

TOutputPixelType is the data type used for the output image phi, the implicit level set image. This should really only ever be set as float (default) or double.

PARAMETERS

From a level set evolution point of view, the shape is represented by a signed distance function from the shape encapsulated in a ShapeSignedDistanceFunction object.

See also:

ShapeSignedDistanceFunction

ShapePriorSegmentationLevelSetFunction

REFERENCES

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

Definition at line 72 of file itkShapePriorSegmentationLevelSetImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef SmartPointer<const Self> itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ConstPointer

Reimplemented from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 86 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef CostFunctionType::Pointer itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::CostFunctionPointer

Definition at line 110 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef ShapePriorMAPCostFunctionBase<TFeatureImage,TOutputPixelType> itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::CostFunctionType

The type of the MAP estimate cost function. Definition at line 109 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef Superclass::FeatureImageType itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::FeatureImageType

Local image typedefs Reimplemented from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 94 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef NodeContainerType::Pointer itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::NodeContainerPointer

Definition at line 116 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef CostFunctionType::NodeContainerType itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::NodeContainerType

Definition at line 115 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef CostFunctionType::NodeType itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::NodeType

Type of node used to represent the active region around the zero set. Definition at line 114 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef OptimizerType::Pointer itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::OptimizerPointer

Definition at line 120 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef SingleValuedNonLinearOptimizer itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::OptimizerType

The type of optimizer used to compute the MAP estimate of the shape and pose parameters. Definition at line 119 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef Superclass::OutputImageType itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::OutputImageType

Output image type typedefs Reimplemented from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 93 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef TOutputPixelType itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::OutputPixelType

Type of the output pixel. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 97 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef CostFunctionType::ParametersType itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ParametersType

Definition at line 111 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef SmartPointer<Self> itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::Pointer

Reimplemented from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 85 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef ShapePriorSegmentationLevelSetImageFilter itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::Self

Standard class typedefs Reimplemented from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 83 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef ShapeFunctionType::Pointer itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ShapeFunctionPointer

Definition at line 106 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef ShapePriorSegmentationFunctionType::ShapeFunctionType itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ShapeFunctionType

The shape signed distance function type. Definition at line 105 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef ShapePriorSegmentationLevelSetFunction<OutputImageType, FeatureImageType> itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ShapePriorSegmentationFunctionType

The level set function with shape prior type Definition at line 101 of file itkShapePriorSegmentationLevelSetImageFilter.h. Referenced by itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetShapePriorScaling().

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef SegmentationLevelSetImageFilter<TInputImage, TFeatureImage, TOutputPixelType> itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::Superclass

Standard class typedefs Reimplemented from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 84 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> typedef Superclass::ValueType itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ValueType

Inherited typedef from the superclass. Reimplemented from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 92 of file itkShapePriorSegmentationLevelSetImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::~ShapePriorSegmentationLevelSetImageFilter (   )  [inline, protected, virtual]

Definition at line 171 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ShapePriorSegmentationLevelSetImageFilter (   )  [protected]

---

Member Function Documentation

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> void itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ExtractActiveRegion (  NodeContainerType *  ptr  )  [protected]

Extract node of active region into a NodeContainer

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> void itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GenerateData (   )  [protected, virtual]

Overridden from ProcessObject to set certain values before starting the finite difference solver and then create an appropriate output Reimplemented from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual CostFunctionType* itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetCostFunction (   )  [virtual]

Set/Get the shape prior MAP cost function.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual const ParametersType& itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetCurrentParameters (   )  [virtual]

Get the current parameters.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual ParametersType itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetInitialParameters (   )  [virtual]

Set/Get the initial parameters. These are the initial parameters applied to the ShapeFunction. The user should refer to the documentation of the particular type of ShapeSignedDistanceFunction used to determine the meaning of the parameters.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual const char* itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual OptimizerType* itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetOptimizer (   )  [virtual]

Set/Get the optimizer.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual ShapeFunctionType* itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetShapeFunction (   )  [virtual]

Set/Get the shape signed distance function.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> ValueType itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetShapePriorScaling (   )  const [inline]

Set/Get the scaling of the shape prior term. Definition at line 154 of file itkShapePriorSegmentationLevelSetImageFilter.h. References itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::ShapePriorSegmentationFunctionType.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual ShapePriorSegmentationFunctionType* itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::GetShapePriorSegmentationFunction (   )  [inline, virtual]

Set the shape prior segmentation function. In general, this should only be called by a subclass of this object. It is made public to allow itk::Command objects access. Definition at line 163 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual void itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::InitializeIteration (   )  [protected, virtual]

Overrides parent implementation. MAP estimates of the shape and pose parameters is computed in this method. Reimplemented from itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TInputImage::ImageDimension  )

Dimension of the input/level set image.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual void itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual void itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetCostFunction (  CostFunctionType *  _arg  )  [virtual]

Set/Get the shape prior MAP cost function.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual void itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetInitialParameters (  ParametersType  _arg  )  [virtual]

Set/Get the initial parameters. These are the initial parameters applied to the ShapeFunction. The user should refer to the documentation of the particular type of ShapeSignedDistanceFunction used to determine the meaning of the parameters.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual void itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetOptimizer (  OptimizerType *  _arg  )  [virtual]

Set/Get the optimizer.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual void itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetShapeFunction (  ShapeFunctionType *  s  )  [virtual]

Set/Get the shape signed distance function.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> void itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetShapePriorScaling (  ValueType  v  )  [inline]

Set/Get the scaling of the shape prior term. Definition at line 146 of file itkShapePriorSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float> virtual void itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetShapePriorSegmentationFunction (  ShapePriorSegmentationFunctionType *  s  )  [virtual]

Set the shape prior segmentation function. In general, this should only be called by a subclass of this object. It is made public to allow itk::Command objects access.

---

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

• itkShapePriorSegmentationLevelSetImageFilter.h

---