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

itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference

#include <itkSegmentationLevelSetFunction.h>

Inheritance diagram for itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >:

[legend]Collaboration diagram for itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >:

[legend]List of all members.


Public Types
typedef SegmentationLevelSetFunction	Self
typedef LevelSetFunction< TImageType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ImageType	ImageType
typedef Superclass::RadiusType	RadiusType
typedef TFeatureImageType	FeatureImageType
typedef Superclass::FloatOffsetType	FloatOffsetType
typedef Superclass::ScalarValueType	ScalarValueType
typedef Superclass::NeighborhoodType	NeighborhoodType
typedef FeatureImageType::PixelType	FeatureScalarType
typedef ImageType::IndexType	IndexType
typedef Superclass::VectorType	VectorType
typedef Superclass::GlobalDataStruct	GlobalDataStruct
typedef Image< VectorType, itkGetStaticConstMacro(ImageDimension)	VectorImageType )
typedef LinearInterpolateImageFunction< ImageType >	InterpolatorType
typedef VectorLinearInterpolateImageFunction< VectorImageType >	VectorInterpolatorType
typedef InterpolatorType::ContinuousIndexType	ContinuousIndexType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual void	Initialize (const RadiusType &r)
virtual void	CalculateSpeedImage ()
virtual void	CalculateAdvectionImage ()
virtual void	AllocateSpeedImage ()
virtual void	AllocateAdvectionImage ()
virtual void	ReverseExpansionDirection ()

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

virtual ImageType *	GetSpeedImage ()
void	SetSpeedImage (ImageType *s)

virtual VectorImageType *	GetAdvectionImage () const
void	SetAdvectionImage (VectorImageType *s)
Protected Member Functions
virtual ScalarValueType	PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const
virtual VectorType	AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const
virtual	~SegmentationLevelSetFunction ()
	SegmentationLevelSetFunction ()
Protected Attributes
FeatureImageType::ConstPointer	m_FeatureImage
ImageType::Pointer	m_SpeedImage
VectorImageType::Pointer	m_AdvectionImage
Functor::VectorCast< typename VectorInterpolatorType::OutputType, VectorType >	m_VectorCast
InterpolatorType::Pointer	m_Interpolator
VectorInterpolatorType::Pointer	m_VectorInterpolator

Detailed Description

template<class TImageType, class TFeatureImageType = TImageType>
class itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >

: This object defines the API for a class of function objects which perform level set based segmentations. The SegmentationLevelSetImageFilter objects use these SegmentationLevelSetFunction objects to perform the numerical calculations which move a level set front to lock onto image features.

: In order to create a working function object, you must subclass the CalculateSpeedImage method to produce a "feature image" that is used by the parent LevelSetFunction class as the PropagationSpeed for its calculations.

See also:: SegmentationLevelSetImageFilter
LevelSetFunction

Definition at line 45 of file itkSegmentationLevelSetFunction.h.

Member Typedef Documentation

template<class TImageType, class TFeatureImageType = TImageType>

typedef InterpolatorType::ContinuousIndexType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::ContinuousIndexType

Continuous index type recognized by the interpolator
Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >.
Definition at line 84 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

typedef Superclass::FloatOffsetType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::FloatOffsetType

A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.
Reimplemented from itk::LevelSetFunction< TImageType >.
Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >.
Definition at line 62 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

typedef Superclass::GlobalDataStruct itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GlobalDataStruct

Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >.
Definition at line 68 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

typedef ImageType::IndexType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::IndexType

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >.
Definition at line 66 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

typedef LinearInterpolateImageFunction<ImageType> itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::InterpolatorType

Define a scalar interpolator
Definition at line 78 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

typedef Superclass::NeighborhoodType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::NeighborhoodType

The type of data structure that is passed to this function object to evaluate at a pixel that does not lie on a data set boundary.
Reimplemented from itk::LevelSetFunction< TImageType >.
Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >.
Definition at line 64 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

typedef Image<VectorType, itkGetStaticConstMacro(ImageDimension) itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorImageType)

Define an image type for the advection field.
Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< OutputImageType, FeatureImageType >.
Definition at line 74 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

typedef VectorLinearInterpolateImageFunction<VectorImageType> itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorInterpolatorType

Define a vector interpolator
Definition at line 81 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

typedef Superclass::VectorType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorType

The vector type that will be used in the calculations.
Reimplemented from itk::LevelSetFunction< TImageType >.
Definition at line 67 of file itkSegmentationLevelSetFunction.h.

