Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage > Class Template Reference

A base class which defines the API for implementing a special class of image segmentation filters using level set methods. More...

#include <itkSegmentationLevelSetImageFilter.h>

Inheritance diagram for itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >:

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

[legend]List of all members.


[NOHEADER]
void	SetMaximumPropagationTimeStep (double n)
double	GetMaximumPropagationTimeStep () const
virtual	~SegmentationLevelSetImageFilter ()
	SegmentationLevelSetImageFilter (const Self &)
	SegmentationLevelSetImageFilter ()
Public Types
typedef SegmentationLevelSetImageFilter	Self
typedef SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ValueType	ValueType
typedef Superclass::IndexType	IndexType
typedef Superclass::TimeStepType	TimeStepType
typedef Superclass::InputImageType	InputImageType
typedef TOutputImage	OutputImageType
typedef TFeatureImage	FeatureImageType
typedef SegmentationLevelSetFunction< OutputImageType, FeatureImageType >	SegmentationFunctionType
typedef SegmentationFunctionType::VectorImageType	VectorImageType
Public Member Functions
virtual const char *	GetClassName () const
virtual void	SetInitialImage (InputImageType *f)
virtual const SegmentationFunctionType::ImageType *	GetSpeedImage () const
virtual const SegmentationFunctionType::VectorImageType *	GetAdvectionImage () const

virtual void	SetMaximumRMSError (ValueType _arg)
virtual ValueType	GetMaximumRMSError ()

virtual void	SetMaximumIterations (unsigned int _arg)
virtual unsigned int	GetMaximumIterations ()

virtual void	SetFeatureImage (const FeatureImageType *f)
virtual FeatureImageType *	GetFeatureImage ()

void	SetUseNegativeFeaturesOn ()
void	SetUseNegativeFeaturesOff ()

void	SetUseNegativeFeatures (bool u)
bool	GetUseNegativeFeatures () const

virtual void	SetReverseExpansionDirection (bool _arg)
virtual bool	GetReverseExpansionDirection ()
virtual void	ReverseExpansionDirectionOn ()
virtual void	ReverseExpansionDirectionOff ()

void	SetFeatureScaling (ValueType v)

void	SetPropagationScaling (ValueType v)
ValueType	GetPropagationScaling () const

void	SetAdvectionScaling (ValueType v)
ValueType	GetAdvectionScaling () const

void	SetCurvatureScaling (ValueType v)
ValueType	GetCurvatureScaling () const

void	SetUseMinimalCurvature (bool b)
bool	GetUseMinimalCurvature () const
void	UseMinimalCurvatureOn ()
void	UseMinimalCurvatureOff ()

virtual void	SetSegmentationFunction (SegmentationFunctionType *s)
virtual SegmentationFunctionType *	GetSegmentationFunction ()

void	SetMaximumCurvatureTimeStep (double n)
double	GetMaximumCurvatureTimeStep () const
Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateData ()
bool	Halt ()

virtual void	InitializeIteration ()
Protected Attributes
bool	m_ReverseExpansionDirection

Detailed Description

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>
class itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >

A base class which defines the API for implementing a special class of image segmentation filters using level set methods.

OVERVIEW: This object defines the framework for a class of segmentation filters which use level set methods. These filters work by constructing a ``feature image'' onto which the evolving level set locks as it moves. In the feature image, values that are close to zero are associated with object boundaries. An original (or preprocessed) image is given to the filter as the feature image and a seed for the level set is given as the input of the filter. The seed is converted into a level set embedding which propagates according to the features calculated from the original image.

TEMPLATE PARAMETERS: There are two required and two optional template parameter for these filters. Of the optional parameters, the last, TOutputImage, should not be changed from its default. It is only there to instantiate the parent class correctly.

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.

INPUTS: The input to any subclass of this filter is the seed image for the initial level set embedding. As with other subclasses of the SparseLevelSetImageFilter, the type of the input image is is not important. The (RequestedRegion) size of the seed image must, however, match the (RequestedRegion) size of the feature image.

You must identify the initial front (surface) in the input image. You do this by specifying its isovalue through the method SetIsoSurfaceValue(float f). The algorithm will then initialize its solution using the front represented by value f. Note that the front is always represented by isosurface zero in the output and not the isosurface you specified for the input. This is because, for simplicity, the filter will shift your input image so that the active front has zero values.

A NOTE ON DATA SPACING: Input data with anisotropic spacing should be resampled to isotropic voxels for use in this filter. Interpolation has not been built into the underlying p.d.e. solver.

