itkAdvancedCombinationTransform.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 itkAdvancedCombinationTransform_h
#define itkAdvancedCombinationTransform_h
 
#include "itkAdvancedTransform.h"
#include "itkMacro.h"
 
namespace itk
{
 
template <typename TScalarType, unsigned int NDimensions = 3>
class ITK_TEMPLATE_EXPORT AdvancedCombinationTransform : public AdvancedTransform<TScalarType, NDimensions, NDimensions>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(AdvancedCombinationTransform);
 
  using Self = AdvancedCombinationTransform;
  using Superclass = AdvancedTransform<TScalarType, NDimensions, NDimensions>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(AdvancedCombinationTransform, AdvancedTransform);
 
  itkStaticConstMacro(SpaceDimension, unsigned int, NDimensions);
 
  using typename Superclass::ScalarType;
  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::InputVectorType;
  using typename Superclass::OutputVectorType;
  using typename Superclass::InputCovariantVectorType;
  using typename Superclass::OutputCovariantVectorType;
  using typename Superclass::InputVnlVectorType;
  using typename Superclass::OutputVnlVectorType;
  using typename Superclass::InputPointType;
  using typename Superclass::OutputPointType;
  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 InverseTransformBaseType = typename Superclass::InverseTransformBaseType;
  using typename Superclass::InverseTransformBasePointer;
  using typename Superclass::TransformCategoryEnum;
  using typename Superclass::MovingImageGradientType;
  using typename Superclass::MovingImageGradientValueType;
 
  using TransformType = typename Superclass::TransformType;
  using TransformTypePointer = typename TransformType::Pointer;
  using TransformTypeConstPointer = typename TransformType::ConstPointer;
 
  using InitialTransformType = Superclass;
  using InitialTransformPointer = typename InitialTransformType::Pointer;
  using InitialTransformConstPointer = typename InitialTransformType::ConstPointer;
  using InitialTransformInverseTransformBaseType = typename InitialTransformType::InverseTransformBaseType;
  using InitialTransformInverseTransformBasePointer = typename InitialTransformType::InverseTransformBasePointer;
 
  using CurrentTransformType = Superclass;
  using CurrentTransformPointer = typename CurrentTransformType::Pointer;
  using CurrentTransformConstPointer = typename CurrentTransformType::ConstPointer;
  using CurrentTransformInverseTransformBaseType = typename CurrentTransformType::InverseTransformBaseType;
  using CurrentTransformInverseTransformBasePointer = typename CurrentTransformType::InverseTransformBasePointer;
 
  void
  SetInitialTransform(InitialTransformType * _arg);
 
  itkGetModifiableObjectMacro(InitialTransform, InitialTransformType);
 
  void
  SetCurrentTransform(CurrentTransformType * _arg);
 
  itkGetModifiableObjectMacro(CurrentTransform, CurrentTransformType);
 
  SizeValueType
  GetNumberOfTransforms() const;
 
  const TransformTypePointer
  GetNthTransform(SizeValueType n) const;
 
  void
  SetUseComposition(bool _arg);
 
  itkGetConstMacro(UseComposition, bool);
 
  void
  SetUseAddition(bool _arg);
 
  itkGetConstMacro(UseAddition, bool);
 
  OutputPointType
  TransformPoint(const InputPointType & point) const override;
 
  OutputVectorType
  TransformVector(const InputVectorType &) const override
  {
    itkExceptionMacro("TransformVector(const InputVectorType &) is not implemented for AdvancedCombinationTransform");
  }
 
 
  OutputVnlVectorType
  TransformVector(const InputVnlVectorType &) const override
  {
    itkExceptionMacro(
      "TransformVector(const InputVnlVectorType &) is not implemented for AdvancedCombinationTransform");
  }
 
 
  OutputCovariantVectorType
  TransformCovariantVector(const InputCovariantVectorType &) const override
  {
    itkExceptionMacro("TransformCovariantVector(const InputCovariantVectorType &) is not implemented for "
                      "AdvancedCombinationTransform");
  }
 
 
  NumberOfParametersType
  GetNumberOfParameters() const override;
 
