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

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(CenteredSimilarity2DTransform);

  static constexpr unsigned int SpaceDimension = 2;
  static constexpr unsigned int InputSpaceDimension = 2;
  static constexpr unsigned int OutputSpaceDimension = 2;
  static constexpr unsigned int ParametersDimension = 6;

  using typename Superclass::ScalarType;

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

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

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

  using typename Superclass::InputPointType;
  using typename Superclass::OutputPointType;
  using InputPointValueType = typename InputPointType::ValueType;

  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
  SetParameters(const ParametersType & parameters) override;

  const ParametersType &
  GetParameters() const override;

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

  void
  SetFixedParameters(const FixedParametersType &) override;

  const FixedParametersType &
  GetFixedParameters() const override;

  void
  CloneInverseTo(Pointer & result) const;

  bool
  GetInverse(Self * inverse) const;

  InverseTransformBasePointer
  GetInverseTransform() const override;

  void
  CloneTo(Pointer & result) const;
 
protected:
  CenteredSimilarity2DTransform();
  CenteredSimilarity2DTransform(unsigned int spaceDimension, unsigned int parametersDimension);
 
  ~CenteredSimilarity2DTransform() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkCenteredSimilarity2DTransform.hxx"
#endif
 
#endif /* itkCenteredSimilarity2DTransform_h */