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

#include <itkGaussianOperator.h>

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

List of all members.

Public Types

typedef GaussianOperator Self
typedef NeighborhoodOperator
< TPixel, VDimension,
TAllocator > 
Superclass

Public Member Functions

 GaussianOperator ()
double GetMaximumError ()
unsigned int GetMaximumKernelWidth () const
double GetVariance ()
void SetMaximumError (const double &max_error)
void SetMaximumKernelWidth (unsigned int n)
void SetVariance (const double &variance)
 GaussianOperator (const Self &other)
Selfoperator= (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 ()
double ModifiedBesselI (int, double)
double ModifiedBesselI0 (double)
double ModifiedBesselI1 (double)

Private Member Functions

const char * GetNameOfClass ()

Private Attributes

double m_MaximumError
unsigned int m_MaximumKernelWidth
double m_Variance

Detailed Description

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

A NeighborhoodOperator whose coefficients are a one dimensional, discrete Gaussian kernel.

GaussianOperator can be used to perform Gaussian blurring by taking its inner product with to a Neighborhood (NeighborhooIterator) that is swept across an image region. It is a directional operator. N successive applications oriented along each dimensional direction will effect separable, efficient, N-D Gaussian blurring of an image region.

GaussianOperator takes two parameters:

(1) The floating-point variance of the desired Gaussian function.

(2) The "maximum error" allowed in the discrete Gaussian function. "Maximum errror" is defined as the difference between the area under the discrete Gaussian curve and the area under the continuous Gaussian. Maximum error affects the Gaussian operator size. Care should be taken not to make this value too small relative to the variance lest the operator size become unreasonably large.

References: The Gaussian kernel contained in this operator was described by Tony Lindeberg (Discrete Scale-Space Theory and the Scale-Space Primal Sketch. Dissertation. Royal Institute of Technology, Stockholm, Sweden. May 1991.).

See also:
NeighborhoodOperator
NeighborhoodIterator
Neighborhood
Wiki Examples:

Definition at line 67 of file itkGaussianOperator.h.


Member Typedef Documentation

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

Typedef support for coefficient vector type. Necessary to fix bug in the microsoft VC++ compiler.

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

Definition at line 154 of file itkGaussianOperator.h.

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

Standard class typedefs.

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

Definition at line 73 of file itkGaussianOperator.h.

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

Constructor & Destructor Documentation

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

Constructor.

Definition at line 77 of file itkGaussianOperator.h.

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

Copy constructor

Definition at line 80 of file itkGaussianOperator.h.


Member Function Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::GaussianOperator< 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 172 of file itkGaussianOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
CoefficientVector itk::GaussianOperator< 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 >>
double itk::GaussianOperator< TPixel, VDimension, TAllocator >::GetMaximumError ( ) [inline]

Returns the maximum error of the gaussian approximation. Maximum error is the difference between the area under the discrete Gaussian curve and the area under the continuous Gaussian. Maximum error affects the Gaussian operator size.

Definition at line 128 of file itkGaussianOperator.h.

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

Returns the maximum allowed kernel width.

Definition at line 139 of file itkGaussianOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
const char* itk::GaussianOperator< TPixel, VDimension, TAllocator >::GetNameOfClass ( ) [inline, private]

For compatibility with itkWarningMacro

Definition at line 189 of file itkGaussianOperator.h.

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

Returns the variance of the Gaussian (scale) for the operator.

Definition at line 121 of file itkGaussianOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
double itk::GaussianOperator< TPixel, VDimension, TAllocator >::ModifiedBesselI ( int  ,
double   
) [protected]

Returns the value of the modified Bessel function Ik(x) at a point x>=0, where k>=2.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
double itk::GaussianOperator< TPixel, VDimension, TAllocator >::ModifiedBesselI0 ( double  ) [protected]

Returns the value of the modified Bessel function I0(x) at a point x >= 0.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
double itk::GaussianOperator< TPixel, VDimension, TAllocator >::ModifiedBesselI1 ( double  ) [protected]

Returns the value of the modified Bessel function I1(x) at a point x, x real.

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

Assignment operator

Definition at line 90 of file itkGaussianOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
virtual void itk::GaussianOperator< 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 143 of file itkGaussianOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::GaussianOperator< TPixel, VDimension, TAllocator >::SetMaximumError ( const double &  max_error) [inline]

Sets the desired maximum error of the gaussian approximation. Maximum error is the difference between the area under the discrete Gaussian curve and the area under the continuous Gaussian. Maximum error affects the Gaussian operator size. The value must be between 0.0 and 1.0.

Definition at line 110 of file itkGaussianOperator.h.

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

Sets a limit for growth of the kernel. Small maximum error values with large variances will yield very large kernel sizes. This value can be used to truncate a kernel in such instances. A warning will be given on truncation of the kernel.

Definition at line 135 of file itkGaussianOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::GaussianOperator< TPixel, VDimension, TAllocator >::SetVariance ( const double &  variance) [inline]

Sets the desired variance of the Gaussian kernel.

Definition at line 101 of file itkGaussianOperator.h.


Member Data Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
double itk::GaussianOperator< TPixel, VDimension, TAllocator >::m_MaximumError [private]

Difference between the areas under the curves of the continuous and discrete Gaussian functions.

Definition at line 181 of file itkGaussianOperator.h.

Referenced by itk::GaussianOperator< ScalarType, Superclass::Dimension >::GaussianOperator(), and itk::GaussianOperator< ScalarType, Superclass::Dimension >::operator=().

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

Maximum kernel size allowed. This value is used to truncate a kernel that has grown too large. A warning is given when the specified maximum error causes the kernel to exceed this size.

Definition at line 186 of file itkGaussianOperator.h.

Referenced by itk::GaussianOperator< ScalarType, Superclass::Dimension >::GaussianOperator(), and itk::GaussianOperator< ScalarType, Superclass::Dimension >::operator=().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
double itk::GaussianOperator< TPixel, VDimension, TAllocator >::m_Variance [private]

The documentation for this class was generated from the following file: