itkAffineTransform.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkAffineTransform_h
#define itkAffineTransform_h
 
#include "itkMatrixOffsetTransformBase.h"
#include <iostream>
 
 
namespace itk
{
 
template <typename TParametersValueType = double, unsigned int VDimension = 3>
// Number of dimensions in the input space
class ITK_TEMPLATE_EXPORT AffineTransform
  : public MatrixOffsetTransformBase<TParametersValueType, VDimension, VDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(AffineTransform);

  using Self = AffineTransform;
  using Superclass = MatrixOffsetTransformBase<TParametersValueType, VDimension, VDimension>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(AffineTransform);

  itkNewMacro(Self);

  static constexpr unsigned int InputSpaceDimension = VDimension;
  static constexpr unsigned int OutputSpaceDimension = VDimension;
  static constexpr unsigned int SpaceDimension = VDimension;
  static constexpr unsigned int ParametersDimension = VDimension * (VDimension + 1);

  using typename Superclass::ParametersType;
  using typename Superclass::FixedParametersType;
  using typename Superclass::JacobianType;
  using typename Superclass::JacobianPositionType;
  using typename Superclass::InverseJacobianPositionType;
  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::MatrixType;
  using typename Superclass::InverseMatrixType;
  using typename Superclass::CenterType;
  using typename Superclass::OffsetType;
  using typename Superclass::TranslationType;

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

  void
  Translate(const OutputVectorType & trans, bool pre = false);

  void
  Scale(const OutputVectorType & factor, bool pre = false);
 
  void
  Scale(const TParametersValueType & factor, bool pre = false);

  void
  Rotate(int axis1, int axis2, TParametersValueType angle, bool pre = false);

  void
  Rotate2D(TParametersValueType angle, bool pre = false);

  void
  Rotate3D(const OutputVectorType & axis, TParametersValueType angle, bool pre = false);

  void
  Shear(int axis1, int axis2, TParametersValueType coef, bool pre = false);

  bool
  GetInverse(Self * inverse) const;

  InverseTransformBasePointer
  GetInverseTransform() const override;

  ScalarType
  Metric(const Self * other) const;

  ScalarType
  Metric() const;
 
protected:
#if !defined(ITK_LEGACY_REMOVE)
  [[deprecated("Removed unused constructor")]] AffineTransform(const MatrixType &       matrix,
                                                               const OutputVectorType & offset);
#endif
  AffineTransform(unsigned int parametersDimension);
  AffineTransform();

  ~AffineTransform() override = default;
 
}; // class AffineTransform
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkAffineTransform.hxx"
#endif
 
#endif /* itkAffineTransform_h */