itkSimilarity2DTransform.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSimilarity2DTransform.h,v $
  Language:  C++
  Date:      $Date: 2009-11-28 15:58:04 $
  Version:   $Revision: 1.15 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

#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; 
 
 const JacobianType & GetJacobian(const InputPointType  &point ) 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();
  Similarity2DTransform( unsigned int spaceDimension, 
                         unsigned int parametersDimension);

  ~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, x, y) namespace itk { \
  _(1(class EXPORT Similarity2DTransform< ITK_TEMPLATE_1 x >)) \
  namespace Templates { typedef Similarity2DTransform< ITK_TEMPLATE_1 x > Similarity2DTransform##y; } \
  }

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

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

#endif /* __itkSimilarity2DTransform_h */