itkKernelTransform.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 itkKernelTransform_h
#define itkKernelTransform_h

#include "itkTransform.h"
#include "itkMatrix.h"
#include "itkPointSet.h"
#include <deque>
#include <cmath>
#include "vnl/vnl_matrix_fixed.h"
#include "vnl/vnl_matrix.h"
#include "vnl/vnl_vector.h"
#include "vnl/vnl_vector_fixed.h"
#include "vnl/algo/vnl_svd.h"
#include "vnl/vnl_sample.h"

namespace itk
{
template<typename TParametersValueType,
          unsigned int NDimensions>
class KernelTransform :
  public Transform<TParametersValueType, NDimensions, NDimensions>
{
public:
  typedef KernelTransform                                             Self;
  typedef Transform<TParametersValueType, NDimensions, NDimensions> Superclass;
  typedef SmartPointer<Self>                                        Pointer;
  typedef SmartPointer<const Self>                                  ConstPointer;

  itkTypeMacro(KernelTransform, Transform);

  itkNewMacro(Self);

  itkStaticConstMacro(SpaceDimension, unsigned int, NDimensions);

  typedef typename Superclass::ScalarType ScalarType;

  typedef typename Superclass::FixedParametersType FixedParametersType;
  typedef typename Superclass::ParametersType      ParametersType;

  typedef typename Superclass::JacobianType JacobianType;

  typedef typename Superclass::TransformCategoryType TransformCategoryType;

  typedef typename Superclass::InputPointType  InputPointType;
  typedef typename Superclass::OutputPointType OutputPointType;

  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 DefaultStaticMeshTraits<TParametersValueType, NDimensions, NDimensions, TParametersValueType, TParametersValueType> PointSetTraitsType;
  typedef PointSet<InputPointType, NDimensions, PointSetTraitsType>                                PointSetType;

  typedef typename PointSetType::Pointer                      PointSetPointer;
  typedef typename PointSetType::PointsContainer              PointsContainer;
  typedef typename PointSetType::PointsContainerIterator      PointsIterator;
  typedef typename PointSetType::PointsContainerConstIterator PointsConstIterator;
  typedef typename PointSetType::PointIdentifier              PointIdentifier;

  typedef itk::VectorContainer<SizeValueType, InputVectorType> VectorSetType;
  typedef typename VectorSetType::Pointer                      VectorSetPointer;

  itkGetModifiableObjectMacro(SourceLandmarks, PointSetType); //NOTE: This is used to circumvent the SetTargetLandmarks
  virtual void SetSourceLandmarks(PointSetType *);

  itkGetModifiableObjectMacro(TargetLandmarks, PointSetType); //NOTE: This is used to circumvent the SetTargetLandmarks
  virtual void SetTargetLandmarks(PointSetType *);

  itkGetModifiableObjectMacro(Displacements, VectorSetType);

  void ComputeWMatrix();

  virtual OutputPointType TransformPoint(const InputPointType & thisPoint) const ITK_OVERRIDE;

  using Superclass::TransformVector;
  virtual OutputVectorType TransformVector(const InputVectorType &) const ITK_OVERRIDE
  {
    itkExceptionMacro( << "TransformVector(const InputVectorType &) is not implemented for KernelTransform");
  }

  virtual OutputVnlVectorType TransformVector(const InputVnlVectorType &) const ITK_OVERRIDE
  {
    itkExceptionMacro( << "TransformVector(const InputVnlVectorType &) is not implemented for KernelTransform");
  }

  using Superclass::TransformCovariantVector;
  virtual OutputCovariantVectorType TransformCovariantVector(const InputCovariantVectorType &) const ITK_OVERRIDE
  {
    itkExceptionMacro( << "TransformCovariantVector(const InputCovariantVectorType &) is not implemented for KernelTransform");
  }

  typedef vnl_matrix_fixed<TParametersValueType, NDimensions, NDimensions> IMatrixType;

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

  virtual void ComputeJacobianWithRespectToPosition(const InputPointType &,
                                                    JacobianType &) const ITK_OVERRIDE
  {
    itkExceptionMacro( "ComputeJacobianWithRespectToPosition not yet implemented "
                       "for " << this->GetNameOfClass() );
  }

  virtual void SetParameters(const ParametersType &) ITK_OVERRIDE;

  virtual void SetFixedParameters(const ParametersType &) ITK_OVERRIDE;

  virtual void UpdateParameters() const;

  virtual const ParametersType & GetParameters() const ITK_OVERRIDE;

  virtual const FixedParametersType & GetFixedParameters() const ITK_OVERRIDE;

  virtual TransformCategoryType GetTransformCategory() const ITK_OVERRIDE
  {
    return Self::Spline;
  }

  itkSetClampMacro( Stiffness, double, 0.0, NumericTraits<double>::max() );
  itkGetConstMacro(Stiffness, double);

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

public:
  typedef vnl_matrix_fixed<TParametersValueType, NDimensions, NDimensions> GMatrixType;

  typedef vnl_matrix<TParametersValueType> LMatrixType;

  typedef vnl_matrix<TParametersValueType> KMatrixType;

  typedef vnl_matrix<TParametersValueType> PMatrixType;

  typedef vnl_matrix<TParametersValueType> YMatrixType;

  typedef vnl_matrix<TParametersValueType> WMatrixType;

  typedef vnl_matrix<TParametersValueType> DMatrixType;

  typedef vnl_matrix_fixed<TParametersValueType, NDimensions, NDimensions> AMatrixType;

  typedef vnl_vector_fixed<TParametersValueType, NDimensions> BMatrixType;

  typedef vnl_matrix_fixed<TParametersValueType, 1, NDimensions> RowMatrixType;

  typedef vnl_matrix_fixed<TParametersValueType, NDimensions, 1> ColumnMatrixType;

protected:
  virtual void ComputeG(const InputVectorType & landmarkVector, GMatrixType & gmatrix) const;

  virtual const GMatrixType & ComputeReflexiveG(PointsIterator) const;

  virtual void ComputeDeformationContribution(const InputPointType & inputPoint, OutputPointType & result) const;

  void ComputeK();

  void ComputeL();

  void ComputeP();

  void ComputeY();

  void ComputeD();

  void ReorganizeW();

  double m_Stiffness;

  VectorSetPointer m_Displacements;

  LMatrixType m_LMatrix;

  KMatrixType m_KMatrix;

  PMatrixType m_PMatrix;

  YMatrixType m_YMatrix;

  WMatrixType m_WMatrix;

  DMatrixType m_DMatrix;

  AMatrixType m_AMatrix;

  BMatrixType m_BVector;

  mutable GMatrixType m_GMatrix;

  bool m_WMatrixComputed;

  IMatrixType m_I;

  PointSetPointer m_SourceLandmarks;

  PointSetPointer m_TargetLandmarks;

private:

  KernelTransform(const Self &); // purposely not implemented
  void operator=(const Self &);  // purposely not implemented

};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkKernelTransform.hxx"
#endif

#endif // itkKernelTransform_h