itkDiscreteGaussianDerivativeImageFunction.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 __itkDiscreteGaussianDerivativeImageFunction_h
#define __itkDiscreteGaussianDerivativeImageFunction_h

#include "itkNeighborhoodOperatorImageFunction.h"
#include "itkGaussianDerivativeOperator.h"

namespace itk
{
template< class TInputImage, class TOutput = double >
class ITK_EXPORT DiscreteGaussianDerivativeImageFunction:
  public ImageFunction< TInputImage, TOutput, TOutput >
{
public:

  typedef DiscreteGaussianDerivativeImageFunction Self;

  typedef ImageFunction< TInputImage, TOutput, TOutput > Superclass;

  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(DiscreteGaussianDerivativeImageFunction, ImageFunction);

  typedef typename Superclass::InputImageType      InputImageType;
  typedef typename Superclass::InputPixelType      InputPixelType;
  typedef typename Superclass::IndexType           IndexType;
  typedef typename Superclass::IndexValueType      IndexValueType;
  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
  typedef typename Superclass::PointType           PointType;

  itkStaticConstMacro(ImageDimension2, unsigned int,
                      InputImageType::ImageDimension);

  typedef typename Superclass::OutputType OutputType;

  typedef FixedArray< double, itkGetStaticConstMacro(ImageDimension2) >       VarianceArrayType;
  typedef FixedArray< unsigned int, itkGetStaticConstMacro(ImageDimension2) > OrderArrayType;

  typedef itk::GaussianDerivativeOperator< TOutput,
                                           itkGetStaticConstMacro(ImageDimension2) >    GaussianDerivativeOperatorType;

  typedef FixedArray< GaussianDerivativeOperatorType,
                      itkGetStaticConstMacro(ImageDimension2) >            GaussianDerivativeOperatorArrayType;

  typedef Neighborhood< TOutput, itkGetStaticConstMacro(ImageDimension2) > KernelType;

  typedef NeighborhoodOperatorImageFunction
  < InputImageType, TOutput >                           OperatorImageFunctionType;
  typedef typename OperatorImageFunctionType::Pointer OperatorImageFunctionPointer;

  enum InterpolationModeType { NearestNeighbourInterpolation, LinearInterpolation };
public:

  virtual OutputType Evaluate(const PointType & point) const;

  virtual OutputType EvaluateAtIndex(const IndexType & index) const;

  virtual OutputType EvaluateAtContinuousIndex(
    const ContinuousIndexType & index) const;

  itkSetMacro(Variance, VarianceArrayType);
  itkGetConstMacro(Variance, const VarianceArrayType);
  itkSetVectorMacro(Variance, double, VarianceArrayType::Length);

  virtual void SetVariance(double variance)
  {
    m_Variance.Fill(variance);
    this->Modified();
  }

  void SetSigma(const double sigma)
  {
    SetVariance(sigma * sigma);
  }

  itkSetClampMacro(MaximumError, double, 0.00001, 0.99999);
  itkGetConstMacro(MaximumError, double);

  itkSetMacro(Order, OrderArrayType);
  itkGetConstMacro(Order, const OrderArrayType);
  itkSetVectorMacro(Order, unsigned int, OrderArrayType::Length);

  virtual void SetOrder(unsigned int order)
  {
    m_Order.Fill(order);
    this->Modified();
  }

  itkSetMacro(NormalizeAcrossScale, bool);
  itkGetConstMacro(NormalizeAcrossScale, bool);
  itkBooleanMacro(NormalizeAcrossScale);

  itkSetMacro(UseImageSpacing, bool);
  itkGetConstMacro(UseImageSpacing, bool);
  itkBooleanMacro(UseImageSpacing);

  itkSetMacro(MaximumKernelWidth, unsigned int);
  itkGetConstMacro(MaximumKernelWidth, unsigned int);

  itkSetMacro(InterpolationMode, InterpolationModeType);
  itkGetConstMacro(InterpolationMode, InterpolationModeType);

  virtual void SetInputImage(const InputImageType *ptr);

  virtual void Initialize() { RecomputeGaussianKernel(); }
protected:

  DiscreteGaussianDerivativeImageFunction();
  DiscreteGaussianDerivativeImageFunction(const Self &){}

  ~DiscreteGaussianDerivativeImageFunction(){}

  void operator=(const Self &){}
  void PrintSelf(std::ostream & os, Indent indent) const;

  void RecomputeGaussianKernel();

private:

  VarianceArrayType m_Variance;

  OrderArrayType m_Order;

  double m_MaximumError;

  unsigned int m_MaximumKernelWidth;

  GaussianDerivativeOperatorArrayType m_OperatorArray;

  KernelType m_DerivativeKernel;

  OperatorImageFunctionPointer m_OperatorImageFunction;

  bool m_NormalizeAcrossScale;

  bool m_UseImageSpacing;

  InterpolationModeType m_InterpolationMode;
};
} // namespace itk

#if 0 //HACK: Not yet implemented
// Define instantiation macro for this template.
#define ITK_TEMPLATE_DiscreteGaussianDerivativeImageFunction(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                                           \
  {                                                                                       \
  _( 2 ( class EXPORT DiscreteGaussianDerivativeImageFunction< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                                                     \
  {                                                                                       \
  typedef DiscreteGaussianDerivativeImageFunction< ITK_TEMPLATE_2 TypeX >                 \
  DiscreteGaussianDerivativeImageFunction##TypeY;                                       \
  }                                                                                       \
  }

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

#if ITK_TEMPLATE_TXX
#include "itkDiscreteGaussianDerivativeImageFunction.hxx"
#endif

#endif