The LevelSetFunction class is a generic function object which can be used to create a level set method filter when combined with an appropriate finite difference image filter. (See FiniteDifferenceImageFilter.) More...

#include <itkLevelSetFunction.h>

Inheritance diagram for itk::LevelSetFunction< TImageType >:

Collaboration diagram for itk::LevelSetFunction< TImageType >:

List of all members.

Classes
struct	GlobalDataStruct

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ZeroFluxNeumannBoundaryCondition < ImageType >	DefaultBoundaryConditionType
typedef Superclass::FloatOffsetType	FloatOffsetType
typedef Superclass::ImageType	ImageType
typedef Superclass::NeighborhoodScalesType	NeighborhoodScalesType
typedef Superclass::NeighborhoodType	NeighborhoodType
typedef Superclass::PixelRealType	PixelRealType
typedef Superclass::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::RadiusType	RadiusType
typedef PixelType	ScalarValueType
typedef LevelSetFunction	Self
typedef FiniteDifferenceFunction < TImageType >	Superclass
typedef double	TimeStepType
typedef FixedArray < ScalarValueType, itkGetStaticConstMacro(ImageDimension)>	VectorType

Public Member Functions
virtual VectorType	AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual ScalarValueType	Compute3DMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual ScalarValueType	ComputeCurvatureTerm (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual TimeStepType	ComputeGlobalTimeStep (void *GlobalData) const
virtual ScalarValueType	ComputeMeanCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual ScalarValueType	ComputeMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
const NeighborhoodScalesType	ComputeNeighborhoodScales () const
virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &=FloatOffsetType(0.0))
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual ScalarValueType	CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual void	Delete ()
ScalarValueType	GetAdvectionWeight () const
ScalarValueType	GetCurvatureWeight () const
ScalarValueType	GetEpsilonMagnitude () const
virtual void *	GetGlobalDataPointer () const
ScalarValueType	GetLaplacianSmoothingWeight () const
virtual const char *	GetNameOfClass () const
ScalarValueType	GetPropagationWeight () const
const RadiusType &	GetRadius () const
virtual int	GetReferenceCount () const
bool	GetUseMinimalCurvature () const
virtual void	Initialize (const RadiusType &r)
virtual void	InitializeIteration ()
virtual ScalarValueType	LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
void	Print (std::ostream &os, Indent indent=0) const
virtual ScalarValueType	PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual void	Register () const
virtual void	ReleaseGlobalDataPointer (void *GlobalData) const
virtual void	SetAdvectionWeight (const ScalarValueType a)
virtual void	SetCurvatureWeight (const ScalarValueType c)
void	SetEpsilonMagnitude (const ScalarValueType e)
void	SetLaplacianSmoothingWeight (const ScalarValueType c)
virtual void	SetPropagationWeight (const ScalarValueType p)
void	SetRadius (const RadiusType &r)
virtual void	SetReferenceCount (int)
void	SetScaleCoefficients (PixelRealType vals[ImageDimension])
void	SetUseMinimalCurvature (bool b)
virtual void	UnRegister () const
void	UseMinimalCurvatureOff ()
void	UseMinimalCurvatureOn ()

Static Public Member Functions
static void	BreakOnError ()
static double	GetMaximumCurvatureTimeStep ()
static double	GetMaximumPropagationTimeStep ()
static Pointer	New ()
static void	SetMaximumCurvatureTimeStep (double n)
static void	SetMaximumPropagationTimeStep (double n)

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	LevelSetFunction ()
virtual	~LevelSetFunction ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &s, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const

Static Protected Member Functions
static VectorType	InitializeZeroVectorConstant ()

Protected Attributes
ScalarValueType	m_AdvectionWeight
::vcl_size_t	m_Center
ScalarValueType	m_CurvatureWeight
ScalarValueType	m_EpsilonMagnitude
ScalarValueType	m_LaplacianSmoothingWeight
ScalarValueType	m_PropagationWeight
RadiusType	m_Radius
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
PixelRealType	m_ScaleCoefficients [ImageDimension]
bool	m_UseMinimalCurvature
::vcl_size_t	m_xStride [itkGetStaticConstMacro(ImageDimension)]
std::slice	x_slice [itkGetStaticConstMacro(ImageDimension)]

Static Protected Attributes
static double	m_DT = 1.0/(2.0 * ImageDimension)
static double	m_WaveDT = 1.0/(2.0 * ImageDimension)
static VectorType	m_ZeroVectorConstant

