itk::simple::GradientAnisotropicDiffusionImageFilter Class Reference

This filter performs anisotropic diffusion on a scalar itk::Image using the classic Perona-Malik, gradient magnitude based equation. More...

#include <sitkGradientAnisotropicDiffusionImageFilter.h>

Inheritance diagram for itk::simple::GradientAnisotropicDiffusionImageFilter:

Collaboration diagram for itk::simple::GradientAnisotropicDiffusionImageFilter:

Detailed Description

This filter performs anisotropic diffusion on a scalar itk::Image using the classic Perona-Malik, gradient magnitude based equation.

For detailed information on anisotropic diffusion, see itkAnisotropicDiffusionFunction and itkGradientNDAnisotropicDiffusionFunction.

Inputs and Outputs

The input to this filter should be a scalar itk::Image of any dimensionality. The output image will be a diffused copy of the input.

Parameters

Please see the description of parameters given in itkAnisotropicDiffusionImageFilter.

See also

AnisotropicDiffusionImageFilter

AnisotropicDiffusionFunction

GradientAnisotropicDiffusionFunction

itk::simple::GradientAnisotropicDiffusion for the procedural interface

itk::GradientAnisotropicDiffusionImageFilter for the Doxygen on the original ITK class.

Definition at line 57 of file sitkGradientAnisotropicDiffusionImageFilter.h.

Public Types
using	PixelIDTypeList = RealPixelIDTypeList
using	Self = GradientAnisotropicDiffusionImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
double	EstimateOptimalTimeStep (Image &inImage)
Image	Execute (const Image &image1)
Image	Execute (Image &&image1)
double	GetConductanceParameter () const
unsigned int	GetConductanceScalingUpdateInterval () const
std::string	GetName () const
uint32_t	GetNumberOfIterations () const
double	GetTimeStep () const
	GradientAnisotropicDiffusionImageFilter ()
Self &	SetConductanceParameter (double ConductanceParameter)
Self &	SetConductanceScalingUpdateInterval (unsigned int ConductanceScalingUpdateInterval)
Self &	SetNumberOfIterations (uint32_t NumberOfIterations)
Self &	SetTimeStep (double TimeStep)
std::string	ToString () const
virtual	~GradientAnisotropicDiffusionImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event.
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.
virtual float	GetProgress () const
	An Active Measurement of the progress of execution.
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands.
virtual	~ProcessObject ()
virtual void	DebugOn ()
virtual void	DebugOff ()
virtual bool	GetDebug () const
virtual void	SetDebug (bool debugFlag)
virtual void	SetNumberOfThreads (unsigned int n)
virtual unsigned int	GetNumberOfThreads () const
virtual void	SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image (Self::*)( const Image& image1 )

Private Member Functions
template<class TImageType>
Image	ExecuteInternal (const Image &image1)

Private Attributes
double	m_ConductanceParameter {3}
unsigned int	m_ConductanceScalingUpdateInterval {1u}
bool	m_InPlace {false}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
uint32_t	m_NumberOfIterations {5u}
double	m_TimeStep {0.125}

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()
static void	GlobalDefaultDebugOff ()
static void	GlobalDefaultDebugOn ()
static void	SetGlobalDefaultDebug (bool debugFlag)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.
Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObject *	GetActiveProcess ()
virtual void	OnActiveProcessDelete ()
virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default
	NonCopyable (const NonCopyable &)=delete
