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:

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

[legend]List of all members.

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 Methods
virtual const char *	GetClassName () const
virtual void	SetInitialImage (InputImageType *f)
virtual SegmentationFunctionType::ImageType *	GetSpeedImage () const
virtual 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 (FeatureImageType *f)
virtual FeatureImageType *	GetFeatureImage ()
void	SetUseNegativeFeaturesOn ()
void	SetUseNegativeFeaturesOff ()
virtual void	SetUseNegativeFeatures (bool _arg)
virtual bool	GetUseNegativeFeatures ()
void	SetFeatureScaling (ValueType v)
virtual void	SetPropagationScaling (ValueType _arg)
virtual ValueType	GetPropagationScaling ()
virtual void	SetAdvectionScaling (ValueType _arg)
virtual ValueType	GetAdvectionScaling ()
virtual void	SetCurvatureScaling (ValueType _arg)
virtual ValueType	GetCurvatureScaling ()
virtual void	SetSegmentationFunction (SegmentationFunctionType *s)
virtual SegmentationFunctionType *	GetSegmentationFunction ()
Protected Methods
virtual	~SegmentationLevelSetImageFilter ()
	SegmentationLevelSetImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateData ()
bool	Halt ()
virtual void	InitializeIteration ()
Protected Attributes
bool	m_UseNegativeFeatures
ValueType	m_CurvatureScaling
ValueType	m_PropagationScaling
ValueType	m_AdvectionScaling

---

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.

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, positive values are pixels inside the segmented region and negative 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 UseNegativeFeatures parameter tells the function object to reverse the sign of the feature image, resulting in surface movement in the opposite direction.

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 137 of file itkSegmentationLevelSetImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> typedef SmartPointer<const Self> itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::ConstPointer

Reimplemented from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LaplacianSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 146 of file itkSegmentationLevelSetImageFilter.h.

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

Reimplemented in itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LaplacianSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 156 of file itkSegmentationLevelSetImageFilter.h.

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

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

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

Information derived from the image types. Reimplemented from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >. Definition at line 152 of file itkSegmentationLevelSetImageFilter.h.

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

Local image typedefs Reimplemented from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LaplacianSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 155 of file itkSegmentationLevelSetImageFilter.h.

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

Reimplemented from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LaplacianSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 145 of file itkSegmentationLevelSetImageFilter.h.

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 160 of file itkSegmentationLevelSetImageFilter.h.

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 >. Reimplemented in itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LaplacianSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 143 of file itkSegmentationLevelSetImageFilter.h.

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 >. Reimplemented in itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LaplacianSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 144 of file itkSegmentationLevelSetImageFilter.h.

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

Typedefs from the superclass Reimplemented from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >. Definition at line 151 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 >. Reimplemented in itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LaplacianSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 149 of file itkSegmentationLevelSetImageFilter.h.

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 Reimplemented in itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >. Definition at line 163 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]

Definition at line 262 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 (    )  [protected]

---

Member Function Documentation

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::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::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual SegmentationFunctionType::VectorImageType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetAdvectionImage (    )  const [inline, virtual]

Definition at line 201 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetAdvectionScaling (    )  [virtual]

Set/Get the scaling of the advection field. Setting the FeatureScaling parameter will override any existing value for AdvectionScaling.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual const char* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >. Reimplemented in itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LaplacianSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetCurvatureScaling (    )  [virtual]

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.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual FeatureImageType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetFeatureImage (    )  [inline, virtual]

Set/Get the feature image to be used for speed function of the level set equation. Equivalent to calling Set/GetInput(1, ..) Definition at line 187 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual unsigned int itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetMaximumIterations (    )  [virtual]

Set/Get the maximum number of iterations allowed for the solver. This prevents infinite loops if a solution "bounces".

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetMaximumRMSError (    )  [virtual]

Set/Get the maximum RMS error allowed for the solution. The solver will halt once this threshold has been reached.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetPropagationScaling (    )  [virtual]

Set/Get the scaling of the propagation speed. Setting the FeatureScaling parameter overrides any previous values set for PropagationScaling.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual SegmentationFunctionType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetSegmentationFunction (    )  [inline, virtual]

Set the 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 257 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual SegmentationFunctionType::ImageType* itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::GetSpeedImage (    )  const [inline, virtual]

Definition at line 198 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 >::GetUseNegativeFeatures (    )  [virtual]

Set/Get the value of the UseNegativeFeatures flag. This flag controls whether (true) or not (false) the direction of the speed function is reversed. By default, level set segmentation filters take ``inside'' values as positive, and ``outside'' values as negative.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::Halt (    )  [protected, virtual]

Tells the solver when the solution has converged within the specified parameters. Implements itk::FiniteDifferenceImageFilter< 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 >::InitializeIteration (    )  [inline, protected, virtual]

Overrides parent implementation Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >. Definition at line 268 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 >::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 >. Reimplemented in itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LaplacianSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetAdvectionScaling (  ValueType    _arg )  [virtual]

Set/Get the scaling of the advection field. Setting the FeatureScaling parameter will override any existing value for AdvectionScaling.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetCurvatureScaling (  ValueType    _arg )  [virtual]

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.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetFeatureImage (  FeatureImageType *    f )  [inline, virtual]

Set/Get the feature image to be used for speed function of the level set equation. Equivalent to calling Set/GetInput(1, ..) Definition at line 182 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 228 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 >::SetInitialImage (  InputImageType *    f )  [inline, virtual]

Set/Get the initial level set model. Equivalent to calling SetInput(..) Definition at line 193 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 >::SetMaximumIterations (  unsigned int    _arg )  [virtual]

Set/Get the maximum number of iterations allowed for the solver. This prevents infinite loops if a solution "bounces".

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetMaximumRMSError (  ValueType    _arg )  [virtual]

Set/Get the maximum RMS error allowed for the solution. The solver will halt once this threshold has been reached.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetPropagationScaling (  ValueType    _arg )  [virtual]

Set/Get the scaling of the propagation speed. Setting the FeatureScaling parameter overrides any previous values set for PropagationScaling.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetSegmentationFunction (  SegmentationFunctionType *    s )  [virtual]

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

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> virtual void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetUseNegativeFeatures (  bool    _arg )  [virtual]

Set/Get the value of the UseNegativeFeatures flag. This flag controls whether (true) or not (false) the direction of the speed function is reversed. By default, level set segmentation filters take ``inside'' values as positive, and ``outside'' values as negative.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> void itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetUseNegativeFeaturesOff (    )  [inline]

This method reverses the speed function direction, effectively changing inside feature values to outside feature values and vice versa Definition at line 210 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 >::SetUseNegativeFeaturesOn (    )  [inline]

This method reverses the speed function direction, effectively changing inside feature values to outside feature values and vice versa Definition at line 206 of file itkSegmentationLevelSetImageFilter.h.

---

Member Data Documentation

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> ValueType itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::m_AdvectionScaling [protected]

Scalar parameter for curvature. Definition at line 295 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 >::m_CurvatureScaling [protected]

Scalar parameter for curvature. Definition at line 289 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 >::m_PropagationScaling [protected]

Scalar parameter for curvature. Definition at line 292 of file itkSegmentationLevelSetImageFilter.h.

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image<TOutputPixelType, ::itk::GetImageDimension<TInputImage>::ImageDimension>> bool itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::m_UseNegativeFeatures [protected]

Flag which sets the inward/outward direction of positive propagation speed. Definition at line 286 of file itkSegmentationLevelSetImageFilter.h.

---

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

• itkSegmentationLevelSetImageFilter.h

---