Private Member Functions
	LevelSetFunction (const Self &)
void	operator= (const Self &)

Detailed Description

template<class TImageType>
class itk::LevelSetFunction< TImageType >

The LevelSetFunction class is a generic function object which can be used to create a level set method filter when combined with an appropriate finite difference image filter. (See FiniteDifferenceImageFilter.)

LevelSetFunction implements a generic level set function. This function is an expanded form of the basic equation developed in [1].

$\phi_{t} + \alpha \stackrel{\rightharpoonup}{A}(\mathbf{x})\cdot\nabla\phi + \beta P(\mathbf{x})\mid\nabla\phi\mid = \gamma Z(\mathbf{x})\kappa\mid\nabla\phi\mid$

where $\stackrel{\rightharpoonup}{A}$ is an advection term, $ P $ is a propagation (growth) term, and $ Z $ is a spatial modifier term for the mean curvature $\kappa$ . $\alpha$ , $\beta$ , and $\gamma$ are all scalar constants.

Terms in the equation above are supplied through virtual methods, which must be subclassed to complete an implementation. Terms can be eliminated from the equation by setting the corresponding constants to zero. A wide variety of level set methods can be implemented by subclassing this basic equation.

In ITK, the usual sign convention is that the INSIDE of a surface contains NEGATIVE values and the OUTSIDE of the surface contains POSITIVE values.

Warning:: You MUST call Initialize() in the constructor of subclasses of this object to set it up properly to do level-set Calculations. The argument that you pass Initialize is the radius of the neighborhood needed to perform the calculations. If your subclass does not do any additional neighborhood processing, then the default radius should be 1 in each direction.

REFERENCES

: [1] Sethian, J.A. Level Set Methods. Cambridge University Press. 1996.

Definition at line 64 of file itkLevelSetFunction.h.

Member Typedef Documentation

template<class TImageType>

typedef SmartPointer<const Self> itk::LevelSetFunction< TImageType >::ConstPointer

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Definition at line 72 of file itkLevelSetFunction.h.

template<class TImageType>

typedef ZeroFluxNeumannBoundaryCondition<ImageType> itk::FiniteDifferenceFunction< TImageType >::DefaultBoundaryConditionType

inherited

The default boundary condition for finite difference functions that is used unless overridden in the Evaluate() method.

Definition at line 91 of file itkFiniteDifferenceFunction.h.

template<class TImageType>

typedef Superclass::FloatOffsetType itk::LevelSetFunction< TImageType >::FloatOffsetType

A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 92 of file itkLevelSetFunction.h.

template<class TImageType>

typedef Superclass::ImageType itk::LevelSetFunction< TImageType >::ImageType

Extract some parameters from the image type

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Definition at line 85 of file itkLevelSetFunction.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

template<class TImageType>

typedef Superclass::NeighborhoodScalesType itk::LevelSetFunction< TImageType >::NeighborhoodScalesType

The type of data structure that holds the scales with which the neighborhood is weighted to properly account for spacing and neighborhood radius.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.

Definition at line 91 of file itkLevelSetFunction.h.

template<class TImageType>

typedef Superclass::NeighborhoodType itk::LevelSetFunction< TImageType >::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::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 90 of file itkLevelSetFunction.h.

template<class TImageType>

typedef Superclass::PixelRealType itk::LevelSetFunction< TImageType >::PixelRealType

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 88 of file itkLevelSetFunction.h.

template<class TImageType>

typedef Superclass::PixelType itk::LevelSetFunction< TImageType >::PixelType

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 86 of file itkLevelSetFunction.h.

template<class TImageType>

typedef SmartPointer<Self> itk::LevelSetFunction< TImageType >::Pointer

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Definition at line 71 of file itkLevelSetFunction.h.

template<class TImageType>

typedef Superclass::RadiusType itk::LevelSetFunction< TImageType >::RadiusType

Neighborhood radius type

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Definition at line 89 of file itkLevelSetFunction.h.

template<class TImageType>

typedef PixelType itk::LevelSetFunction< TImageType >::ScalarValueType

Definition at line 87 of file itkLevelSetFunction.h.

template<class TImageType>

typedef LevelSetFunction itk::LevelSetFunction< TImageType >::Self

Standard class typedefs.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Definition at line 69 of file itkLevelSetFunction.h.

template<class TImageType>

