itkDiscreteGradientMagnitudeGaussianImageFunction.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 itkDiscreteGradientMagnitudeGaussianImageFunction_h
#define itkDiscreteGradientMagnitudeGaussianImageFunction_h
 
#include "itkNeighborhoodOperatorImageFunction.h"
#include "itkGaussianDerivativeOperator.h"
 
namespace itk
{
template <typename TInputImage, typename TOutput = double>
class ITK_TEMPLATE_EXPORT DiscreteGradientMagnitudeGaussianImageFunction
  : public ImageFunction<TInputImage, TOutput, TOutput>
{
public:
  using Self = DiscreteGradientMagnitudeGaussianImageFunction;

  using Superclass = ImageFunction<TInputImage, TOutput, TOutput>;

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(DiscreteGradientMagnitudeGaussianImageFunction);

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

  static constexpr unsigned int ImageDimension2 = InputImageType::ImageDimension;

  using typename Superclass::OutputType;

  using VarianceArrayType = FixedArray<double, Self::ImageDimension2>;
  using OrderArrayType = FixedArray<unsigned int, Self::ImageDimension2>;
 
  using GaussianDerivativeOperatorType = itk::GaussianDerivativeOperator<TOutput, Self::ImageDimension2>;

  using GaussianDerivativeOperatorArrayType = FixedArray<GaussianDerivativeOperatorType, 2 * Self::ImageDimension2>;

  using KernelType = Neighborhood<TOutput, Self::ImageDimension2>;

  using KernelArrayType = FixedArray<KernelType, Self::ImageDimension2>;

  using OperatorImageFunctionType = NeighborhoodOperatorImageFunction<InputImageType, TOutput>;
  using OperatorImageFunctionPointer = typename OperatorImageFunctionType::Pointer;
 
  using InterpolationModeEnum = itk::GaussianDerivativeOperatorEnums::InterpolationMode;
#if !defined(ITK_LEGACY_REMOVE)
  static constexpr InterpolationModeEnum NearestNeighbourInterpolation =
    InterpolationModeEnum::NearestNeighbourInterpolation;
  static constexpr InterpolationModeEnum LinearInterpolation = InterpolationModeEnum::LinearInterpolation;
#endif
 
public:
  OutputType
  Evaluate(const PointType & point) const override;

  OutputType
  EvaluateAtIndex(const IndexType & index) const override;

  OutputType
  EvaluateAtContinuousIndex(const ContinuousIndexType & index) const override;

  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(NormalizeAcrossScale, bool);
  itkGetConstMacro(NormalizeAcrossScale, bool);
  itkBooleanMacro(NormalizeAcrossScale);

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

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

  itkSetEnumMacro(InterpolationMode, InterpolationModeEnum);
  itkGetEnumMacro(InterpolationMode, InterpolationModeEnum);

  void
  SetInputImage(const InputImageType * ptr) override;

  virtual void
  Initialize()
  {
    RecomputeGaussianKernel();
  }
 
protected:
  DiscreteGradientMagnitudeGaussianImageFunction();
  DiscreteGradientMagnitudeGaussianImageFunction(const Self &) {}
 
  ~DiscreteGradientMagnitudeGaussianImageFunction() override = default;
 
  void
  operator=(const Self &)
  {}
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  RecomputeGaussianKernel();
 
  // void RecomputeContinuousGaussianKernel(
  //        const double* offset) const;
 
private:
  VarianceArrayType m_Variance{};

  double m_MaximumError{ 0.005 };

  unsigned int m_MaximumKernelWidth{ 30 };

  GaussianDerivativeOperatorArrayType m_OperatorArray{};

  KernelArrayType m_KernelArray{};

  OperatorImageFunctionPointer m_OperatorImageFunction{};

  bool m_NormalizeAcrossScale{ true };

  bool m_UseImageSpacing{ true };

  InterpolationModeEnum m_InterpolationMode{ InterpolationModeEnum::NearestNeighbourInterpolation };
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkDiscreteGradientMagnitudeGaussianImageFunction.hxx"
#endif
 
#endif