itkGaussianBlurImageFunction.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 itkGaussianBlurImageFunction_h
#define itkGaussianBlurImageFunction_h

#include "itkNeighborhoodOperatorImageFunction.h"
#include "itkGaussianOperator.h"
#include "itkGaussianSpatialFunction.h"

namespace itk
{
template< typename TInputImage, typename TOutput = double >
class GaussianBlurImageFunction:
  public ImageFunction< TInputImage, TOutput >
{
public:

  typedef GaussianBlurImageFunction Self;

  typedef ImageFunction< TInputImage, TOutput > Superclass;

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

  itkNewMacro(Self);

  itkTypeMacro(GaussianBlurImageFunction, ImageFunction);

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

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

  typedef GaussianOperator<
    TOutput, itkGetStaticConstMacro(ImageDimension) >                            GaussianOperatorType;
  typedef Neighborhood< TOutput, itkGetStaticConstMacro(ImageDimension) >        NeighborhoodType;
  typedef FixedArray< NeighborhoodType, itkGetStaticConstMacro(ImageDimension) > OperatorArrayType;

  typedef GaussianSpatialFunction< TOutput, 1 >                        GaussianFunctionType;
  typedef typename GaussianFunctionType::Pointer                       GaussianFunctionPointer;
  typedef typename NumericTraits< InputPixelType >::RealType           InputPixelRealType;
  typedef itk::Image<
    InputPixelRealType, itkGetStaticConstMacro(ImageDimension) >       InternalImageType;
  typedef typename InternalImageType::Pointer                          InternalImagePointer;

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

  typedef NeighborhoodOperatorImageFunction< InternalImageType, TOutput > OperatorInternalImageFunctionType;
  typedef typename OperatorInternalImageFunctionType::Pointer             OperatorInternalImageFunctionPointer;

  typedef itk::FixedArray< double, itkGetStaticConstMacro(ImageDimension) > ErrorArrayType;
  typedef itk::FixedArray< double, itkGetStaticConstMacro(ImageDimension) > ExtentArrayType;
  typedef itk::FixedArray< double, itkGetStaticConstMacro(ImageDimension) > SigmaArrayType;

  typedef typename Superclass::PointType PointType;

  virtual TOutput Evaluate(const PointType & point) const ITK_OVERRIDE;

  virtual TOutput EvaluateAtIndex(const IndexType & index) const ITK_OVERRIDE;

  virtual TOutput EvaluateAtContinuousIndex(
    const ContinuousIndexType & index) const ITK_OVERRIDE;

  void SetSigma(const double *sigma);

  void SetSigma(const float *sigma);

  void SetSigma(const double sigma);

  itkSetMacro(Sigma, SigmaArrayType);
  itkGetConstReferenceMacro(Sigma, SigmaArrayType);

  virtual void SetInputImage(const InputImageType *ptr) ITK_OVERRIDE;

  itkSetMacro(Extent, ExtentArrayType);
  itkGetConstReferenceMacro(Extent, ExtentArrayType);
  void SetExtent(const double *extent);

  void SetExtent(const double extent);

  itkSetMacro(MaximumError, ErrorArrayType);
  itkGetConstReferenceMacro(MaximumError, ErrorArrayType);

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

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

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

  ~GaussianBlurImageFunction(){}

  void operator=(const Self &);

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

  void RecomputeGaussianKernel();

  void RecomputeContinuousGaussianKernel(const double *offset) const;

private:

  virtual TOutput EvaluateAtIndex(
    const IndexType & index, const OperatorArrayType & operatorArray) const;

  SigmaArrayType                        m_Sigma;
  OperatorImageFunctionPointer          m_OperatorImageFunction;
  OperatorInternalImageFunctionPointer  m_OperatorInternalImageFunction;
  mutable OperatorArrayType             m_OperatorArray;
  mutable OperatorArrayType             m_ContinuousOperatorArray;
  InternalImagePointer                  m_InternalImage;

  ErrorArrayType  m_MaximumError;
  ExtentArrayType m_Extent;

  int m_MaximumKernelWidth;

  unsigned int m_FilterDimensionality;

  bool m_UseImageSpacing;

  GaussianFunctionPointer m_GaussianFunction;
};
} // end namespace itk

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

#endif