itkAffineTransform.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 itkAffineTransform_h
#define itkAffineTransform_h

#include "itkMatrixOffsetTransformBase.h"
#include <iostream>


namespace itk
{

template<
  typename TParametersValueType = double,
  unsigned int NDimensions = 3 >
// Number of dimensions in the input space
class ITK_TEMPLATE_EXPORT AffineTransform:
  public MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions>
{
public:
  using Self = AffineTransform;
  using Superclass = MatrixOffsetTransformBase< TParametersValueType,
                                     NDimensions,
                                     NDimensions >;

  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkTypeMacro(AffineTransform, MatrixOffsetTransformBase);

  itkNewMacro(Self);

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

  using ParametersType = typename Superclass::ParametersType;
  using FixedParametersType = typename Superclass::FixedParametersType;
  using JacobianType = typename Superclass::JacobianType;
  using JacobianPositionType = typename Superclass::JacobianPositionType;
  using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType;
  using ScalarType = typename Superclass::ScalarType;
  using InputPointType = typename Superclass::InputPointType;
  using OutputPointType = typename Superclass::OutputPointType;
  using InputVectorType = typename Superclass::InputVectorType;
  using OutputVectorType = typename Superclass::OutputVectorType;
  using InputVnlVectorType = typename Superclass::InputVnlVectorType;
  using OutputVnlVectorType = typename Superclass::OutputVnlVectorType;
  using InputCovariantVectorType = typename Superclass::InputCovariantVectorType;
  using OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType;
  using MatrixType = typename Superclass::MatrixType;
  using InverseMatrixType = typename Superclass::InverseMatrixType;
  using CenterType = typename Superclass::CenterType;
  using OffsetType = typename Superclass::OffsetType;
  using TranslationType = typename Superclass::TranslationType;

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

  void Translate(const OutputVectorType & offset, 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:
  AffineTransform(const MatrixType & matrix,
                  const OutputVectorType & offset);
  AffineTransform(unsigned int paramDims);
  AffineTransform();

  ~AffineTransform() override = default;

  void PrintSelf(std::ostream & s, Indent indent) const override;

private:

  AffineTransform(const Self & other) = delete;
  const Self & operator=(const Self &) = delete;
}; //class AffineTransform

}  // namespace itk

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

#endif /* itkAffineTransform_h */