ITK
6.0.0
Insight Toolkit
|
#include <itkFiniteDifferenceFunction.h>
This class is a component object of the finite difference solver hierarchy (see FiniteDifferenceImageFilter). It defines a generic interface for a function object that computes a single scalar value from a neighborhood of values. Examples of the application of this class are the various flavors of AnisotropicDiffusionFunction and LevelSetFunction objects.
These functions calculate the incremental change at a pixel in the solution image from one iteration of the Partial Differential Equation (PDE) solver to the next.
Definition at line 66 of file itkFiniteDifferenceFunction.h.
Public Types | |
using | ConstPointer = SmartPointer< const Self > |
using | DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< ImageType > |
using | FloatOffsetType = Vector< float, Self::ImageDimension > |
using | ImageType = TImageType |
using | NeighborhoodScalesType = Vector< PixelRealType, Self::ImageDimension > |
using | NeighborhoodType = ConstNeighborhoodIterator< TImageType, DefaultBoundaryConditionType > |
using | PixelRealType = double |
using | PixelType = typename ImageType::PixelType |
using | Pointer = SmartPointer< Self > |
using | RadiusType = typename ConstNeighborhoodIterator< TImageType >::RadiusType |
using | Self = FiniteDifferenceFunction |
using | Superclass = LightObject |
using | TimeStepType = double |
Public Types inherited from itk::LightObject | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = LightObject |
Public Member Functions | |
virtual TimeStepType | ComputeGlobalTimeStep (void *GlobalData) const =0 |
const NeighborhoodScalesType | ComputeNeighborhoodScales () const |
virtual PixelType | ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))=0 |
virtual void * | GetGlobalDataPointer () const =0 |
const char * | GetNameOfClass () const override |
const RadiusType & | GetRadius () const |
void | GetScaleCoefficients (PixelRealType vals[ImageDimension]) const |
virtual void | InitializeIteration () |
virtual void | ReleaseGlobalDataPointer (void *GlobalData) const =0 |
void | SetRadius (const RadiusType &r) |
void | SetScaleCoefficients (const PixelRealType vals[ImageDimension]) |
Public Member Functions inherited from itk::LightObject | |
Pointer | Clone () const |
virtual Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
Static Public Attributes | |
static constexpr unsigned int | ImageDimension = ImageType::ImageDimension |
Protected Member Functions | |
FiniteDifferenceFunction () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~FiniteDifferenceFunction () override=default | |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Protected Attributes | |
RadiusType | m_Radius {} |
PixelRealType | m_ScaleCoefficients [ImageDimension] {} |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
using itk::FiniteDifferenceFunction< TImageType >::ConstPointer = SmartPointer<const Self> |
Definition at line 76 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition<ImageType> |
The default boundary condition for finite difference functions that is used unless overridden in the Evaluate() method.
Definition at line 94 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::FloatOffsetType = Vector<float, Self::ImageDimension> |
A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.
Definition at line 109 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::ImageType = TImageType |
Extract some parameters from the image type
Definition at line 82 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::NeighborhoodScalesType = Vector<PixelRealType, Self::ImageDimension> |
The type of data structure that holds the scales with which the neighborhood is weighted to properly account for spacing and neighborhood radius.
Definition at line 105 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::NeighborhoodType = ConstNeighborhoodIterator<TImageType, DefaultBoundaryConditionType> |
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.
Definition at line 101 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::PixelRealType = double |
Definition at line 84 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::PixelType = typename ImageType::PixelType |
Definition at line 83 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::Pointer = SmartPointer<Self> |
Definition at line 75 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::RadiusType = typename ConstNeighborhoodIterator<TImageType>::RadiusType |
Neighborhood radius type
Definition at line 97 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::Self = FiniteDifferenceFunction |
Standard class type aliases.
Definition at line 73 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::Superclass = LightObject |
Definition at line 74 of file itkFiniteDifferenceFunction.h.
using itk::FiniteDifferenceFunction< TImageType >::TimeStepType = double |
Define the TimeStepType to always be double.
Definition at line 90 of file itkFiniteDifferenceFunction.h.
|
protected |
|
overrideprotecteddefault |
|
pure 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.
Implemented in itk::AnisotropicDiffusionFunction< TImage >, itk::GPUAnisotropicDiffusionFunction< TImage >, itk::MeanSquareRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::FastSymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::NormalVectorFunctionBase< TSparseImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TImageType >, itk::CurvatureFlowFunction< TImage >, itk::RegionBasedLevelSetFunction< TInput, TFeature, TSharedData >, itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >, itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetFunction< TImageType >, and itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >.
const NeighborhoodScalesType itk::FiniteDifferenceFunction< TImageType >::ComputeNeighborhoodScales | ( | ) | const |
Compute the scales that weight the neighborhood during difference operations to properly account for spacing and neighborhood radius
|
pure virtual |
This method is called by a finite difference solver image filter at each pixel that does not lie on a data set boundary. The width of the data set boundary is defined by the width of the neighborhood being evaluated.
The neighborhood argument is the neighborhood data. The globalData argument is a pointer to a data structure that holds values that need to be persistent across calls to this function, but cannot be stored in the function object itself for thread-safety reasons. Examples are values needed to compute the time-step for an iteration of the solver.
Implemented in itk::FiniteDifferenceSparseImageFunction< TSparseImageType >, itk::GPUFiniteDifferenceFunction< TImageType >, itk::GPUFiniteDifferenceFunction< TImage >, itk::GPUFiniteDifferenceFunction< TDisplacementField >, itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetFunction< TImageType >, itk::CurvatureNDAnisotropicDiffusionFunction< TImage >, itk::GradientNDAnisotropicDiffusionFunction< TImage >, itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >, itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >, itk::BinaryMinMaxCurvatureFlowFunction< TImage >, itk::CurvatureFlowFunction< TImage >, itk::MinMaxCurvatureFlowFunction< TImage >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TImageType >, itk::RegionBasedLevelSetFunction< TInput, TFeature, TSharedData >, itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >, itk::MeanSquareRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, and itk::FastSymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.
|
pure virtual |
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.
Implemented in itk::AnisotropicDiffusionFunction< TImage >, itk::CurvatureFlowFunction< TImage >, itk::GPUAnisotropicDiffusionFunction< TImage >, itk::RegionBasedLevelSetFunction< TInput, TFeature, TSharedData >, itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >, itk::MeanSquareRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::FastSymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetFunction< TImageType >, itk::NormalVectorFunctionBase< TSparseImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< TImageType, TImageType >.
|
overridevirtual |
Reimplemented from itk::LightObject.
Reimplemented in itk::GPUFiniteDifferenceFunction< TImageType >, itk::GPUFiniteDifferenceFunction< TImage >, itk::GPUFiniteDifferenceFunction< TDisplacementField >, itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >, itk::CannySegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::SegmentationLevelSetFunction< TImageType, TImageType >, itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapeDetectionLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >.
const RadiusType & itk::FiniteDifferenceFunction< TImageType >::GetRadius | ( | ) | const |
Returns the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.
void itk::FiniteDifferenceFunction< TImageType >::GetScaleCoefficients | ( | PixelRealType | vals[ImageDimension] | ) | const |
Returns the current scale coefficients.
|
inlinevirtual |
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 AnisotropicDiffusionFunction class of FiniteDifferenceFunction 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::CurvatureNDAnisotropicDiffusionFunction< TImage >, itk::GradientNDAnisotropicDiffusionFunction< TImage >, itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >, itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >, itk::GPUGradientNDAnisotropicDiffusionFunction< TImage >, itk::MeanSquareRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::FastSymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, and itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.
Definition at line 121 of file itkFiniteDifferenceFunction.h.
|
overrideprotectedvirtual |
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::LightObject.
Reimplemented in itk::CurvesLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourLevelSetFunction< TImageType, TFeatureImageType >, itk::GeodesicActiveContourShapePriorLevelSetFunction< TImageType, TFeatureImageType >, itk::LevelSetFunction< TImageType >, itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TImageType >, itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >.
|
pure virtual |
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.
Implemented in itk::AnisotropicDiffusionFunction< TImage >, itk::GPUAnisotropicDiffusionFunction< TImage >, itk::NormalVectorFunctionBase< TSparseImageType >, itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::CurvatureFlowFunction< TImage >, itk::RegionBasedLevelSetFunction< TInput, TFeature, TSharedData >, itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >, itk::MeanSquareRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::GPUDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::FastSymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetFunction< TImageType >, itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< TImageType, TImageType >.
void itk::FiniteDifferenceFunction< TImageType >::SetRadius | ( | const RadiusType & | r | ) |
Sets the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.
void itk::FiniteDifferenceFunction< TImageType >::SetScaleCoefficients | ( | const PixelRealType | vals[ImageDimension] | ) |
Set the ScaleCoefficients for the difference operators. The defaults a 1.0. These can be set to take the image spacing into account.
|
staticconstexpr |
Save image dimension.
Definition at line 87 of file itkFiniteDifferenceFunction.h.
|
protected |
Definition at line 203 of file itkFiniteDifferenceFunction.h.
|
protected |
Definition at line 204 of file itkFiniteDifferenceFunction.h.