itkGaussianDerivativeImageFunction.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 __itkGaussianDerivativeImageFunction_h
#define __itkGaussianDerivativeImageFunction_h

#include "itkNeighborhoodOperatorImageFunction.h"
#include "itkGaussianDerivativeSpatialFunction.h"
#include "itkGaussianSpatialFunction.h"

namespace itk
{
template< class TInputImage, class TOutput = double >
class ITK_EXPORT GaussianDerivativeImageFunction:
  public ImageFunction< TInputImage,
                        Vector< TOutput, ::itk::GetImageDimension< TInputImage >::ImageDimension >,
                        TOutput >
{
public:

  typedef GaussianDerivativeImageFunction Self;

  typedef ImageFunction< TInputImage,
                         Vector< TOutput, ::itk::GetImageDimension< TInputImage >::ImageDimension >,
                         TOutput > Superclass;

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

  itkNewMacro(Self);

  itkTypeMacro(GaussianDerivativeImageFunction, ImageFunction);

  typedef TInputImage                        InputImageType;
  typedef typename InputImageType::PixelType InputPixelType;
  typedef typename InputImageType::IndexType IndexType;

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

  typedef ContinuousIndex< TOutput, itkGetStaticConstMacro(ImageDimension2) >
  ContinuousIndexType;

  typedef Neighborhood< InputPixelType, itkGetStaticConstMacro(ImageDimension2) > NeighborhoodType;
  typedef Neighborhood< TOutput, itkGetStaticConstMacro(ImageDimension2) >        OperatorNeighborhoodType;

  typedef Vector< TOutput, itkGetStaticConstMacro(ImageDimension2) >                         VectorType;
  typedef typename Superclass::OutputType                                                    OutputType;
  typedef FixedArray< OperatorNeighborhoodType, 2 *itkGetStaticConstMacro(ImageDimension2) > OperatorArrayType;
  typedef NeighborhoodOperatorImageFunction< InputImageType,
                                             TOutput > OperatorImageFunctionType;
  typedef typename OperatorImageFunctionType::Pointer OperatorImageFunctionPointer;

  typedef GaussianDerivativeSpatialFunction< TOutput, 1 >  GaussianDerivativeFunctionType;
  typedef typename GaussianDerivativeFunctionType::Pointer GaussianDerivativeFunctionPointer;

  typedef GaussianSpatialFunction< TOutput, 1 >  GaussianFunctionType;
  typedef typename GaussianFunctionType::Pointer GaussianFunctionPointer;

  typedef Point< TOutput, itkGetStaticConstMacro(ImageDimension2) > PointType;

  virtual OutputType Evaluate(const PointType & point) const;

  virtual OutputType EvaluateAtIndex(const IndexType & index) const;

  virtual OutputType EvaluateAtContinuousIndex(
    const ContinuousIndexType & index) const;

  void SetSigma(const double *sigma);

  void SetSigma(const double sigma);

  const double * GetSigma() const { return m_Sigma; }

  void SetExtent(const double *extent);

  void SetExtent(const double extent);

  const double * GetExtent() const { return m_Extent; }

  virtual void SetInputImage(const InputImageType *ptr);

protected:
  GaussianDerivativeImageFunction();
  GaussianDerivativeImageFunction(const Self &);

  ~GaussianDerivativeImageFunction(){}

  void operator=(const Self &);

  void PrintSelf(std::ostream & os, Indent indent) const;

  void RecomputeGaussianKernel();

  void RecomputeContinuousGaussianKernel(
    const double *offset) const;

private:

  double m_Sigma[ImageDimension2];

  mutable OperatorArrayType m_OperatorArray;
  mutable OperatorArrayType m_ContinuousOperatorArray;

  OperatorImageFunctionPointer m_OperatorImageFunction;
  double                       m_Extent[ImageDimension2];

  bool m_UseImageSpacing;

  GaussianDerivativeFunctionPointer m_GaussianDerivativeFunction;
  GaussianFunctionPointer           m_GaussianFunction;
};
} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_GaussianDerivativeImageFunction(_, EXPORT, TypeX, TypeY)                                \
  namespace itk                                                                                              \
  {                                                                                                          \
  _( 2 ( class EXPORT GaussianDerivativeImageFunction< ITK_TEMPLATE_2 TypeX > ) )                            \
  namespace Templates                                                                                        \
  {                                                                                                          \
  typedef GaussianDerivativeImageFunction< ITK_TEMPLATE_2 TypeX >  GaussianDerivativeImageFunction##TypeY; \
  }                                                                                                          \
  }

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

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

#endif