itkSimilarity2DTransform.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 __itkSimilarity2DTransform_h
#define __itkSimilarity2DTransform_h

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

namespace itk
{
template <class TScalarType = double>
// Data type for scalars (float or double)
class ITK_EXPORT Similarity2DTransform :
  public Rigid2DTransform<TScalarType>
{
public:
  typedef Similarity2DTransform         Self;
  typedef Rigid2DTransform<TScalarType> Superclass;
  typedef SmartPointer<Self>            Pointer;
  typedef SmartPointer<const Self>      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(Similarity2DTransform, Rigid2DTransform);

  itkStaticConstMacro(SpaceDimension,           unsigned int, 2);
  itkStaticConstMacro(InputSpaceDimension,      unsigned int, 2);
  itkStaticConstMacro(OutputSpaceDimension,     unsigned int, 2);
  itkStaticConstMacro(ParametersDimension,      unsigned int, 4);

  typedef typename Superclass::ScalarType ScalarType;
  typedef          TScalarType            ScaleType;

  typedef typename Superclass::ParametersType      ParametersType;
  typedef typename Superclass::ParametersValueType ParametersValueType;

  typedef typename Superclass::JacobianType JacobianType;

  typedef typename Superclass::OffsetType      OffsetType;
  typedef typename Superclass::OffsetValueType OffsetValueType;

  typedef typename Superclass::MatrixType      MatrixType;
  typedef typename Superclass::MatrixValueType MatrixValueType;

  typedef typename Superclass::InputPointType  InputPointType;
  typedef typename Superclass::OutputPointType OutputPointType;

  typedef typename Superclass::InputVectorType  InputVectorType;
  typedef typename Superclass::OutputVectorType OutputVectorType;

  typedef typename Superclass::InputCovariantVectorType  InputCovariantVectorType;
  typedef typename Superclass::OutputCovariantVectorType OutputCovariantVectorType;

  typedef typename Superclass::InputVnlVectorType  InputVnlVectorType;
  typedef typename Superclass::OutputVnlVectorType OutputVnlVectorType;

  typedef typename Superclass::InverseTransformBaseType InverseTransformBaseType;
  typedef typename InverseTransformBaseType::Pointer    InverseTransformBasePointer;

  void SetScale(ScaleType scale);

  itkGetConstReferenceMacro(Scale, ScaleType);

  void SetParameters(const ParametersType & parameters);

  const ParametersType & GetParameters(void) const;

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

  virtual void SetIdentity(void);

  void CloneInverseTo(Pointer & newinverse) const;

  bool GetInverse(Self *inverse) const;

  virtual InverseTransformBasePointer GetInverseTransform() const;

  void CloneTo(Pointer & clone) const;

  virtual void SetMatrix(const MatrixType & matrix);

protected:
  Similarity2DTransform(unsigned int outputSpaceDimension, unsigned int parametersDimension);
  Similarity2DTransform(unsigned int parametersDimension);
  Similarity2DTransform();

  ~Similarity2DTransform()
  {
  }
  void PrintSelf(std::ostream & os, Indent indent) const;

  virtual void ComputeMatrix(void);

  virtual void ComputeMatrixParameters(void);

  void SetVarScale(ScaleType scale)
  {
    m_Scale = scale;
  }
private:
  Similarity2DTransform(const Self &); // purposely not implemented
  void operator=(const Self &);        // purposely not implemented

  ScaleType m_Scale;
}; // class Similarity2DTransform
}  // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_Similarity2DTransform(_, EXPORT, TypeX, TypeY)                     \
  namespace itk                                                                         \
  {                                                                                     \
  _( 1 ( class EXPORT Similarity2DTransform<ITK_TEMPLATE_1 TypeX> ) )                 \
  namespace Templates                                                                   \
  {                                                                                     \
  typedef Similarity2DTransform<ITK_TEMPLATE_1 TypeX> Similarity2DTransform##TypeY; \
  }                                                                                     \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkSimilarity2DTransform+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkSimilarity2DTransform.hxx"
#endif

#endif /* __itkSimilarity2DTransform_h */