itk::simple::GradientImageFilter Class Reference

Computes the gradient of an image using directional derivatives. More...

#include <sitkGradientImageFilter.h>

Inheritance diagram for itk::simple::GradientImageFilter:

Collaboration diagram for itk::simple::GradientImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef GradientImageFilter	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, bool useImageSpacing, bool useImageDirection)
std::string	GetName () const
bool	GetUseImageDirection () const
bool	GetUseImageSpacing () const
	GradientImageFilter ()
Self &	SetUseImageDirection (bool UseImageDirection)
Self &	SetUseImageSpacing (bool UseImageSpacing)
std::string	ToString () const
Self &	UseImageDirectionOff ()
Self &	UseImageDirectionOn ()
Self &	UseImageSpacingOff ()
Self &	UseImageSpacingOn ()
virtual	~GradientImageFilter ()
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_UseImageDirection
bool	m_UseImageSpacing

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 using directional derivatives.

Computes the gradient of an image using directional derivatives. The directional derivative at each pixel location is computed by convolution with a first-order derivative operator.

The second template parameter defines the value type used in the derivative operator (defaults to float). The third template parameter defines the value type used for output image (defaults to float). The output image is defined as a covariant vector image whose value type is specified as this third template parameter.

See also

Image

Neighborhood

NeighborhoodOperator

NeighborhoodIterator

itk::simple::Gradient for the procedural interface

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

Definition at line 52 of file sitkGradientImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 112 of file sitkGradientImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::GradientImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkGradientImageFilter.h.

typedef GradientImageFilter itk::simple::GradientImageFilter::Self

Definition at line 54 of file sitkGradientImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::GradientImageFilter::~GradientImageFilter ( )

virtual

Destructor

itk::simple::GradientImageFilter::GradientImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::GradientImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::GradientImageFilter::Execute	(	const Image &	image1,
		bool	useImageSpacing,
		bool	useImageDirection
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 95 of file sitkGradientImageFilter.h.

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

inline

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives 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 93 of file sitkGradientImageFilter.h.

bool itk::simple::GradientImageFilter::GetUseImageSpacing ( ) const

inline

Definition at line 79 of file sitkGradientImageFilter.h.

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

inline

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives 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 84 of file sitkGradientImageFilter.h.

Self& itk::simple::GradientImageFilter::SetUseImageSpacing ( bool  UseImageSpacing )

inline

Set/Get whether or not the filter will use the spacing of the input image in its calculations

Definition at line 71 of file sitkGradientImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

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

inline

Definition at line 88 of file sitkGradientImageFilter.h.

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

inline

Set the value of UseImageDirection to true or false respectfully.

Definition at line 87 of file sitkGradientImageFilter.h.

Self& itk::simple::GradientImageFilter::UseImageSpacingOff ( )

inline

Definition at line 75 of file sitkGradientImageFilter.h.

Self& itk::simple::GradientImageFilter::UseImageSpacingOn ( )

inline

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 74 of file sitkGradientImageFilter.h.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 116 of file sitkGradientImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::GradientImageFilter::m_MemberFactory

private

Definition at line 118 of file sitkGradientImageFilter.h.

bool itk::simple::GradientImageFilter::m_UseImageDirection

private

Definition at line 122 of file sitkGradientImageFilter.h.

bool itk::simple::GradientImageFilter::m_UseImageSpacing

private

Definition at line 121 of file sitkGradientImageFilter.h.

---

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

• sitkGradientImageFilter.h