ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Attributes
itk::DerivativeOperator< TPixel, VDimension, TAllocator > Class Template Reference
Operators | Module ITKCommon

#include <itkDerivativeOperator.h>

+ Inheritance diagram for itk::DerivativeOperator< TPixel, VDimension, TAllocator >:
+ Collaboration diagram for itk::DerivativeOperator< TPixel, VDimension, TAllocator >:

List of all members.

Public Types

typedef Superclass::PixelRealType PixelRealType
typedef Superclass::PixelType PixelType
typedef DerivativeOperator Self
typedef NeighborhoodOperator
< TPixel, VDimension,
TAllocator > 		Superclass

Public Member Functions

 DerivativeOperator ()
 DerivativeOperator (const Self &other)
unsigned int GetOrder () const
void SetOrder (const unsigned int &order)
Self & operator= (const Self &other)
virtual void PrintSelf (std::ostream &os, Indent i) const

Protected Types

typedef
Superclass::CoefficientVector 		CoefficientVector

Protected Member Functions

void Fill (const CoefficientVector &coeff)
CoefficientVector GenerateCoefficients ()

Private Attributes

unsigned int m_Order

Detailed Description

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
class itk::DerivativeOperator< TPixel, VDimension, TAllocator >

A NeighborhoodOperator for taking an n-th order derivative at a pixel.

DerivativeOperator's coefficients are a tightest-fitting convolution kernel for calculating the n-th order directional derivative at a pixel. DerivativeOperator is a directional NeighborhoodOperator that should be applied to a Neighborhood or NeighborhoodPointer using the inner product method.

An example operator to compute X derivatives of a 2D image can be created with: 

       typedef itk::DerivativeOperator<float, 2> DerivativeOperatorType;
       DerivativeOperatorType derivativeOperator;
       derivativeOperator.SetDirection(0); // X dimension
       itk::Size<2> radius;
       radius.Fill(1); // A radius of 1 in both dimensions is a 3x3 operator
       derivativeOperator.CreateToRadius(radius);

and creates a kernel that looks like: 

       0        0 0
       0.5  0   -0.5
       0    0   0
See also:
NeighborhoodOperator
Neighborhood
ForwardDifferenceOperator
BackwardDifferenceOperator
Wiki Examples:

Definition at line 67 of file itkDerivativeOperator.h.

Member Typedef Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef Superclass::CoefficientVector itk::DerivativeOperator< TPixel, VDimension, TAllocator >::CoefficientVector [protected]

Typedef support for coefficient vector type. Necessary to work around compiler bug on VC++.

Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

Definition at line 118 of file itkDerivativeOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef Superclass::PixelRealType itk::DerivativeOperator< TPixel, VDimension, TAllocator >::PixelRealType

Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

Definition at line 78 of file itkDerivativeOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef Superclass::PixelType itk::DerivativeOperator< TPixel, VDimension, TAllocator >::PixelType

External support for pixel type

Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

Definition at line 77 of file itkDerivativeOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef DerivativeOperator itk::DerivativeOperator< TPixel, VDimension, TAllocator >::Self

Standard class typedefs.

Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

Definition at line 73 of file itkDerivativeOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef NeighborhoodOperator< TPixel, VDimension, TAllocator > itk::DerivativeOperator< TPixel, VDimension, TAllocator >::Superclass

Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

Definition at line 75 of file itkDerivativeOperator.h.

Constructor & Destructor Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
itk::DerivativeOperator< TPixel, VDimension, TAllocator >::DerivativeOperator ( ) [inline]

Constructor.

Definition at line 81 of file itkDerivativeOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
itk::DerivativeOperator< TPixel, VDimension, TAllocator >::DerivativeOperator ( const Self &  other) [inline]

Copy constructor.

Definition at line 84 of file itkDerivativeOperator.h.

Member Function Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::DerivativeOperator< TPixel, VDimension, TAllocator >::Fill ( const CoefficientVector &  coeff) [inline, protected, virtual]

Arranges coefficients spatially in the memory buffer.

Implements itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

Definition at line 124 of file itkDerivativeOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
CoefficientVector itk::DerivativeOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients ( ) [protected, virtual]

Calculates operator coefficients.

Implements itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
unsigned int itk::DerivativeOperator< TPixel, VDimension, TAllocator >::GetOrder ( ) const [inline]

Returns the order of the derivative.

Definition at line 104 of file itkDerivativeOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
Self& itk::DerivativeOperator< TPixel, VDimension, TAllocator >::operator= ( const Self &  other) [inline]

Assignment operator

Definition at line 89 of file itkDerivativeOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
virtual void itk::DerivativeOperator< TPixel, VDimension, TAllocator >::PrintSelf ( std::ostream &  os,
Indent  i 
) const [inline, virtual]

Prints some debugging information

Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

Definition at line 107 of file itkDerivativeOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::DerivativeOperator< TPixel, VDimension, TAllocator >::SetOrder ( const unsigned int &  order) [inline]

Sets the order of the derivative.

Definition at line 98 of file itkDerivativeOperator.h.

Member Data Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
unsigned int itk::DerivativeOperator< TPixel, VDimension, TAllocator >::m_Order [private]

Order of the derivative.

Definition at line 129 of file itkDerivativeOperator.h.

Referenced by itk::DerivativeOperator< PixelType, itkGetStaticConstMacro(ImageDimension) >::DerivativeOperator(), and itk::DerivativeOperator< PixelType, itkGetStaticConstMacro(ImageDimension) >::operator=().

The documentation for this class was generated from the following file:
Generated on Thu Mar 1 2012 23:57:55 for ITK by doxygen 1.7.6.1