itkAdvancedRigid2DTransform.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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.
 *
 *=========================================================================*/
/*=========================================================================
 
  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkAdvancedRigid2DTransform.h,v $
  Language:  C++
  Date:      $Date: 2009-01-14 18:39:05 $
  Version:   $Revision: 1.22 $
 
  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 __itkAdvancedRigid2DTransform_h
#define __itkAdvancedRigid2DTransform_h
 
#include <iostream>
#include "itkAdvancedMatrixOffsetTransformBase.h"
#include "itkMacro.h"
 
namespace itk
{
 
template< class TScalarType = double >
// Data type for scalars (float or double)
class AdvancedRigid2DTransform :
  public AdvancedMatrixOffsetTransformBase< TScalarType, 2, 2 >      // Dimensions of input and output spaces
{
public:
 
  typedef AdvancedRigid2DTransform                               Self;
  typedef AdvancedMatrixOffsetTransformBase< TScalarType, 2, 2 > Superclass;
  typedef SmartPointer< Self >                                   Pointer;
  typedef SmartPointer< const Self >                             ConstPointer;
 
  itkTypeMacro( AdvancedRigid2DTransform, AdvancedMatrixOffsetTransformBase );
 
  itkNewMacro( Self );
 
  itkStaticConstMacro( InputSpaceDimension, unsigned int, 2 );
  itkStaticConstMacro( OutputSpaceDimension, unsigned int, 2 );
  itkStaticConstMacro( ParametersDimension, unsigned int, 3 );
 
  typedef typename Superclass::ScalarType ScalarType;
 
  typedef typename Superclass::ParametersType         ParametersType;
  typedef typename Superclass::NumberOfParametersType NumberOfParametersType;
 
  typedef typename Superclass::JacobianType JacobianType;
 
  typedef typename Superclass::MatrixType MatrixType;
 
  typedef typename Superclass::OffsetType OffsetType;
 
  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::InputPointType  InputPointType;
  typedef typename Superclass::OutputPointType OutputPointType;
 
  typedef typename Superclass
    ::NonZeroJacobianIndicesType NonZeroJacobianIndicesType;
  typedef typename Superclass::SpatialJacobianType SpatialJacobianType;
  typedef typename Superclass
    ::JacobianOfSpatialJacobianType JacobianOfSpatialJacobianType;
  typedef typename Superclass::SpatialHessianType SpatialHessianType;
  typedef typename Superclass
    ::JacobianOfSpatialHessianType JacobianOfSpatialHessianType;
  typedef typename Superclass::InternalMatrixType InternalMatrixType;
 
  void SetMatrix( const MatrixType & matrix ) override;
 
  virtual void SetRotationMatrix( const MatrixType & matrix )
  { this->SetMatrix( matrix ); }
  const MatrixType & GetRotationMatrix() const
  { return this->GetMatrix(); }
 
  void Translate( const OffsetType & offset, bool pre = false );
 
  inline InputPointType      BackTransform( const OutputPointType  & point ) const;
 
  inline InputVectorType     BackTransform( const OutputVectorType & vector ) const;
 
  inline InputVnlVectorType  BackTransform( const OutputVnlVectorType & vector ) const;
 
  inline InputCovariantVectorType BackTransform(
    const OutputCovariantVectorType & vector ) const;
 
  void SetAngle( TScalarType angle );
 
  itkGetConstReferenceMacro( Angle, TScalarType );
 
  void SetAngleInDegrees( TScalarType angle );
 
  void SetRotation( TScalarType angle )
  { this->SetAngle( angle ); }
  virtual const TScalarType & GetRotation() const
  { return m_Angle; }
 
  void SetParameters( const ParametersType & parameters ) override;
 
  const ParametersType & GetParameters( void ) const override;
 
  void GetJacobian(
    const InputPointType &,
    JacobianType &,
    NonZeroJacobianIndicesType & ) const override;
 
  void CloneInverseTo( Pointer & newinverse ) const;
 
  void CloneTo( Pointer & clone ) const;
 
  void SetIdentity( void ) override;
 
protected:
 
  AdvancedRigid2DTransform();
  AdvancedRigid2DTransform( unsigned int parametersDimension );
  AdvancedRigid2DTransform( unsigned int outputSpaceDimension, unsigned int parametersDimension );
 
  ~AdvancedRigid2DTransform() override;
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  void ComputeMatrix( void ) override;
 
  void ComputeMatrixParameters( void ) override;
 
  void SetVarAngle( TScalarType angle )
  { m_Angle = angle; }
 
  virtual void PrecomputeJacobianOfSpatialJacobian( void );
 
private:
 
  AdvancedRigid2DTransform( const Self & ); // purposely not implemented
  void operator=( const Self & );           // purposely not implemented
 
  TScalarType m_Angle;
 
};
 
// Back transform a point
template< class TScalarType >
inline
typename AdvancedRigid2DTransform< TScalarType >::InputPointType
AdvancedRigid2DTransform< TScalarType >::BackTransform( const OutputPointType & point ) const
{
  itkWarningMacro(
      << "BackTransform(): This method is slated to be removed from ITK.  Instead, please use GetInverse() to generate an inverse transform and then perform the transform using that inverted transform."
    );
  return this->GetInverseMatrix() * ( point - this->GetOffset() );
}
 
 
// Back transform a vector
template< class TScalarType >
inline
typename AdvancedRigid2DTransform< TScalarType >::InputVectorType
AdvancedRigid2DTransform< TScalarType >
::BackTransform( const OutputVectorType & vect ) const
{
  itkWarningMacro(
      << "BackTransform(): This method is slated to be removed from ITK.  Instead, please use GetInverse() to generate an inverse transform and then perform the transform using that inverted transform."
    );
  return this->GetInverseMatrix() * vect;
}
 
 
// Back transform a vnl_vector
template< class TScalarType >
inline
typename AdvancedRigid2DTransform< TScalarType >::InputVnlVectorType
AdvancedRigid2DTransform< TScalarType >
::BackTransform( const OutputVnlVectorType & vect ) const
{
  itkWarningMacro(
      << "BackTransform(): This method is slated to be removed from ITK.  Instead, please use GetInverse() to generate an inverse transform and then perform the transform using that inverted transform."
    );
  return this->GetInverseMatrix() * vect;
}
 
 
// Back Transform a CovariantVector
template< class TScalarType >
inline
typename AdvancedRigid2DTransform< TScalarType >::InputCovariantVectorType
AdvancedRigid2DTransform< TScalarType >
::BackTransform( const OutputCovariantVectorType & vect ) const
{
  itkWarningMacro(
      << "BackTransform(): This method is slated to be removed from ITK.  Instead, please use GetInverse() to generate an inverse transform and then perform the transform using that inverted transform."
    );
  return this->GetMatrix() * vect;
}
 
 
}  // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkAdvancedRigid2DTransform.hxx"
#endif
 
#endif /* __itkAdvancedRigid2DTransform_h */