itkScaleSkewVersor3DTransform.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 __itkScaleSkewVersor3DTransform_h
#define __itkScaleSkewVersor3DTransform_h

#include <iostream>
#include "itkVersorRigid3DTransform.h"

namespace itk
{
template <class TScalarType = double>
// Data type for scalars:float or double
class ITK_EXPORT ScaleSkewVersor3DTransform :
  public VersorRigid3DTransform<TScalarType>
{
public:
  typedef ScaleSkewVersor3DTransform          Self;
  typedef VersorRigid3DTransform<TScalarType> Superclass;
  typedef SmartPointer<Self>                  Pointer;
  typedef SmartPointer<const Self>            ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ScaleSkewVersor3DTransform, VersorRigid3DTransform);

  itkStaticConstMacro(InputSpaceDimension, unsigned int, 3);
  itkStaticConstMacro(OutputSpaceDimension, unsigned int, 3);
  itkStaticConstMacro(ParametersDimension, unsigned int, 15);

  typedef typename Superclass::ParametersType            ParametersType;
  typedef typename Superclass::JacobianType              JacobianType;
  typedef typename Superclass::ScalarType                ScalarType;
  typedef typename Superclass::InputPointType            InputPointType;
  typedef typename Superclass::OutputPointType           OutputPointType;
  typedef typename Superclass::InputVectorType           InputVectorType;
  typedef typename Superclass::OutputVectorType          OutputVectorType;
  typedef typename Superclass::InputVnlVectorType        InputVnlVectorType;
  typedef typename Superclass::OutputVnlVectorType       OutputVnlVectorType;
  typedef typename Superclass::InputCovariantVectorType  InputCovariantVectorType;
  typedef typename Superclass::OutputCovariantVectorType OutputCovariantVectorType;
  typedef typename Superclass::MatrixType                MatrixType;
  typedef typename Superclass::InverseMatrixType         InverseMatrixType;
  typedef typename Superclass::CenterType                CenterType;
  typedef typename Superclass::OffsetType                OffsetType;
  typedef typename Superclass::TranslationType           TranslationType;

  typedef typename Superclass::VersorType VersorType;
  typedef typename Superclass::AxisType   AxisType;
  typedef typename Superclass::AngleType  AngleType;

  typedef Vector<TScalarType, 3> ScaleVectorType;
  typedef Vector<TScalarType, 6> SkewVectorType;

  typedef typename ScaleVectorType::ValueType ScaleVectorValueType;
  typedef typename SkewVectorType::ValueType  SkewVectorValueType;
  typedef typename TranslationType::ValueType TranslationValueType;

  typedef typename Superclass::AxisValueType      AxisValueType;
  typedef typename Superclass::ParameterValueType ParameterValueType;

  virtual void SetMatrix(const MatrixType & matrix);

  virtual void SetParameters(const ParametersType & parameters);

  virtual const ParametersType & GetParameters(void) const;

  void SetScale(const ScaleVectorType & scale);

  itkGetConstReferenceMacro(Scale, ScaleVectorType);

  void SetSkew(const SkewVectorType & skew);

  itkGetConstReferenceMacro(Skew, SkewVectorType);

  void SetIdentity();

  virtual void ComputeJacobianWithRespectToParameters( const InputPointType  & p, JacobianType & jacobian) const;

protected:
  ScaleSkewVersor3DTransform();
  ScaleSkewVersor3DTransform(const MatrixType & matrix, const OutputVectorType & offset);
  ScaleSkewVersor3DTransform(unsigned int paramDims);
  ~ScaleSkewVersor3DTransform()
  {
  }

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

  void SetVarScale(const ScaleVectorType & scale)
  {
    m_Scale = scale;
  }

  void SetVarSkew(const SkewVectorType & skew)
  {
    m_Skew = skew;
  }

  void ComputeMatrix(void);

  void ComputeMatrixParameters(void);

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

  ScaleVectorType m_Scale;

  SkewVectorType m_Skew;
}; // class ScaleSkewVersor3DTransform
}  // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ScaleSkewVersor3DTransform(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                              \
  {                                                                          \
  _( 1 ( class EXPORT ScaleSkewVersor3DTransform<ITK_TEMPLATE_1 TypeX> ) ) \
  namespace Templates                                                        \
  {                                                                          \
  typedef ScaleSkewVersor3DTransform<ITK_TEMPLATE_1 TypeX>                 \
  ScaleSkewVersor3DTransform##TypeY;                                       \
  }                                                                          \
  }

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

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

#endif /* __ScaleSkewVersor3DTransform_h */