itkTranslationTransform.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 __itkTranslationTransform_h
#define __itkTranslationTransform_h

#include <iostream>
#include "itkTransform.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 TranslationTransform :
  public Transform<TScalarType, NDimensions, NDimensions>
{
public:
  typedef TranslationTransform                             Self;
  typedef Transform<TScalarType, NDimensions, NDimensions> Superclass;
  typedef SmartPointer<Self>                               Pointer;
  typedef SmartPointer<const Self>                         ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(TranslationTransform, Transform);

  itkStaticConstMacro(SpaceDimension, unsigned int, NDimensions);
  itkStaticConstMacro(ParametersDimension, unsigned int, NDimensions);

  typedef typename Superclass::ScalarType ScalarType;

  typedef typename Superclass::ParametersType ParametersType;

  typedef typename Superclass::JacobianType JacobianType;

  typedef typename Superclass::NumberOfParametersType NumberOfParametersType;

  typedef Vector<TScalarType, NDimensions> InputVectorType;
  typedef Vector<TScalarType, NDimensions> OutputVectorType;

  typedef CovariantVector<TScalarType, NDimensions> InputCovariantVectorType;
  typedef CovariantVector<TScalarType, NDimensions> OutputCovariantVectorType;

  typedef vnl_vector_fixed<TScalarType, NDimensions> InputVnlVectorType;
  typedef vnl_vector_fixed<TScalarType, NDimensions> OutputVnlVectorType;

  typedef Point<TScalarType, NDimensions> InputPointType;
  typedef Point<TScalarType, NDimensions> OutputPointType;

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

  const OutputVectorType & GetOffset(void) const
  {
    return m_Offset;
  }

  void SetParameters(const ParametersType & parameters);

  virtual const ParametersType & GetParameters(void) const;

  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;

  using Superclass::TransformVector;
  OutputVectorType    TransformVector(const InputVectorType & vector) const;

  OutputVnlVectorType TransformVector(const InputVnlVectorType & vector) const;

  using Superclass::TransformCovariantVector;
  OutputCovariantVectorType TransformCovariantVector(const InputCovariantVectorType & vector) const;

  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;

  virtual InverseTransformBasePointer GetInverseTransform() const;

  virtual void ComputeJacobianWithRespectToParameters(const InputPointType  & point, JacobianType & j) const;

  virtual void ComputeJacobianWithRespectToPosition(const InputPointType  & x, JacobianType & jac) const;

  void SetIdentity(void);

  virtual NumberOfParametersType GetNumberOfParameters(void) const
  {
    return NDimensions;
  }

  virtual bool IsLinear() const
  {
    return true;
  }

  virtual void SetFixedParameters(const ParametersType &)
  {
  }

  virtual const ParametersType & GetFixedParameters(void) const
  {
    this->m_FixedParameters.SetSize(0);
    return this->m_FixedParameters;
  }

protected:
  TranslationTransform();
  ~TranslationTransform();
  void PrintSelf(std::ostream & os, Indent indent) const;

private:
  TranslationTransform(const Self &); // purposely not implemented
  void operator=(const Self &);       // purposely not implemented

  JacobianType     m_IdentityJacobian;
  OutputVectorType m_Offset; // Offset of the transformation
};                           // class TranslationTransform

// Back transform a point
template <class TScalarType, unsigned int NDimensions>
inline
typename TranslationTransform<TScalarType, NDimensions>::InputPointType
TranslationTransform<TScalarType, NDimensions>::BackTransform(const OutputPointType & point) const
{
  return point - m_Offset;
}

// Back transform a vector
template <class TScalarType, unsigned int NDimensions>
inline
typename TranslationTransform<TScalarType, NDimensions>::InputVectorType
TranslationTransform<TScalarType, NDimensions>::BackTransform(const OutputVectorType & vect) const
{
  return vect;
}

// Back transform a vnl_vector
template <class TScalarType, unsigned int NDimensions>
inline
typename TranslationTransform<TScalarType, NDimensions>::InputVnlVectorType
TranslationTransform<TScalarType, NDimensions>::BackTransform(const OutputVnlVectorType & vect) const
{
  return vect;
}

// Back Transform a CovariantVector
template <class TScalarType, unsigned int NDimensions>
inline
typename TranslationTransform<TScalarType, NDimensions>::InputCovariantVectorType
TranslationTransform<TScalarType, NDimensions>::BackTransform(const OutputCovariantVectorType & vect) const
{
  return vect;
}

}  // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_TranslationTransform(_, EXPORT, TypeX, TypeY)                    \
  namespace itk                                                                       \
  {                                                                                   \
  _( 2 ( class EXPORT TranslationTransform<ITK_TEMPLATE_2 TypeX> ) )                \
  namespace Templates                                                                 \
  {                                                                                   \
  typedef TranslationTransform<ITK_TEMPLATE_2 TypeX> TranslationTransform##TypeY; \
  }                                                                                   \
  }

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

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

#endif /* __itkTranslationTransform_h */