itkDisplacementFieldTransform.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 itkDisplacementFieldTransform_h
#define itkDisplacementFieldTransform_h

#include "itkTransform.h"

#include "itkImage.h"
#include "itkMatrixOffsetTransformBase.h"
#include "itkImageVectorOptimizerParametersHelper.h"
#include "itkVectorInterpolateImageFunction.h"

namespace itk
{

template
<typename TParametersValueType, unsigned int NDimensions>
class ITK_TEMPLATE_EXPORT DisplacementFieldTransform :
  public Transform<TParametersValueType, NDimensions, NDimensions>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(DisplacementFieldTransform);

  using Self = DisplacementFieldTransform;
  using Superclass = Transform<TParametersValueType, NDimensions, NDimensions>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkTypeMacro( DisplacementFieldTransform, Transform );

  itkNewMacro( Self );

  using InverseTransformBasePointer = typename Superclass::InverseTransformBasePointer;

  using ScalarType = typename Superclass::ScalarType;

  using FixedParametersType = typename Superclass::FixedParametersType;
  using FixedParametersValueType = typename Superclass::FixedParametersValueType;
  using ParametersType = typename Superclass::ParametersType;
  using ParametersValueType = typename Superclass::ParametersValueType;

  using JacobianType = typename Superclass::JacobianType;
  using JacobianPositionType = typename Superclass::JacobianPositionType;
  using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType;

  using TransformCategoryType = typename Superclass::TransformCategoryType;

  using NumberOfParametersType = typename Superclass::NumberOfParametersType;

  using InputPointType = typename Superclass::InputPointType;
  using OutputPointType = typename Superclass::OutputPointType;

  using InputVectorType = typename Superclass::InputVectorType;
  using OutputVectorType = typename Superclass::OutputVectorType;

  using InputVectorPixelType = typename Superclass::InputVectorPixelType;
  using OutputVectorPixelType = typename Superclass::OutputVectorPixelType;

  using InputCovariantVectorType = typename Superclass::InputCovariantVectorType;
  using OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType;

  using InputVnlVectorType = typename Superclass::InputVnlVectorType;
  using OutputVnlVectorType = typename Superclass::OutputVnlVectorType;

  using InputDiffusionTensor3DType = typename Superclass::InputDiffusionTensor3DType;
  using OutputDiffusionTensor3DType = typename Superclass::OutputDiffusionTensor3DType;

  using InputTensorEigenVectorType =
      CovariantVector<ScalarType, InputDiffusionTensor3DType::Dimension>;
  using OutputTensorEigenVectorType =
      CovariantVector<ScalarType, OutputDiffusionTensor3DType::Dimension>;

  using DerivativeType = typename Superclass::DerivativeType;

  static constexpr unsigned int Dimension = NDimensions;

  using DisplacementFieldType = Image<OutputVectorType,  Dimension>;
  using DisplacementFieldPointer = typename DisplacementFieldType::Pointer;
  using DisplacementFieldConstPointer = typename DisplacementFieldType::ConstPointer;

  using InterpolatorType = VectorInterpolateImageFunction
    <DisplacementFieldType, ScalarType>;

  using IndexType = typename DisplacementFieldType::IndexType;
  using RegionType = typename DisplacementFieldType::RegionType;
  using SizeType = typename DisplacementFieldType::SizeType;
  using SpacingType = typename DisplacementFieldType::SpacingType;
  using DirectionType = typename DisplacementFieldType::DirectionType;
  using PointType = typename DisplacementFieldType::PointType;
  using PixelType = typename DisplacementFieldType::PixelType;

  using OptimizerParametersHelperType = ImageVectorOptimizerParametersHelper<
    ScalarType,
    OutputVectorType::Dimension,
    Dimension>;

  virtual void SetDisplacementField( DisplacementFieldType* field );
  itkGetModifiableObjectMacro(DisplacementField, DisplacementFieldType );

  virtual void SetInverseDisplacementField( DisplacementFieldType * inverseDisplacementField );
  itkGetModifiableObjectMacro(InverseDisplacementField, DisplacementFieldType );

  virtual void SetInterpolator( InterpolatorType* interpolator );
  itkGetModifiableObjectMacro( Interpolator, InterpolatorType );

  virtual void SetInverseInterpolator( InterpolatorType* interpolator );
  itkGetModifiableObjectMacro(InverseInterpolator, InterpolatorType );

  itkGetConstReferenceMacro( DisplacementFieldSetTime, ModifiedTimeType );

  OutputPointType TransformPoint( const InputPointType& thisPoint ) const override;

  using Superclass::TransformVector;
  OutputVectorType TransformVector(const InputVectorType &) const override
  {
    itkExceptionMacro( "TransformVector(Vector) unimplemented, use "
                       "TransformVector(Vector,Point)" );
  }

  OutputVectorPixelType TransformVector(const InputVectorPixelType &) const override
  {
    itkExceptionMacro( "TransformVector(Vector) unimplemented, use "
                       "TransformVector(Vector,Point)" );
  }

