itk::DerivativeImageFilter< TInputImage, TOutputImage > Class Template Reference
[Image Feature Extraction Filters]

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

Inheritance diagram for itk::DerivativeImageFilter< TInputImage, TOutputImage >:

[legend]Collaboration diagram for itk::DerivativeImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef DerivativeImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TOutputImage::PixelType	OutputPixelType
typedef TOutputImage::InternalPixelType	OutputInternalPixelType
typedef TInputImage::PixelType	InputPixelType
typedef TInputImage::InternalPixelType	InputInternalPixelType
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
enum	{ SignedOutputPixelType = 0 }
Public Member Functions
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual const char *	GetClassName () const
void	SetUseImageSpacingOn ()
void	SetUseImageSpacingOff ()
virtual void	GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
virtual void	SetOrder (unsigned int _arg)
virtual unsigned int	GetOrder ()
virtual void	SetDirection (unsigned int _arg)
virtual unsigned int	GetDirection ()
virtual void	SetUseImageSpacing (bool _arg)
virtual bool	GetUseImageSpacing ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	DerivativeImageFilter ()
virtual	~DerivativeImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateData ()

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::DerivativeImageFilter< TInputImage, TOutputImage >

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

Definition at line 44 of file itkDerivativeImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage> typedef SmartPointer<const Self> itk::DerivativeImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 52 of file itkDerivativeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage itk::DerivativeImageFilter< TInputImage, TOutputImage >::InputImageType

Image typedef support. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 67 of file itkDerivativeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage::InternalPixelType itk::DerivativeImageFilter< TInputImage, TOutputImage >::InputInternalPixelType

Definition at line 59 of file itkDerivativeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage::PixelType itk::DerivativeImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 58 of file itkDerivativeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage itk::DerivativeImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 68 of file itkDerivativeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::InternalPixelType itk::DerivativeImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType

Definition at line 57 of file itkDerivativeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::PixelType itk::DerivativeImageFilter< TInputImage, TOutputImage >::OutputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same. Definition at line 56 of file itkDerivativeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef SmartPointer<Self> itk::DerivativeImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 51 of file itkDerivativeImageFilter.h.

template<class TInputImage, class TOutputImage> typedef DerivativeImageFilter itk::DerivativeImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 49 of file itkDerivativeImageFilter.h. Referenced by itk::DerivativeImageFilter< TInputImage, TOutputImage >::~DerivativeImageFilter().

template<class TInputImage, class TOutputImage> typedef ImageToImageFilter< TInputImage, TOutputImage > itk::DerivativeImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 50 of file itkDerivativeImageFilter.h.

---

Member Enumeration Documentation

template<class TInputImage, class TOutputImage> anonymous enum

The output pixel type must be signed. Enumeration values: SignedOutputPixelType  Definition at line 77 of file itkDerivativeImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage> itk::DerivativeImageFilter< TInputImage, TOutputImage >::DerivativeImageFilter (   )  [inline, protected]

Definition at line 112 of file itkDerivativeImageFilter.h.

template<class TInputImage, class TOutputImage> virtual itk::DerivativeImageFilter< TInputImage, TOutputImage >::~DerivativeImageFilter (   )  [inline, protected, virtual]

Definition at line 118 of file itkDerivativeImageFilter.h. References itk::DerivativeImageFilter< TInputImage, TOutputImage >::Self.

---

Member Function Documentation

template<class TInputImage, class TOutputImage> void itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateData (   )  [protected, virtual]

Standard pipeline method. While this class does not implement a ThreadedGenerateData(), its GenerateData() delegates all calculations to an NeighborhoodOperatorImageFilter. Since the NeighborhoodOperatorImageFilter is multithreaded, this filter is multithreaded by default. Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (   )  throw (InvalidRequestedRegionError) [virtual]

DerivativeImageFilter needs a larger input requested region than the output requested region (larger in the direction of the derivative). As such, DerivativeImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model. See also: ImageToImageFilter::GenerateInputRequestedRegion() Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual const char* itk::DerivativeImageFilter< TInputImage, TOutputImage >::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual unsigned int itk::DerivativeImageFilter< TInputImage, TOutputImage >::GetDirection (   )  [virtual]

Standard get/set macros for filter parameters.

template<class TInputImage, class TOutputImage> virtual unsigned int itk::DerivativeImageFilter< TInputImage, TOutputImage >::GetOrder (   )  [virtual]

Standard get/set macros for filter parameters.

template<class TInputImage, class TOutputImage> virtual bool itk::DerivativeImageFilter< TInputImage, TOutputImage >::GetUseImageSpacing (   )  [virtual]

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

template<class TInputImage, class TOutputImage> itk::DerivativeImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TOutputImage::ImageDimension  )

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

template<class TInputImage, class TOutputImage> Pointer itk::DerivativeImageFilter< TInputImage, TOutputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage> void itk::DerivativeImageFilter< TInputImage, TOutputImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::DerivativeImageFilter< TInputImage, TOutputImage >::SetDirection (  unsigned int  _arg  )  [virtual]

Standard get/set macros for filter parameters.

template<class TInputImage, class TOutputImage> virtual void itk::DerivativeImageFilter< TInputImage, TOutputImage >::SetOrder (  unsigned int  _arg  )  [virtual]

Standard get/set macros for filter parameters.

template<class TInputImage, class TOutputImage> virtual void itk::DerivativeImageFilter< TInputImage, TOutputImage >::SetUseImageSpacing (  bool  _arg  )  [virtual]

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

template<class TInputImage, class TOutputImage> void itk::DerivativeImageFilter< TInputImage, TOutputImage >::SetUseImageSpacingOff (   )  [inline]

Ignore the image spacing. Use this option if you want derivatives in isotropic pixel space. Default is UseImageSpacingOn. Definition at line 93 of file itkDerivativeImageFilter.h.

template<class TInputImage, class TOutputImage> void itk::DerivativeImageFilter< TInputImage, TOutputImage >::SetUseImageSpacingOn (   )  [inline]

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOn. Definition at line 88 of file itkDerivativeImageFilter.h.

---

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

• itkDerivativeImageFilter.h

---