itkDiscreteGaussianDerivativeImageFunction.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkDiscreteGaussianDerivativeImageFunction.h,v $
  Language:  C++
  Date:      $Date: 2009-10-29 11:19:14 $
  Version:   $Revision: 1.11 $

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

#include "itkNeighborhoodOperatorImageFunction.h"
#include "itkImageFunction.h"
#include "itkGaussianOperator.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

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

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

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

#endif