itkAdvancedBSplineDeformableTransformBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 itkAdvancedBSplineDeformableTransformBase_h
#define itkAdvancedBSplineDeformableTransformBase_h
 
#include "itkAdvancedTransform.h"
#include "itkImage.h"
#include "itkImageRegion.h"
 
namespace itk
{

template <typename TScalarType = double, // Data type for scalars
          unsigned int NDimensions = 3>
// Number of dimensions
class ITK_TEMPLATE_EXPORT AdvancedBSplineDeformableTransformBase
  : public AdvancedTransform<TScalarType, NDimensions, NDimensions>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(AdvancedBSplineDeformableTransformBase);

  using Self = AdvancedBSplineDeformableTransformBase;
  using Superclass = AdvancedTransform<TScalarType, NDimensions, NDimensions>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(AdvancedBSplineDeformableTransformBase);

  itkStaticConstMacro(SpaceDimension, unsigned int, NDimensions);

  static constexpr unsigned int NumberOfFixedParameters = NDimensions * (NDimensions + 3);

  using typename Superclass::ParametersType;
  using typename Superclass::FixedParametersType;
  using typename Superclass::ParametersValueType;
  using typename Superclass::NumberOfParametersType;
  using typename Superclass::DerivativeType;
  using typename Superclass::JacobianType;
  using typename Superclass::ScalarType;
  using typename Superclass::InputPointType;
  using typename Superclass::OutputPointType;
  using typename Superclass::InputVectorType;
  using typename Superclass::OutputVectorType;
  using typename Superclass::InputVnlVectorType;
  using typename Superclass::OutputVnlVectorType;
  using typename Superclass::InputCovariantVectorType;
  using typename Superclass::OutputCovariantVectorType;
  using typename Superclass::TransformCategoryEnum;
 
  using typename Superclass::NonZeroJacobianIndicesType;
  using typename Superclass::SpatialJacobianType;
  using typename Superclass::JacobianOfSpatialJacobianType;
  using typename Superclass::SpatialHessianType;
  using typename Superclass::JacobianOfSpatialHessianType;
  using typename Superclass::InternalMatrixType;
  using typename Superclass::MovingImageGradientType;
  using typename Superclass::MovingImageGradientValueType;
 
  /* Creates a `BSplineDeformableTransform` of the specified derived type and spline order. */
  template <template <class, unsigned, unsigned> class TBSplineDeformableTransform>
  static Pointer
  Create(const unsigned splineOrder)
  {
    switch (splineOrder)
    {
      case 1:
      {
        return TBSplineDeformableTransform<TScalarType, NDimensions, 1>::New();
      }
      case 2:
      {
        return TBSplineDeformableTransform<TScalarType, NDimensions, 2>::New();
      }
      case 3:
      {
        return TBSplineDeformableTransform<TScalarType, NDimensions, 3>::New();
      }
    }
    itkGenericExceptionMacro("ERROR: The provided spline order (" << splineOrder << ") is not supported.");
  }
 
 
  unsigned
  GetSplineOrder() const
  {
    return m_SplineOrder;
  }
 

  void
  SetParameters(const ParametersType & parameters) override;

  void
  SetFixedParameters(const FixedParametersType & parameters) override;

  void
  SetParametersByValue(const ParametersType & parameters) override;

  void
  SetIdentity();

  const ParametersType &
  GetParameters() const override;

  const FixedParametersType &
  GetFixedParameters() const override;

  using PixelType = typename ParametersType::ValueType;
  using ImageType = Image<PixelType, Self::SpaceDimension>;
  using ImagePointer = typename ImageType::Pointer;

  const ImagePointer *
  GetCoefficientImages() const
  {
    return m_CoefficientImages.data();
  }

  void
  SetCoefficientImages(ImagePointer images[]);

  using RegionType = ImageRegion<Self::SpaceDimension>;
 
  using IndexType = typename RegionType::IndexType;
  using SizeType = typename RegionType::SizeType;
  using SpacingType = typename ImageType::SpacingType;
  using DirectionType = typename ImageType::DirectionType;
  using OriginType = typename ImageType::PointType;
  using GridOffsetType = IndexType;

  virtual void
  SetGridRegion(const RegionType & region) = 0;
 
  itkGetConstMacro(GridRegion, RegionType);

  virtual void
  SetGridSpacing(const SpacingType & spacing);
 
  itkGetConstMacro(GridSpacing, SpacingType);

  virtual void
  SetGridDirection(const DirectionType & direction);
 
  itkGetConstMacro(GridDirection, DirectionType);

  virtual void
  SetGridOrigin(const OriginType & origin);
 
  itkGetConstMacro(GridOrigin, OriginType);

  using ParameterIndexArrayType = Array<unsigned long>;

  OutputVectorType
  TransformVector(const InputVectorType &) const override
  {
    itkExceptionMacro("Method not applicable for deformable transform.");
  }
 

  OutputVnlVectorType
  TransformVector(const InputVnlVectorType &) const override
  {
    itkExceptionMacro("Method not applicable for deformable transform. ");
  }
 

  OutputCovariantVectorType
  TransformCovariantVector(const InputCovariantVectorType &) const override
  {
    itkExceptionMacro("Method not applicable for deformable transform. ");
  }
 

  NumberOfParametersType
  GetNumberOfParameters() const override;

  virtual NumberOfParametersType
  GetNumberOfParametersPerDimension() const;

  bool
  IsLinear() const override
  {
    return false;
  }

  TransformCategoryEnum
  GetTransformCategory() const override
  {
    return TransformCategoryEnum::BSpline;
  }
 
 
  virtual unsigned int
  GetNumberOfAffectedWeights() const = 0;
 
  NumberOfParametersType
  GetNumberOfNonZeroJacobianIndices() const override = 0;

  using ContinuousIndexType = ContinuousIndex<ScalarType, SpaceDimension>;
 
protected:
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  AdvancedBSplineDeformableTransformBase() = delete;
  explicit AdvancedBSplineDeformableTransformBase(const unsigned splineOrder);
  ~AdvancedBSplineDeformableTransformBase() override = default;

  void
  WrapAsImages();

  ContinuousIndexType
  TransformPointToContinuousGridIndex(const InputPointType & point) const;
 
  void
  UpdatePointIndexConversions();
 
  virtual void
  ComputeNonZeroJacobianIndices(NonZeroJacobianIndicesType & nonZeroJacobianIndices,
                                const RegionType &           supportRegion) const = 0;

  virtual bool
  InsideValidRegion(const ContinuousIndexType & index) const;
 
private:
  const unsigned m_SplineOrder{};
 
  // Private using-declarations, to avoid `-Woverloaded-virtual` warnings from GCC (GCC 11.4) or clang (macos-12).
  using Superclass::TransformVector;
  using Superclass::TransformCovariantVector;
 
protected:
  FixedArray<ImagePointer, NDimensions> m_CoefficientImages{};

  RegionType     m_GridRegion{};
  SpacingType    m_GridSpacing{ 1.0 }; // default spacing is all ones
  DirectionType  m_GridDirection{ DirectionType::GetIdentity() };
  OriginType     m_GridOrigin{};
  GridOffsetType m_GridOffsetTable{};
 
  DirectionType                                     m_PointToIndexMatrix{};
  SpatialJacobianType                               m_PointToIndexMatrix2{};
  DirectionType                                     m_PointToIndexMatrixTransposed{};
  SpatialJacobianType                               m_PointToIndexMatrixTransposed2{};
  FixedArray<ScalarType, NDimensions>               m_PointToIndexMatrixDiagonal{};
  FixedArray<ScalarType, NDimensions * NDimensions> m_PointToIndexMatrixDiagonalProducts{};
  DirectionType                                     m_IndexToPoint{};
  bool                                              m_PointToIndexMatrixIsDiagonal{};

  ContinuousIndexType m_ValidRegionBegin{};
  ContinuousIndexType m_ValidRegionEnd{};

  using JacobianPixelType = typename JacobianType::ValueType;
  using JacobianImageType = Image<JacobianPixelType, Self::SpaceDimension>;

  FixedArray<ImagePointer, NDimensions> m_WrappedImage{};

  ParametersType m_InternalParametersBuffer{};

  const ParametersType * m_InputParametersPointer{ &m_InternalParametersBuffer };
 
  void
  UpdateGridOffsetTable();
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkAdvancedBSplineDeformableTransformBase.hxx"
#endif
 
#endif /* itkAdvancedBSplineDeformableTransformBase_h */