ITK
4.4.0
Insight Segmentation and Registration Toolkit
|
#include <itkLevelSetFunction.h>
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].
where is an advection term, is a propagation (growth) term, and is a spatial modifier term for the mean curvature . , , and 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.
Definition at line 66 of file itkLevelSetFunction.h.
Classes | |
struct | GlobalDataStruct |
Static Public Member Functions | |
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 |
Static Public Attributes inherited from itk::FiniteDifferenceFunction< TImageType > | |
static const unsigned int | ImageDimension = ImageType::ImageDimension |
Protected Member Functions | |
LevelSetFunction () | |
void | PrintSelf (std::ostream &s, Indent indent) const |
virtual | ~LevelSetFunction () |
Protected Member Functions inherited from itk::FiniteDifferenceFunction< TImageType > | |
FiniteDifferenceFunction () | |
~FiniteDifferenceFunction () | |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Static Protected Member Functions | |
static VectorType | InitializeZeroVectorConstant () |
Protected Attributes | |
ScalarValueType | m_AdvectionWeight |
OffsetValueType | m_Center |
ScalarValueType | m_CurvatureWeight |
ScalarValueType | m_EpsilonMagnitude |
ScalarValueType | m_LaplacianSmoothingWeight |
ScalarValueType | m_PropagationWeight |
bool | m_UseMinimalCurvature |
OffsetValueType | m_xStride [itkGetStaticConstMacro(ImageDimension)] |
std::slice | x_slice [itkGetStaticConstMacro(ImageDimension)] |
Protected Attributes inherited from itk::FiniteDifferenceFunction< TImageType > | |
RadiusType | m_Radius |
PixelRealType | m_ScaleCoefficients [ImageDimension] |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
Static Protected Attributes | |
static double | m_DT |
static double | m_WaveDT |
static VectorType | m_ZeroVectorConstant |
Private Member Functions | |
LevelSetFunction (const Self &) | |
void | operator= (const Self &) |
Additional Inherited Members | |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
typedef SmartPointer< const Self > itk::LevelSetFunction< TImageType >::ConstPointer |
Definition at line 74 of file itkLevelSetFunction.h.
typedef Superclass::FloatOffsetType itk::LevelSetFunction< TImageType >::FloatOffsetType |
Definition at line 94 of file itkLevelSetFunction.h.
typedef Superclass::ImageType itk::LevelSetFunction< TImageType >::ImageType |
Definition at line 87 of file itkLevelSetFunction.h.
typedef Superclass::NeighborhoodScalesType itk::LevelSetFunction< TImageType >::NeighborhoodScalesType |
Definition at line 93 of file itkLevelSetFunction.h.
typedef Superclass::NeighborhoodType itk::LevelSetFunction< TImageType >::NeighborhoodType |
Definition at line 92 of file itkLevelSetFunction.h.
typedef Superclass::PixelRealType itk::LevelSetFunction< TImageType >::PixelRealType |
Definition at line 90 of file itkLevelSetFunction.h.
typedef Superclass::PixelType itk::LevelSetFunction< TImageType >::PixelType |
Definition at line 88 of file itkLevelSetFunction.h.
typedef SmartPointer< Self > itk::LevelSetFunction< TImageType >::Pointer |
Definition at line 73 of file itkLevelSetFunction.h.
typedef Superclass::RadiusType itk::LevelSetFunction< TImageType >::RadiusType |
Definition at line 91 of file itkLevelSetFunction.h.
typedef PixelType itk::LevelSetFunction< TImageType >::ScalarValueType |
Definition at line 89 of file itkLevelSetFunction.h.
typedef LevelSetFunction itk::LevelSetFunction< TImageType >::Self |
Standard class typedefs.
Definition at line 71 of file itkLevelSetFunction.h.
typedef FiniteDifferenceFunction< TImageType > itk::LevelSetFunction< TImageType >::Superclass |
Definition at line 72 of file itkLevelSetFunction.h.
typedef double itk::LevelSetFunction< TImageType >::TimeStepType |
Convenient typedefs.
Definition at line 86 of file itkLevelSetFunction.h.
typedef FixedArray< ScalarValueType, itkGetStaticConstMacro(ImageDimension) > itk::LevelSetFunction< TImageType >::VectorType |
The vector type that will be used in the calculations.
Definition at line 98 of file itkLevelSetFunction.h.
|
inlineprotected |
Definition at line 298 of file itkLevelSetFunction.h.
|
inlineprotectedvirtual |
Definition at line 307 of file itkLevelSetFunction.h.
|
private |
|
inlinevirtual |
Advection field. Default implementation returns a vector of zeros.
Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 125 of file itkLevelSetFunction.h.
|
virtual |
|
virtual |
|
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::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, and itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.
|
virtual |
|
virtual |
|
virtual |
Compute the equation value.
Implements itk::FiniteDifferenceFunction< TImageType >.
Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.
|
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.
Reimplemented in itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.
|
inlinevirtual |
Curvature speed. Can be used to spatially modify the effects of curvature . The default implementation returns one.
Reimplemented in itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, and itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 138 of file itkLevelSetFunction.h.
|
inline |
Alpha. Scales all advection term values.
Definition at line 153 of file itkLevelSetFunction.h.
|
inline |
Gamma. Scales all curvature weight values
Definition at line 167 of file itkLevelSetFunction.h.
|
inline |
Epsilon.
Definition at line 181 of file itkLevelSetFunction.h.
|
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 205 of file itkLevelSetFunction.h.
References itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxAdvectionChange, itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxCurvatureChange, and itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxPropagationChange.
|
inline |
Weight of the laplacian smoothing term
Definition at line 174 of file itkLevelSetFunction.h.
|
inlinestatic |
Definition at line 278 of file itkLevelSetFunction.h.
|
inlinestatic |
Definition at line 292 of file itkLevelSetFunction.h.
|
virtual |
Run-time type information (and related methods)
Reimplemented from itk::FiniteDifferenceFunction< TImageType >.
Reimplemented in itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >.
|
inline |
Beta. Scales all propagation term values.
Definition at line 160 of file itkLevelSetFunction.h.
|
inline |
Definition at line 254 of file itkLevelSetFunction.h.
|
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::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >.
|
staticprotected |
This method's only purpose is to initialize the zero vector constant.
|
inlinevirtual |
Laplacian smoothing speed. Can be used to spatially modify the effects of laplacian smoothing of the level set function
Definition at line 145 of file itkLevelSetFunction.h.
|
static |
Method for creation through the object factory.
|
private |
|
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.
Reimplemented from itk::FiniteDifferenceFunction< TImageType >.
Reimplemented in itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.
|
inlinevirtual |
Propagation speed. This term controls surface expansion/contraction. Default implementation returns zero.
Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 131 of file itkLevelSetFunction.h.
|
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 224 of file itkLevelSetFunction.h.
|
inlinevirtual |
Alpha. Scales all advection term values.
Definition at line 151 of file itkLevelSetFunction.h.
|
inlinevirtual |
Gamma. Scales all curvature weight values
Definition at line 165 of file itkLevelSetFunction.h.
|
inline |
|
inline |
Weight of the laplacian smoothing term
Definition at line 172 of file itkLevelSetFunction.h.
|
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 273 of file itkLevelSetFunction.h.
Referenced by itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMaximumCurvatureTimeStep().
|
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 287 of file itkLevelSetFunction.h.
|
inlinevirtual |
Beta. Scales all propagation term values.
Definition at line 158 of file itkLevelSetFunction.h.
|
inline |
Definition at line 249 of file itkLevelSetFunction.h.
|
inline |
Definition at line 264 of file itkLevelSetFunction.h.
|
inline |
Definition at line 259 of file itkLevelSetFunction.h.
|
static |
Extract some parameters from the superclass.
Definition at line 83 of file itkLevelSetFunction.h.
|
protected |
Alpha.
Definition at line 336 of file itkLevelSetFunction.h.
|
protected |
The offset of the center pixel in the neighborhood.
Definition at line 318 of file itkLevelSetFunction.h.
|
protected |
Gamma.
Definition at line 342 of file itkLevelSetFunction.h.
|
staticprotected |
Definition at line 312 of file itkLevelSetFunction.h.
|
protected |
Epsilon magnitude controls the lower limit for gradient magnitude.
Definition at line 333 of file itkLevelSetFunction.h.
|
protected |
Laplacean smoothing term
Definition at line 345 of file itkLevelSetFunction.h.
|
protected |
Beta.
Definition at line 339 of file itkLevelSetFunction.h.
|
protected |
Definition at line 323 of file itkLevelSetFunction.h.
|
staticprotected |
Constants used in the time step calculation.
Definition at line 311 of file itkLevelSetFunction.h.
|
protected |
Stride length along the y-dimension.
Definition at line 321 of file itkLevelSetFunction.h.
|
staticprotected |
Zero vector constant.
Definition at line 330 of file itkLevelSetFunction.h.
|
protected |
Slices for the ND neighborhood.
Definition at line 315 of file itkLevelSetFunction.h.