itkGaussianOperator.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkGaussianOperator.h,v $
  Language:  C++
  Date:      $Date: 2008-10-17 01:08:45 $
  Version:   $Revision: 1.26 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkGaussianOperator_h
#define __itkGaussianOperator_h

#include "itkNeighborhoodOperator.h"
#include <math.h>
namespace itk {

template<class TPixel,unsigned int VDimension=2,
  class TAllocator = NeighborhoodAllocator<TPixel> >
class ITK_EXPORT GaussianOperator
  : public NeighborhoodOperator<TPixel, VDimension, TAllocator>
{
public:
  typedef GaussianOperator                                        Self;
  typedef NeighborhoodOperator<TPixel, VDimension, TAllocator>    Superclass;

  GaussianOperator() : m_Variance(1), m_MaximumError(.01), m_MaximumKernelWidth(30) { }

  GaussianOperator(const Self &other)
    : NeighborhoodOperator<TPixel, VDimension, TAllocator>(other)
    {
    m_Variance = other.m_Variance;
    m_MaximumError = other.m_MaximumError;
    m_MaximumKernelWidth = other.m_MaximumKernelWidth;
    }

  Self &operator=(const Self &other)
  {
    Superclass::operator=(other);
    m_Variance = other.m_Variance;
    m_MaximumError = other.m_MaximumError;
    m_MaximumKernelWidth = other.m_MaximumKernelWidth;
    return *this;
  }

  void SetVariance(const double &variance)
    {
    m_Variance = variance;
    }

  void SetMaximumError(const double &max_error)
    {
    if (max_error >= 1 || max_error <= 0)
      {
      itkExceptionMacro("Maximum Error Must be in the range [ 0.0 , 1.0 ]");
      }

    m_MaximumError = max_error;
    }

  double GetVariance()
    {  return m_Variance;  }

  double GetMaximumError()
    {    return m_MaximumError;  }

  void SetMaximumKernelWidth( unsigned int n )
    {    m_MaximumKernelWidth = n; }

  unsigned int GetMaximumKernelWidth() const
    {   return m_MaximumKernelWidth; }

  virtual void PrintSelf(std::ostream &os, Indent i) const
  {
    os << i << "GaussianOperator { this=" << this
       << ", m_Variance = " << m_Variance
       << ", m_MaximumError = " << m_MaximumError
       << "} "  << std::endl;
    Superclass::PrintSelf(os, i.GetNextIndent());
  }

protected:
  typedef typename Superclass::CoefficientVector CoefficientVector;

  double ModifiedBesselI0(double);

  double ModifiedBesselI1(double);

  double ModifiedBesselI(int, double);

  CoefficientVector GenerateCoefficients();

  void Fill(const CoefficientVector& coeff)
  {    this->FillCenteredDirectional(coeff);  }

private:
  double m_Variance;

  double m_MaximumError;

  unsigned int m_MaximumKernelWidth;

  const char *GetNameOfClass()
    { return "itkGaussianOperator"; }

};

} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_GaussianOperator(_, EXPORT, x, y) namespace itk { \
  _(2(class EXPORT GaussianOperator< ITK_TEMPLATE_2 x >)) \
  namespace Templates { typedef GaussianOperator< ITK_TEMPLATE_2 x > \
                                                  GaussianOperator##y; } \
  }

#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkGaussianOperator+-.h"
#endif

#if ITK_TEMPLATE_TXX
# include "itkGaussianOperator.txx"
#endif

#endif