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::DerivativeImageFilter< TInputImage, TOutputImage > Class Template Reference
Image Feature Extraction Filters | Module ITKImageFeature

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 >:
Collaboration diagram for itk::DerivativeImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef TInputImage InputImageType
typedef
TInputImage::InternalPixelType 		InputInternalPixelType
typedef TInputImage::PixelType InputPixelType
typedef TOutputImage OutputImageType
typedef
TOutputImage::InternalPixelType 		OutputInternalPixelType
typedef TOutputImage::PixelType OutputPixelType
typedef SmartPointer< Self > Pointer
typedef DerivativeImageFilter 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::Signed< OutputPixelType >) SignedOutputPixelType
virtual void SetOrder (unsigned int _arg)
virtual unsigned int GetOrder () const
virtual void SetDirection (unsigned int _arg)
virtual unsigned int GetDirection () const
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

 DerivativeImageFilter ()
void GenerateData ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~DerivativeImageFilter ()

Private Member Functions

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

Private Attributes

unsigned int m_Direction
unsigned int m_Order
bool m_UseImageSpacing

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

itkOrthogonalSwath2DPathFilterTest.cxx.

Definition at line 48 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 56 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 71 of file itkDerivativeImageFilter.h.

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

Definition at line 63 of file itkDerivativeImageFilter.h.

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

Definition at line 62 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 72 of file itkDerivativeImageFilter.h.

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

Definition at line 61 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 60 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 55 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 53 of file itkDerivativeImageFilter.h.

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

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

Definition at line 54 of file itkDerivativeImageFilter.h.

Constructor & Destructor Documentation

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

Definition at line 124 of file itkDerivativeImageFilter.h.

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

Definition at line 131 of file itkDerivativeImageFilter.h.

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

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::DerivativeImageFilter< 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<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 unsigned int itk::DerivativeImageFilter< TInputImage, TOutputImage >::GetDirection ( ) const [virtual]

End concept checking Standard get/set macros for filter parameters.

template<class TInputImage , class TOutputImage >
virtual const char* itk::DerivativeImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) 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 >::GetOrder ( ) const [virtual]

End concept checking Standard get/set macros for filter parameters.

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

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

template<class TInputImage , class TOutputImage >
static 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 >::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<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]

End concept checking Standard get/set macros for filter parameters.

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

End concept checking 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 104 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 99 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >
itk::DerivativeImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Signed< OutputPixelType >  )

The output pixel type must be signed. Begin concept checking This class requires SignedOutputPixelType in the form of ( Concept::Signed< OutputPixelType > )

Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int itk::DerivativeImageFilter< 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 68 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned int itk::DerivativeImageFilter< TInputImage, TOutputImage >::m_Direction [private]

The direction of the derivative.

Definition at line 149 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned int itk::DerivativeImageFilter< TInputImage, TOutputImage >::m_Order [private]

The order of the derivative.

Definition at line 146 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >
bool itk::DerivativeImageFilter< TInputImage, TOutputImage >::m_UseImageSpacing [private]

Definition at line 151 of file itkDerivativeImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Sun Dec 18 2011 23:51:41 for ITK by doxygen 1.7.4