itkGaussianDerivativeOperator.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkGaussianDerivativeOperator.h,v $
  Language:  C++
  Date:      $Date: 2009-01-28 18:14:36 $
  Version:   $Revision: 1.4 $

  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 __itkGaussianDerivativeOperator_h
#define __itkGaussianDerivativeOperator_h

#include "itkNeighborhoodOperator.h"
#include "itkGaussianOperator.h"
#include "itkDerivativeOperator.h"
#include <math.h>

namespace itk {

template<class TPixel,unsigned int VDimension=2,
  class TAllocator = NeighborhoodAllocator<TPixel> >
class ITK_EXPORT GaussianDerivativeOperator
  : public NeighborhoodOperator<TPixel, VDimension, TAllocator>
{
public:
  typedef GaussianDerivativeOperator                            Self;
  typedef NeighborhoodOperator<TPixel, VDimension, TAllocator>  Superclass;
  
  typedef GaussianOperator<TPixel, VDimension, TAllocator>      GaussianOperatorType;
  typedef DerivativeOperator<TPixel, VDimension, TAllocator>    DerivativeOperatorType;
  
  GaussianDerivativeOperator()
    {
    m_Order = 1;
    m_Variance = 1.0;
    m_Spacing = 1.0;
    m_MaximumError = 0.005;
    m_MaximumKernelWidth = 30;
    m_UseDerivativeOperator = false;
    m_NormalizeAcrossScale = true;
    }

  GaussianDerivativeOperator(const Self &other) :
    NeighborhoodOperator<TPixel, VDimension, TAllocator>(other)
    {
    m_UseDerivativeOperator = other.m_UseDerivativeOperator;
    m_NormalizeAcrossScale = other.m_NormalizeAcrossScale;
    m_Spacing = other.m_Spacing;
    m_Order = other.m_Order;
    m_Variance = other.m_Variance;
    m_MaximumError = other.m_MaximumError;
    m_MaximumKernelWidth = other.m_MaximumKernelWidth;
    }

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

  void SetUseDerivativeOperator( bool flag )
    {
    if( m_UseDerivativeOperator != flag )
      {
      m_UseDerivativeOperator = flag;
      }
    }
  bool GetUseDerivativeOperator() const { return m_UseDerivativeOperator; }
  itkBooleanMacro(UseDerivativeOperator);

  void SetNormalizeAcrossScale( bool flag )
    {
    if( m_NormalizeAcrossScale != flag )
      {
      m_NormalizeAcrossScale = flag;
      }
    }
  bool GetNormalizeAcrossScale() const { return m_NormalizeAcrossScale; }
  itkBooleanMacro(NormalizeAcrossScale);
  
  void SetVariance(const double variance) { m_Variance = variance; }
  
  void SetSpacing(const double spacing)
    {  
    m_Spacing = spacing;
    }

  void SetMaximumError( const double maxerror )
    {
    const double Min = 0.00001;
    const double Max = 1.0 - Min;
    m_MaximumError = (maxerror<Min?Min:(maxerror>Max?Max:maxerror));
    }
  
  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; }
   
  void SetOrder(const unsigned int order)
    {
    m_Order = order;
    }

  unsigned int GetOrder() const { return m_Order; }

  virtual void PrintSelf(std::ostream &os, Indent i) const
    {
    os << i << "GaussianDerivativeOperator { this=" << this
       << ", m_UseDerivativeOperator = " << m_UseDerivativeOperator
       << ", m_NormalizeAcrossScale = " << m_NormalizeAcrossScale
       << ", m_Order = " << m_Order
       << ", m_Spacing = " << m_Spacing
       << ", m_Variance = " << m_Variance
       << ", m_MaximumError = " << m_MaximumError
       << ", m_MaximumKernelWidth = " << m_MaximumKernelWidth
       << "} "  << 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:

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

  bool m_UseDerivativeOperator;

  bool m_NormalizeAcrossScale;

  double m_Variance;

  double m_MaximumError;

  unsigned int m_MaximumKernelWidth;

  unsigned int m_Order; 

  double m_Spacing;
};

} // namespace itk

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

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

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

#endif