typedef FiniteDifferenceFunction<TImageType> itk::LevelSetFunction< TImageType >::Superclass

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Definition at line 70 of file itkLevelSetFunction.h.

template<class TImageType>

typedef double itk::LevelSetFunction< TImageType >::TimeStepType

Convenient typedefs.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.

Definition at line 84 of file itkLevelSetFunction.h.

template<class TImageType>

typedef FixedArray<ScalarValueType, itkGetStaticConstMacro(ImageDimension)> itk::LevelSetFunction< TImageType >::VectorType

The vector type that will be used in the calculations.

Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 96 of file itkLevelSetFunction.h.

Constructor & Destructor Documentation

template<class TImageType>

itk::LevelSetFunction< TImageType >::LevelSetFunction ( )

inlineprotected

Definition at line 285 of file itkLevelSetFunction.h.

template<class TImageType>

virtual itk::LevelSetFunction< TImageType >::~LevelSetFunction ( )

inlineprotectedvirtual

Definition at line 293 of file itkLevelSetFunction.h.

template<class TImageType>

itk::LevelSetFunction< TImageType >::LevelSetFunction ( const Self & )

private

Member Function Documentation

template<class TImageType>

virtual VectorType itk::LevelSetFunction< TImageType >::AdvectionField	(	const NeighborhoodType &	,
		const FloatOffsetType &	,
		GlobalDataStruct *	= `0`
	)		const

inlinevirtual

Advection field. Default implementation returns a vector of zeros.

Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 124 of file itkLevelSetFunction.h.

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

template<class TImageType >

LevelSetFunction< TImageType >::ScalarValueType itk::LevelSetFunction< TImageType >::Compute3DMinimalCurvature	(	const NeighborhoodType &	neighborhood,
		const FloatOffsetType &	offset,
		GlobalDataStruct *	gd = `0`
	)

virtual

Definition at line 127 of file itkLevelSetFunction.txx.

References itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_dx, and itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_dxy.

template<class TImageType >

LevelSetFunction< TImageType >::ScalarValueType itk::LevelSetFunction< TImageType >::ComputeCurvatureTerm	(	const NeighborhoodType &	neighborhood,
		const FloatOffsetType &	offset,
		GlobalDataStruct *	gd = `0`
	)

virtual

Definition at line 27 of file itkLevelSetFunction.txx.

template<class TImageType >

LevelSetFunction< TImageType >::TimeStepType itk::LevelSetFunction< TImageType >::ComputeGlobalTimeStep ( void * GlobalData ) const

virtual

Computes the time step for an update given a global data structure. The data used in the computation may take different forms depending on the nature of the equations. This global data cannot be kept in the instance of the equation object itself since the equation object must remain stateless for thread safety. The global data is therefore managed for each thread by the finite difference solver filters.

Implements itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.

Definition at line 227 of file itkLevelSetFunction.txx.

References itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxAdvectionChange, itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxCurvatureChange, and itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxPropagationChange.

template<class TImageType >

LevelSetFunction< TImageType >::ScalarValueType itk::LevelSetFunction< TImageType >::ComputeMeanCurvature	(	const NeighborhoodType &	,
		const FloatOffsetType &	,
		GlobalDataStruct *	gd = `0`
	)

virtual

Definition at line 160 of file itkLevelSetFunction.txx.

References itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_dx, itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_dxy, and itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_GradMagSqr.

template<class TImageType >

LevelSetFunction< TImageType >::ScalarValueType itk::LevelSetFunction< TImageType >::ComputeMinimalCurvature	(	const NeighborhoodType &	,
		const FloatOffsetType &	,
		GlobalDataStruct *	gd = `0`
	)

virtual

Definition at line 55 of file itkLevelSetFunction.txx.

References itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_dx, itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_dxy, itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_GradMagSqr, and itk::ZERO.

template<class TImageType >

const FiniteDifferenceFunction< TImageType >::NeighborhoodScalesType itk::FiniteDifferenceFunction< TImageType >::ComputeNeighborhoodScales ( ) const

inherited

Compute the scales that weight the neighborhood during difference operations to properly account for spacing and neighborhood radius

Definition at line 37 of file itkFiniteDifferenceFunction.txx.

References itk::FixedArray< TValueType, VLength >::Fill().

template<class TImageType >

LevelSetFunction< TImageType >::PixelType itk::LevelSetFunction< TImageType >::ComputeUpdate	(	const NeighborhoodType &	neighborhood,
		void *	globalData,
		const FloatOffsetType &	offset = `FloatOffsetType(0.0)`
	)

