itkAdvancedIdentityTransform.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.
 *
 *=========================================================================*/
/*=========================================================================
 
  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkIdentityTransform.h,v $
  Date:      $Date: 2009-06-28 14:41:47 $
  Version:   $Revision: 1.19 $
 
  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
 
=========================================================================*/
#ifndef itkAdvancedIdentityTransform_h
#define itkAdvancedIdentityTransform_h
 
#include "itkObject.h"
#include "itkPoint.h"
#include "itkVector.h"
#include "itkCovariantVector.h"
#include <vnl/vnl_vector_fixed.h>
#include "itkArray.h"
#include "itkArray2D.h"
#include "itkAdvancedTransform.h"
 
#include "itkObjectFactory.h"
 
#include <numeric> // For iota.
 
namespace itk
{

template <typename TScalarType, unsigned int NDimensions = 3>
class ITK_TEMPLATE_EXPORT AdvancedIdentityTransform : public AdvancedTransform<TScalarType, NDimensions, NDimensions>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(AdvancedIdentityTransform);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(AdvancedIdentityTransform);

  itkStaticConstMacro(InputSpaceDimension, unsigned int, NDimensions);
  itkStaticConstMacro(OutputSpaceDimension, unsigned int, NDimensions);
  itkStaticConstMacro(ParametersDimension, unsigned int, 1);

  using ScalarType = TScalarType;

  using typename Superclass::ParametersType;
  using typename Superclass::NumberOfParametersType;
  using typename Superclass::TransformCategoryEnum;

  using typename Superclass::JacobianType;

  using InputVectorType = Vector<TScalarType, Self::InputSpaceDimension>;
  using OutputVectorType = Vector<TScalarType, Self::OutputSpaceDimension>;

  using InputCovariantVectorType = CovariantVector<TScalarType, Self::InputSpaceDimension>;
  using OutputCovariantVectorType = CovariantVector<TScalarType, Self::OutputSpaceDimension>;

  using InputVnlVectorType = vnl_vector_fixed<TScalarType, Self::InputSpaceDimension>;
  using OutputVnlVectorType = vnl_vector_fixed<TScalarType, Self::OutputSpaceDimension>;

  using InputPointType = Point<TScalarType, Self::InputSpaceDimension>;
  using OutputPointType = Point<TScalarType, Self::OutputSpaceDimension>;

  using InverseTransformBaseType = typename Superclass::InverseTransformBaseType;
  using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer;

  using typename Superclass::NonZeroJacobianIndicesType;
  using typename Superclass::SpatialJacobianType;
  using typename Superclass::JacobianOfSpatialJacobianType;
  using typename Superclass::SpatialHessianType;
  using typename Superclass::JacobianOfSpatialHessianType;
  using typename Superclass::InternalMatrixType;

  OutputPointType
  TransformPoint(const InputPointType & point) const override
  {
    return point;
  }

  OutputVectorType
  TransformVector(const InputVectorType & vector) const override
  {
    return vector;
  }

  OutputVnlVectorType
  TransformVector(const InputVnlVectorType & vector) const override
  {
    return vector;
  }

  OutputCovariantVectorType
  TransformCovariantVector(const InputCovariantVectorType & vector) const override
  {
    return vector;
  }

  void
  SetIdentity()
  {}

  InverseTransformBasePointer
  GetInverseTransform() const override
  {
    return this->New().GetPointer();
  }
 

  bool
  IsLinear() const override
  {
    return true;
  }

  TransformCategoryEnum
  GetTransformCategory() const override
  {
    return TransformCategoryEnum::Linear;
  }
 

  const ParametersType &
  GetFixedParameters() const override
  {
    return this->m_FixedParameters;
  }
 

  void
  SetFixedParameters(const ParametersType &) override
  {}

  const ParametersType &
  GetParameters() const override
  {
    return this->m_Parameters;
  }
 

  void
  SetParameters(const ParametersType &) override
  {}

  void
  GetJacobian(const InputPointType &,
              JacobianType &               j,
              NonZeroJacobianIndicesType & nonZeroJacobianIndices) const override
  {
    j = this->m_LocalJacobian;
    nonZeroJacobianIndices = this->m_NonZeroJacobianIndices;
  }
 

  void
  GetSpatialJacobian(const InputPointType &, SpatialJacobianType & sj) const override
  {
    sj = this->m_SpatialJacobian;
  }
 

  void
  GetSpatialHessian(const InputPointType &, SpatialHessianType & sh) const override
  {
    sh = this->m_SpatialHessian;
  }
 

  void
  GetJacobianOfSpatialJacobian(const InputPointType &,
                               JacobianOfSpatialJacobianType & jsj,
                               NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const override
  {
    jsj = this->m_JacobianOfSpatialJacobian;
    nonZeroJacobianIndices = this->m_NonZeroJacobianIndices;
  }
 

  void
  GetJacobianOfSpatialJacobian(const InputPointType &,
                               SpatialJacobianType &           sj,
                               JacobianOfSpatialJacobianType & jsj,
                               NonZeroJacobianIndicesType &    nonZeroJacobianIndices) const override
  {
    sj = this->m_SpatialJacobian;
    jsj = this->m_JacobianOfSpatialJacobian;
    nonZeroJacobianIndices = this->m_NonZeroJacobianIndices;
  }
 

  void
  GetJacobianOfSpatialHessian(const InputPointType &,
                              JacobianOfSpatialHessianType & jsh,
                              NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const override
  {
    jsh = this->m_JacobianOfSpatialHessian;
    nonZeroJacobianIndices = this->m_NonZeroJacobianIndices;
  }
 

  void
  GetJacobianOfSpatialHessian(const InputPointType &,
                              SpatialHessianType &           sh,
                              JacobianOfSpatialHessianType & jsh,
                              NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const override
  {
    sh = this->m_SpatialHessian;
    jsh = this->m_JacobianOfSpatialHessian;
    nonZeroJacobianIndices = this->m_NonZeroJacobianIndices;
  }
 
 
protected:
  AdvancedIdentityTransform()
    : AdvancedTransform<TScalarType, NDimensions, NDimensions>(NDimensions)
  {
    // The Jacobian is constant, therefore it can be initialized in the constructor.
    this->m_LocalJacobian = JacobianType(NDimensions, 1, 0.0);

    this->m_SpatialJacobian.SetIdentity();

    this->m_NonZeroJacobianIndices.resize(ParametersDimension);
    std::iota(m_NonZeroJacobianIndices.begin(), m_NonZeroJacobianIndices.end(), 0u);

    this->m_HasNonZeroSpatialHessian = false;
    this->m_HasNonZeroJacobianOfSpatialHessian = false;
    this->m_JacobianOfSpatialJacobian.resize(ParametersDimension);
    this->m_JacobianOfSpatialHessian.resize(ParametersDimension);

  }
 
 
  ~AdvancedIdentityTransform() override = default;
 
private:
  // Private using-declarations, to avoid `-Woverloaded-virtual` warnings from GCC (GCC 11.4).
  using Superclass::TransformVector;
  using Superclass::TransformCovariantVector;
 
  JacobianType                  m_LocalJacobian{};
  SpatialJacobianType           m_SpatialJacobian{};
  SpatialHessianType            m_SpatialHessian{};
  NonZeroJacobianIndicesType    m_NonZeroJacobianIndices{};
  JacobianOfSpatialJacobianType m_JacobianOfSpatialJacobian{};
  JacobianOfSpatialHessianType  m_JacobianOfSpatialHessian{};
};
 
} // end namespace itk
 
#endif