Constructor & Destructor Documentation

template<class TImageType, class TFeatureImageType = TImageType>

virtual itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::~SegmentationLevelSetFunction ( ) [inline, protected, virtual]

Definition at line 166 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SegmentationLevelSetFunction ( ) [inline, protected]

Definition at line 167 of file itkSegmentationLevelSetFunction.h.

Member Function Documentation

template<class TImageType, class TFeatureImageType = TImageType>

virtual VectorType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::AdvectionField ( const NeighborhoodType & ,

const FloatOffsetType & ,

GlobalDataStruct * gd

) const [protected, virtual]

Advection field. Returns a vector from the computed advectionfield.
Reimplemented from itk::LevelSetFunction< TImageType >.

template<class TImageType, class TFeatureImageType = TImageType>

virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::AllocateAdvectionImage ( ) [virtual]

Allocates the image that will be used for the level set function's Advection field term. See LevelSetFunction for more information.

template<class TImageType, class TFeatureImageType = TImageType>

virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::AllocateSpeedImage ( ) [virtual]

Allocates the image that will be used for the level set function's Propagation Speed term. See LevelSetFunction for more information.

template<class TImageType, class TFeatureImageType = TImageType>

virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateAdvectionImage ( ) [inline, virtual]

This method must be defined in a subclass to implement a working function object. This method is called before the solver begins its work to produce the speed image used as the level set function's Advection field term. See LevelSetFunction for more information.
Reimplemented in itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, and itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 121 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

virtual VectorImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetAdvectionImage ( ) const [inline, virtual]

Get/Set the image used as the advection field in the level set equation
Definition at line 100 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

virtual const FeatureImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetFeatureImage ( ) const [inline, virtual]

Set/Get the image which will be used to calculate the speed function.
Definition at line 87 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

virtual ImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSpeedImage ( ) [inline, virtual]

Get/Set the image used as the speed function in the level set equation
Definition at line 94 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

virtual ScalarValueType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::PropagationSpeed ( const NeighborhoodType & ,

const FloatOffsetType & ,

GlobalDataStruct * gd

) const [protected, virtual]

Returns the propagation speed from the precalculated speed image.
Reimplemented from itk::LevelSetFunction< TImageType >.

template<class TImageType, class TFeatureImageType = TImageType>

virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::ReverseExpansionDirection ( ) [virtual]

Determines whether Positive or Negative speed terms will cause surface expansion. This method flips the sign of all of the speed, advection, etc terms. By convention, filters should be written so that POSITIVE speed terms cause surface expansion. Calling this method will toggle between the standard POSITIVE EXPANSION convention and the nonstandard NEGATIVE EXPANSION convention.
IMPORTANT: When adding terms to the level-set equation through subclassing you may need to override this function so that your new terms will be properly adjusted.

template<class TImageType, class TFeatureImageType = TImageType>

void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetAdvectionImage ( VectorImageType * s )

Get/Set the image used as the advection field in the level set equation

template<class TImageType, class TFeatureImageType = TImageType>

virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetFeatureImage ( const FeatureImageType * f ) [inline, virtual]

Set/Get the image which will be used to calculate the speed function.
Definition at line 89 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetSpeedImage ( ImageType * s )

Get/Set the image used as the speed function in the level set equation

Member Data Documentation

template<class TImageType, class TFeatureImageType = TImageType>

VectorImageType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_AdvectionImage [protected]

The image holding the advection field for front propation
Definition at line 151 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

FeatureImageType::ConstPointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_FeatureImage [protected]

The image whose features will be used to create a speed image
Definition at line 145 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

InterpolatorType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Interpolator [protected]

Definition at line 175 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

ImageType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_SpeedImage [protected]

The image holding the speed values for front propagation
Definition at line 148 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

Functor::VectorCast< typename VectorInterpolatorType::OutputType, VectorType > itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_VectorCast [protected]

A casting functor to convert between vector types.
Definition at line 155 of file itkSegmentationLevelSetFunction.h.

template<class TImageType, class TFeatureImageType = TImageType>

VectorInterpolatorType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_VectorInterpolator [protected]

Definition at line 176 of file itkSegmentationLevelSetFunction.h.

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

itkSegmentationLevelSetFunction.h

Generated at Thu May 25 02:16:29 2006 for ITK by

itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference

Public Types

Public Member Functions

Protected Member Functions