itkBSplineControlPointImageFunction.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 itkBSplineControlPointImageFunction_h
#define itkBSplineControlPointImageFunction_h
 
#include "itkImageFunction.h"
 
#include "itkBSplineKernelFunction.h"
#include "itkCoxDeBoorBSplineKernelFunction.h"
#include "itkFixedArray.h"
#include "itkImage.h"
#include "itkPointSet.h"
#include "itkVariableSizeMatrix.h"
#include "itkVector.h"
#include "itkVectorContainer.h"
 
namespace itk
{
template <typename TInputImage, typename TCoordinate = double>
class ITK_TEMPLATE_EXPORT BSplineControlPointImageFunction
  : public ImageFunction<TInputImage, typename TInputImage::PixelType, TCoordinate>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BSplineControlPointImageFunction);
 
  using Self = BSplineControlPointImageFunction;
  using Superclass = ImageFunction<TInputImage, typename TInputImage::PixelType, TCoordinate>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(BSplineControlPointImageFunction);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using ControlPointLatticeType = TInputImage;
  using InputImageType = TInputImage;
  using CoordinateType = TCoordinate;
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#endif
  using PixelType = typename InputImageType::PixelType;
  using RegionType = typename InputImageType::RegionType;
  using IndexType = typename InputImageType::IndexType;
  using typename Superclass::PointType;
  using InputImageRegionType = typename InputImageType::RegionType;
 
  using SpacingType = typename InputImageType::SpacingType;
  using OriginType = typename InputImageType::PointType;
  using SizeType = typename InputImageType::SizeType;

  using OutputType = PixelType;
  using GradientType = VariableSizeMatrix<CoordinateType>;
  using HessianComponentType = VariableSizeMatrix<CoordinateType>;

  using ArrayType = FixedArray<unsigned int, ImageDimension>;
  using RealImageType = Image<CoordinateType, ImageDimension>;
  using RealImagePointer = typename RealImageType::Pointer;
  using typename Superclass::ContinuousIndexType;
  using RealType = float;

  using KernelType = CoxDeBoorBSplineKernelFunction<3>;
  using KernelOrder0Type = BSplineKernelFunction<0>;
  using KernelOrder1Type = BSplineKernelFunction<1>;
  using KernelOrder2Type = BSplineKernelFunction<2>;
  using KernelOrder3Type = BSplineKernelFunction<3>;

  void
  SetInputImage(const InputImageType *) override;

  void
  SetSplineOrder(const unsigned int);

  void
  SetSplineOrder(const ArrayType &);

  itkGetConstReferenceMacro(SplineOrder, ArrayType);

  itkSetMacro(CloseDimension, ArrayType);

  itkGetConstReferenceMacro(CloseDimension, ArrayType);

  itkSetMacro(Spacing, SpacingType);
  itkGetConstMacro(Spacing, SpacingType);

  itkSetMacro(Origin, OriginType);
  itkGetConstMacro(Origin, OriginType);

  itkSetMacro(Size, SizeType);
  itkGetConstMacro(Size, SizeType);

  itkSetMacro(BSplineEpsilon, RealType);
  itkGetConstMacro(BSplineEpsilon, RealType);

  OutputType
  EvaluateAtParametricPoint(const PointType &) const;

  OutputType
  EvaluateAtIndex(const IndexType &) const override;

  OutputType
  EvaluateAtContinuousIndex(const ContinuousIndexType &) const override;

  OutputType
  Evaluate(const PointType &) const override;

  GradientType
  EvaluateGradientAtParametricPoint(const PointType &) const;

  GradientType
  EvaluateGradientAtIndex(const IndexType &) const;

  GradientType
  EvaluateGradientAtContinuousIndex(const ContinuousIndexType &) const;

  GradientType
  EvaluateGradient(const PointType &) const;

  HessianComponentType
  EvaluateHessianAtParametricPoint(const PointType &, const unsigned int) const;

  HessianComponentType
  EvaluateHessianAtIndex(const IndexType &, const unsigned int) const;

  HessianComponentType
  EvaluateHessianAtContinuousIndex(const ContinuousIndexType &, const unsigned int) const;

  HessianComponentType
  EvaluateHessian(const PointType &, const unsigned int) const;
 
protected:
  BSplineControlPointImageFunction();
  ~BSplineControlPointImageFunction() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  SizeType    m_Size{};
  SpacingType m_Spacing{};
  OriginType  m_Origin{};
 
  ArrayType m_NumberOfControlPoints{};
  ArrayType m_CloseDimension{};
  ArrayType m_SplineOrder{};
 
  RealImagePointer m_NeighborhoodWeightImage{};
 
  typename KernelType::Pointer       m_Kernel[ImageDimension]{};
  typename KernelOrder0Type::Pointer m_KernelOrder0{};
  typename KernelOrder1Type::Pointer m_KernelOrder1{};
  typename KernelOrder2Type::Pointer m_KernelOrder2{};
  typename KernelOrder3Type::Pointer m_KernelOrder3{};
 
  CoordinateType m_BSplineEpsilon{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBSplineControlPointImageFunction.hxx"
#endif
 
#endif