itkMultiBSplineDeformableTransformWithNormal.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 itkMultiBSplineDeformableTransformWithNormal_h
#define itkMultiBSplineDeformableTransformWithNormal_h
 
#include "itkAdvancedBSplineDeformableTransform.h"
#include "itkNearestNeighborInterpolateImageFunction.h"
 
namespace itk
{
 
template <class TScalarType = double,   // Data type for scalars
          unsigned int NDimensions = 3, // Number of dimensions
          unsigned int VSplineOrder = 3>
// Spline order
class ITK_TEMPLATE_EXPORT MultiBSplineDeformableTransformWithNormal
  : public AdvancedTransform<TScalarType, NDimensions, NDimensions>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MultiBSplineDeformableTransformWithNormal);

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

  itkNewMacro(Self);

  itkTypeMacro(MultiBSplineDeformableTransformWithNormal, AdvancedTransform);

  itkStaticConstMacro(SpaceDimension, unsigned int, NDimensions);

  itkStaticConstMacro(SplineOrder, unsigned int, VSplineOrder);

  using typename Superclass::ParametersType;
  using typename Superclass::NumberOfParametersType;
  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::NonZeroJacobianIndicesType;
  using typename Superclass::SpatialJacobianType;
  using typename Superclass::JacobianOfSpatialJacobianType;
  using typename Superclass::SpatialHessianType;
  using typename Superclass::JacobianOfSpatialHessianType;
  using typename Superclass::InternalMatrixType;

  using WeightsFunctionType = BSplineInterpolationWeightFunction2<ScalarType, Self::SpaceDimension, VSplineOrder>;
  using WeightsType = typename WeightsFunctionType::WeightsType;

  void
  SetParameters(const ParametersType & parameters) override;

  void
  SetFixedParameters(const ParametersType & parameters) override;

  void
  SetParametersByValue(const ParametersType & parameters) override;

  void
  SetIdentity();

  const ParametersType &
  GetParameters() const override;

  const ParametersType &
  GetFixedParameters() const override;

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

  // virtual ImagePointer * GetCoefficientImage()
  //  { return this->m_CoefficientImage; }
  // virtual const ImagePointer * GetCoefficientImage() const
  //  { return this->m_CoefficientImage; }

  // virtual void SetCoefficientImage( ImagePointer images[] );

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

  virtual void
  SetGridRegion(const RegionType & region);
 
  virtual RegionType
  GetGridRegion() const;

  virtual void
  SetGridSpacing(const SpacingType & spacing);
 
  virtual SpacingType
  GetGridSpacing() const;

  virtual void
  SetGridDirection(const DirectionType & spacing);
 
  virtual DirectionType
  GetGridDirection() const;

  virtual void
  SetGridOrigin(const OriginType & origin);
 
  virtual OriginType
  GetGridOrigin() const;

  using ImageLabelType = Image<unsigned char, Self::SpaceDimension>;
  using ImageLabelPointer = typename ImageLabelType::Pointer;
 
  using ImageLabelInterpolator = itk::NearestNeighborInterpolateImageFunction<ImageLabelType, TScalarType>;
  using ImageLabelInterpolatorPointer = typename ImageLabelInterpolator::Pointer;

  using VectorType = Vector<TScalarType, Self::SpaceDimension>;
  using BaseType = Vector<VectorType, Self::SpaceDimension>;
  using ImageVectorType = Image<VectorType, Self::SpaceDimension>;
  using ImageVectorPointer = typename ImageVectorType::Pointer;
  using ImageBaseType = Image<BaseType, Self::SpaceDimension>;
  using ImageBasePointer = typename ImageBaseType::Pointer;

  void
  SetLabels(ImageLabelType * labels);
 
  itkGetConstMacro(Labels, ImageLabelType *);
 
  itkGetConstMacro(NbLabels, unsigned char);

  void
  UpdateLocalBases();
 
  itkGetConstMacro(LocalBases, ImageBaseType *);

  using ParameterIndexArrayType = Array<unsigned long>;

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

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

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

  NumberOfParametersType
  GetNumberOfParameters() const override;

  virtual NumberOfParametersType
  GetNumberOfParametersPerDimension() const;

  virtual const RegionType &
  GetValidRegion()
  {
    return m_Trans[0]->GetValidRegion();
  }
 

  bool
  IsLinear() const override
  {
    return false;
  }
 
 
  virtual unsigned int
  GetNumberOfAffectedWeights() const
  {
    return NumberOfWeights;
  }
 
 
  NumberOfParametersType
  GetNumberOfNonZeroJacobianIndices() const override
  {
    return NumberOfWeights * SpaceDimension;
  }
 

  virtual bool
  GetHasNonZeroSpatialJacobian() const
  {
    return true;
  }
 
 
  virtual bool
  HasNonZeroJacobianOfSpatialJacobian() const
  {
    return true;
  }
 
 
  bool
  GetHasNonZeroSpatialHessian() const override
  {
    return true;
  }
 
 
  virtual bool
  HasNonZeroJacobianOfSpatialHessian() const
  {
    return true;
  }
 

  using ContinuousIndexType = ContinuousIndex<ScalarType, SpaceDimension>;

  OutputPointType
  TransformPoint(const InputPointType & point) const override;

  // virtual const JacobianType & GetJacobian( const InputPointType & point ) const;

  void
  GetJacobian(const InputPointType & inputPoint, JacobianType & j, NonZeroJacobianIndicesType &) const override;

  void
  GetSpatialJacobian(const InputPointType & inputPoint, SpatialJacobianType & sj) const override;
 
  void
  GetJacobianOfSpatialJacobian(const InputPointType &          inputPoint,
                               JacobianOfSpatialJacobianType & jsj,
                               NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const override;
 
  void
  GetJacobianOfSpatialJacobian(const InputPointType &,
                               SpatialJacobianType &,
                               JacobianOfSpatialJacobianType &,
                               NonZeroJacobianIndicesType &) const override;

  void
  GetSpatialHessian(const InputPointType & inputPoint, SpatialHessianType & sh) const override;
 
  void
  GetJacobianOfSpatialHessian(const InputPointType &,
                              JacobianOfSpatialHessianType &,
                              NonZeroJacobianIndicesType &) const override
  {
    itkExceptionMacro("ERROR: GetJacobianOfSpatialHessian() not yet implemented in the "
                      "MultiBSplineDeformableTransformWithNormal class.");
  }
 
 
  void
  GetJacobianOfSpatialHessian(const InputPointType &,
                              SpatialHessianType &,
                              JacobianOfSpatialHessianType &,
                              NonZeroJacobianIndicesType &) const override;
 
protected:
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  MultiBSplineDeformableTransformWithNormal();
  ~MultiBSplineDeformableTransformWithNormal() override = default;

  // void WrapAsImages();

  /*
  void TransformPointToContinuousGridIndex(
   const InputPointType & point, ContinuousIndexType & index ) const;
 
  virtual void ComputeNonZeroJacobianIndices(
    NonZeroJacobianIndicesType & nonZeroJacobianIndices,
    const RegionType & supportRegion ) const;
    */

  // virtual bool InsideValidRegion( const ContinuousIndexType& index ) const;

  // BulkTransformPointer  m_BulkTransform;

  // ImagePointer    m_CoefficientImage[ NDimensions ];

  // RegionType          m_GridRegion;
  // SpacingType         m_GridSpacing;
  // DirectionType       m_GridDirection;
  // OriginType          m_GridOrigin;
  // GridOffsetType      m_GridOffsetTable;
 
  // DirectionType       m_PointToIndexMatrix;
  // SpatialJacobianType m_PointToIndexMatrix2;
  // DirectionType       m_PointToIndexMatrixTransposed;
  // SpatialJacobianType m_PointToIndexMatrixTransposed2;
  // DirectionType       m_IndexToPoint;
 
  // RegionType      m_ValidRegion;

  // unsigned long   m_Offset;
  // SizeType        m_SupportSize;
  // ContinuousIndexType m_ValidRegionBegin;
  // ContinuousIndexType m_ValidRegionEnd;

  // bool m_SplineOrderOdd;

  const ParametersType * m_InputParametersPointer{};

  /*
  using JacobianPixelType = typename JacobianType::ValueType;
  using JacobianImageType = Image< JacobianPixelType,
    itkGetStaticConstMacro( SpaceDimension ) >;
 
  typename JacobianImageType::Pointer m_JacobianImage[ NDimensions ]{};
  */

  // mutable IndexType m_LastJacobianIndex;

  // ImagePointer    m_WrappedImage[ NDimensions ];

  ParametersType m_InternalParametersBuffer{};
 
  using TransformType = AdvancedBSplineDeformableTransform<TScalarType, Self::SpaceDimension, VSplineOrder>;
 
  unsigned char                                m_NbLabels{};
  ImageLabelPointer                            m_Labels{};
  ImageLabelInterpolatorPointer                m_LabelsInterpolator{};
  ImageVectorPointer                           m_LabelsNormals{};
  std::vector<typename TransformType::Pointer> m_Trans{};
  std::vector<ParametersType>                  m_Para{};
  mutable int                                  m_LastJacobian{};
  ImageBasePointer                             m_LocalBases{};
 
private:
  // Private using-declarations, to avoid `-Woverloaded-virtual` warnings from GCC (GCC 11.4).
  using Superclass::TransformCovariantVector;
  using Superclass::TransformVector;

  static constexpr unsigned NumberOfWeights = TransformType::NumberOfWeights;
 
  void
  DispatchParameters(const ParametersType & parameters);
 
  void
  PointToLabel(const InputPointType & p, int & l) const;
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMultiBSplineDeformableTransformWithNormal.hxx"
#endif
 
#endif // end itkMultiBSplineDeformableTransformWithNormal_h