itk::simple::DerivativeImageFilter Class Reference

Computes the directional derivative of an image. The directional derivative at each pixel location is computed by convolution with a derivative operator of user-specified order. More...

#include <sitkDerivativeImageFilter.h>

Inheritance diagram for itk::simple::DerivativeImageFilter:

Collaboration diagram for itk::simple::DerivativeImageFilter:

Public Types
typedef RealPixelIDTypeList	PixelIDTypeList
typedef DerivativeImageFilter	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
	DerivativeImageFilter ()
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, unsigned int direction, unsigned int order, bool useImageSpacing)
unsigned int	GetDirection () const
std::string	GetName () const
unsigned int	GetOrder () const
bool	GetUseImageSpacing () const
Self &	SetDirection (unsigned int Direction)
Self &	SetOrder (unsigned int Order)
Self &	SetUseImageSpacing (bool UseImageSpacing)
std::string	ToString () const
Self &	UseImageSpacingOff ()
Self &	UseImageSpacingOn ()
virtual	~DerivativeImageFilter ()
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)
template<class TImageType >
Image	ExecuteInternalVectorImage (const Image &image)

Private Attributes
unsigned int	m_Direction
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
unsigned int	m_Order
bool	m_UseImageSpacing

Friends
struct	detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >
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 directional derivative of an image. The directional derivative at each pixel location is computed by convolution with a derivative operator of user-specified order.

SetOrder specifies the order of the derivative.

SetDirection specifies the direction of the derivative with respect to the coordinate axes of the image.

See also

Image

Neighborhood

NeighborhoodOperator

NeighborhoodIterator

itk::simple::Derivative for the procedural interface

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

Definition at line 52 of file sitkDerivativeImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 119 of file sitkDerivativeImageFilter.h.

typedef RealPixelIDTypeList itk::simple::DerivativeImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkDerivativeImageFilter.h.

typedef DerivativeImageFilter itk::simple::DerivativeImageFilter::Self

Definition at line 54 of file sitkDerivativeImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::DerivativeImageFilter::~DerivativeImageFilter ( )

virtual

Destructor

itk::simple::DerivativeImageFilter::DerivativeImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::DerivativeImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::DerivativeImageFilter::Execute	(	const Image &	image1,
		unsigned int	direction,
		unsigned int	order,
		bool	useImageSpacing
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

template<class TImageType >

Image itk::simple::DerivativeImageFilter::ExecuteInternalVectorImage ( const Image &  image )

private

Dispatched methods which calls ExecuteInteral on each component

unsigned int itk::simple::DerivativeImageFilter::GetDirection ( ) const

inline

The output pixel type must be signed. Standard get/set macros for filter parameters.

Definition at line 76 of file sitkDerivativeImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 102 of file sitkDerivativeImageFilter.h.

unsigned int itk::simple::DerivativeImageFilter::GetOrder ( ) const

inline

The output pixel type must be signed. Standard get/set macros for filter parameters.

Definition at line 86 of file sitkDerivativeImageFilter.h.

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

inline

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

Definition at line 100 of file sitkDerivativeImageFilter.h.

Self& itk::simple::DerivativeImageFilter::SetDirection ( unsigned int  Direction )

inline

The output pixel type must be signed. Standard get/set macros for filter parameters.

Definition at line 71 of file sitkDerivativeImageFilter.h.

Self& itk::simple::DerivativeImageFilter::SetOrder ( unsigned int  Order )

inline

The output pixel type must be signed. Standard get/set macros for filter parameters.

Definition at line 81 of file sitkDerivativeImageFilter.h.

Self& itk::simple::DerivativeImageFilter::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 91 of file sitkDerivativeImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

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

inline

Definition at line 95 of file sitkDerivativeImageFilter.h.

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

inline

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 94 of file sitkDerivativeImageFilter.h.

Friends And Related Function Documentation

friend struct detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

friend

Definition at line 125 of file sitkDerivativeImageFilter.h.

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 124 of file sitkDerivativeImageFilter.h.

Member Data Documentation

unsigned int itk::simple::DerivativeImageFilter::m_Direction

private

Definition at line 129 of file sitkDerivativeImageFilter.h.

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

private

Definition at line 126 of file sitkDerivativeImageFilter.h.

unsigned int itk::simple::DerivativeImageFilter::m_Order

private

Definition at line 130 of file sitkDerivativeImageFilter.h.

bool itk::simple::DerivativeImageFilter::m_UseImageSpacing

private

Definition at line 131 of file sitkDerivativeImageFilter.h.

---

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

• sitkDerivativeImageFilter.h