virtual

Compute the equation value.

Implements itk::FiniteDifferenceFunction< TImageType >.

Definition at line 296 of file itkLevelSetFunction.txx.

template<class TImageType>

virtual::itk::LightObject::Pointer itk::LevelSetFunction< TImageType >::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

template<class TImageType>

virtual ScalarValueType itk::LevelSetFunction< TImageType >::CurvatureSpeed	(	const NeighborhoodType &	,
		const FloatOffsetType &	,
		GlobalDataStruct *	= `0`
	)		const

inlinevirtual

Curvature speed. Can be used to spatially modify the effects of curvature . The default implementation returns one.

Definition at line 137 of file itkLevelSetFunction.h.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

template<class TImageType>

ScalarValueType itk::LevelSetFunction< TImageType >::GetAdvectionWeight ( ) const

inline

Definition at line 152 of file itkLevelSetFunction.h.

template<class TImageType>

ScalarValueType itk::LevelSetFunction< TImageType >::GetCurvatureWeight ( ) const

inline

Definition at line 164 of file itkLevelSetFunction.h.

template<class TImageType>

ScalarValueType itk::LevelSetFunction< TImageType >::GetEpsilonMagnitude ( ) const

inline

Definition at line 176 of file itkLevelSetFunction.h.

template<class TImageType>

virtual void* itk::LevelSetFunction< TImageType >::GetGlobalDataPointer ( ) const

inlinevirtual

Returns a pointer to a global data structure that is passed to this object from the solver at each calculation. The idea is that the solver holds the state of any global values needed to calculate the time step, while the equation object performs the actual calculations. The global data should also be initialized in this method. Global data can be used for caching any values used or reused by the FunctionObject. Each thread should receive its own global data struct.

Implements itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 199 of file itkLevelSetFunction.h.

References itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxAdvectionChange, itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxCurvatureChange, and itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxPropagationChange.

template<class TImageType>

ScalarValueType itk::LevelSetFunction< TImageType >::GetLaplacianSmoothingWeight ( ) const

inline

Definition at line 170 of file itkLevelSetFunction.h.

template<class TImageType>

static double itk::LevelSetFunction< TImageType >::GetMaximumCurvatureTimeStep ( )

inlinestatic

Definition at line 266 of file itkLevelSetFunction.h.

template<class TImageType>

static double itk::LevelSetFunction< TImageType >::GetMaximumPropagationTimeStep ( )

inlinestatic

Definition at line 279 of file itkLevelSetFunction.h.

template<class TImageType>

virtual const char* itk::LevelSetFunction< TImageType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

template<class TImageType>

ScalarValueType itk::LevelSetFunction< TImageType >::GetPropagationWeight ( ) const

inline

Definition at line 158 of file itkLevelSetFunction.h.

template<class TImageType>

const RadiusType& itk::FiniteDifferenceFunction< TImageType >::GetRadius ( void ) const

inlineinherited

Returns the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.

Definition at line 145 of file itkFiniteDifferenceFunction.h.

Referenced by otb::NCCRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetNCCRadius().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

template<class TImageType>

bool itk::LevelSetFunction< TImageType >::GetUseMinimalCurvature ( ) const

inline

Definition at line 245 of file itkLevelSetFunction.h.

template<class TImageType >

void itk::LevelSetFunction< TImageType >::Initialize ( const RadiusType & r )

virtual

This method creates the appropriate member variable operators for the level-set calculations. The argument to this function is a the radius necessary for performing the level-set calculations.

Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 277 of file itkLevelSetFunction.txx.

References itk::Neighborhood< TPixel, VDimension, TAllocator >::GetStride(), itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius(), and itk::Neighborhood< TPixel, VDimension, TAllocator >::Size().

template<class TImageType>

virtual void itk::FiniteDifferenceFunction< TImageType >::InitializeIteration ( )

inlinevirtualinherited

This method allows the function to set its state before each iteration of the finite difference solver (image filter) that uses it. This is a thread-safe time to manipulate the object's state.

An example of how this can be used: the Anisotropic diffusion class of FiniteDifferenceFunctions use this method to pre-calculate an average gradient magnitude across the entire image region. This value is set in the function object and used by the ComputeUpdate methods that are called at each pixel as a constant.

Definition at line 117 of file itkFiniteDifferenceFunction.h.

template<class TImageType >

