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

#include <sitkGradientRecursiveGaussianImageFilter.h>

Inheritance diagram for itk::simple::GradientRecursiveGaussianImageFilter:

Collaboration diagram for itk::simple::GradientRecursiveGaussianImageFilter:

Public Types
typedef typelist::Append< BasicPixelIDTypeList, VectorPixelIDTypeList >::Type	PixelIDTypeList

typedef GradientRecursiveGaussianImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1)

Image	Execute (const Image &image1, double sigma, bool normalizeAcrossScale, bool useImageDirection)

std::string	GetName () const

bool	GetNormalizeAcrossScale () const

double	GetSigma () const

bool	GetUseImageDirection () const

	GradientRecursiveGaussianImageFilter ()

Self &	NormalizeAcrossScaleOff ()

Self &	NormalizeAcrossScaleOn ()

Self &	SetNormalizeAcrossScale (bool NormalizeAcrossScale)

Self &	SetSigma (double Sigma)

Self &	SetUseImageDirection (bool UseImageDirection)

std::string	ToString () const

Self &	UseImageDirectionOff ()

Self &	UseImageDirectionOn ()

virtual	~GradientRecursiveGaussianImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

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

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

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

Private Attributes
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

bool	m_NormalizeAcrossScale

double	m_Sigma

bool	m_UseImageDirection

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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

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...

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) SITK_NOEXCEPT

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)

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)

Detailed Description

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

This filter is implemented using the recursive gaussian filters.

This filter supports both scalar and vector pixel types within the input image, including VectorImage type.

See also: itk::simple::GradientRecursiveGaussian for the procedural interface; itk::GradientRecursiveGaussianImageFilter for the Doxygen on the original ITK class.

Definition at line 44 of file sitkGradientRecursiveGaussianImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::GradientRecursiveGaussianImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 114 of file sitkGradientRecursiveGaussianImageFilter.h.

typedef typelist::Append<BasicPixelIDTypeList, VectorPixelIDTypeList>::Type itk::simple::GradientRecursiveGaussianImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 56 of file sitkGradientRecursiveGaussianImageFilter.h.

typedef GradientRecursiveGaussianImageFilter itk::simple::GradientRecursiveGaussianImageFilter::Self

Definition at line 46 of file sitkGradientRecursiveGaussianImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::GradientRecursiveGaussianImageFilter::~GradientRecursiveGaussianImageFilter ( )

virtual

Destructor

itk::simple::GradientRecursiveGaussianImageFilter::GradientRecursiveGaussianImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::GradientRecursiveGaussianImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

Image itk::simple::GradientRecursiveGaussianImageFilter::Execute	(	const Image &	image1,
		double	sigma,
		bool	normalizeAcrossScale,
		bool	useImageDirection
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 97 of file sitkGradientRecursiveGaussianImageFilter.h.

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

inline

Define which normalization factor will be used for the Gaussian

See also: RecursiveGaussianImageFilter::SetNormalizeAcrossScale

Definition at line 81 of file sitkGradientRecursiveGaussianImageFilter.h.

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

inline

Definition at line 67 of file sitkGradientRecursiveGaussianImageFilter.h.

bool itk::simple::GradientRecursiveGaussianImageFilter::GetUseImageDirection ( ) const

inline

The UseImageDirection flag determines whether the gradients are computed with respect to the image grid or with respect to the physical space. When this flag is ON the gradients are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

Definition at line 95 of file sitkGradientRecursiveGaussianImageFilter.h.

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

inline

Definition at line 76 of file sitkGradientRecursiveGaussianImageFilter.h.

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

inline

Set the value of NormalizeAcrossScale to true or false respectfully.

Definition at line 75 of file sitkGradientRecursiveGaussianImageFilter.h.

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

inline

Define which normalization factor will be used for the Gaussian

See also: RecursiveGaussianImageFilter::SetNormalizeAcrossScale

Definition at line 72 of file sitkGradientRecursiveGaussianImageFilter.h.

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

inline

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

Definition at line 63 of file sitkGradientRecursiveGaussianImageFilter.h.

Self& itk::simple::GradientRecursiveGaussianImageFilter::SetUseImageDirection ( bool UseImageDirection )

inline

The UseImageDirection flag determines whether the gradients are computed with respect to the image grid or with respect to the physical space. When this flag is ON the gradients are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

Definition at line 86 of file sitkGradientRecursiveGaussianImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Self& itk::simple::GradientRecursiveGaussianImageFilter::UseImageDirectionOff ( )

inline

Definition at line 90 of file sitkGradientRecursiveGaussianImageFilter.h.

Self& itk::simple::GradientRecursiveGaussianImageFilter::UseImageDirectionOn ( )

inline

Set the value of UseImageDirection to true or false respectfully.

Definition at line 89 of file sitkGradientRecursiveGaussianImageFilter.h.