  OutputVnlVectorType TransformVector(const InputVnlVectorType &) const override
  {
    itkExceptionMacro( "TransformVector(Vector) unimplemented, use "
                       "TransformVector(Vector,Point)" );
  }

  using Superclass::TransformDiffusionTensor3D;
  OutputDiffusionTensor3DType TransformDiffusionTensor(
    const InputDiffusionTensor3DType & ) const
  {
    itkExceptionMacro( "TransformDiffusionTensor(Tensor) unimplemented, use "
                       "TransformDiffusionTensor(Tensor,Point)" );
  }

  OutputVectorPixelType TransformDiffusionTensor(const InputVectorPixelType & )
  const
  {
    itkExceptionMacro( "TransformDiffusionTensor(Tensor) unimplemented, use "
                       "TransformDiffusionTensor(Tensor,Point)" );
  }

  using Superclass::TransformCovariantVector;
  OutputCovariantVectorType TransformCovariantVector(
    const InputCovariantVectorType &) const override
  {
    itkExceptionMacro( "TransformCovariantVector(CovariantVector) "
                       "unimplemented, use TransformCovariantVector(CovariantVector,Point)" );
  }

  OutputVectorPixelType TransformCovariantVector(
    const InputVectorPixelType &) const override
  {
    itkExceptionMacro( "TransformCovariantVector(CovariantVector) "
                       "unimplemented, use TransformCovariantVector(CovariantVector,Point)" );
  }

  void SetParameters(const ParametersType & params) override
  {
    if( &(this->m_Parameters) != &params )
      {
      if( params.Size() != this->m_Parameters.Size() )
        {
        itkExceptionMacro("Input parameters size (" << params.Size()
                                                    << ") does not match internal size ("
                                                    << this->m_Parameters.Size() << ").");
        }
      // Copy into existing object
      this->m_Parameters = params;
      this->Modified();
      }
  }

  void SetFixedParameters( const FixedParametersType & ) override;

  void ComputeJacobianWithRespectToParameters(const InputPointType &,
                                                      JacobianType & j) const override
  {
    j = this->m_IdentityJacobian;
  }

  virtual void ComputeJacobianWithRespectToParameters(const IndexType &,
                                                      JacobianType & j) const
  {
    j = this->m_IdentityJacobian;
  }

  void ComputeJacobianWithRespectToPosition(const InputPointType  & x, JacobianPositionType & j ) const override;
  using Superclass::ComputeJacobianWithRespectToPosition;

  void ComputeInverseJacobianWithRespectToPosition(const InputPointType  & x,
                                                   InverseJacobianPositionType & j ) const override;
  using Superclass::ComputeInverseJacobianWithRespectToPosition;

  virtual void ComputeJacobianWithRespectToPosition(const IndexType  & x, JacobianPositionType & j ) const;

  virtual void GetInverseJacobianOfForwardFieldWithRespectToPosition(const InputPointType & point,
                                                                     JacobianPositionType & jacobian,
                                                                     bool useSVD = false ) const;

  virtual void GetInverseJacobianOfForwardFieldWithRespectToPosition(const IndexType & index,
                                                                     JacobianPositionType & jacobian,
                                                                     bool useSVD = false ) const;

  void UpdateTransformParameters( const DerivativeType & update, ScalarType factor = 1.0 ) override;

  bool GetInverse( Self *inverse ) const;

  InverseTransformBasePointer GetInverseTransform() const override;

  virtual void SetIdentity();

  TransformCategoryType GetTransformCategory() const override
  {
    return Self::DisplacementField;
  }

  NumberOfParametersType GetNumberOfLocalParameters() const override
  {
    return Dimension;
  }

  itkSetMacro(CoordinateTolerance, double);
  itkGetConstMacro(CoordinateTolerance, double);

  itkSetMacro(DirectionTolerance, double);
  itkGetConstMacro(DirectionTolerance, double);

protected:

  DisplacementFieldTransform();
  ~DisplacementFieldTransform() override = default;
  void PrintSelf( std::ostream& os, Indent indent ) const override;

  typename DisplacementFieldType::Pointer      m_DisplacementField;
  typename DisplacementFieldType::Pointer      m_InverseDisplacementField;

  typename InterpolatorType::Pointer          m_Interpolator;
  typename InterpolatorType::Pointer          m_InverseInterpolator;

  ModifiedTimeType m_DisplacementFieldSetTime{ 0 };

  JacobianType m_IdentityJacobian;

private:
  virtual void ComputeJacobianWithRespectToPositionInternal(const IndexType & index,
                                                            JacobianPositionType & jacobian,
                                                            bool doInverseJacobian) const;

  virtual void VerifyFixedParametersInformation();

  virtual void SetFixedParametersFromDisplacementField() const;

  double m_CoordinateTolerance;
  double m_DirectionTolerance;

};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkDisplacementFieldTransform.hxx"
#endif

#endif // itkDisplacementFieldTransform_h