LevelSetFunction< TImageType >::VectorType itk::LevelSetFunction< TImageType >::InitializeZeroVectorConstant ( )

staticprotected

This method's only purpose is to initialize the zero vector constant.

Definition at line 186 of file itkLevelSetFunction.txx.

template<class TImageType>

virtual ScalarValueType itk::LevelSetFunction< TImageType >::LaplacianSmoothingSpeed	(	const NeighborhoodType &	,
		const FloatOffsetType &	,
		GlobalDataStruct *	= `0`
	)		const

inlinevirtual

Laplacian smoothing speed. Can be used to spatially modify the effects of laplacian smoothing of the level set function

Definition at line 144 of file itkLevelSetFunction.h.

template<class TImageType>

static Pointer itk::LevelSetFunction< TImageType >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::LightObject.

template<class TImageType>

void itk::LevelSetFunction< TImageType >::operator= ( const Self & )

private

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

template<class TImageType >

void itk::LevelSetFunction< TImageType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, and itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.

Definition at line 205 of file itkLevelSetFunction.txx.

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

template<class TImageType>

virtual ScalarValueType itk::LevelSetFunction< TImageType >::PropagationSpeed	(	const NeighborhoodType &	,
		const FloatOffsetType &	,
		GlobalDataStruct *	= `0`
	)		const

inlinevirtual

Propagation speed. This term controls surface expansion/contraction. Default implementation returns zero.

Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 130 of file itkLevelSetFunction.h.

void itk::LightObject::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented in itk::ExceptionObject::ReferenceCountedExceptionData, and itk::Object.

Definition at line 160 of file itkLightObject.cxx.

template<class TImageType>

virtual void itk::LevelSetFunction< TImageType >::ReleaseGlobalDataPointer ( void * GlobalData ) const

inlinevirtual

When the finite difference solver filter has finished using a global data pointer, it passes it to this method, which frees the memory. The solver cannot free the memory because it does not know the type to which the pointer points.

Implements itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 217 of file itkLevelSetFunction.h.

template<class TImageType>

virtual void itk::LevelSetFunction< TImageType >::SetAdvectionWeight ( const ScalarValueType a )

inlinevirtual

Alpha. Scales all advection term values.

Definition at line 150 of file itkLevelSetFunction.h.

template<class TImageType>

virtual void itk::LevelSetFunction< TImageType >::SetCurvatureWeight ( const ScalarValueType c )

inlinevirtual

Gamma. Scales all curvature weight values

Definition at line 162 of file itkLevelSetFunction.h.

template<class TImageType>

void itk::LevelSetFunction< TImageType >::SetEpsilonMagnitude ( const ScalarValueType e )

inline

Epsilon.

Definition at line 174 of file itkLevelSetFunction.h.

template<class TImageType>

void itk::LevelSetFunction< TImageType >::SetLaplacianSmoothingWeight ( const ScalarValueType c )

inline

Weight of the laplacian smoothing term

Definition at line 168 of file itkLevelSetFunction.h.

template<class TImageType>

static void itk::LevelSetFunction< TImageType >::SetMaximumCurvatureTimeStep ( double n )

inlinestatic

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 can be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 262 of file itkLevelSetFunction.h.

Referenced by itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMaximumCurvatureTimeStep().

template<class TImageType>

static void itk::LevelSetFunction< TImageType >::SetMaximumPropagationTimeStep ( double n )

inlinestatic

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 can be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 275 of file itkLevelSetFunction.h.

template<class TImageType>

virtual void itk::LevelSetFunction< TImageType >::SetPropagationWeight ( const ScalarValueType p )

inlinevirtual

Beta. Scales all propagation term values.

Definition at line 156 of file itkLevelSetFunction.h.

template<class TImageType>

void itk::FiniteDifferenceFunction< TImageType >::SetRadius ( const RadiusType & r )

inlineinherited

Sets the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.

Definition at line 140 of file itkFiniteDifferenceFunction.h.

Referenced by otb::NCCRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetNCCRadius().

void itk::LightObject::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count on this object. This is a dangerous method, use it with care.

Sets the reference count (use with care)

Reimplemented in itk::Object.

Definition at line 244 of file itkLightObject.cxx.

template<class TImageType>

void itk::FiniteDifferenceFunction< TImageType >::SetScaleCoefficients ( PixelRealType vals[ImageDimension] )

inlineinherited

Set the ScaleCoefficients for the difference operators. The defaults a 1.0. These can be set to take the image spacing into account.

