itk::NormalVectorFunctionBase< TSparseImageType > Class Template Reference

#include <itkNormalVectorFunctionBase.h>

Detailed Description

template<typename TSparseImageType>
class itk::NormalVectorFunctionBase< TSparseImageType >

This class defines the common functionality for Sparse Image neighborhoods of unit vectors.

This class is derived from the FiniteDifferenceSparseImageFunction class and adds the functionality needed to process unit normal vector neighborhoods.

This class is the parent class of the NormalVectorDiffusionFunction class which defines all the necessary functionality for performing diffusion operations on unit vectors stored in sparse images. Other (non-diffusion) filters (such as median filtering) on unit vectors can also be derived from this base class.

PARAMETERS

This function class has a time step parameter which is returned by the ComputeGlobalTimeStep method. Unlike other finite difference function classes, this class does not use the maximum change magnitude to compute the time step, it returns this predetermined time step.

Definition at line 52 of file itkNormalVectorFunctionBase.h.

Inheritance diagram for itk::NormalVectorFunctionBase< TSparseImageType >:

Collaboration diagram for itk::NormalVectorFunctionBase< TSparseImageType >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	NodeType = typename SparseImageType::NodeType
using	NodeValueType = typename NodeType::NodeValueType
using	NormalVectorType = typename NodeType::NodeDataType
using	Pointer = SmartPointer< Self >
using	Self = NormalVectorFunctionBase
using	Superclass = FiniteDifferenceSparseImageFunction< TSparseImageType >
Public Types inherited from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >
using	ConstPointer = SmartPointer< const Self >
using	IndexType = typename SparseImageType::IndexType
using	NodeDataType = typename NodeType::NodeDataType
using	NodeType = typename SparseImageType::NodeType
using	Pointer = SmartPointer< Self >
using	Self = FiniteDifferenceSparseImageFunction
using	SparseImageType = typename Superclass::ImageType
using	Superclass = FiniteDifferenceFunction< TSparseImageType >
Public Types inherited from itk::FiniteDifferenceFunction< TSparseImageType >
using	ConstPointer = SmartPointer< const Self >
using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< ImageType >
using	FloatOffsetType = Vector< float, Self::ImageDimension >
using	ImageType = TSparseImageType
using	NeighborhoodScalesType = Vector< PixelRealType, Self::ImageDimension >
using	NeighborhoodType = ConstNeighborhoodIterator< TSparseImageType, DefaultBoundaryConditionType >
using	PixelRealType = double
using	PixelType = typename ImageType::PixelType
using	Pointer = SmartPointer< Self >
using	RadiusType = typename ConstNeighborhoodIterator< TSparseImageType >::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
TimeStepType	ComputeGlobalTimeStep (void *) const override
const char *	GetNameOfClass () const override
TimeStepType	GetTimeStep () const
void	SetTimeStep (const TimeStepType &ts)
void *	GetGlobalDataPointer () const override
void	ReleaseGlobalDataPointer (void *) const override
Public Member Functions inherited from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >
virtual NodeDataType	ComputeSparseUpdate (NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) const =0
PixelType	ComputeUpdate (const NeighborhoodType &, void *, const FloatOffsetType &) override
const char *	GetNameOfClass () const override
virtual void	PrecomputeSparseUpdate (NeighborhoodType &) const
Public Member Functions inherited from itk::FiniteDifferenceFunction< TSparseImageType >
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 = Superclass::ImageDimension
Static Public Attributes inherited from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::FiniteDifferenceFunction< TSparseImageType >
static constexpr unsigned int	ImageDimension

Protected Member Functions
	NormalVectorFunctionBase ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~NormalVectorFunctionBase () override=default
Protected Member Functions inherited from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >
	FiniteDifferenceSparseImageFunction ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~FiniteDifferenceSparseImageFunction () override=default
Protected Member Functions inherited from itk::FiniteDifferenceFunction< TSparseImageType >
	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 ()

Private Attributes
TimeStepType	m_TimeStep {}

Additional Inherited Members
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()
Protected Attributes inherited from itk::FiniteDifferenceFunction< TSparseImageType >
RadiusType	m_Radius
PixelRealType	m_ScaleCoefficients [ImageDimension]
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

ConstPointer

template<typename TSparseImageType >

using itk::NormalVectorFunctionBase< TSparseImageType >::ConstPointer = SmartPointer<const Self>

Definition at line 61 of file itkNormalVectorFunctionBase.h.

NodeType

template<typename TSparseImageType >

