itkGaussianDerivativeImageFunction.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 itkGaussianDerivativeImageFunction_h
#define itkGaussianDerivativeImageFunction_h
 
#include "itkContinuousIndex.h"
#include "itkFixedArray.h"
#include "itkGaussianDerivativeSpatialFunction.h"
#include "itkGaussianSpatialFunction.h"
#include "itkImage.h"
#include "itkImageFunction.h"
#include "itkNeighborhood.h"
#include "itkOffset.h"
#include "itkVector.h"
 
#include <vector>
 
namespace itk
{
template <typename TInputImage, typename TOutput = double>
class ITK_TEMPLATE_EXPORT GaussianDerivativeImageFunction
  : public ImageFunction<TInputImage, Vector<TOutput, TInputImage::ImageDimension>, TOutput>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GaussianDerivativeImageFunction);

  using Self = GaussianDerivativeImageFunction;
  using Superclass = ImageFunction<TInputImage, Vector<TOutput, TInputImage::ImageDimension>, TOutput>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GaussianDerivativeImageFunction);

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

  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
 
#if !defined(ITK_LEGACY_REMOVE)
  static constexpr unsigned int ImageDimension2 = ImageDimension;
#endif
 
  using ContinuousIndexType = typename Superclass::ContinuousIndexType;
 
  using NeighborhoodType = Neighborhood<InputPixelType, Self::ImageDimension>;
  using OperatorNeighborhoodType = Neighborhood<TOutput, Self::ImageDimension>;
 
  using VectorType = Vector<TOutput, Self::ImageDimension>;
  using typename Superclass::OutputType;
  using OperatorArrayType = FixedArray<OperatorNeighborhoodType, Self::ImageDimension>;
 
  using GaussianDerivativeSpatialFunctionType = GaussianDerivativeSpatialFunction<TOutput, 1>;
  using GaussianDerivativeSpatialFunctionPointer = typename GaussianDerivativeSpatialFunctionType::Pointer;
 
#if !defined(ITK_LEGACY_REMOVE)
  using GaussianDerivativeFunctionType = GaussianDerivativeSpatialFunctionType;
  using GaussianDerivativeFunctionPointer = GaussianDerivativeSpatialFunctionPointer;
#endif

  // using PointType = Point< TOutput, Self::ImageDimension >;
  using PointType = typename Superclass::PointType;

  OutputType
  Evaluate(const PointType & point) const override;

  OutputType
  EvaluateAtIndex(const IndexType & index) const override;

  OutputType
  EvaluateAtContinuousIndex(const ContinuousIndexType & cindex) const override;

  void
  SetUseImageSpacing(const bool val)
  {
    if (val != this->m_UseImageSpacing)
    {
      this->m_UseImageSpacing = val;
      this->RecomputeGaussianKernel();
      this->Modified();
    }
  }
  itkBooleanMacro(UseImageSpacing);
  itkGetMacro(UseImageSpacing, bool);

  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;
  }

  void
  SetInputImage(const InputImageType * ptr) override;
 
protected:
  GaussianDerivativeImageFunction();
  ~GaussianDerivativeImageFunction() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  RecomputeGaussianKernel();
 
private:
  double m_Sigma[ImageDimension]{};

  OperatorArrayType m_OperatorArray{};
 
  std::vector<Offset<ImageDimension>> m_ImageNeighborhoodOffsets[ImageDimension]{};
 
  double m_Extent[ImageDimension]{};

  bool m_UseImageSpacing{ true };

  const GaussianDerivativeSpatialFunctionPointer m_GaussianDerivativeSpatialFunction{
    GaussianDerivativeSpatialFunctionType::New()
  };
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGaussianDerivativeImageFunction.hxx"
#endif
 
#endif