itkGaussianBlurImageFunction.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 ITK_TEMPLATE_EXPORT GaussianBlurImageFunction : public ImageFunction<TInputImage, TOutput>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GaussianBlurImageFunction);

  using Self = GaussianBlurImageFunction;

  using Superclass = ImageFunction<TInputImage, TOutput>;

  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GaussianBlurImageFunction);

  using InputImageType = TInputImage;
  using InputPixelType = typename InputImageType::PixelType;
  using typename Superclass::IndexType;
  using typename Superclass::ContinuousIndexType;

  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
 
  using GaussianOperatorType = GaussianOperator<TOutput, Self::ImageDimension>;
  using NeighborhoodType = Neighborhood<TOutput, Self::ImageDimension>;
  using OperatorArrayType = FixedArray<NeighborhoodType, Self::ImageDimension>;
 
  using GaussianFunctionType = GaussianSpatialFunction<TOutput, 1>;
  using GaussianFunctionPointer = typename GaussianFunctionType::Pointer;
  using InputPixelRealType = typename NumericTraits<InputPixelType>::RealType;
  using InternalImageType = itk::Image<InputPixelRealType, Self::ImageDimension>;
  using InternalImagePointer = typename InternalImageType::Pointer;
 
  using OperatorImageFunctionType = NeighborhoodOperatorImageFunction<InputImageType, TOutput>;
  using OperatorImageFunctionPointer = typename OperatorImageFunctionType::Pointer;
 
  using OperatorInternalImageFunctionType = NeighborhoodOperatorImageFunction<InternalImageType, TOutput>;
  using OperatorInternalImageFunctionPointer = typename OperatorInternalImageFunctionType::Pointer;
 
  using ErrorArrayType = itk::FixedArray<double, Self::ImageDimension>;
  using ExtentArrayType = itk::FixedArray<double, Self::ImageDimension>;
  using SigmaArrayType = itk::FixedArray<double, Self::ImageDimension>;

  using typename Superclass::PointType;

  TOutput
  Evaluate(const PointType & point) const override;

  TOutput
  EvaluateAtIndex(const IndexType & index) const override;

  TOutput
  EvaluateAtContinuousIndex(const ContinuousIndexType & cindex) const override;

  void
  SetSigma(const double * sigma);
 
  void
  SetSigma(const float * sigma);
 
  void
  SetSigma(const double sigma);
 
  itkSetMacro(Sigma, SigmaArrayType);
  itkGetConstReferenceMacro(Sigma, SigmaArrayType);

  void
  SetInputImage(const InputImageType * ptr) 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() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const 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{ true };

  GaussianFunctionPointer m_GaussianFunction{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGaussianBlurImageFunction.hxx"
#endif
 
#endif