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 ComputeGloablTimeStep 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.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	FloatOffsetType = typename Superclass::FloatOffsetType

using	IndexType = typename Superclass::IndexType

using	NeighborhoodType = typename Superclass::NeighborhoodType

using	NodeType = typename SparseImageType::NodeType

using	NodeValueType = typename NodeType::NodeValueType

using	NormalVectorType = typename NodeType::NodeDataType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename Superclass::RadiusType

using	Self = NormalVectorFunctionBase

using	SparseImageType = typename Superclass::SparseImageType

using	Superclass = FiniteDifferenceSparseImageFunction< TSparseImageType >

using	TimeStepType = typename Superclass::TimeStepType

Public Types inherited from itk::FiniteDifferenceSparseImageFunction< TSparseImageType >
using	ConstPointer = SmartPointer< const Self >

using	FloatOffsetType = typename Superclass::FloatOffsetType

using	IndexType = typename SparseImageType::IndexType

using	NeighborhoodType = typename Superclass::NeighborhoodType

using	NodeDataType = typename NodeType::NodeDataType

using	NodeType = typename SparseImageType::NodeType

using	PixelType = typename Superclass::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename Superclass::RadiusType

using	Self = FiniteDifferenceSparseImageFunction

using	SparseImageType = typename Superclass::ImageType

using	Superclass = FiniteDifferenceFunction< TSparseImageType >

using	TimeStepType = typename Superclass::TimeStepType

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

virtual const char *	GetNameOfClass () const

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

virtual void	PrecomputeSparseUpdate (NeighborhoodType &) const

Public Member Functions inherited from itk::FiniteDifferenceFunction< TSparseImageType >
const NeighborhoodScalesType	ComputeNeighborhoodScales () const

virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))=0

const RadiusType &	GetRadius () const

void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const

virtual void	InitializeIteration ()

void	SetRadius (const RadiusType &r)

void	SetScaleCoefficients (PixelRealType vals[ImageDimension])

Public Member Functions inherited from itk::LightObject
virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

	~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	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