#include <itkFiniteDifferenceSparseImageFunction.h>

Detailed Description

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

This is the base class for function classes that can be used with filters derived from FiniteDifferenceSparseImageFilter.

This class is derived from FiniteDifferenceFunction. It is designed to: work with neighborhoods of pointers instead of actual data. Towards this purpose ComputeUpdate method is no longer used and is replaced by the ComputeSparseUpdate method. ComputeSparseUpdate assumes that the pointers are associated with structures that have the member variable m_Data. The pointers would normally originate from a SparseImage object.

The PrecomputeSparseUpdate method can be defined to do a first pass of: computations which then can be used by ComputeSparseUpdate. If PrecomputeSparseUpdate is used then the m_PrecomputeFlag should be set in the FiniteDifferenceSparseImageFilter class. The precomputation step can be used to speed up computation by avoiding repetitions. See the NormalVectorDiffusionFunction for an example.

Definition at line 47 of file itkFiniteDifferenceSparseImageFunction.h.

Inheritance diagram for itk::FiniteDifferenceSparseImageFunction< TSparseImageType >:

Collaboration diagram for itk::FiniteDifferenceSparseImageFunction< TSparseImageType >:

Public Types
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

using	DefaultBoundaryConditionType

using	FloatOffsetType

using	ImageType

using	NeighborhoodScalesType

using	NeighborhoodType

using	PixelRealType

using	PixelType

using	Pointer

using	RadiusType

using	Self

using	Superclass

using	TimeStepType

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

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
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

virtual TimeStepType	ComputeGlobalTimeStep (void *GlobalData) const=0

const NeighborhoodScalesType	ComputeNeighborhoodScales () const

const NeighborhoodScalesType	ComputeNeighborhoodScales () const

virtual void *	GetGlobalDataPointer () const=0

virtual void *	GetGlobalDataPointer () const=0

const RadiusType &	GetRadius () const

const RadiusType &	GetRadius () const

void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const

void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const

virtual void	InitializeIteration ()

virtual void	InitializeIteration ()

virtual void	ReleaseGlobalDataPointer (void *GlobalData) const=0

virtual void	ReleaseGlobalDataPointer (void *GlobalData) const=0

void	SetRadius (const RadiusType &r)

void	SetRadius (const RadiusType &r)

void	SetScaleCoefficients (const PixelRealType vals[ImageDimension])

void	SetScaleCoefficients (const PixelRealType vals[ImageDimension])

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

virtual Pointer	CreateAnother () const

virtual void	Delete ()

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::FiniteDifferenceFunction< TSparseImageType >
static constexpr unsigned int	ImageDimension

static constexpr unsigned int	ImageDimension

Protected Member Functions
	FiniteDifferenceSparseImageFunction ()=default

void	PrintSelf (std::ostream &os, Indent indent) const override

	~FiniteDifferenceSparseImageFunction () override=default

Protected Member Functions inherited from itk::FiniteDifferenceFunction< TSparseImageType >
	FiniteDifferenceFunction ()

	FiniteDifferenceFunction ()

	~FiniteDifferenceFunction () override=default

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

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

RadiusType	m_Radius

PixelRealType	m_ScaleCoefficients [ImageDimension]

PixelRealType	m_ScaleCoefficients [ImageDimension]

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TSparseImageType>

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

Definition at line 56 of file itkFiniteDifferenceSparseImageFunction.h.

◆ IndexType

template<typename TSparseImageType>

using itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::IndexType = typename SparseImageType::IndexType

The index type for the sparse image.

Definition at line 73 of file itkFiniteDifferenceSparseImageFunction.h.

◆ NodeDataType

template<typename TSparseImageType>

using itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::NodeDataType = typename NodeType::NodeDataType

The type for the variables of NodeType. Scalar or vector.

Definition at line 79 of file itkFiniteDifferenceSparseImageFunction.h.

◆ NodeType

template<typename TSparseImageType>

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

The actual type of nodes stored the sparse image.

Definition at line 76 of file itkFiniteDifferenceSparseImageFunction.h.

◆ Pointer

template<typename TSparseImageType>

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

Definition at line 55 of file itkFiniteDifferenceSparseImageFunction.h.

◆ Self

template<typename TSparseImageType>

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

Standard class type alias.

Definition at line 53 of file itkFiniteDifferenceSparseImageFunction.h.

◆ SparseImageType

template<typename TSparseImageType>

using itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::SparseImageType = typename Superclass::ImageType

Definition at line 70 of file itkFiniteDifferenceSparseImageFunction.h.

◆ Superclass

template<typename TSparseImageType>

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

Definition at line 54 of file itkFiniteDifferenceSparseImageFunction.h.

Constructor & Destructor Documentation

◆ FiniteDifferenceSparseImageFunction()

template<typename TSparseImageType>

itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::FiniteDifferenceSparseImageFunction ( )

protecteddefault

◆ ~FiniteDifferenceSparseImageFunction()

template<typename TSparseImageType>

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

overrideprotecteddefault

Member Function Documentation

◆ ComputeSparseUpdate()

template<typename TSparseImageType>

virtual NodeDataType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::ComputeSparseUpdate	(	NeighborhoodType &	neighborhood,
		void *	globalData,
		const FloatOffsetType &	offset = FloatOffsetType(0.0) ) const

pure virtual

The update called from the FiniteDifferenceSparseImageFilter. This function replaces the ComputeUpdate function.

Implemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, itk::NormalVectorDiffusionFunction< SparseImageType >, and itk::NormalVectorDiffusionFunction< SparseImageType >.

◆ ComputeUpdate()

template<typename TSparseImageType>

PixelType itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::ComputeUpdate	(	const NeighborhoodType &	,
		void *	,
		const FloatOffsetType &	)

inlineoverridevirtual

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 86 of file itkFiniteDifferenceSparseImageFunction.h.

◆ GetNameOfClass()

template<typename TSparseImageType>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::FiniteDifferenceFunction< TSparseImageType >.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, itk::NormalVectorDiffusionFunction< SparseImageType >, itk::NormalVectorDiffusionFunction< SparseImageType >, itk::NormalVectorFunctionBase< TSparseImageType >, itk::NormalVectorFunctionBase< SparseOutputImageType >, and itk::NormalVectorFunctionBase< SparseOutputImageType >.

◆ PrecomputeSparseUpdate()

template<typename TSparseImageType>

virtual void itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::PrecomputeSparseUpdate ( NeighborhoodType & ) const

inlinevirtual

This function provides support for a 2 step update computation that avoids repetitive computation. FiniteDifferenceSparseImageFilter first calls this function for all active pixels in the SparseImage class, then calls ComputeSparseUpdate for the same set of pixels. This is used in NormalVectorDiffusionFunction to calculate flux variables which are then used to compute the updates. Intermediate variables such as the flux in the above examples are stored in the nodes of the SparseImage itself. Therefore, this function will have to know about the NodeType it is dealing with. This function does nothing by default.

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, itk::NormalVectorDiffusionFunction< SparseImageType >, and itk::NormalVectorDiffusionFunction< SparseImageType >.

Definition at line 108 of file itkFiniteDifferenceSparseImageFunction.h.

◆ PrintSelf()

template<typename TSparseImageType>

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

Reimplemented in itk::NormalVectorDiffusionFunction< TSparseImageType >, itk::NormalVectorDiffusionFunction< SparseImageType >, itk::NormalVectorDiffusionFunction< SparseImageType >, itk::NormalVectorFunctionBase< TSparseImageType >, itk::NormalVectorFunctionBase< SparseOutputImageType >, and itk::NormalVectorFunctionBase< SparseOutputImageType >.

Member Data Documentation

◆ ImageDimension

template<typename TSparseImageType>

unsigned int itk::FiniteDifferenceSparseImageFunction< TSparseImageType >::ImageDimension = Superclass::ImageDimension

staticconstexpr

The image dimension.

Definition at line 62 of file itkFiniteDifferenceSparseImageFunction.h.

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

itkFiniteDifferenceSparseImageFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ NodeDataType

◆ NodeType

◆ Pointer

◆ Self

◆ SparseImageType

◆ Superclass

Constructor & Destructor Documentation

◆ FiniteDifferenceSparseImageFunction()

◆ ~FiniteDifferenceSparseImageFunction()

Member Function Documentation

◆ ComputeSparseUpdate()

◆ ComputeUpdate()

◆ GetNameOfClass()

◆ PrecomputeSparseUpdate()

◆ PrintSelf()

Member Data Documentation

◆ ImageDimension