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:

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 54 of file sitkDerivativeImageFilter.h.

Public Types
using	PixelIDTypeList = RealPixelIDTypeList

using	Self = DerivativeImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	DerivativeImageFilter ()

Image	Execute (const Image &image1)

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

template<class TImageType >
Image	ExecuteInternalVectorImage (const Image &image)

Private Attributes
unsigned int	m_Direction {0u}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

unsigned int	m_Order {1u}

bool	m_UseImageSpacing {true}

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 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::DerivativeImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 118 of file sitkDerivativeImageFilter.h.

◆ PixelIDTypeList

using itk::simple::DerivativeImageFilter::PixelIDTypeList = RealPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 66 of file sitkDerivativeImageFilter.h.

◆ Self

using itk::simple::DerivativeImageFilter::Self = DerivativeImageFilter

Definition at line 56 of file sitkDerivativeImageFilter.h.

Constructor & Destructor Documentation

◆ ~DerivativeImageFilter()

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

virtual

Destructor

◆ DerivativeImageFilter()

itk::simple::DerivativeImageFilter::DerivativeImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

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

private

◆ ExecuteInternalVectorImage()

template<class TImageType >

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

private

Dispatched methods which calls ExecuteInternal on each component

◆ GetDirection()

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 77 of file sitkDerivativeImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 104 of file sitkDerivativeImageFilter.h.

◆ GetOrder()

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 87 of file sitkDerivativeImageFilter.h.

◆ GetUseImageSpacing()

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. Use On to compute the derivatives in physical space; use Off to ignore the image spacing and to compute the derivatives in isotropic voxel space. Default is On.

Definition at line 101 of file sitkDerivativeImageFilter.h.

◆ SetDirection()

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 72 of file sitkDerivativeImageFilter.h.

◆ SetOrder()

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 82 of file sitkDerivativeImageFilter.h.

◆ SetUseImageSpacing()

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. Use On to compute the derivatives in physical space; use Off to ignore the image spacing and to compute the derivatives in isotropic voxel space. Default is On.

Definition at line 92 of file sitkDerivativeImageFilter.h.