  NumberOfParametersType
  GetNumberOfNonZeroJacobianIndices() const override;
 
  const ParametersType &
  GetParameters() const override;
 
  const FixedParametersType &
  GetFixedParameters() const override;
 
  void
  SetParameters(const ParametersType & param) override;
 
  void
  SetParametersByValue(const ParametersType & param) override;
 
  void
  SetFixedParameters(const FixedParametersType & fixedParam) override;
 
  bool
  GetInverse(Self * inverse) const;
 
  bool
  IsLinear() const override;
 
  TransformCategoryEnum
  GetTransformCategory() const override;
 
  bool
  GetHasNonZeroSpatialHessian() const override;
 
  bool
  HasNonZeroJacobianOfSpatialHessian() const;
 
  void
  GetJacobian(const InputPointType &       inputPoint,
              JacobianType &               j,
              NonZeroJacobianIndicesType & nonZeroJacobianIndices) const override;
 
  void
  EvaluateJacobianWithImageGradientProduct(const InputPointType &          inputPoint,
                                           const MovingImageGradientType & movingImageGradient,
                                           DerivativeType &                imageJacobian,
                                           NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const override;
 
  void
  GetSpatialJacobian(const InputPointType & inputPoint, SpatialJacobianType & sj) const override;
 
  void
  GetSpatialHessian(const InputPointType & inputPoint, SpatialHessianType & sh) const override;
 
  void
  GetJacobianOfSpatialJacobian(const InputPointType &          inputPoint,
                               JacobianOfSpatialJacobianType & jsj,
                               NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const override;
 
  void
  GetJacobianOfSpatialJacobian(const InputPointType &          inputPoint,
                               SpatialJacobianType &           sj,
                               JacobianOfSpatialJacobianType & jsj,
                               NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const override;
 
  void
  GetJacobianOfSpatialHessian(const InputPointType &         inputPoint,
                              JacobianOfSpatialHessianType & jsh,
                              NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const override;
 
  void
  GetJacobianOfSpatialHessian(const InputPointType &         inputPoint,
                              SpatialHessianType &           sh,
                              JacobianOfSpatialHessianType & jsh,
                              NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const override;
 
protected:
  AdvancedCombinationTransform();
 
  ~AdvancedCombinationTransform() override = default;
 
  void
  UpdateCombinationMethod();
 
  OutputPointType
  TransformPointUseAddition(const InputPointType & point) const;
 
  OutputPointType
  TransformPointUseComposition(const InputPointType & point) const;
 
  OutputPointType
  TransformPointNoInitialTransform(const InputPointType & point) const;
 
  OutputPointType
  TransformPointNoCurrentTransform(const InputPointType & point) const;
 
  void
  GetJacobianUseAddition(const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const;
 
  void
  GetJacobianUseComposition(const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const;
 
  void
  GetJacobianNoInitialTransform(const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const;
 
  void
  GetJacobianNoCurrentTransform(const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const;
 
  void
  EvaluateJacobianWithImageGradientProductUseAddition(const InputPointType &,
                                                      const MovingImageGradientType &,
                                                      DerivativeType &,
                                                      NonZeroJacobianIndicesType &) const;
 
  void
  EvaluateJacobianWithImageGradientProductUseComposition(const InputPointType &,
                                                         const MovingImageGradientType &,
                                                         DerivativeType &,
                                                         NonZeroJacobianIndicesType &) const;
 
  void
  EvaluateJacobianWithImageGradientProductNoInitialTransform(const InputPointType &,
                                                             const MovingImageGradientType &,
                                                             DerivativeType &,
                                                             NonZeroJacobianIndicesType &) const;
 
  void
  EvaluateJacobianWithImageGradientProductNoCurrentTransform(const InputPointType &,
                                                             const MovingImageGradientType &,
                                                             DerivativeType &,
                                                             NonZeroJacobianIndicesType &) const;
 
  void
  GetSpatialJacobianUseAddition(const InputPointType & inputPoint, SpatialJacobianType & sj) const;
 
  void
  GetSpatialJacobianUseComposition(const InputPointType & inputPoint, SpatialJacobianType & sj) const;
 
  void
  GetSpatialJacobianNoInitialTransform(const InputPointType & inputPoint, SpatialJacobianType & sj) const;
 
  void
  GetSpatialJacobianNoCurrentTransform(const InputPointType & inputPoint, SpatialJacobianType & sj) const;
 
  void
  GetSpatialHessianUseAddition(const InputPointType & inputPoint, SpatialHessianType & sh) const;
 
  void
  GetSpatialHessianUseComposition(const InputPointType & inputPoint, SpatialHessianType & sh) const;
 
  void
  GetSpatialHessianNoInitialTransform(const InputPointType & inputPoint, SpatialHessianType & sh) const;
 
  void
  GetSpatialHessianNoCurrentTransform(const InputPointType & inputPoint, SpatialHessianType & sh) const;
 
  void
  GetJacobianOfSpatialJacobianUseAddition(const InputPointType &          inputPoint,
                                          JacobianOfSpatialJacobianType & jsj,
                                          NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialJacobianUseAddition(const InputPointType &          inputPoint,
                                          SpatialJacobianType &           sj,
                                          JacobianOfSpatialJacobianType & jsj,
                                          NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialJacobianUseComposition(const InputPointType &          inputPoint,
                                             JacobianOfSpatialJacobianType & jsj,
                                             NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialJacobianUseComposition(const InputPointType &          inputPoint,
                                             SpatialJacobianType &           sj,
                                             JacobianOfSpatialJacobianType & jsj,
                                             NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialJacobianNoInitialTransform(const InputPointType &          inputPoint,
                                                 JacobianOfSpatialJacobianType & jsj,
                                                 NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialJacobianNoInitialTransform(const InputPointType &          inputPoint,
                                                 SpatialJacobianType &           sj,
                                                 JacobianOfSpatialJacobianType & jsj,
                                                 NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialJacobianNoCurrentTransform(const InputPointType &          inputPoint,
                                                 JacobianOfSpatialJacobianType & jsj,
                                                 NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialJacobianNoCurrentTransform(const InputPointType &          inputPoint,
                                                 SpatialJacobianType &           sj,
                                                 JacobianOfSpatialJacobianType & jsj,
                                                 NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialHessianUseAddition(const InputPointType &         inputPoint,
                                         JacobianOfSpatialHessianType & jsh,
                                         NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialHessianUseAddition(const InputPointType &         inputPoint,
                                         SpatialHessianType &           sh,
                                         JacobianOfSpatialHessianType & jsh,
                                         NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialHessianUseComposition(const InputPointType &         inputPoint,
                                            JacobianOfSpatialHessianType & jsh,
                                            NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialHessianUseComposition(const InputPointType &         inputPoint,
                                            SpatialHessianType &           sh,
                                            JacobianOfSpatialHessianType & jsh,
                                            NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialHessianNoInitialTransform(const InputPointType &         inputPoint,
                                                JacobianOfSpatialHessianType & jsh,
                                                NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialHessianNoInitialTransform(const InputPointType &         inputPoint,
                                                SpatialHessianType &           sh,
                                                JacobianOfSpatialHessianType & jsh,
                                                NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialHessianNoCurrentTransform(const InputPointType &         inputPoint,
                                                JacobianOfSpatialHessianType & jsh,
                                                NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const;
 
  void
  GetJacobianOfSpatialHessianNoCurrentTransform(const InputPointType &         inputPoint,
                                                SpatialHessianType &           sh,
                                                JacobianOfSpatialHessianType & jsh,
                                                NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const;
 
private:
  // Private using-declarations, to avoid `-Woverloaded-virtual` warnings from GCC (GCC 11.4).
  using Superclass::TransformCovariantVector;
  using Superclass::TransformVector;
 
  static constexpr const char * NoCurrentTransformSet = "No current transform set in the AdvancedCombinationTransform";
 
  InitialTransformPointer m_InitialTransform{ nullptr };
  CurrentTransformPointer m_CurrentTransform{ nullptr };
 
  using TransformPointFunctionPointer = OutputPointType (Self::*)(const InputPointType &) const;
  using GetSparseJacobianFunctionPointer = void (Self::*)(const InputPointType &,
                                                          JacobianType &,
                                                          NonZeroJacobianIndicesType &) const;
  using EvaluateJacobianWithImageGradientProductFunctionPointer = void (Self::*)(const InputPointType &,
                                                                                 const MovingImageGradientType &,
                                                                                 DerivativeType &,
                                                                                 NonZeroJacobianIndicesType &) const;
  using GetSpatialJacobianFunctionPointer = void (Self::*)(const InputPointType &, SpatialJacobianType &) const;
  using GetSpatialHessianFunctionPointer = void (Self::*)(const InputPointType &, SpatialHessianType &) const;
  using GetJacobianOfSpatialJacobianFunctionPointer = void (Self::*)(const InputPointType &,
                                                                     JacobianOfSpatialJacobianType &,
                                                                     NonZeroJacobianIndicesType &) const;
  using GetJacobianOfSpatialJacobianFunctionPointer2 = void (Self::*)(const InputPointType &,
                                                                      SpatialJacobianType &,
                                                                      JacobianOfSpatialJacobianType &,
                                                                      NonZeroJacobianIndicesType &) const;
  using GetJacobianOfSpatialHessianFunctionPointer = void (Self::*)(const InputPointType &,
                                                                    JacobianOfSpatialHessianType &,
                                                                    NonZeroJacobianIndicesType &) const;
  using GetJacobianOfSpatialHessianFunctionPointer2 = void (Self::*)(const InputPointType &,
                                                                     SpatialHessianType &,
                                                                     JacobianOfSpatialHessianType &,
                                                                     NonZeroJacobianIndicesType &) const;
 
  TransformPointFunctionPointer m_SelectedTransformPointFunction{ &Self::TransformPointNoCurrentTransform };
 
  // GetJacobianFunctionPointer m_SelectedGetJacobianFunction;
 
  GetSparseJacobianFunctionPointer m_SelectedGetSparseJacobianFunction{ &Self::GetJacobianNoCurrentTransform };
  EvaluateJacobianWithImageGradientProductFunctionPointer m_SelectedEvaluateJacobianWithImageGradientProductFunction{
    &Self::EvaluateJacobianWithImageGradientProductNoInitialTransform
  };
  GetSpatialJacobianFunctionPointer m_SelectedGetSpatialJacobianFunction{ &Self::GetSpatialJacobianNoCurrentTransform };
  GetSpatialHessianFunctionPointer  m_SelectedGetSpatialHessianFunction{ &Self::GetSpatialHessianNoCurrentTransform };
  GetJacobianOfSpatialJacobianFunctionPointer m_SelectedGetJacobianOfSpatialJacobianFunction{
    &Self::GetJacobianOfSpatialJacobianNoCurrentTransform
  };
  GetJacobianOfSpatialJacobianFunctionPointer2 m_SelectedGetJacobianOfSpatialJacobianFunction2{
    &Self::GetJacobianOfSpatialJacobianNoCurrentTransform
  };
  GetJacobianOfSpatialHessianFunctionPointer m_SelectedGetJacobianOfSpatialHessianFunction{
    &Self::GetJacobianOfSpatialHessianNoCurrentTransform
  };
  GetJacobianOfSpatialHessianFunctionPointer2 m_SelectedGetJacobianOfSpatialHessianFunction2{
    &Self::GetJacobianOfSpatialHessianNoCurrentTransform
  };
 
  bool m_UseAddition{ false };
  bool m_UseComposition{ true };
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkAdvancedCombinationTransform.hxx"
#endif
 
#endif // end #ifndef itkAdvancedCombinationTransform_h