itkAdvancedTranslationTransform.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: itkAdvancedTranslationTransform.h,v $
  Date:      $Date: 2007-07-15 16:38:25 $
  Version:   $Revision: 1.36 $
 
  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 itkAdvancedTranslationTransform_h
#define itkAdvancedTranslationTransform_h
 
#include <iostream>
#include "itkAdvancedTransform.h"
#include "itkMacro.h"
#include "itkMatrix.h"
 
namespace itk
{
 
template <class TScalarType = double, // Data type for scalars (float or double)
          unsigned int NDimensions = 3>
// Number of dimensions
class ITK_TEMPLATE_EXPORT AdvancedTranslationTransform : public AdvancedTransform<TScalarType, NDimensions, NDimensions>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(AdvancedTranslationTransform);
 
  using Self = AdvancedTranslationTransform;
  using Superclass = AdvancedTransform<TScalarType, NDimensions, NDimensions>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(AdvancedTranslationTransform, AdvancedTransform);
 
  itkStaticConstMacro(SpaceDimension, unsigned int, NDimensions);
  itkStaticConstMacro(ParametersDimension, unsigned int, NDimensions);
 
  using typename Superclass::ScalarType;
 
  using typename Superclass::ParametersType;
  using typename Superclass::FixedParametersType;
  using typename Superclass::NumberOfParametersType;
  using typename Superclass::TransformCategoryEnum;
 
  using typename Superclass::JacobianType;
 
  using InputVectorType = Vector<TScalarType, Self::SpaceDimension>;
  using OutputVectorType = Vector<TScalarType, Self::SpaceDimension>;
 
  using InputCovariantVectorType = CovariantVector<TScalarType, Self::SpaceDimension>;
  using OutputCovariantVectorType = CovariantVector<TScalarType, Self::SpaceDimension>;
 
  using InputVnlVectorType = vnl_vector_fixed<TScalarType, Self::SpaceDimension>;
  using OutputVnlVectorType = vnl_vector_fixed<TScalarType, Self::SpaceDimension>;
 
  using InputPointType = Point<TScalarType, Self::SpaceDimension>;
  using OutputPointType = Point<TScalarType, Self::SpaceDimension>;
 
  using typename Superclass::NonZeroJacobianIndicesType;
  using typename Superclass::SpatialJacobianType;
  using typename Superclass::JacobianOfSpatialJacobianType;
  using typename Superclass::SpatialHessianType;
  using typename Superclass::JacobianOfSpatialHessianType;
  using typename Superclass::InternalMatrixType;
 
  const OutputVectorType &
  GetOffset() const
  {
    return m_Offset;
  }
 
  void
  SetParameters(const ParametersType & parameters) override;
 
  const ParametersType &
  GetParameters() const override;
 
  void
  SetOffset(const OutputVectorType & offset)
  {
    m_Offset = offset;
    return;
  }
 
  OutputPointType
  TransformPoint(const InputPointType & point) const override;
 
  OutputVectorType
  TransformVector(const InputVectorType & vector) const override;
 
  OutputVnlVectorType
  TransformVector(const InputVnlVectorType & vector) const override;
 
  OutputCovariantVectorType
  TransformCovariantVector(const InputCovariantVectorType & vector) const override;
 
  void
  GetJacobian(const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const override;
 
  void
  GetSpatialJacobian(const InputPointType &, SpatialJacobianType &) const override;
 
  void
  GetSpatialHessian(const InputPointType &, SpatialHessianType &) const override;
 
  void
  GetJacobianOfSpatialJacobian(const InputPointType &,
                               JacobianOfSpatialJacobianType &,
                               NonZeroJacobianIndicesType &) const override;
 
  void
  GetJacobianOfSpatialJacobian(const InputPointType &,
                               SpatialJacobianType &,
                               JacobianOfSpatialJacobianType &,
                               NonZeroJacobianIndicesType &) const override;
 
  void
  GetJacobianOfSpatialHessian(const InputPointType &,
                              JacobianOfSpatialHessianType &,
                              NonZeroJacobianIndicesType &) const override;
 
  void
  GetJacobianOfSpatialHessian(const InputPointType &         inputPoint,
                              SpatialHessianType &           sh,
                              JacobianOfSpatialHessianType & jsh,
                              NonZeroJacobianIndicesType &   nonZeroJacobianIndices) const override;
 
  void
  SetIdentity();
 
  NumberOfParametersType
  GetNumberOfParameters() const override
  {
    return NDimensions;
  }
 
  bool
  IsLinear() const override
  {
    return true;
  }
 
  TransformCategoryEnum
  GetTransformCategory() const override
  {
    return TransformCategoryEnum::Linear;
  }
 
 
  void
  SetFixedParameters(const FixedParametersType &) override
  { /* purposely blank */
  }
 
  const FixedParametersType &
  GetFixedParameters() const override
  {
    this->m_FixedParameters.SetSize(0);
    return this->m_FixedParameters;
  }
 
 
protected:
  AdvancedTranslationTransform();
  ~AdvancedTranslationTransform() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  // Private using-declarations, to avoid `-Woverloaded-virtual` warnings from GCC (GCC 11.4).
  using Superclass::TransformCovariantVector;
  using Superclass::TransformVector;
 
  OutputVectorType m_Offset{}; // Offset of the transformation
 
  // The Jacobian of this transform is constant. Therefore it can be shared among all the threads.
  const JacobianType m_LocalJacobian{
    Matrix<TScalarType, NDimensions, NDimensions>::GetIdentity().GetVnlMatrix().as_matrix()
  };
  const SpatialJacobianType           m_SpatialJacobian{ SpatialJacobianType::GetIdentity() };
  const SpatialHessianType            m_SpatialHessian{};
  NonZeroJacobianIndicesType          m_NonZeroJacobianIndices{ NonZeroJacobianIndicesType(NDimensions) };
  const JacobianOfSpatialJacobianType m_JacobianOfSpatialJacobian{ JacobianOfSpatialJacobianType(NDimensions) };
  const JacobianOfSpatialHessianType  m_JacobianOfSpatialHessian{ JacobianOfSpatialHessianType(NDimensions) };
};
 
// class AdvancedTranslationTransform
 
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkAdvancedTranslationTransform.hxx"
#endif
 
#endif /* itkAdvancedTranslationTransform_h */