: Depending on the particular application and filter that you are using, the feature image should be preprocessed with some type of noise reduction filtering. The feature image input can be of any type, but it will be cast to floating point before calculations are done.

OUTPUTS: The output of any subclass of this filter is a level set embedding as described in SparseFieldLevelSetImageFilter. The zero crossings of the output image give the pixels closest to the level set boundary. By ITK convention, NEGATIVE values are pixels INSIDE the segmented region and POSITIVE values are pixels OUTSIDE the segmented region.

PARAMETERS: The MaximumRMSChange parameter is used to determine when the solution has converged. A lower value will result in a tighter-fitting solution, but will require more computations. Too low a value could put the solver into an infinite loop unless a reasonable MaximumIterations parameter is set. Values should always be greater than 0.0 and less than 1.0.

: The MaximumIterations parameter can be used to halt the solution after a specified number of iterations, overriding the MaximumRMSChange halting criteria.

: The standard convention for ITK level-set segmentation filters is that POSITIVE propagation (speed) and advection terms cause the surface to EXPAND while negative terms cause the surface to CONTRACT. When the ReverseExpansionDirection parameter is set to TRUE (on), it tells the function object to reverse the standard ITK convention so that NEGATIVE terms cause EXPANSION and positive terms cause CONTRACTION.

This parameter can be safely changed as appropriate for a particular application or data set to achieve the desired behavior.

: The FeatureScaling parameter controls the magnitude of the features calculated for use in the level set propagation and advection speeds. This value simply sets both parameters to equal values at once. Some filters may only use on of these two terms and this method is a generic way to set either or both without having to know which is in use.

: The CurvatureScaling parameter controls the magnitude of the curvature values which are calculated on the evolving isophote. This is important in controlling the relative effect of curvature in the calculation. Default value is 1.0. Higher values relative to the other level set equation terms (propagation and advection) will give a smoother result.

: The PropagationScaling parameter controls the scaling of the scalar propagation (speed) term relative to other terms in the level set equation. Setting this value will override any value already set by FeatureScaling.

: The AdvectionScaling parameter controls the scaling of the vector advection field term relative to other terms in the level set equation. Setting this value will override any value already set by FeatureScaling.

: See LevelSetFunction for more information.

Definition at line 147 of file itkSegmentationLevelSetImageFilter.h.

Member Typedef Documentation

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

typedef SegmentationLevelSetFunction<OutputImageType, FeatureImageType> itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SegmentationFunctionType

The generic level set function type Definition at line 170 of file itkSegmentationLevelSetImageFilter.h.
Referenced by itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::InitializeIteration().

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

typedef SegmentationLevelSetImageFilter itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::Self

Standard class typedefs
Reimplemented from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >.
Definition at line 153 of file itkSegmentationLevelSetImageFilter.h.
Referenced by itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetMaximumPropagationTimeStep().

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

typedef SparseFieldLevelSetImageFilter<TInputImage, TOutputImage> itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::Superclass

Reimplemented from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >.
Definition at line 154 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

typedef Superclass::ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::ValueType

Inherited typedef from the superclass.
Reimplemented from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >.
Definition at line 159 of file itkSegmentationLevelSetImageFilter.h.
Referenced by itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::InitializeIteration(), and itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetPropagationScaling().

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

typedef SegmentationFunctionType::VectorImageType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::VectorImageType

The type used for the advection field Definition at line 173 of file itkSegmentationLevelSetImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

virtual itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::~SegmentationLevelSetImageFilter ( ) [inline, protected, virtual]

Set/Get the maximum constraint for the scalar/vector term factor of the time step calculation. Changing this value from the default is not recommended or necessary but could be used to speed up the surface evolution at the risk of creating an unstable solution. Definition at line 404 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SegmentationLevelSetImageFilter ( const Self & ) [protected]

Set/Get the maximum constraint for the scalar/vector term factor of the time step calculation. Changing this value from the default is not recommended or necessary but could be used to speed up the surface evolution at the risk of creating an unstable solution.

Member Function Documentation

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

virtual const SegmentationFunctionType::VectorImageType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetAdvectionImage ( ) const [inline, virtual]

Definition at line 211 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetCurvatureScaling ( ) const [inline]

Set/Get the scaling of the curvature. Use this parameter to increase the influence of curvature on the movement of the surface. Higher values relative to Advection and Propagation values will give smoother surfaces. Definition at line 330 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

double itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetMaximumCurvatureTimeStep ( ) const [inline]

Set/Get the maximum constraint for the curvature term factor in the time step calculation. Changing this value from the default is not recommended or necessary but could be used to speed up the surface evolution at the risk of creating an unstable solution. Definition at line 381 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

double itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetMaximumPropagationTimeStep ( ) const [inline]

Set/Get the maximum constraint for the scalar/vector term factor of the time step calculation. Changing this value from the default is not recommended or necessary but could be used to speed up the surface evolution at the risk of creating an unstable solution. Definition at line 399 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

virtual bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetReverseExpansionDirection ( ) [virtual]

Turn On/Off the flag which determines whether Positive or Negative speed terms will cause surface expansion. If set to TRUE then negative speed terms will cause the surface to expand and positive speed terms will cause the surface to contract. If set to FALSE (default) then positive speed terms will cause the surface to expand and negative speed terms will cause the surface to contract. This method can be safely used to reverse the expansion/contraction as appropriate to a particular application or data set.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

virtual const SegmentationFunctionType::ImageType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetSpeedImage ( ) const [inline, virtual]

Definition at line 208 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::InitializeIteration ( ) [inline, protected, virtual]

Overrides parent implementation
Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.
Definition at line 412 of file itkSegmentationLevelSetImageFilter.h.
References itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SegmentationFunctionType, and itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::ValueType.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::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::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::ReverseExpansionDirectionOff ( ) [virtual]

Turn On/Off the flag which determines whether Positive or Negative speed terms will cause surface expansion. If set to TRUE then negative speed terms will cause the surface to expand and positive speed terms will cause the surface to contract. If set to FALSE (default) then positive speed terms will cause the surface to expand and negative speed terms will cause the surface to contract. This method can be safely used to reverse the expansion/contraction as appropriate to a particular application or data set.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::ReverseExpansionDirectionOn ( ) [virtual]

Turn On/Off the flag which determines whether Positive or Negative speed terms will cause surface expansion. If set to TRUE then negative speed terms will cause the surface to expand and positive speed terms will cause the surface to contract. If set to FALSE (default) then positive speed terms will cause the surface to expand and negative speed terms will cause the surface to contract. This method can be safely used to reverse the expansion/contraction as appropriate to a particular application or data set.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetCurvatureScaling ( ValueType v ) [inline]

Set/Get the scaling of the curvature. Use this parameter to increase the influence of curvature on the movement of the surface. Higher values relative to Advection and Propagation values will give smoother surfaces. Definition at line 322 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetFeatureScaling ( ValueType v ) [inline]

Combined scaling of the propagation and advection speed terms. You should use either this -or- Get/SetPropagationScaling and Get/SetAdvectionScaling (if appropriate). See subclasses for details on when and whether to set these parameters. Definition at line 274 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetMaximumCurvatureTimeStep ( double n ) [inline]

Set/Get the maximum constraint for the curvature term factor in the time step calculation. Changing this value from the default is not recommended or necessary but could be used to speed up the surface evolution at the risk of creating an unstable solution. Definition at line 373 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetMaximumPropagationTimeStep ( double n ) [inline]

Set/Get the maximum constraint for the scalar/vector term factor of the time step calculation. Changing this value from the default is not recommended or necessary but could be used to speed up the surface evolution at the risk of creating an unstable solution. Definition at line 391 of file itkSegmentationLevelSetImageFilter.h.
References itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::Self.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetPropagationScaling ( ValueType v ) [inline]

Set/Get the scaling of the propagation speed. Setting the FeatureScaling parameter overrides any previous values set for PropagationScaling. Definition at line 289 of file itkSegmentationLevelSetImageFilter.h.
References itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::ValueType.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>>

virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetReverseExpansionDirection ( bool _arg ) [virtual]

Turn On/Off the flag which determines whether Positive or Negative speed terms will cause surface expansion. If set to TRUE then negative speed terms will cause the surface to expand and positive speed terms will cause the surface to contract. If set to FALSE (default) then positive speed terms will cause the surface to expand and negative speed terms will cause the surface to contract. This method can be safely used to reverse the expansion/contraction as appropriate to a particular application or data set.

Member Data Documentation

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

itkSegmentationLevelSetImageFilter.h

Generated at Sat Mar 31 02:39:47 2007 for ITK by

itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage > Class Template Reference

[NOHEADER]

Public Types

Public Member Functions

Protected Member Functions