itk::NormalVectorDiffusionFunction< TSparseImageType > Class Template Reference
#include <itkNormalVectorDiffusionFunction.h>
Detailed Description
template<class TSparseImageType>
class itk::NormalVectorDiffusionFunction< TSparseImageType >
This class defines all the necessary functionality for performing isotropic and anisotropic diffusion operations on vector neighborhoods from a sparse image.
- This class implements the actual computations for performing isotropic and anisotropic diffusion operations on a neighborhood of unit length vectors. Moreover, this processing is intrinsic to a manifold as specified by the ManifoldNormal member variables in the nodes of the sparse image.
- Since the only difference between isotropic and anisotropic diffusion is the exectution of 1 extra line of code, we have implemented both in this class and made the choice between the two depend on a parameter (see below).
- PARAMETERS
- The choice between is isotropic/anisotropic diffusion is made by the parameter NormalProcessType. A value of 0 corresponds to isotropic diffusion whereas a value of 1 corresponds to anisotropic diffusion. If anisotropic diffusion is chosen, the parameter ConductanceParameter should be set. This conductance parameter determines the level of feature preservation.
- IMPORTANT
- This class works on SparseImage neighborhoods. Before using this class please read the documentation for SparseImage. Also the documentation for ImplicitManifoldNormalVectorField class will be helpful in understanding how to use this class as a function object.
Definition at line 58 of file itkNormalVectorDiffusionFunction.h.
Member Typedef Documentation
| typedef SmartPointer<const Self> itk::NormalVectorDiffusionFunction< TSparseImageType >::ConstPointer |
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 66 of file itkNormalVectorDiffusionFunction.h.
typedef ZeroFluxNeumannBoundaryCondition<ImageType> itk::FiniteDifferenceFunction< TSparseImageType >::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 Superclass::FloatOffsetType itk::NormalVectorDiffusionFunction< TSparseImageType >::FloatOffsetType |
A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 82 of file itkNormalVectorDiffusionFunction.h.
typedef TSparseImageType itk::FiniteDifferenceFunction< TSparseImageType >::ImageType [inherited] |
Extract some parameters from the image type
Definition at line 76 of file itkFiniteDifferenceFunction.h.
| typedef Superclass::IndexType itk::NormalVectorDiffusionFunction< TSparseImageType >::IndexType |
The index type for the sparse image.
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 83 of file itkNormalVectorDiffusionFunction.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 Superclass::NeighborhoodScalesType itk::NormalVectorDiffusionFunction< TSparseImageType >::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< TSparseImageType >.
Definition at line 81 of file itkNormalVectorDiffusionFunction.h.
| typedef Superclass::NeighborhoodType itk::NormalVectorDiffusionFunction< TSparseImageType >::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::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 80 of file itkNormalVectorDiffusionFunction.h.
typedef NodeType::NodeDataType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::NodeDataType [inherited] |
The type for the variables of NodeType. Scalar or vector.
Definition at line 77 of file itkFiniteDifferenceSparseImageFunction.h.
| typedef Superclass::NodeType itk::NormalVectorDiffusionFunction< TSparseImageType >::NodeType |
The node type for the sparse image.
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 85 of file itkNormalVectorDiffusionFunction.h.
| typedef Superclass::NodeValueType itk::NormalVectorDiffusionFunction< TSparseImageType >::NodeValueType |
The basic floating point type for the variables.
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 86 of file itkNormalVectorDiffusionFunction.h.
| typedef Superclass::NormalVectorType itk::NormalVectorDiffusionFunction< TSparseImageType >::NormalVectorType |
The vector type for the normals.
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 87 of file itkNormalVectorDiffusionFunction.h.
typedef double itk::FiniteDifferenceFunction< TSparseImageType >::PixelRealType [inherited] |
Definition at line 81 of file itkFiniteDifferenceFunction.h.
typedef Superclass::PixelType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::PixelType [inherited] |
Typedefs from the superclass.
Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.
Definition at line 63 of file itkFiniteDifferenceSparseImageFunction.h.
| typedef SmartPointer<Self> itk::NormalVectorDiffusionFunction< TSparseImageType >::Pointer |
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 65 of file itkNormalVectorDiffusionFunction.h.
| typedef Superclass::RadiusType itk::NormalVectorDiffusionFunction< TSparseImageType >::RadiusType |
Neighborhood radius type
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 79 of file itkNormalVectorDiffusionFunction.h.
| typedef NormalVectorDiffusionFunction itk::NormalVectorDiffusionFunction< TSparseImageType >::Self |
Standard class typedef.
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 63 of file itkNormalVectorDiffusionFunction.h.
| typedef Superclass::SparseImageType itk::NormalVectorDiffusionFunction< TSparseImageType >::SparseImageType |
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 84 of file itkNormalVectorDiffusionFunction.h.
| typedef NormalVectorFunctionBase<TSparseImageType> itk::NormalVectorDiffusionFunction< TSparseImageType >::Superclass |
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 64 of file itkNormalVectorDiffusionFunction.h.
| typedef Superclass::TimeStepType itk::NormalVectorDiffusionFunction< TSparseImageType >::TimeStepType |
Typedefs from the superclass.
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
Definition at line 75 of file itkNormalVectorDiffusionFunction.h.
Constructor & Destructor Documentation
| itk::NormalVectorDiffusionFunction< TSparseImageType >::NormalVectorDiffusionFunction | ( | ) | [protected] |
| itk::NormalVectorDiffusionFunction< TSparseImageType >::~NormalVectorDiffusionFunction | ( | ) | [inline, protected] |
Definition at line 136 of file itkNormalVectorDiffusionFunction.h.
Member Function Documentation
| static void itk::LightObject::BreakOnError | ( | ) | [static, inherited] |
This method is called when itkExceptionMacro executes. It allows the debugger to break on error.
| virtual TimeStepType itk::NormalVectorFunctionBase< TSparseImageType >::ComputeGlobalTimeStep | ( | void * | ) | const [inline, virtual, inherited] |
For the global time step, we return the time step parameter.
Implements itk::FiniteDifferenceFunction< TSparseImageType >.
Definition at line 89 of file itkNormalVectorFunctionBase.h.
| const NeighborhoodScalesType itk::FiniteDifferenceFunction< TSparseImageType >::ComputeNeighborhoodScales | ( | ) | const [inherited] |
Compute the scales that weight the neighborhood during difference operations to properly account for spacing and neighborhood radius
| virtual NormalVectorType itk::NormalVectorDiffusionFunction< TSparseImageType >::ComputeSparseUpdate | ( | NeighborhoodType & | neighborhood, | |
| void * | globalData, | |||
| const FloatOffsetType & | offset | |||
| ) | const [virtual] |
The actual update rule for the normal vectors.
Implements itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.
| virtual PixelType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::ComputeUpdate | ( | const NeighborhoodType & | , | |
| void * | , | |||
| const FloatOffsetType & | ||||
| ) | [inline, virtual, inherited] |
This function is not called from the FiniteDifferenceSparseImageFilter class because we need to work with neighborhoods of pointers to data variables instead of neighborhoods of data directly. This function is replaced by the ComputeSparseUpdate function.
Implements itk::FiniteDifferenceFunction< TSparseImageType >.
Definition at line 83 of file itkFiniteDifferenceSparseImageFunction.h.
| 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::Object.
| 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.
| NodeValueType itk::NormalVectorDiffusionFunction< TSparseImageType >::FluxStopFunction | ( | const NodeValueType | v | ) | const [inline, protected] |
The method called in anisotropic diffusion to inhibit diffusion across areas with large curvature.
Definition at line 141 of file itkNormalVectorDiffusionFunction.h.
| NodeValueType itk::NormalVectorDiffusionFunction< TSparseImageType >::GetConductanceParameter | ( | ) | const [inline] |
This method returns the conductance parameter.
Definition at line 116 of file itkNormalVectorDiffusionFunction.h.
| NodeValueType itk::NormalVectorDiffusionFunction< TSparseImageType >::GetFluxStopConstant | ( | ) | const [inline] |
This method returns the internal variable FluxStopConstant.
Definition at line 120 of file itkNormalVectorDiffusionFunction.h.
| virtual void* itk::NormalVectorFunctionBase< TSparseImageType >::GetGlobalDataPointer | ( | ) | const [inline, virtual, inherited] |
Globaldata methods are not needed in this class.
Implements itk::FiniteDifferenceFunction< TSparseImageType >.
Definition at line 84 of file itkNormalVectorFunctionBase.h.
| virtual const char* itk::NormalVectorDiffusionFunction< TSparseImageType >::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods)
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
| int itk::NormalVectorDiffusionFunction< TSparseImageType >::GetNormalProcessType | ( | ) | const [inline] |
This method returns the isotropic/anisotropic filtering parameter.
Definition at line 97 of file itkNormalVectorDiffusionFunction.h.
| const RadiusType& itk::FiniteDifferenceFunction< TSparseImageType >::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.
| TimeStepType itk::NormalVectorFunctionBase< TSparseImageType >::GetTimeStep | ( | ) | const [inline, inherited] |
Returns the time step.
Definition at line 97 of file itkNormalVectorFunctionBase.h.
| virtual void itk::FiniteDifferenceFunction< TSparseImageType >::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.
Definition at line 118 of file itkFiniteDifferenceFunction.h.
| itk::FiniteDifferenceFunction< TSparseImageType >::itkStaticConstMacro | ( | ImageDimension | , | |
| unsigned | int, | |||
| ImageType::ImageDimension | ||||
| ) | [inherited] |
Save image dimension.
| itk::NormalVectorDiffusionFunction< TSparseImageType >::itkStaticConstMacro | ( | ImageDimension | , | |
| unsigned | int, | |||
| Superclass::ImageDimension | ||||
| ) |
Image dimension derived from the superclass.
Reimplemented from itk::NormalVectorFunctionBase< TSparseImageType >.
| static Pointer itk::NormalVectorDiffusionFunction< TSparseImageType >::New | ( | ) | [static] |
Standard New macro.
Reimplemented from itk::LightObject.
| virtual void itk::NormalVectorDiffusionFunction< TSparseImageType >::PrecomputeSparseUpdate | ( | NeighborhoodType & | it | ) | const [virtual] |
This function is called from LevelSetNormalImageFilter for all of the nodes to compute and store the flux vectors (first derivatives of the normal vectors. ComputeUpdateNormal then takes derivatives of the flux vectors. This way we avoid repeating the same flux computations.
Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.
| void itk::LightObject::Print | ( | std::ostream & | os, | |
| Indent | indent = 0 | |||
| ) | const [inherited] |
Cause the object to print itself out.
Referenced by itk::WeakPointer< itk::ProcessObject >::Print(), and itk::SmartPointer< itk::MutualInformationImageToImageMetric >::Print().
| virtual void itk::LightObject::PrintHeader | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| void itk::NormalVectorDiffusionFunction< TSparseImageType >::PrintSelf | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [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::NormalVectorFunctionBase< TSparseImageType >.
| virtual void itk::LightObject::PrintTrailer | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| 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::NormalVectorFunctionBase< TSparseImageType >::ReleaseGlobalDataPointer | ( | void * | ) | const [inline, virtual, inherited] |
Globaldata methods are not needed in this class.
Implements itk::FiniteDifferenceFunction< TSparseImageType >.
Definition at line 85 of file itkNormalVectorFunctionBase.h.
| void itk::NormalVectorDiffusionFunction< TSparseImageType >::SetConductanceParameter | ( | NodeValueType | cp | ) | [inline] |
This method sets the conductance parameter used in anisotropic filtering. Useful values for processing 2D and 3D shapes are between 0.1 and 0.25. Lower values preserve more shape features, higher values smooth more. As the conductance parameter large, the processing becomes isotropic. Default is 0.
Definition at line 105 of file itkNormalVectorDiffusionFunction.h.
| void itk::NormalVectorDiffusionFunction< TSparseImageType >::SetNormalProcessType | ( | int | npt | ) | [inline] |
This method is used to choose between isotropic/anisotropic filtering. A parameter value of 0 indicates isotropic diffusion and is the default. Parameter value 1 is anisotropic diffusion. When using anisotropic diffusion the conductance parameter should also be set.
Definition at line 93 of file itkNormalVectorDiffusionFunction.h.
| void itk::FiniteDifferenceFunction< TSparseImageType >::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< TSparseImageType >::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::NormalVectorFunctionBase< TSparseImageType >::SetTimeStep | ( | const TimeStepType & | ts | ) | [inline, inherited] |
Sets the time step.
Definition at line 93 of file itkNormalVectorFunctionBase.h.
| virtual void itk::LightObject::UnRegister | ( | ) | const [virtual, inherited] |
Decrease the reference count (release by another object).
Reimplemented in itk::Object.
Member Data Documentation
RadiusType itk::FiniteDifferenceFunction< TSparseImageType >::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< TSparseImageType >::m_ScaleCoefficients[ImageDimension] [protected, inherited] |
Definition at line 204 of file itkFiniteDifferenceFunction.h.
The documentation for this class was generated from the following file:
