itk::VectorAnisotropicDiffusionFunction< TImage > Class Template Reference

#include <itkVectorAnisotropicDiffusionFunction.h>

Inheritance diagram for itk::VectorAnisotropicDiffusionFunction< TImage >:

Collaboration diagram for itk::VectorAnisotropicDiffusionFunction< TImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	ImageType = typename Superclass::ImageType
using	NeighborhoodType = typename Superclass::NeighborhoodType
using	PixelType = typename Superclass::PixelType
using	Pointer = SmartPointer< Self >
using	RadiusType = typename Superclass::RadiusType
using	Self = VectorAnisotropicDiffusionFunction
using	Superclass = AnisotropicDiffusionFunction< TImage >
using	TimeStepType = typename Superclass::TimeStepType
Public Types inherited from itk::AnisotropicDiffusionFunction< TImage >
using	ConstPointer = SmartPointer< const Self >
using	FloatOffsetType = typename Superclass::FloatOffsetType
using	ImageType = typename Superclass::ImageType
using	NeighborhoodType = typename Superclass::NeighborhoodType
using	PixelrealType = typename Superclass::PixelRealType
using	PixelType = typename Superclass::PixelType
using	Pointer = SmartPointer< Self >
using	RadiusType = typename Superclass::RadiusType
using	Self = AnisotropicDiffusionFunction
using	Superclass = FiniteDifferenceFunction< TImage >
using	TimeStepType = typename Superclass::TimeStepType
Public Types inherited from itk::FiniteDifferenceFunction< TImage >
using	ConstPointer = SmartPointer< const Self >
using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< ImageType >
using	FloatOffsetType = Vector< float, Self::ImageDimension >
using	ImageType = TImage
using	NeighborhoodScalesType = Vector< PixelRealType, Self::ImageDimension >
using	NeighborhoodType = ConstNeighborhoodIterator< TImage, DefaultBoundaryConditionType >
using	PixelRealType = double
using	PixelType = typename ImageType::PixelType
using	Pointer = SmartPointer< Self >
using	RadiusType = typename ConstNeighborhoodIterator< TImage >::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
void	CalculateAverageGradientMagnitudeSquared (TImage *) override
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::AnisotropicDiffusionFunction< TImage >
virtual void	CalculateAverageGradientMagnitudeSquared (ImageType *)=0
TimeStepType	ComputeGlobalTimeStep (void *) const override
const double &	GetAverageGradientMagnitudeSquared () const
const double &	GetConductanceParameter () const
void *	GetGlobalDataPointer () const override
const TimeStepType &	GetTimeStep () const
void	ReleaseGlobalDataPointer (void *) const override
void	SetAverageGradientMagnitudeSquared (const double &c)
void	SetConductanceParameter (const double &c)
void	SetTimeStep (const TimeStepType &t)
Public Member Functions inherited from itk::FiniteDifferenceFunction< TImage >
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 (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 constexpr unsigned int	VectorDimension = PixelType::Dimension
Static Public Attributes inherited from itk::AnisotropicDiffusionFunction< TImage >
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::FiniteDifferenceFunction< TImage >
static constexpr unsigned int	ImageDimension

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

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

Detailed Description

template<typename TImage>
class itk::VectorAnisotropicDiffusionFunction< TImage >

This class implements a vector-valued version of AnisotropicDiffusionFunction. Typically in vector-valued diffusion, vector components are diffused independently of one another using a conductance term that is linked across the components. Refer to the the documentation of AnisotropicDiffusionFunction for an overview of anisotropic diffusion. The way that the conductance term is calculated is specific to the specific type of diffusion function.

Data type requirements

This filter was designed to process itk::Images of itk::Vector type. The code relies on various type alias and overloaded operators defined in itk::Vector. It is perfectly reasonable, however, to apply this filter to images of other, user-defined types as long as the appropriate type alias and operator overloads are in place. As a general rule, follow the example of itk::Vector in defining your data types.

See also

AnisotropicDiffusionFunction

ScalarAnisotropicDiffusionFunction

Definition at line 53 of file itkVectorAnisotropicDiffusionFunction.h.

Member Typedef Documentation

ConstPointer

template<typename TImage >

using itk::VectorAnisotropicDiffusionFunction< TImage >::ConstPointer = SmartPointer<const Self>

Definition at line 62 of file itkVectorAnisotropicDiffusionFunction.h.

ImageType

template<typename TImage >

using itk::VectorAnisotropicDiffusionFunction< TImage >::ImageType = typename Superclass::ImageType

Inherit some parameters from the superclass type

Definition at line 68 of file itkVectorAnisotropicDiffusionFunction.h.

NeighborhoodType

template<typename TImage >

using itk::VectorAnisotropicDiffusionFunction< TImage >::NeighborhoodType = typename Superclass::NeighborhoodType

Definition at line 72 of file itkVectorAnisotropicDiffusionFunction.h.

PixelType

template<typename TImage >

using itk::VectorAnisotropicDiffusionFunction< TImage >::PixelType = typename Superclass::PixelType

Definition at line 69 of file itkVectorAnisotropicDiffusionFunction.h.

Pointer

template<typename TImage >

using itk::VectorAnisotropicDiffusionFunction< TImage >::Pointer = SmartPointer<Self>

Definition at line 61 of file itkVectorAnisotropicDiffusionFunction.h.

RadiusType

template<typename TImage >

using itk::VectorAnisotropicDiffusionFunction< TImage >::RadiusType = typename Superclass::RadiusType

Definition at line 71 of file itkVectorAnisotropicDiffusionFunction.h.

Self

template<typename TImage >

using itk::VectorAnisotropicDiffusionFunction< TImage >::Self = VectorAnisotropicDiffusionFunction

Standard class type aliases.

Definition at line 59 of file itkVectorAnisotropicDiffusionFunction.h.

Superclass

template<typename TImage >

using itk::VectorAnisotropicDiffusionFunction< TImage >::Superclass = AnisotropicDiffusionFunction<TImage>

Definition at line 60 of file itkVectorAnisotropicDiffusionFunction.h.

TimeStepType

template<typename TImage >

using itk::VectorAnisotropicDiffusionFunction< TImage >::TimeStepType = typename Superclass::TimeStepType

Definition at line 70 of file itkVectorAnisotropicDiffusionFunction.h.

Constructor & Destructor Documentation

VectorAnisotropicDiffusionFunction()

template<typename TImage >

itk::VectorAnisotropicDiffusionFunction< TImage >::VectorAnisotropicDiffusionFunction ( )

protecteddefault

~VectorAnisotropicDiffusionFunction()

template<typename TImage >

itk::VectorAnisotropicDiffusionFunction< TImage >::~VectorAnisotropicDiffusionFunction ( )

overrideprotecteddefault

Member Function Documentation

CalculateAverageGradientMagnitudeSquared()

template<typename TImage >

void itk::VectorAnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared ( TImage *  )

override

Compute the average gradient magnitude squared.

GetNameOfClass()

template<typename TImage >

virtual const char* itk::VectorAnisotropicDiffusionFunction< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.

Reimplemented in itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >, and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >.

PrintSelf()

template<typename TImage >

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

inlineoverrideprotectedvirtual

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::AnisotropicDiffusionFunction< TImage >.

Reimplemented in itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >.

Definition at line 86 of file itkVectorAnisotropicDiffusionFunction.h.

Member Data Documentation

ImageDimension

template<typename TImage >

constexpr unsigned int itk::VectorAnisotropicDiffusionFunction< TImage >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Inherit some parameters from the superclass type

Definition at line 75 of file itkVectorAnisotropicDiffusionFunction.h.

VectorDimension

template<typename TImage >

constexpr unsigned int itk::VectorAnisotropicDiffusionFunction< TImage >::VectorDimension = PixelType::Dimension

staticconstexpr

Definition at line 76 of file itkVectorAnisotropicDiffusionFunction.h.

---

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

• itkVectorAnisotropicDiffusionFunction.h