itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference
[Finite Difference Functions]
This function is used in GeodesicActiveContourLevelSetImageFilter to segment structures in an image based on a user supplied edge potential map. More...
#include <itkGeodesicActiveContourLevelSetFunction.h>
Detailed Description
template<class TImageType, class TFeatureImageType = TImageType>
class itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >
This function is used in GeodesicActiveContourLevelSetImageFilter to segment structures in an image based on a user supplied edge potential map.
- IMPORTANT
- The LevelSetFunction class contain additional information necessary to gain full understanding of how to use this function.
GeodesicActiveContourLevelSetFunction is a subclass of the generic LevelSetFunction. It is used to segment structures in an image based on a user supplied edge potential map 
, which has values close to zero in regions near edges (or high image gradient) and values close to one in regions with relatively constant intensity. Typically, the edge potential map is a function of the gradient, for example:
![\[ g(I) = 1 / ( 1 + | (\nabla * G)(I)| ) \]](form_20.png)
![\[ g(I) = \exp^{-|(\nabla * G)(I)|} \]](form_21.png)
where 
is image intensity and 
is the derivative of Gaussian operator.
The edge potential image is set via the SetFeatureImage() method.
In this function both the propagation term 
and the curvature spatial modifier term 
are taken directly from the edge potential image such that:
![\[ P(\mathbf{x}) = g(\mathbf{x}) \]](form_28.png)
![\[ Z(\mathbf{x}) = g(\mathbf{x}) \]](form_29.png)
An advection term 
is constructed from the negative gradient of the edge potential image.
![\[ \mathbf{A}(\mathbf{x}) = -\nabla g(\mathbf{x}) \]](form_31.png)
This term behaves like a doublet attracting the contour to the edges.
This implementation is based on: "Geodesic Active Contours", V. Caselles, R. Kimmel and G. Sapiro. International Journal on Computer Vision, Vol 22, No. 1, pp 61-97, 1997
- See also:
- LevelSetFunction
- SegmentationLevelSetImageFunction
- GeodesicActiveContourLevelSetImageFilter
Definition at line 75 of file itkGeodesicActiveContourLevelSetFunction.h.
Member Typedef Documentation
| typedef SmartPointer<const Self> itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer |
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 84 of file itkGeodesicActiveContourLevelSetFunction.h.
typedef InterpolatorType::ContinuousIndexType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::ContinuousIndexType [inherited] |
Continuous index type recognized by the interpolator
Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 85 of file itkSegmentationLevelSetFunction.h.
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 92 of file itkFiniteDifferenceFunction.h.
| typedef TFeatureImageType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::FeatureImageType |
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 85 of file itkGeodesicActiveContourLevelSetFunction.h.
| typedef Superclass::FeatureScalarType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::FeatureScalarType |
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 97 of file itkGeodesicActiveContourLevelSetFunction.h.
| typedef Superclass::FloatOffsetType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::FloatOffsetType |
A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 99 of file itkGeodesicActiveContourLevelSetFunction.h.
| typedef Superclass::GlobalDataStruct itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GlobalDataStruct |
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 101 of file itkGeodesicActiveContourLevelSetFunction.h.
| typedef Superclass::ImageType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::ImageType |
Extract some parameters from the superclass.
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 91 of file itkGeodesicActiveContourLevelSetFunction.h.
typedef ImageType::IndexType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::IndexType [inherited] |
Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 67 of file itkSegmentationLevelSetFunction.h.
typedef int itk::LightObject::InternalReferenceCountType [protected, inherited] |
Define the type of the reference count according to the target. This allows the use of atomic operations
Definition at line 139 of file itkLightObject.h.
typedef LinearInterpolateImageFunction<ImageType> itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::InterpolatorType [inherited] |
Define a scalar interpolator
Definition at line 79 of file itkSegmentationLevelSetFunction.h.
typedef Superclass::NeighborhoodScalesType itk::LevelSetFunction< TImageType >::NeighborhoodScalesType [inherited] |
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.
| typedef Superclass::NeighborhoodType itk::GeodesicActiveContourLevelSetFunction< 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::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 95 of file itkGeodesicActiveContourLevelSetFunction.h.
typedef Superclass::PixelRealType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::PixelRealType [inherited] |
Reimplemented from itk::LevelSetFunction< TImageType >.
Definition at line 61 of file itkSegmentationLevelSetFunction.h.
typedef Superclass::PixelType itk::LevelSetFunction< TImageType >::PixelType [inherited] |
Reimplemented from itk::FiniteDifferenceFunction< TImageType >.
Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 86 of file itkLevelSetFunction.h.
| typedef SmartPointer<Self> itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Pointer |
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 83 of file itkGeodesicActiveContourLevelSetFunction.h.
| typedef Superclass::RadiusType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::RadiusType |
Neighborhood radius type
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 98 of file itkGeodesicActiveContourLevelSetFunction.h.
| typedef Superclass::ScalarValueType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::ScalarValueType |
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 96 of file itkGeodesicActiveContourLevelSetFunction.h.
| typedef GeodesicActiveContourLevelSetFunction itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Self |
Standard class typedefs.
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 80 of file itkGeodesicActiveContourLevelSetFunction.h.
| typedef SegmentationLevelSetFunction<TImageType, TFeatureImageType> itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Superclass |
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 82 of file itkGeodesicActiveContourLevelSetFunction.h.
typedef double itk::LevelSetFunction< TImageType >::TimeStepType [inherited] |
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.
| typedef Superclass::VectorImageType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::VectorImageType |
Define an image type for the advection field.
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 100 of file itkGeodesicActiveContourLevelSetFunction.h.
typedef VectorLinearInterpolateImageFunction<VectorImageType> itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorInterpolatorType [inherited] |
Define a vector interpolator
Definition at line 82 of file itkSegmentationLevelSetFunction.h.
typedef Superclass::VectorType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorType [inherited] |
The vector type that will be used in the calculations.
Reimplemented from itk::LevelSetFunction< TImageType >.
Definition at line 68 of file itkSegmentationLevelSetFunction.h.
Constructor & Destructor Documentation
| itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GeodesicActiveContourLevelSetFunction | ( | ) | [inline, protected] |
Definition at line 138 of file itkGeodesicActiveContourLevelSetFunction.h.
| virtual itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::~GeodesicActiveContourLevelSetFunction | ( | ) | [inline, protected, virtual] |
Definition at line 146 of file itkGeodesicActiveContourLevelSetFunction.h.
| itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GeodesicActiveContourLevelSetFunction | ( | const Self & | ) | [protected] |
Member Function Documentation
| virtual VectorType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::AdvectionField | ( | const NeighborhoodType & | , | |
| const FloatOffsetType & | , | |||
| GlobalDataStruct * | gd | |||
| ) | const [protected, virtual, inherited] |
Advection field. Returns a vector from the computed advectionfield.
Reimplemented from itk::LevelSetFunction< TImageType >.
| virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::AllocateAdvectionImage | ( | ) | [virtual, inherited] |
Allocates the image that will be used for the level set function's Advection field term. See LevelSetFunction for more information.
| virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::AllocateSpeedImage | ( | ) | [virtual, inherited] |
Allocates the image that will be used for the level set function's Propagation Speed term. See LevelSetFunction for more information.
| static void itk::LightObject::BreakOnError | ( | ) | [static, inherited] |
This method is called when itkExceptionMacro executes. It allows the debugger to break on error.
| virtual void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::CalculateAdvectionImage | ( | ) | [virtual] |
Compute the advection field from feature image.
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
| virtual void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage | ( | ) | [virtual] |
Compute speed image from feature image.
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
| virtual ScalarValueType itk::LevelSetFunction< TImageType >::Compute3DMinimalCurvature | ( | const NeighborhoodType & | , | |
| const FloatOffsetType & | , | |||
| GlobalDataStruct * | gd = 0 | |||
| ) | [virtual, inherited] |
| virtual ScalarValueType itk::LevelSetFunction< TImageType >::ComputeCurvatureTerm | ( | const NeighborhoodType & | , | |
| const FloatOffsetType & | , | |||
| GlobalDataStruct * | gd = 0 | |||
| ) | [virtual, inherited] |
| virtual TimeStepType itk::LevelSetFunction< TImageType >::ComputeGlobalTimeStep | ( | void * | GlobalData | ) | const [virtual, inherited] |
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 >.
| virtual ScalarValueType itk::LevelSetFunction< TImageType >::ComputeMeanCurvature | ( | const NeighborhoodType & | , | |
| const FloatOffsetType & | , | |||
| GlobalDataStruct * | gd = 0 | |||
| ) | [virtual, inherited] |
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.
| virtual ScalarValueType itk::LevelSetFunction< TImageType >::ComputeMinimalCurvature | ( | const NeighborhoodType & | , | |
| const FloatOffsetType & | , | |||
| GlobalDataStruct * | gd = 0 | |||
| ) | [virtual, inherited] |
| const 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
| virtual PixelType itk::LevelSetFunction< TImageType >::ComputeUpdate | ( | const NeighborhoodType & | neighborhood, | |
| void * | globalData, | |||
| const FloatOffsetType & | = FloatOffsetType(0.0) | |||
| ) | [virtual, inherited] |
Compute the equation value.
Implements itk::FiniteDifferenceFunction< TImageType >.
Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.
| virtual Pointer itk::LightObject::CreateAnother | ( | ) | const [virtual, inherited] |
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 in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, itk::CreateObjectFunction< T >, itk::MetaDataObject< MetaDataObjectType >, itk::Object, itk::TransformFactoryBase, itk::AnalyzeImageIOFactory, itk::BioRadImageIOFactory, itk::BMPImageIOFactory, itk::Brains2MaskImageIOFactory, itk::DICOMImageIO2Factory, itk::DicomImageIOFactory, itk::GDCMImageIOFactory, itk::GE4ImageIOFactory, itk::GE5ImageIOFactory, itk::GEAdwImageIOFactory, itk::GiplImageIOFactory, itk::JPEGImageIOFactory, itk::LSMImageIOFactory, itk::MetaImageIOFactory, itk::NiftiImageIOFactory, itk::NrrdImageIOFactory, itk::PNGImageIOFactory, itk::RawImageIOFactory< TPixel, VImageDimension >, itk::SiemensVisionImageIOFactory, itk::StimulateImageIOFactory, itk::TIFFImageIOFactory, itk::VTKImageIOFactory, itk::Bruker2DSEQImageIOFactory, itk::MatlabTransformIOFactory, itk::MINC2ImageIOFactory, itk::PhilipsRECImageIOFactory, itk::TxtTransformIOFactory, itk::VoxBoCUBImageIOFactory, and itk::SpatialObjectFactoryBase.
| virtual ScalarValueType itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::CurvatureSpeed | ( | const NeighborhoodType & | neighborhood, | |
| const FloatOffsetType & | offset, | |||
| GlobalDataStruct * | gd | |||
| ) | const [inline, virtual] |
The curvature speed is same as the propagation speed.
Reimplemented from itk::LevelSetFunction< TImageType >.
Definition at line 114 of file itkGeodesicActiveContourLevelSetFunction.h.
| virtual void itk::LightObject::Delete | ( | ) | [virtual, inherited] |
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.
| virtual VectorImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetAdvectionImage | ( | ) | const [inline, virtual, inherited] |
Get/Set the image used as the advection field in the level set equation
Definition at line 101 of file itkSegmentationLevelSetFunction.h.
| ScalarValueType itk::LevelSetFunction< TImageType >::GetAdvectionWeight | ( | ) | const [inline, inherited] |
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 152 of file itkLevelSetFunction.h.
| ScalarValueType itk::LevelSetFunction< TImageType >::GetCurvatureWeight | ( | ) | const [inline, inherited] |
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 166 of file itkLevelSetFunction.h.
| double itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GetDerivativeSigma | ( | ) | [inline] |
Set/Get the sigma for the Gaussian kernel used to compute the gradient of the feature image needed for the advection term of the equation.
Definition at line 124 of file itkGeodesicActiveContourLevelSetFunction.h.
| ScalarValueType itk::LevelSetFunction< TImageType >::GetEpsilonMagnitude | ( | ) | const [inline, inherited] |
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 180 of file itkLevelSetFunction.h.
| virtual const FeatureImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetFeatureImage | ( | ) | const [inline, virtual, inherited] |
Set/Get the image which will be used to calculate the speed function.
Definition at line 88 of file itkSegmentationLevelSetFunction.h.
| virtual void* itk::LevelSetFunction< TImageType >::GetGlobalDataPointer | ( | ) | const [inline, virtual, inherited] |
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 204 of file itkLevelSetFunction.h.
References itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxAdvectionChange, itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxCurvatureChange, and itk::LevelSetFunction< TImageType >::GlobalDataStruct::m_MaxPropagationChange.
| ScalarValueType itk::LevelSetFunction< TImageType >::GetLaplacianSmoothingWeight | ( | ) | const [inline, inherited] |
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 173 of file itkLevelSetFunction.h.
| static double itk::LevelSetFunction< TImageType >::GetMaximumCurvatureTimeStep | ( | ) | [inline, static, inherited] |
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 274 of file itkLevelSetFunction.h.
| static double itk::LevelSetFunction< TImageType >::GetMaximumPropagationTimeStep | ( | ) | [inline, static, inherited] |
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 288 of file itkLevelSetFunction.h.
| virtual const char* itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods)
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
| ScalarValueType itk::LevelSetFunction< TImageType >::GetPropagationWeight | ( | ) | const [inline, inherited] |
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 159 of file itkLevelSetFunction.h.
| const RadiusType& itk::FiniteDifferenceFunction< TImageType >::GetRadius | ( | void | ) | const [inline, inherited] |
Returns the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.
Definition at line 146 of file itkFiniteDifferenceFunction.h.
| virtual int itk::LightObject::GetReferenceCount | ( | ) | const [inline, virtual, inherited] |
Gets the reference count on this object.
Definition at line 106 of file itkLightObject.h.
| virtual ImageType* itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSpeedImage | ( | ) | [inline, virtual, inherited] |
Get/Set the image used as the speed function in the level set equation
Definition at line 95 of file itkSegmentationLevelSetFunction.h.
| bool itk::LevelSetFunction< TImageType >::GetUseMinimalCurvature | ( | ) | const [inline, inherited] |
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 252 of file itkLevelSetFunction.h.
| virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::Initialize | ( | const RadiusType & | r | ) | [virtual, inherited] |
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 from itk::LevelSetFunction< TImageType >.
Referenced by itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSegmentationFunction().
| virtual void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::Initialize | ( | const RadiusType & | r | ) | [inline, virtual] |
Definition at line 128 of file itkGeodesicActiveContourLevelSetFunction.h.
| virtual void itk::FiniteDifferenceFunction< TImageType >::InitializeIteration | ( | ) | [inline, virtual, inherited] |
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.
Reimplemented in itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::FastSymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::MeanSquareRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::MIRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >, itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, itk::GradientNDAnisotropicDiffusionFunction< TImage >, itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >, itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >, and itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >.
Definition at line 118 of file itkFiniteDifferenceFunction.h.
| static VectorType itk::LevelSetFunction< TImageType >::InitializeZeroVectorConstant | ( | ) | [static, protected, inherited] |
This method's only purpose is to initialize the zero vector constant.
| virtual ScalarValueType itk::LevelSetFunction< TImageType >::LaplacianSmoothingSpeed | ( | const NeighborhoodType & | , | |
| const FloatOffsetType & | , | |||
| GlobalDataStruct * | = 0 | |||
| ) | const [inline, virtual, inherited] |
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.
| static Pointer itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::LevelSetFunction< TImageType >.
| void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::operator= | ( | const Self & | ) | [protected] |
Reimplemented from itk::FiniteDifferenceFunction< TImageType >.
| void itk::LightObject::Print | ( | std::ostream & | os, | |
| Indent | indent = 0 | |||
| ) | const [inherited] |
Cause the object to print itself out.
Referenced by itk::WeakPointer< ProcessObject >::Print().
| virtual void itk::LightObject::PrintHeader | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
Define the type of the reference count according to the target. This allows the use of atomic operations
| void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::PrintSelf | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [inline, 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::LevelSetFunction< TImageType >.
Definition at line 151 of file itkGeodesicActiveContourLevelSetFunction.h.
References HardConnectedComponentImageFilter::PrintSelf().
| virtual void itk::LightObject::PrintTrailer | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
Define the type of the reference count according to the target. This allows the use of atomic operations
| virtual ScalarValueType itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::PropagationSpeed | ( | const NeighborhoodType & | , | |
| const FloatOffsetType & | , | |||
| GlobalDataStruct * | gd | |||
| ) | const [protected, virtual, inherited] |
Returns the propagation speed from the precalculated speed image.
Reimplemented from itk::LevelSetFunction< TImageType >.
| virtual void itk::LightObject::Register | ( | ) | const [virtual, inherited] |
Increase the reference count (mark as used by another object).
Reimplemented in itk::Object.
| virtual void itk::LevelSetFunction< TImageType >::ReleaseGlobalDataPointer | ( | void * | GlobalData | ) | const [inline, virtual, inherited] |
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 223 of file itkLevelSetFunction.h.
| virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::ReverseExpansionDirection | ( | ) | [virtual, inherited] |
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.
| void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetAdvectionImage | ( | VectorImageType * | s | ) | [inherited] |
Get/Set the image used as the advection field in the level set equation
| virtual void itk::LevelSetFunction< TImageType >::SetAdvectionWeight | ( | const ScalarValueType | a | ) | [inline, virtual, inherited] |
Alpha. Scales all advection term values.
Definition at line 150 of file itkLevelSetFunction.h.
| virtual void itk::LevelSetFunction< TImageType >::SetCurvatureWeight | ( | const ScalarValueType | c | ) | [inline, virtual, inherited] |
Gamma. Scales all curvature weight values
Definition at line 164 of file itkLevelSetFunction.h.
| void itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::SetDerivativeSigma | ( | const double | v | ) | [inline] |
Set/Get the sigma for the Gaussian kernel used to compute the gradient of the feature image needed for the advection term of the equation.
Definition at line 122 of file itkGeodesicActiveContourLevelSetFunction.h.
| void itk::LevelSetFunction< TImageType >::SetEpsilonMagnitude | ( | const ScalarValueType | e | ) | [inline, inherited] |
Epsilon.
Definition at line 178 of file itkLevelSetFunction.h.
| virtual void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetFeatureImage | ( | const FeatureImageType * | f | ) | [inline, virtual, inherited] |
Get/Set the image used as the advection field in the level set equation
Definition at line 90 of file itkSegmentationLevelSetFunction.h.
| void itk::LevelSetFunction< TImageType >::SetLaplacianSmoothingWeight | ( | const ScalarValueType | c | ) | [inline, inherited] |
Weight of the laplacian smoothing term
Definition at line 171 of file itkLevelSetFunction.h.
| static void itk::LevelSetFunction< TImageType >::SetMaximumCurvatureTimeStep | ( | double | n | ) | [inline, static, inherited] |
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 270 of file itkLevelSetFunction.h.
| static void itk::LevelSetFunction< TImageType >::SetMaximumPropagationTimeStep | ( | double | n | ) | [inline, static, inherited] |
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 284 of file itkLevelSetFunction.h.
| virtual void itk::LevelSetFunction< TImageType >::SetPropagationWeight | ( | const ScalarValueType | p | ) | [inline, virtual, inherited] |
Beta. Scales all propagation term values.
Definition at line 157 of file itkLevelSetFunction.h.
| void itk::FiniteDifferenceFunction< TImageType >::SetRadius | ( | const RadiusType & | r | ) | [inline, inherited] |
Sets the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.
Definition at line 141 of file itkFiniteDifferenceFunction.h.
| virtual void itk::LightObject::SetReferenceCount | ( | int | ) | [virtual, inherited] |
Sets the reference count on this object. This is a dangerous method, use it with care.
Reimplemented in itk::Object.
| void itk::FiniteDifferenceFunction< TImageType >::SetScaleCoefficients | ( | PixelRealType | vals[ImageDimension] | ) | [inline, inherited] |
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 152 of file itkFiniteDifferenceFunction.h.
| void itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetSpeedImage | ( | ImageType * | s | ) | [inherited] |
Get/Set the image used as the advection field in the level set equation
| void itk::LevelSetFunction< TImageType >::SetUseMinimalCurvature | ( | bool | b | ) | [inline, inherited] |
Definition at line 248 of file itkLevelSetFunction.h.
| virtual void itk::LightObject::UnRegister | ( | ) | const [virtual, inherited] |
Decrease the reference count (release by another object).
Reimplemented in itk::Object.
| void itk::LevelSetFunction< TImageType >::UseMinimalCurvatureOff | ( | ) | [inline, inherited] |
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 260 of file itkLevelSetFunction.h.
| void itk::LevelSetFunction< TImageType >::UseMinimalCurvatureOn | ( | ) | [inline, inherited] |
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 256 of file itkLevelSetFunction.h.
Member Data Documentation
const unsigned int itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >::ImageDimension = Superclass::ImageDimension [static] |
Extract some parameters from the superclass.
Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.
Definition at line 105 of file itkGeodesicActiveContourLevelSetFunction.h.
VectorImageType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_AdvectionImage [protected, inherited] |
The image holding the advection field for front propation
Definition at line 152 of file itkSegmentationLevelSetFunction.h.
ScalarValueType itk::LevelSetFunction< TImageType >::m_AdvectionWeight [protected, inherited] |
Alpha.
Definition at line 332 of file itkLevelSetFunction.h.
:: vcl_size_t itk::LevelSetFunction< TImageType >::m_Center [protected, inherited] |
The offset of the center pixel in the neighborhood.
Definition at line 314 of file itkLevelSetFunction.h.
ScalarValueType itk::LevelSetFunction< TImageType >::m_CurvatureWeight [protected, inherited] |
Gamma.
Definition at line 338 of file itkLevelSetFunction.h.
double itk::LevelSetFunction< TImageType >::m_DT [static, protected, inherited] |
Definition at line 308 of file itkLevelSetFunction.h.
ScalarValueType itk::LevelSetFunction< TImageType >::m_EpsilonMagnitude [protected, inherited] |
Epsilon magnitude controls the lower limit for gradient magnitude.
Definition at line 329 of file itkLevelSetFunction.h.
FeatureImageType::ConstPointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_FeatureImage [protected, inherited] |
The image whose features will be used to create a speed image
Definition at line 146 of file itkSegmentationLevelSetFunction.h.
InterpolatorType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Interpolator [protected, inherited] |
Definition at line 176 of file itkSegmentationLevelSetFunction.h.
ScalarValueType itk::LevelSetFunction< TImageType >::m_LaplacianSmoothingWeight [protected, inherited] |
Laplacean smoothing term
Definition at line 341 of file itkLevelSetFunction.h.
ScalarValueType itk::LevelSetFunction< TImageType >::m_PropagationWeight [protected, inherited] |
Beta.
Definition at line 335 of file itkLevelSetFunction.h.
RadiusType itk::FiniteDifferenceFunction< TImageType >::m_Radius [protected, inherited] |
Definition at line 203 of file itkFiniteDifferenceFunction.h.
InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited] |
Number of uses of this object by other objects.
Definition at line 144 of file itkLightObject.h.
SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited] |
Mutex lock to protect modification to the reference count
Definition at line 147 of file itkLightObject.h.
PixelRealType itk::FiniteDifferenceFunction< TImageType >::m_ScaleCoefficients[ImageDimension] [protected, inherited] |
Definition at line 204 of file itkFiniteDifferenceFunction.h.
ImageType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_SpeedImage [protected, inherited] |
The image holding the speed values for front propagation
Definition at line 149 of file itkSegmentationLevelSetFunction.h.
bool itk::LevelSetFunction< TImageType >::m_UseMinimalCurvature [protected, inherited] |
Definition at line 319 of file itkLevelSetFunction.h.
Functor::VectorCast< typename VectorInterpolatorType::OutputType, VectorType > itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_VectorCast [protected, inherited] |
A casting functor to convert between vector types.
Definition at line 156 of file itkSegmentationLevelSetFunction.h.
VectorInterpolatorType::Pointer itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_VectorInterpolator [protected, inherited] |
Definition at line 177 of file itkSegmentationLevelSetFunction.h.
double itk::LevelSetFunction< TImageType >::m_WaveDT [static, protected, inherited] |
Constants used in the time step calculation.
Definition at line 307 of file itkLevelSetFunction.h.
:: vcl_size_t itk::LevelSetFunction< TImageType >::m_xStride[itkGetStaticConstMacro(ImageDimension)] [protected, inherited] |
Stride length along the y-dimension.
Definition at line 317 of file itkLevelSetFunction.h.
VectorType itk::LevelSetFunction< TImageType >::m_ZeroVectorConstant [static, protected, inherited] |
Zero vector constant.
Definition at line 326 of file itkLevelSetFunction.h.
std::slice itk::LevelSetFunction< TImageType >::x_slice[itkGetStaticConstMacro(ImageDimension)] [protected, inherited] |
Slices for the ND neighborhood.
Definition at line 311 of file itkLevelSetFunction.h.
The documentation for this class was generated from the following file:
