itkGaussianOperator.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkGaussianOperator_h
#define itkGaussianOperator_h

#include "itkNeighborhoodOperator.h"
#include <cmath>
namespace itk
{
template< typename TPixel, unsigned int VDimension = 2,
          typename TAllocator = NeighborhoodAllocator< TPixel > >
class ITK_TEMPLATE_EXPORT GaussianOperator:
  public NeighborhoodOperator< TPixel, VDimension, TAllocator >
{
public:

  using Self = GaussianOperator;
  using Superclass = NeighborhoodOperator< TPixel, VDimension, TAllocator >;

  itkTypeMacro(GaussianOperator, NeighborhoodOperator);

  GaussianOperator() {}

  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)
  {
    if(this != &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; }

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

protected:
  using CoefficientVector = typename Superclass::CoefficientVector;

public:
  double ModifiedBesselI0(double);

  double ModifiedBesselI1(double);

  double ModifiedBesselI(int, double);

protected:
  CoefficientVector GenerateCoefficients() override;

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

private:
  double m_Variance{1};

  double m_MaximumError{.01};

  unsigned int m_MaximumKernelWidth{30};

};
} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkGaussianOperator.hxx"
#endif

#endif