ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | Static Private Attributes | List of all members
itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage > Class Template Reference

#include <itkVectorCurvatureNDAnisotropicDiffusionFunction.h>

+ Inheritance diagram for itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >:
+ Collaboration diagram for itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FloatOffsetType = typename Superclass::FloatOffsetType
 
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 ScalarValueType = typename PixelType::ValueType
 
using Self = VectorCurvatureNDAnisotropicDiffusionFunction
 
using Superclass = VectorAnisotropicDiffusionFunction< TImage >
 
using TimeStepType = typename Superclass::TimeStepType
 
- Public Types inherited from itk::VectorAnisotropicDiffusionFunction< TImage >
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

PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0)) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
void InitializeIteration () override
 
- Public Member Functions inherited from itk::VectorAnisotropicDiffusionFunction< TImage >
void CalculateAverageGradientMagnitudeSquared (TImage *) override
 
- 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 TimeStepTypeGetTimeStep () 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 RadiusTypeGetRadius () const
 
void GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
 
void SetRadius (const RadiusType &r)
 
void SetScaleCoefficients (PixelRealType vals[ImageDimension])
 
- Public Member Functions inherited from itk::LightObject
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 Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
static constexpr unsigned int VectorDimension = Superclass::VectorDimension
 
- Static Public Attributes inherited from itk::VectorAnisotropicDiffusionFunction< TImage >
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
 
 VectorCurvatureNDAnisotropicDiffusionFunction ()
 
 ~VectorCurvatureNDAnisotropicDiffusionFunction () override=default
 
- Protected Member Functions inherited from itk::VectorAnisotropicDiffusionFunction< TImage >
 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 ()
 

Private Attributes

SizeValueType m_Center
 
DerivativeOperator< ScalarValueType, Self::ImageDimensionm_DerivativeOperator
 
VectorNeighborhoodInnerProduct< ImageTypem_InnerProduct
 
double m_K { 0.0 }
 
SizeValueType m_Stride [ImageDimension]
 
std::slice x_slice [ImageDimension]
 
std::slice xa_slice [ImageDimension][ImageDimension]
 
std::slice xd_slice [ImageDimension][ImageDimension]
 

Static Private Attributes

static double m_MIN_NORM
 

Additional Inherited Members

- 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::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >

This class is a simple extension of the CurvatureNDAnisotropicDiffusionFunction to pixel types of multiple components. Vector components are diffused separately, but diffusion of each component is limited by a conductance term which depends on all components.

For more information, please see CurvatureNDAnisotropicDiffusionFunction.

See also
CurvatureNDAnisotropicDiffusionFunction
VectorGradientNDAnisotropicDiffusionFunction
AnisotropicDiffusionFunction

Definition at line 44 of file itkVectorCurvatureNDAnisotropicDiffusionFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TImage>
using itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::ConstPointer = SmartPointer<const Self>

◆ FloatOffsetType

◆ ImageType

template<typename TImage>
using itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::ImageType = typename Superclass::ImageType

Inherit some parameters from the superclass type.

Definition at line 63 of file itkVectorCurvatureNDAnisotropicDiffusionFunction.h.

◆ NeighborhoodType

◆ PixelType

template<typename TImage>
using itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::PixelType = typename Superclass::PixelType

◆ Pointer

template<typename TImage>
using itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::Pointer = SmartPointer<Self>

◆ RadiusType

template<typename TImage>
using itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::RadiusType = typename Superclass::RadiusType

◆ ScalarValueType

template<typename TImage>
using itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::ScalarValueType = typename PixelType::ValueType

◆ Self

Standard itk Self & Superclass type alias

Definition at line 51 of file itkVectorCurvatureNDAnisotropicDiffusionFunction.h.

◆ Superclass

◆ TimeStepType

template<typename TImage>
using itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::TimeStepType = typename Superclass::TimeStepType

Constructor & Destructor Documentation

◆ VectorCurvatureNDAnisotropicDiffusionFunction()

◆ ~VectorCurvatureNDAnisotropicDiffusionFunction()

template<typename TImage>
itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::~VectorCurvatureNDAnisotropicDiffusionFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ ComputeUpdate()

template<typename TImage>
PixelType itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::ComputeUpdate ( const NeighborhoodType neighborhood,
void *  globalData,
const FloatOffsetType offset = FloatOffsetType(0.0) 
)
override

Compute the equation value.

◆ CreateAnother()

template<typename TImage>
virtual::itk::LightObject::Pointer itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::CreateAnother ( ) const
virtual

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 from itk::LightObject.

◆ GetNameOfClass()

template<typename TImage>
virtual const char* itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::VectorAnisotropicDiffusionFunction< TImage >.

◆ InitializeIteration()

template<typename TImage>
void itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::InitializeIteration ( )
inlineoverridevirtual

This method is called prior to each iteration of the solver.

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Definition at line 83 of file itkVectorCurvatureNDAnisotropicDiffusionFunction.h.

◆ New()

template<typename TImage>
static Pointer itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::New ( )
static

◆ PrintSelf()

template<typename TImage>
void itk::VectorCurvatureNDAnisotropicDiffusionFunction< 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::VectorAnisotropicDiffusionFunction< TImage >.

Definition at line 93 of file itkVectorCurvatureNDAnisotropicDiffusionFunction.h.

Member Data Documentation

◆ ImageDimension

template<typename TImage>
constexpr unsigned int itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Extract the image and vector dimension.

Definition at line 72 of file itkVectorCurvatureNDAnisotropicDiffusionFunction.h.

◆ m_Center

template<typename TImage>
SizeValueType itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::m_Center
private

◆ m_DerivativeOperator

template<typename TImage>
DerivativeOperator<ScalarValueType, Self::ImageDimension> itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::m_DerivativeOperator
private

Derivative operator

Definition at line 108 of file itkVectorCurvatureNDAnisotropicDiffusionFunction.h.

◆ m_InnerProduct

template<typename TImage>
VectorNeighborhoodInnerProduct<ImageType> itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::m_InnerProduct
private

Inner product function.

Definition at line 100 of file itkVectorCurvatureNDAnisotropicDiffusionFunction.h.

◆ m_K

template<typename TImage>
double itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::m_K { 0.0 }
private

Modified global average gradient magnitude term.

Definition at line 111 of file itkVectorCurvatureNDAnisotropicDiffusionFunction.h.

◆ m_MIN_NORM

template<typename TImage>
double itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::m_MIN_NORM
staticprivate

◆ m_Stride

template<typename TImage>
SizeValueType itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::m_Stride[ImageDimension]
private

◆ VectorDimension

template<typename TImage>
constexpr unsigned int itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::VectorDimension = Superclass::VectorDimension
staticconstexpr

◆ x_slice

template<typename TImage>
std::slice itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::x_slice[ImageDimension]
private

Slices for the ND neighborhood.

Definition at line 103 of file itkVectorCurvatureNDAnisotropicDiffusionFunction.h.

◆ xa_slice

template<typename TImage>
std::slice itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::xa_slice[ImageDimension][ImageDimension]
private

◆ xd_slice

template<typename TImage>
std::slice itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::xd_slice[ImageDimension][ImageDimension]
private

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