Definition at line 151 of file itkFiniteDifferenceFunction.h.

template<class TImageType>

void itk::LevelSetFunction< TImageType >::SetUseMinimalCurvature ( bool b )

inline

Definition at line 241 of file itkLevelSetFunction.h.

void itk::LightObject::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

Reimplemented in itk::ExceptionObject::ReferenceCountedExceptionData, and itk::Object.

Definition at line 192 of file itkLightObject.cxx.

Referenced by itk::LightObject::New().

template<class TImageType>

void itk::LevelSetFunction< TImageType >::UseMinimalCurvatureOff ( )

inline

Definition at line 253 of file itkLevelSetFunction.h.

template<class TImageType>

void itk::LevelSetFunction< TImageType >::UseMinimalCurvatureOn ( )

inline

Definition at line 249 of file itkLevelSetFunction.h.

Member Data Documentation

template<class TImageType>

const unsigned int itk::LevelSetFunction< TImageType >::ImageDimension = Superclass::ImageDimension

static

Extract some parameters from the superclass.

Reimplemented from itk::FiniteDifferenceFunction< TImageType >.

Definition at line 81 of file itkLevelSetFunction.h.

template<class TImageType>

ScalarValueType itk::LevelSetFunction< TImageType >::m_AdvectionWeight

protected

Alpha.

Definition at line 322 of file itkLevelSetFunction.h.

template<class TImageType>

::vcl_size_t itk::LevelSetFunction< TImageType >::m_Center

protected

The offset of the center pixel in the neighborhood.

Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 304 of file itkLevelSetFunction.h.

template<class TImageType>

ScalarValueType itk::LevelSetFunction< TImageType >::m_CurvatureWeight

protected

Gamma.

Definition at line 328 of file itkLevelSetFunction.h.

template<class TImageType>

double itk::LevelSetFunction< TImageType >::m_DT = 1.0/(2.0 * ImageDimension)

staticprotected

Definition at line 298 of file itkLevelSetFunction.h.

template<class TImageType>

ScalarValueType itk::LevelSetFunction< TImageType >::m_EpsilonMagnitude

protected

Epsilon magnitude controls the lower limit for gradient magnitude.

Definition at line 319 of file itkLevelSetFunction.h.

template<class TImageType>

ScalarValueType itk::LevelSetFunction< TImageType >::m_LaplacianSmoothingWeight

protected

Laplacean smoothing term

Definition at line 331 of file itkLevelSetFunction.h.

template<class TImageType>

ScalarValueType itk::LevelSetFunction< TImageType >::m_PropagationWeight

protected

Beta.

Definition at line 325 of file itkLevelSetFunction.h.

template<class TImageType>

RadiusType itk::FiniteDifferenceFunction< TImageType >::m_Radius

protectedinherited

Definition at line 201 of file itkFiniteDifferenceFunction.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

template<class TImageType>

PixelRealType itk::FiniteDifferenceFunction< TImageType >::m_ScaleCoefficients[ImageDimension]

protectedinherited

Definition at line 202 of file itkFiniteDifferenceFunction.h.

template<class TImageType>

bool itk::LevelSetFunction< TImageType >::m_UseMinimalCurvature

protected

Definition at line 309 of file itkLevelSetFunction.h.

template<class TImageType>

double itk::LevelSetFunction< TImageType >::m_WaveDT = 1.0/(2.0 * ImageDimension)

staticprotected

Constants used in the time step calculation.

Definition at line 297 of file itkLevelSetFunction.h.

template<class TImageType>

::vcl_size_t itk::LevelSetFunction< TImageType >::m_xStride[itkGetStaticConstMacro(ImageDimension)]

protected

Stride length along the y-dimension.

Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 307 of file itkLevelSetFunction.h.

template<class TImageType>

LevelSetFunction< TImageType >::VectorType itk::LevelSetFunction< TImageType >::m_ZeroVectorConstant

staticprotected

Initial value:

LevelSetFunction<TImageType>::InitializeZeroVectorConstant()

Zero vector constant.

Definition at line 316 of file itkLevelSetFunction.h.

template<class TImageType>

std::slice itk::LevelSetFunction< TImageType >::x_slice[itkGetStaticConstMacro(ImageDimension)]

protected

Slices for the ND neighborhood.

Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 301 of file itkLevelSetFunction.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

template<class TImageType> class itk::LevelSetFunction< TImageType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TImageType>
class itk::LevelSetFunction< TImageType >