NonCopyable &	operator= (const NonCopyable &)=delete
Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
static void	FixNonZeroIndex (TImageType *img)
Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType>
static TImageType::ConstPointer	CastImageToITK (const Image &img)
template<class TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)
template<class TImageType>
static Image	CastITKToImage (TImageType *img)
static const itk::EventObject &	GetITKEventObject (EventEnum e)
template<typename T>
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)
static std::ostream &	ToStringHelper (std::ostream &os, const char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

MemberFunctionType

using itk::simple::GradientAnisotropicDiffusionImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 125 of file sitkGradientAnisotropicDiffusionImageFilter.h.

PixelIDTypeList

using itk::simple::GradientAnisotropicDiffusionImageFilter::PixelIDTypeList = RealPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 69 of file sitkGradientAnisotropicDiffusionImageFilter.h.

Self

using itk::simple::GradientAnisotropicDiffusionImageFilter::Self = GradientAnisotropicDiffusionImageFilter

Definition at line 59 of file sitkGradientAnisotropicDiffusionImageFilter.h.

Constructor & Destructor Documentation

~GradientAnisotropicDiffusionImageFilter()

virtual itk::simple::GradientAnisotropicDiffusionImageFilter::~GradientAnisotropicDiffusionImageFilter ( )

virtual

Destructor

GradientAnisotropicDiffusionImageFilter()

itk::simple::GradientAnisotropicDiffusionImageFilter::GradientAnisotropicDiffusionImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

EstimateOptimalTimeStep()

double itk::simple::GradientAnisotropicDiffusionImageFilter::EstimateOptimalTimeStep

(

Image &

inImage

)

This method autmatically sets the optimal timestep for an image given its spacing.

Execute() [1/2]

Image itk::simple::GradientAnisotropicDiffusionImageFilter::Execute

(

const Image &

image1

)

Execute() [2/2]

Image itk::simple::GradientAnisotropicDiffusionImageFilter::Execute

(

Image &&

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType>

Image itk::simple::GradientAnisotropicDiffusionImageFilter::ExecuteInternal ( const Image & image1 )

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetConductanceParameter()

double itk::simple::GradientAnisotropicDiffusionImageFilter::GetConductanceParameter ( ) const

inline

Definition at line 86 of file sitkGradientAnisotropicDiffusionImageFilter.h.

References m_ConductanceParameter.

GetConductanceScalingUpdateInterval()

unsigned int itk::simple::GradientAnisotropicDiffusionImageFilter::GetConductanceScalingUpdateInterval ( ) const

inline

Definition at line 94 of file sitkGradientAnisotropicDiffusionImageFilter.h.

References m_ConductanceScalingUpdateInterval.

GetName()

std::string itk::simple::GradientAnisotropicDiffusionImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 105 of file sitkGradientAnisotropicDiffusionImageFilter.h.

GetNumberOfIterations()

uint32_t itk::simple::GradientAnisotropicDiffusionImageFilter::GetNumberOfIterations ( ) const

inline

Definition at line 102 of file sitkGradientAnisotropicDiffusionImageFilter.h.

References m_NumberOfIterations.

GetTimeStep()

double itk::simple::GradientAnisotropicDiffusionImageFilter::GetTimeStep ( ) const

inline

Definition at line 78 of file sitkGradientAnisotropicDiffusionImageFilter.h.

References m_TimeStep.

SetConductanceParameter()

Self & itk::simple::GradientAnisotropicDiffusionImageFilter::SetConductanceParameter ( double ConductanceParameter )

inline

Definition at line 82 of file sitkGradientAnisotropicDiffusionImageFilter.h.

References m_ConductanceParameter.

SetConductanceScalingUpdateInterval()

Self & itk::simple::GradientAnisotropicDiffusionImageFilter::SetConductanceScalingUpdateInterval ( unsigned int ConductanceScalingUpdateInterval )

inline

Definition at line 90 of file sitkGradientAnisotropicDiffusionImageFilter.h.

References m_ConductanceScalingUpdateInterval.

SetNumberOfIterations()

Self & itk::simple::GradientAnisotropicDiffusionImageFilter::SetNumberOfIterations ( uint32_t NumberOfIterations )

inline

Definition at line 98 of file sitkGradientAnisotropicDiffusionImageFilter.h.

References m_NumberOfIterations.

SetTimeStep()

Self & itk::simple::GradientAnisotropicDiffusionImageFilter::SetTimeStep ( double TimeStep )

inline

Definition at line 74 of file sitkGradientAnisotropicDiffusionImageFilter.h.

References m_TimeStep.

ToString()

std::string itk::simple::GradientAnisotropicDiffusionImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 126 of file sitkGradientAnisotropicDiffusionImageFilter.h.

References ExecuteInternal().

Member Data Documentation

m_ConductanceParameter

double itk::simple::GradientAnisotropicDiffusionImageFilter::m_ConductanceParameter {3}

private

Definition at line 138 of file sitkGradientAnisotropicDiffusionImageFilter.h.

Referenced by GetConductanceParameter(), and SetConductanceParameter().

m_ConductanceScalingUpdateInterval

unsigned int itk::simple::GradientAnisotropicDiffusionImageFilter::m_ConductanceScalingUpdateInterval {1u}

private

Definition at line 141 of file sitkGradientAnisotropicDiffusionImageFilter.h.

Referenced by GetConductanceScalingUpdateInterval(), and SetConductanceScalingUpdateInterval().

m_InPlace

bool itk::simple::GradientAnisotropicDiffusionImageFilter::m_InPlace {false}

private

Definition at line 147 of file sitkGradientAnisotropicDiffusionImageFilter.h.

m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::GradientAnisotropicDiffusionImageFilter::m_MemberFactory

private

Definition at line 131 of file sitkGradientAnisotropicDiffusionImageFilter.h.

m_NumberOfIterations

uint32_t itk::simple::GradientAnisotropicDiffusionImageFilter::m_NumberOfIterations {5u}

private

Definition at line 144 of file sitkGradientAnisotropicDiffusionImageFilter.h.

Referenced by GetNumberOfIterations(), and SetNumberOfIterations().

m_TimeStep

double itk::simple::GradientAnisotropicDiffusionImageFilter::m_TimeStep {0.125}

private

Definition at line 135 of file sitkGradientAnisotropicDiffusionImageFilter.h.

Referenced by GetTimeStep(), and SetTimeStep().

---

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

• sitkGradientAnisotropicDiffusionImageFilter.h