itkSimilarity2DTransform.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 itkSimilarity2DTransform_h
#define itkSimilarity2DTransform_h
 
#include <iostream>
#include "itkRigid2DTransform.h"
 
namespace itk
{
template <typename TParametersValueType = double>
class ITK_TEMPLATE_EXPORT Similarity2DTransform : public Rigid2DTransform<TParametersValueType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(Similarity2DTransform);

  using Self = Similarity2DTransform;
  using Superclass = Rigid2DTransform<TParametersValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(Similarity2DTransform);

  static constexpr unsigned int SpaceDimension = 2;
  static constexpr unsigned int InputSpaceDimension = 2;
  static constexpr unsigned int OutputSpaceDimension = 2;
  static constexpr unsigned int ParametersDimension = 4;
 
  using typename Superclass::ScalarType;
  using ScaleType = TParametersValueType;

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

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

  using typename Superclass::OffsetType;
  using typename Superclass::OffsetValueType;

  using typename Superclass::MatrixType;
  using typename Superclass::MatrixValueType;

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

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

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

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

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

  void
  SetScale(ScaleType scale);
 
  itkGetConstReferenceMacro(Scale, ScaleType);

  void
  SetParameters(const ParametersType & parameters) override;

  const ParametersType &
  GetParameters() const override;

  void
  ComputeJacobianWithRespectToParameters(const InputPointType & p, JacobianType & jacobian) const override;

  void
  SetIdentity() override;

  void
  CloneInverseTo(Pointer & result) const;

  bool
  GetInverse(Self * inverse) const;

  InverseTransformBasePointer
  GetInverseTransform() const override;

  void
  CloneTo(Pointer & result) const;

  void
  SetMatrix(const MatrixType & matrix) override;

  void
  SetMatrix(const MatrixType & matrix, const TParametersValueType tolerance) override;
 
protected:
  Similarity2DTransform(unsigned int outputSpaceDimension, unsigned int parametersDimension);
  Similarity2DTransform(unsigned int parametersDimension);
  Similarity2DTransform();
 
  ~Similarity2DTransform() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  ComputeMatrix() override;

  void
  ComputeMatrixParameters() override;

  void
  SetVarScale(ScaleType scale)
  {
    m_Scale = scale;
  }
 
private:
  ScaleType m_Scale{};
}; // class Similarity2DTransform
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSimilarity2DTransform.hxx"
#endif
 
#endif /* itkSimilarity2DTransform_h */