ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage > Class Template Reference
Image Gradient Filters | Module ITKImageGradient

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

#include <itkGradientMagnitudeImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef InputImageType::Pointer InputImagePointer
typedef TInputImage InputImageType
typedef TInputImage::PixelType InputPixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef
Superclass::OutputImageRegionType 		OutputImageRegionType
typedef TOutputImage OutputImageType
typedef TOutputImage::PixelType OutputPixelType
typedef SmartPointer< Self > Pointer
typedef NumericTraits
< InputPixelType >::RealType 		RealType
typedef
GradientMagnitudeImageFilter 		Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 		Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void GenerateInputRequestedRegion () throw ( InvalidRequestedRegionError )
virtual const char * GetNameOfClass () const
void SetUseImageSpacingOff ()
void SetUseImageSpacingOn ()
 typedef (Concept::HasNumericTraits< InputPixelType >) InputHasNumericTraitsCheck
virtual void SetUseImageSpacing (bool _arg)
virtual bool GetUseImageSpacing () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TOutputImage::ImageDimension

Protected Member Functions

 GradientMagnitudeImageFilter ()
void PrintSelf (std::ostream &, Indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual ~GradientMagnitudeImageFilter ()

Private Member Functions

 GradientMagnitudeImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

bool m_UseImageSpacing

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
Wiki Examples:

Definition at line 41 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 49 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 71 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 69 of file itkGradientMagnitudeImageFilter.h.

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

Definition at line 60 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 72 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 75 of file itkGradientMagnitudeImageFilter.h.

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

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 70 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 48 of file itkGradientMagnitudeImageFilter.h.

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

Definition at line 61 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 46 of file itkGradientMagnitudeImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 47 of file itkGradientMagnitudeImageFilter.h.

Constructor & Destructor Documentation

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

End concept checking

Definition at line 112 of file itkGradientMagnitudeImageFilter.h.

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

Definition at line 117 of file itkGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TOutputImage >
itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::GradientMagnitudeImageFilter ( const Self &  ) [private]

Member Function Documentation

template<typename TInputImage , typename TOutputImage >
virtual::itk::LightObject::Pointer itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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 ( ) const [virtual]

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

template<typename TInputImage , typename TOutputImage >
static 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 >::operator= ( const Self &  ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

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

template<typename TInputImage , typename TOutputImage >
void itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
ThreadIdType  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 >.

template<typename TInputImage , typename TOutputImage >
itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::typedef ( Concept::HasNumericTraits< InputPixelType >  )

Begin concept checking This class requires InputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< InputPixelType > )

Member Data Documentation

template<typename TInputImage , typename TOutputImage >
const unsigned int itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension [static]

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

Definition at line 66 of file itkGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TOutputImage >
bool itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::m_UseImageSpacing [private]

Definition at line 138 of file itkGradientMagnitudeImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Mon Dec 19 2011 00:05:07 for ITK by doxygen 1.7.4