Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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:

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

Collaboration graph
[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< SelfPointer
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 Methods

virtual const char * GetClassName () const
virtual void GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
 itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
 itkStaticConstMacro (OutputImageDimension, unsigned int, TInputImage::ImageDimension)

Static Public Methods

Pointer New ()

Protected Methods

 GradientImageFilter ()
virtual ~GradientImageFilter ()
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.

Todo:
Take into account the Spacing of the pixels

See also:
Image , Neighborhood , NeighborhoodOperator , NeighborhoodIterator

Definition at line 49 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, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 73 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, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 66 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, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 65 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 82 of file itkGradientImageFilter.h.

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

Definition at line 83 of file itkGradientImageFilter.h.

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

Definition at line 68 of file itkGradientImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 86 of file itkGradientImageFilter.h.

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

Definition at line 67 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 85 of file itkGradientImageFilter.h.

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

Definition at line 84 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, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 72 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, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 62 of file itkGradientImageFilter.h.

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, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 71 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 97 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 98 of file itkGradientImageFilter.h.


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, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float>
virtual const char* itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GetClassName   const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

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, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

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::ImageToImageFilter< TInputImage, Image< CovariantVector< TOutputValueType,::itk::GetImageDimension< TInputImage >::ImageDimension >,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

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

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


The documentation for this class was generated from the following file:
Generated at Wed Mar 12 01:16:36 2003 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000