itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType > Class Template Reference
[Image Gradient Filters]

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

#include <itkGradientImageFilter.h>

Inheritance diagram for itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >:

[legend]Collaboration diagram for itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >:

[legend]List of all members.

Public Types
typedef GradientImageFilter	Self
typedef TInputImage	InputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef Image< CovariantVector< TOutputValueType, itkGetStaticConstMacro(OutputImageDimension)>, itkGetStaticConstMacro(OutputImageDimension)	OutputImageType )
typedef OutputImageType::Pointer	OutputImagePointer
typedef ImageToImageFilter< InputImageType, OutputImageType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::PixelType	InputPixelType
typedef TOperatorValueType	OperatorValueType
typedef TOutputValueType	OutputValueType
typedef CovariantVector< OutputValueType, itkGetStaticConstMacro(OutputImageDimension)	OutputPixelType )
typedef OutputImageType::RegionType	OutputImageRegionType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
void	SetUseImageSpacingOn ()
void	SetUseImageSpacingOff ()
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void	SetUseImageSpacing (bool _arg)
virtual bool	GetUseImageSpacing ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	GradientImageFilter ()
virtual	~GradientImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float>
class itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >

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

Definition at line 48 of file itkGradientImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef SmartPointer<const Self> itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ConstPointer

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

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef InputImageType::Pointer itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::InputImagePointer

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

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef TInputImage itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::InputImageType

Convenient typedefs for simplifying declarations. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 64 of file itkGradientImageFilter.h.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef InputImageType::PixelType itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::InputPixelType

Image typedef support. Definition at line 81 of file itkGradientImageFilter.h.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef TOperatorValueType itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::OperatorValueType

Definition at line 82 of file itkGradientImageFilter.h.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef OutputImageType::Pointer itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 67 of file itkGradientImageFilter.h.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef OutputImageType::RegionType itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 85 of file itkGradientImageFilter.h. Referenced by itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::~GradientImageFilter().

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef Image<CovariantVector<TOutputValueType, itkGetStaticConstMacro(OutputImageDimension)>, itkGetStaticConstMacro(OutputImageDimension) itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::OutputImageType)

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

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef CovariantVector<OutputValueType, itkGetStaticConstMacro(OutputImageDimension) itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::OutputPixelType)

Definition at line 84 of file itkGradientImageFilter.h.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef TOutputValueType itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::OutputValueType

Definition at line 83 of file itkGradientImageFilter.h.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef SmartPointer<Self> itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::Pointer

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

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef GradientImageFilter itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 61 of file itkGradientImageFilter.h. Referenced by itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::~GradientImageFilter().

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> typedef ImageToImageFilter< InputImageType, OutputImageType> itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::Superclass

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 70 of file itkGradientImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GradientImageFilter (   )  [inline, protected]

Definition at line 112 of file itkGradientImageFilter.h.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> virtual itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::~GradientImageFilter (   )  [inline, protected, virtual]

Definition at line 116 of file itkGradientImageFilter.h. References itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::OutputImageRegionType, and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::Self.

---

Member Function Documentation

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> virtual void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GenerateInputRequestedRegion (   )  throw (InvalidRequestedRegionError) [virtual]

GradientImageFilter needs a larger input requested region than the output requested region. As such, GradientImageFilter 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 TOperatorValueType = float, class TOutputValueType = float> virtual const char* itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GetNameOfClass (   )  const [virtual]

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

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> virtual bool itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GetUseImageSpacing (   )  [virtual]

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

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::itkStaticConstMacro (  OutputImageDimension  , unsigned  int, TInputImage::ImageDimension  )

Extract dimension from input image.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::itkStaticConstMacro (  InputImageDimension  , unsigned  int, TInputImage::ImageDimension  )

Extract dimension from input image. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> Pointer itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::New (   )  [static]

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

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::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 TOperatorValueType = float, class TOutputValueType = float> virtual void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::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 TOperatorValueType = float, class TOutputValueType = float> void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::SetUseImageSpacingOff (   )  [inline]

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

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::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 97 of file itkGradientImageFilter.h.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float> void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData (  const OutputImageRegionType &  outputRegionForThread, int  threadId )  [protected, virtual]

GradientImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread" See also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData() Reimplemented from itk::ImageSource< TOutputImage >.

---

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

• itkGradientImageFilter.h

---