itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage > Class Template Reference
[Image Gradient Filters]

Computes the gradient magnitude of an image region at each pixel. More...

#include <itkGradientMagnitudeImageFilter.h>

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

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

[legend]List of all members.

Public Types
typedef GradientMagnitudeImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TOutputImage::PixelType	OutputPixelType
typedef TInputImage::PixelType	InputPixelType
typedef NumericTraits< InputPixelType >::RealType	RealType
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef OutputImageType::Pointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual void	GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
void	SetUseImageSpacingOn ()
void	SetUseImageSpacingOff ()
virtual void	SetUseImageSpacing (bool _arg)
virtual bool	GetUseImageSpacing ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	GradientMagnitudeImageFilter ()
virtual	~GradientMagnitudeImageFilter ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
void	PrintSelf (std::ostream &, Indent) const

---

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >

Computes the gradient magnitude of an image region at each pixel.

See also:

Image

Neighborhood

NeighborhoodOperator

NeighborhoodIterator

Definition at line 37 of file itkGradientMagnitudeImageFilter.h.

---

Member Typedef Documentation

template<typename TInputImage, typename TOutputImage> typedef SmartPointer<const Self> itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ConstPointer

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

template<typename TInputImage, typename TOutputImage> typedef InputImageType::Pointer itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::InputImagePointer

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

template<typename TInputImage, typename TOutputImage> typedef TInputImage itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::InputImageType

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

template<typename TInputImage, typename TOutputImage> typedef TInputImage::PixelType itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 56 of file itkGradientMagnitudeImageFilter.h.

template<typename TInputImage, typename TOutputImage> typedef OutputImageType::Pointer itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 68 of file itkGradientMagnitudeImageFilter.h.

template<typename TInputImage, typename TOutputImage> typedef Superclass::OutputImageRegionType itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 71 of file itkGradientMagnitudeImageFilter.h. Referenced by itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::~GradientMagnitudeImageFilter().

template<typename TInputImage, typename TOutputImage> typedef TOutputImage itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::OutputImageType

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

template<typename TInputImage, typename TOutputImage> typedef TOutputImage::PixelType itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::OutputPixelType

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

template<typename TInputImage, typename TOutputImage> typedef SmartPointer<Self> itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::Pointer

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

template<typename TInputImage, typename TOutputImage> typedef NumericTraits<InputPixelType>::RealType itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::RealType

Definition at line 57 of file itkGradientMagnitudeImageFilter.h.

template<typename TInputImage, typename TOutputImage> typedef GradientMagnitudeImageFilter itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::Self

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

template<typename TInputImage, typename TOutputImage> typedef ImageToImageFilter< TInputImage, TOutputImage > itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::Superclass

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

---

Constructor & Destructor Documentation

template<typename TInputImage, typename TOutputImage> itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::GradientMagnitudeImageFilter (   )  [inline, protected]

Definition at line 100 of file itkGradientMagnitudeImageFilter.h.

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

Definition at line 104 of file itkGradientMagnitudeImageFilter.h. References itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::OutputImageRegionType, and itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::Self.

---

Member Function Documentation

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

GradientMagnitudeImageFilter needs a larger input requested region than the output requested region (larger by the kernel size to calculate derivatives). As such, GradientMagnitudeImageFilter 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<typename TInputImage, typename TOutputImage> virtual const char* itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::GetNameOfClass (   )  const [virtual]

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

template<typename TInputImage, typename TOutputImage> virtual bool itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::GetUseImageSpacing (   )  [virtual]

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

template<typename TInputImage, typename TOutputImage> itk::GradientMagnitudeImageFilter< 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<typename TInputImage, typename TOutputImage> Pointer itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::New (   )  [static]

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

template<typename TInputImage, typename TOutputImage> void itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::PrintSelf (  std::ostream &  , 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<typename TInputImage, typename TOutputImage> virtual void itk::GradientMagnitudeImageFilter< 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<typename TInputImage, typename TOutputImage> void itk::GradientMagnitudeImageFilter< 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 90 of file itkGradientMagnitudeImageFilter.h.

template<typename TInputImage, typename TOutputImage> void itk::GradientMagnitudeImageFilter< 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 85 of file itkGradientMagnitudeImageFilter.h.

template<typename TInputImage, typename TOutputImage> void itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData (  const OutputImageRegionType &  outputRegionForThread, int  threadId )  [protected, virtual]

GradientMagnitudeImageFilter 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:

• itkGradientMagnitudeImageFilter.h

---