using itk::NormalVectorFunctionBase< TSparseImageType >::NodeType = typename SparseImageType::NodeType

The node type for the sparse image.

Definition at line 78 of file itkNormalVectorFunctionBase.h.

NodeValueType

template<typename TSparseImageType >

using itk::NormalVectorFunctionBase< TSparseImageType >::NodeValueType = typename NodeType::NodeValueType

The basic floating point type for the variables.

Definition at line 81 of file itkNormalVectorFunctionBase.h.

NormalVectorType

template<typename TSparseImageType >

using itk::NormalVectorFunctionBase< TSparseImageType >::NormalVectorType = typename NodeType::NodeDataType

The vector type for the normals.

Definition at line 84 of file itkNormalVectorFunctionBase.h.

Pointer

template<typename TSparseImageType >

using itk::NormalVectorFunctionBase< TSparseImageType >::Pointer = SmartPointer<Self>

Definition at line 60 of file itkNormalVectorFunctionBase.h.

Self

template<typename TSparseImageType >

using itk::NormalVectorFunctionBase< TSparseImageType >::Self = NormalVectorFunctionBase

Standard class type alias.

Definition at line 58 of file itkNormalVectorFunctionBase.h.

Superclass

template<typename TSparseImageType >

using itk::NormalVectorFunctionBase< TSparseImageType >::Superclass = FiniteDifferenceSparseImageFunction<TSparseImageType>

Definition at line 59 of file itkNormalVectorFunctionBase.h.

Constructor & Destructor Documentation

NormalVectorFunctionBase()

template<typename TSparseImageType >

itk::NormalVectorFunctionBase< TSparseImageType >::NormalVectorFunctionBase ( )

protected

~NormalVectorFunctionBase()

template<typename TSparseImageType >

itk::NormalVectorFunctionBase< TSparseImageType >::~NormalVectorFunctionBase ( )

overrideprotecteddefault

Member Function Documentation

ComputeGlobalTimeStep()

template<typename TSparseImageType >

TimeStepType itk::NormalVectorFunctionBase< TSparseImageType >::ComputeGlobalTimeStep ( void *  ) const

inlineoverridevirtual

For the global time step, we return the time step parameter.

Implements itk::FiniteDifferenceFunction< TSparseImageType >.

Definition at line 99 of file itkNormalVectorFunctionBase.h.

GetGlobalDataPointer()

template<typename TSparseImageType >

void * itk::NormalVectorFunctionBase< TSparseImageType >::GetGlobalDataPointer ( ) const

inlineoverridevirtual

GlobalData methods are not needed in this class.

Implements itk::FiniteDifferenceFunction< TSparseImageType >.

Definition at line 88 of file itkNormalVectorFunctionBase.h.

GetNameOfClass()

template<typename TSparseImageType >

const char * itk::NormalVectorFunctionBase< TSparseImageType >::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >.

GetTimeStep()

template<typename TSparseImageType >

TimeStepType itk::NormalVectorFunctionBase< TSparseImageType >::GetTimeStep ( ) const

inline

Returns the time step.

Definition at line 113 of file itkNormalVectorFunctionBase.h.

PrintSelf()

template<typename TSparseImageType >

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

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::FiniteDifferenceSparseImageFunction< TSparseImageType >.

ReleaseGlobalDataPointer()

template<typename TSparseImageType >

void itk::NormalVectorFunctionBase< TSparseImageType >::ReleaseGlobalDataPointer ( void *  ) const

inlineoverridevirtual

GlobalData methods are not needed in this class.

Implements itk::FiniteDifferenceFunction< TSparseImageType >.

Definition at line 93 of file itkNormalVectorFunctionBase.h.

SetTimeStep()

template<typename TSparseImageType >

void itk::NormalVectorFunctionBase< TSparseImageType >::SetTimeStep ( const TimeStepType &  ts )

inline

Sets the time step.

Definition at line 106 of file itkNormalVectorFunctionBase.h.

Member Data Documentation

ImageDimension

template<typename TSparseImageType >

constexpr unsigned int itk::NormalVectorFunctionBase< TSparseImageType >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Image dimension derived from the superclass.

Definition at line 67 of file itkNormalVectorFunctionBase.h.

m_TimeStep

template<typename TSparseImageType >

TimeStepType itk::NormalVectorFunctionBase< TSparseImageType >::m_TimeStep {}

private

The time step for normal vector finite difference computations.

Definition at line 126 of file itkNormalVectorFunctionBase.h.

---

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

• itkNormalVectorFunctionBase.h