itkScaleTransform.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 __itkScaleTransform_h
#define __itkScaleTransform_h

#include <iostream>
#include "itkMatrixOffsetTransformBase.h"
#include "itkMacro.h"
#include "itkMatrix.h"

namespace itk
{
template <
  class TScalarType = float, // Type for cordinate representation type (float or
                             // double)
  unsigned int NDimensions = 3>
// Number of dimensions
// class ITK_EXPORT ScaleTransform:public Transform< TScalarType,
class ITK_EXPORT ScaleTransform : public MatrixOffsetTransformBase<TScalarType,
                                                                   NDimensions,
                                                                   NDimensions>
{
public:
  typedef ScaleTransform                                                   Self;
  typedef MatrixOffsetTransformBase<TScalarType, NDimensions, NDimensions> Superclass;
  typedef SmartPointer<Self>                                               Pointer;
  typedef SmartPointer<const Self>                                         ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ScaleTransform, 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 FixedArray<TScalarType, NDimensions> ScaleType;

  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;

  typedef typename Superclass::MatrixType MatrixType;

  void SetParameters(const ParametersType & parameters);

  const ParametersType & GetParameters(void) const;

  virtual void SetFixedParameters(const ParametersType &)
  {
  }

  virtual const ParametersType & GetFixedParameters(void) const;

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

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

  void SetScale(const ScaleType & scale)
  {
    m_Scale = scale; this->ComputeMatrix(); this->Modified();
  }

  virtual void ComputeMatrix(void);

  void Compose(const Self *other, bool pre = false);

  void Scale(const ScaleType & scale, bool pre = false);

  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;

  void SetIdentity(void)
  {
    m_Scale.Fill(1.0);
  }

  itkSetMacro(Center, InputPointType);
  itkGetConstReferenceMacro(Center, InputPointType);

  itkGetConstReferenceMacro(Scale, ScaleType);

  virtual bool IsLinear() const
  {
    return true;
  }
protected:

  ScaleTransform();

  ~ScaleTransform();

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

private:
  ScaleTransform(const Self & other);   // purposely not implemented
  const Self & operator=(const Self &); // purposely not implemented

  ScaleType m_Scale;    // Scales of the transformation

  InputPointType         m_Center; // Scaling center
  mutable ParametersType m_FixedParameters;
};                         // class ScaleTransform

// Back transform a point
template <class ScalarType, unsigned int NDimensions>
inline
typename ScaleTransform<ScalarType, NDimensions>::InputPointType
ScaleTransform<ScalarType, NDimensions>::BackTransform(const OutputPointType & point) const
{
  InputPointType result;

  for( unsigned int i = 0; i < SpaceDimension; i++ )
    {
    result[i] = ( point[i] + m_Center[i] ) / m_Scale[i] - m_Center[i];
    }
  return result;
}

// Back transform a vector
template <class ScalarType, unsigned int NDimensions>
inline
typename ScaleTransform<ScalarType, NDimensions>::InputVectorType
ScaleTransform<ScalarType, NDimensions>::BackTransform(const OutputVectorType & vect) const
{
  InputVectorType result;

  for( unsigned int i = 0; i < SpaceDimension; i++ )
    {
    result[i] = vect[i] / m_Scale[i];
    }
  return result;
}

// Back transform a vnl_vector
template <class ScalarType, unsigned int NDimensions>
inline
typename ScaleTransform<ScalarType, NDimensions>::InputVnlVectorType
ScaleTransform<ScalarType, NDimensions>::BackTransform(const OutputVnlVectorType & vect) const
{
  InputVnlVectorType result;

  for( unsigned int i = 0; i < SpaceDimension; i++ )
    {
    result[i] = vect[i] / m_Scale[i];
    }
  return result;
}

// Back Transform a CovariantVector
template <class ScalarType, unsigned int NDimensions>
inline
typename ScaleTransform<ScalarType, NDimensions>::InputCovariantVectorType
ScaleTransform<ScalarType, NDimensions>::BackTransform(const OutputCovariantVectorType & vect) const
{
  // Covariant Vectors are scaled by the inverse
  InputCovariantVectorType result;

  for( unsigned int i = 0; i < SpaceDimension; i++ )
    {
    result[i] = vect[i] * m_Scale[i];
    }
  return result;
}

}  // namespace itk

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

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

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

#endif /* __itkScaleTransform_h */