Common/Transforms/itkAdvancedTranslationTransform.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: itkAdvancedTranslationTransform.h,v $
  Language:  C++
  Date:      $Date: 2007-07-15 16:38:25 $
  Version:   $Revision: 1.36 $
 
  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 __itkAdvancedTranslationTransform_h
#define __itkAdvancedTranslationTransform_h
 
#include <iostream>
#include "itkAdvancedTransform.h"
#include "itkMacro.h"
#include "itkMatrix.h"
 
namespace itk
{
 
template<
class TScalarType        = double,   // Data type for scalars (float or double)
unsigned int NDimensions = 3 >
// Number of dimensions
class ITK_EXPORT AdvancedTranslationTransform :
  public         AdvancedTransform< TScalarType, NDimensions, NDimensions >
{
public:
 
  typedef AdvancedTranslationTransform                               Self;
  typedef AdvancedTransform< TScalarType, NDimensions, NDimensions > Superclass;
  typedef SmartPointer< Self >                                       Pointer;
  typedef SmartPointer< const Self >                                 ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( AdvancedTranslationTransform, AdvancedTransform );
 
  itkStaticConstMacro( SpaceDimension, unsigned int, NDimensions );
  itkStaticConstMacro( ParametersDimension, unsigned int, NDimensions );
 
  typedef typename Superclass::ScalarType ScalarType;
 
  typedef typename Superclass::ParametersType         ParametersType;
  typedef typename Superclass::FixedParametersType    FixedParametersType;
  typedef typename Superclass::NumberOfParametersType NumberOfParametersType;
  typedef typename Superclass::TransformCategoryEnum  TransformCategoryEnum;
 
  typedef typename Superclass::JacobianType JacobianType;
 
  typedef Vector< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > InputVectorType;
  typedef Vector< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > OutputVectorType;
 
  typedef CovariantVector< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > InputCovariantVectorType;
  typedef CovariantVector< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > OutputCovariantVectorType;
 
  typedef vnl_vector_fixed< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > InputVnlVectorType;
  typedef vnl_vector_fixed< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > OutputVnlVectorType;
 
  typedef Point< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > InputPointType;
  typedef Point< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > 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;
 
  const OutputVectorType & GetOffset( void ) const
  { return m_Offset; }
 
  void SetParameters( const ParametersType & parameters ) override;
 
  const ParametersType & GetParameters( void ) const override;
 
  void SetOffset( const OutputVectorType & offset )
  { m_Offset = offset; return; }
 
  void Compose( const Self * other, bool pre = 0 );
 
  void Translate( const OutputVectorType & offset, bool pre = 0 );
 
  OutputPointType     TransformPoint( const InputPointType  & point ) const override;
 
  OutputVectorType    TransformVector( const InputVectorType & vector ) const override;
 
  OutputVnlVectorType TransformVector( const InputVnlVectorType & vector ) const override;
 
  OutputCovariantVectorType TransformCovariantVector(
    const InputCovariantVectorType & vector ) const override;
 
  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;
 
  bool GetInverse( Self * inverse ) const;
 
  void GetJacobian(
    const InputPointType &,
    JacobianType &,
    NonZeroJacobianIndicesType & ) const override;
 
  void GetSpatialJacobian(
    const InputPointType &,
    SpatialJacobianType & ) const override;
 
  void GetSpatialHessian(
    const InputPointType &,
    SpatialHessianType & ) const override;
 
  void GetJacobianOfSpatialJacobian(
    const InputPointType &,
    JacobianOfSpatialJacobianType &,
    NonZeroJacobianIndicesType & ) const override;
 
  void GetJacobianOfSpatialJacobian(
    const InputPointType &,
    SpatialJacobianType &,
    JacobianOfSpatialJacobianType &,
    NonZeroJacobianIndicesType & ) const override;
 
  void GetJacobianOfSpatialHessian(
    const InputPointType &,
    JacobianOfSpatialHessianType &,
    NonZeroJacobianIndicesType & ) const override;
 
  void GetJacobianOfSpatialHessian(
    const InputPointType & ipp,
    SpatialHessianType & sh,
    JacobianOfSpatialHessianType & jsh,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const override;
 
  void SetIdentity( void );
 
  NumberOfParametersType GetNumberOfParameters( void ) const override
  { return NDimensions; }
 
  bool IsLinear() const override { return true; }
 
  TransformCategoryEnum GetTransformCategory() const override
  {
    return TransformCategoryEnum::Linear;
  }
 
 
  void SetFixedParameters( const FixedParametersType & ) override
  { /* purposely blank */ }
 
  const FixedParametersType & GetFixedParameters( void ) const override
  {
    this->m_FixedParameters.SetSize( 0 );
    return this->m_FixedParameters;
  }
 
 
protected:
 
  AdvancedTranslationTransform();
  ~AdvancedTranslationTransform() override;
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
private:
 
  AdvancedTranslationTransform( const Self & ); //purposely not implemented
  void operator=( const Self & );               //purposely not implemented
 
  OutputVectorType m_Offset;         // Offset of the transformation
 
  JacobianType                  m_LocalJacobian;
  SpatialJacobianType           m_SpatialJacobian;
  SpatialHessianType            m_SpatialHessian;
  NonZeroJacobianIndicesType    m_NonZeroJacobianIndices;
  JacobianOfSpatialJacobianType m_JacobianOfSpatialJacobian;
  JacobianOfSpatialHessianType  m_JacobianOfSpatialHessian;
 
};
 
//class AdvancedTranslationTransform
 
// Back transform a point
template< class TScalarType, unsigned int NDimensions >
inline
typename AdvancedTranslationTransform< TScalarType, NDimensions >::InputPointType
AdvancedTranslationTransform< TScalarType, NDimensions >::BackTransform( const OutputPointType & point ) const
{
  return point - m_Offset;
}
 
 
// Back transform a vector
template< class TScalarType, unsigned int NDimensions >
inline
typename AdvancedTranslationTransform< TScalarType, NDimensions >::InputVectorType
AdvancedTranslationTransform< TScalarType, NDimensions >::BackTransform( const OutputVectorType & vect ) const
{
  return vect;
}
 
 
// Back transform a vnl_vector
template< class TScalarType, unsigned int NDimensions >
inline
typename AdvancedTranslationTransform< TScalarType, NDimensions >::InputVnlVectorType
AdvancedTranslationTransform< TScalarType, NDimensions >::BackTransform( const OutputVnlVectorType & vect ) const
{
  return vect;
}
 
 
// Back Transform a CovariantVector
template< class TScalarType, unsigned int NDimensions >
inline
typename AdvancedTranslationTransform< TScalarType, NDimensions >::InputCovariantVectorType
AdvancedTranslationTransform< TScalarType, NDimensions >::BackTransform( const OutputCovariantVectorType & vect ) const
{
  return vect;
}
 
 
}  // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkAdvancedTranslationTransform.hxx"
#endif
 
#endif /* __itkAdvancedTranslationTransform_h */