itk::simple::GradientMagnitudeRecursiveGaussianImageFilter Class Reference

Computes the Magnitude of the Gradient of an image by convolution with the first derivative of a Gaussian. More...

#include <sitkGradientMagnitudeRecursiveGaussianImageFilter.h>

Inheritance diagram for itk::simple::GradientMagnitudeRecursiveGaussianImageFilter:

Collaboration diagram for itk::simple::GradientMagnitudeRecursiveGaussianImageFilter:

Detailed Description

Computes the Magnitude of the Gradient of an image by convolution with the first derivative of a Gaussian.

This filter is implemented using the recursive gaussian filters

See also

itk::simple::GradientMagnitudeRecursiveGaussian for the procedural interface

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

Examples

FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 41 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = GradientMagnitudeRecursiveGaussianImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &image1)
Image	Execute (Image &&image1)
std::string	GetName () const
bool	GetNormalizeAcrossScale () const
double	GetSigma () const
	GradientMagnitudeRecursiveGaussianImageFilter ()
Self &	NormalizeAcrossScaleOff ()
Self &	NormalizeAcrossScaleOn ()
Self &	SetNormalizeAcrossScale (bool NormalizeAcrossScale)
Self &	SetSigma (double Sigma)
std::string	ToString () const
virtual	~GradientMagnitudeRecursiveGaussianImageFilter ()
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. More...
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...
virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands. More...
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
bool	m_InPlace {false}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
bool	m_NormalizeAcrossScale {false}
double	m_Sigma {1.0}

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. More...
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...
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::GradientMagnitudeRecursiveGaussianImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 97 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

PixelIDTypeList

using itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 53 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

Self

using itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::Self = GradientMagnitudeRecursiveGaussianImageFilter

Definition at line 43 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

Constructor & Destructor Documentation

~GradientMagnitudeRecursiveGaussianImageFilter()

virtual itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::~GradientMagnitudeRecursiveGaussianImageFilter ( )

virtual

Destructor

GradientMagnitudeRecursiveGaussianImageFilter()

itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::GradientMagnitudeRecursiveGaussianImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute() [1/2]

Image itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::Execute

(

const Image &

image1

)

Execute() [2/2]

Image itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::Execute

(

Image &&

image1

)

Execute the filter on the input image

Examples

FastMarchingSegmentation/FastMarchingSegmentation.cxx.

ExecuteInternal()

template<class TImageType >

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

private

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 81 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

GetNormalizeAcrossScale()

bool itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::GetNormalizeAcrossScale ( ) const

inline

Set/Get the normalization factor that will be used for the Gaussian.

See also

RecursiveGaussianImageFilter::SetNormalizeAcrossScale

Definition at line 78 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

GetSigma()

double itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::GetSigma ( ) const

inline

Set/Get Sigma value. Sigma is measured in the units of image spacing.

Definition at line 64 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

NormalizeAcrossScaleOff()

Self& itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::NormalizeAcrossScaleOff ( )

inline

Definition at line 73 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

NormalizeAcrossScaleOn()

Self& itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::NormalizeAcrossScaleOn ( )

inline

Set the value of NormalizeAcrossScale to true or false respectfully.

Definition at line 72 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

SetNormalizeAcrossScale()

Self& itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::SetNormalizeAcrossScale ( bool  NormalizeAcrossScale )

inline

Set/Get the normalization factor that will be used for the Gaussian.

See also

RecursiveGaussianImageFilter::SetNormalizeAcrossScale

Definition at line 69 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

SetSigma()

Self& itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::SetSigma ( double  Sigma )

inline

Set/Get Sigma value. Sigma is measured in the units of image spacing.

Examples

FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 59 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 101 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

Member Data Documentation

m_InPlace

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

private

Definition at line 113 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

m_MemberFactory

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

private

Definition at line 103 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

m_NormalizeAcrossScale

bool itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::m_NormalizeAcrossScale {false}

private

Definition at line 110 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

m_Sigma

double itk::simple::GradientMagnitudeRecursiveGaussianImageFilter::m_Sigma {1.0}

private

Definition at line 107 of file sitkGradientMagnitudeRecursiveGaussianImageFilter.h.

---

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

• sitkGradientMagnitudeRecursiveGaussianImageFilter.h