itkDeformationFieldInterpolatingTransform.h

Go to the documentation of this file.

/*======================================================================

  This file is part of the elastix software.

  Copyright (c) University Medical Center Utrecht. All rights reserved.
  See src/CopyrightElastix.txt or http://elastix.isi.uu.nl/legal.php 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 __itkDeformationFieldInterpolatingTransform_h
#define __itkDeformationFieldInterpolatingTransform_h

#include <iostream>
#include "itkAdvancedTransform.h"
#include "itkExceptionObject.h"
#include "itkImage.h"
#include "itkVectorInterpolateImageFunction.h"
#include "itkVectorNearestNeighborInterpolateImageFunction.h"

namespace itk
{

template<
class TScalarType        = double,     // Data type for scalars (float or double)
unsigned int NDimensions = 3,          // Number of input dimensions
class TComponentType     = double >
// ComponentType of the deformation field
class DeformationFieldInterpolatingTransform :
  public AdvancedTransform< TScalarType, NDimensions, NDimensions >
{
public:

  typedef DeformationFieldInterpolatingTransform                     Self;
  typedef AdvancedTransform< TScalarType, NDimensions, NDimensions > Superclass;
  typedef SmartPointer< Self >                                       Pointer;
  typedef SmartPointer< const Self >                                 ConstPointer;

  itkNewMacro( Self );

  itkTypeMacro( DeformationFieldInterpolatingTransform, AdvancedTransform );

  itkStaticConstMacro( InputSpaceDimension, unsigned int, Superclass::InputSpaceDimension );
  itkStaticConstMacro( OutputSpaceDimension, unsigned int, Superclass::OutputSpaceDimension );

  typedef typename Superclass::ScalarType                    ScalarType;
  typedef typename Superclass::ParametersType                ParametersType;
  typedef typename Superclass::NumberOfParametersType        NumberOfParametersType;
  typedef typename Superclass::JacobianType                  JacobianType;
  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 typename Superclass::InputPointType                InputPointType;
  typedef typename Superclass::OutputPointType               OutputPointType;
  typedef typename Superclass::NonZeroJacobianIndicesType    NonZeroJacobianIndicesType;
  typedef typename Superclass::SpatialHessianType            SpatialHessianType;
  typedef typename Superclass::SpatialJacobianType           SpatialJacobianType;
  typedef typename Superclass::JacobianOfSpatialHessianType  JacobianOfSpatialHessianType;
  typedef typename Superclass::JacobianOfSpatialJacobianType JacobianOfSpatialJacobianType;

  typedef typename Superclass::InternalMatrixType InternalMatrixType;

  typedef TComponentType DeformationFieldComponentType;
  typedef Vector< DeformationFieldComponentType,
    itkGetStaticConstMacro( OutputSpaceDimension ) >    DeformationFieldVectorType;
  typedef Image< DeformationFieldVectorType,
    itkGetStaticConstMacro( InputSpaceDimension ) >     DeformationFieldType;
  typedef typename DeformationFieldType::Pointer DeformationFieldPointer;

  typedef VectorInterpolateImageFunction<
    DeformationFieldType, ScalarType >                DeformationFieldInterpolatorType;
  typedef typename DeformationFieldInterpolatorType::Pointer DeformationFieldInterpolatorPointer;
  typedef VectorNearestNeighborInterpolateImageFunction<
    DeformationFieldType, ScalarType >                DefaultDeformationFieldInterpolatorType;

  virtual void SetParameters( const ParametersType & )
  {
    itkExceptionMacro( << "ERROR: SetParameters() is not implemented "
                       << "for DeformationFieldInterpolatingTransform.\n"
                       << "Use SetDeformationField() instead.\n"
                       << "Note that this transform is NOT suited for image registration.\n"
                       << "Just use it as an (initial) fixed transform that is not optimized." );
  }


  virtual void SetFixedParameters( const ParametersType & )
  {
    // This transform has no fixed parameters.
  }


  virtual const ParametersType & GetFixedParameters( void ) const
  {
    // This transform has no fixed parameters.
    return this->m_FixedParameters;
  }


  OutputPointType TransformPoint( const InputPointType & point ) const;

  virtual OutputVectorType TransformVector( const InputVectorType & ) const
  {
    itkExceptionMacro(
        << "TransformVector(const InputVectorType &) is not implemented "
        << "for DeformationFieldInterpolatingTransform" );
  }


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


  virtual OutputCovariantVectorType TransformCovariantVector( const InputCovariantVectorType & ) const
  {
    itkExceptionMacro(
        << "TransformCovariantVector(const InputCovariantVectorType &) is not implemented "
        << "for DeformationFieldInterpolatingTransform" );
  }


  void SetIdentity( void );

  virtual void SetDeformationField( DeformationFieldType * _arg );

  itkGetObjectMacro( DeformationField, DeformationFieldType );

  virtual void SetDeformationFieldInterpolator( DeformationFieldInterpolatorType * _arg );

  itkGetObjectMacro( DeformationFieldInterpolator, DeformationFieldInterpolatorType );

  virtual bool IsLinear( void ) const { return false; }

  virtual void GetJacobian(
    const InputPointType & ipp, JacobianType & j,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const
  {
    itkExceptionMacro( << "Not implemented for DeformationFieldInterpolatingTransform" );
  }


  virtual void GetSpatialJacobian(
    const InputPointType & ipp, SpatialJacobianType & sj ) const
  {
    itkExceptionMacro( << "Not implemented for DeformationFieldInterpolatingTransform" );
  }


  virtual void GetSpatialHessian(
    const InputPointType & ipp, SpatialHessianType & sh ) const
  {
    itkExceptionMacro( << "Not implemented for DeformationFieldInterpolatingTransform" );
  }


  virtual void GetJacobianOfSpatialJacobian(
    const InputPointType & ipp, JacobianOfSpatialJacobianType & jsj,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const
  {
    itkExceptionMacro( << "Not implemented for DeformationFieldInterpolatingTransform" );
  }


  virtual void GetJacobianOfSpatialJacobian(
    const InputPointType & ipp, SpatialJacobianType & sj,
    JacobianOfSpatialJacobianType & jsj,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const
  {
    itkExceptionMacro( << "Not implemented for DeformationFieldInterpolatingTransform" );
  }


  virtual void GetJacobianOfSpatialHessian(
    const InputPointType & ipp, JacobianOfSpatialHessianType & jsh,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const
  {
    itkExceptionMacro( << "Not implemented for DeformationFieldInterpolatingTransform" );
  }


  virtual void GetJacobianOfSpatialHessian(
    const InputPointType & ipp, SpatialHessianType & sh,
    JacobianOfSpatialHessianType & jsh,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const
  {
    itkExceptionMacro( << "Not implemented for DeformationFieldInterpolatingTransform" );
  }


protected:

  DeformationFieldInterpolatingTransform();
  ~DeformationFieldInterpolatingTransform();

  typedef typename DeformationFieldInterpolatorType::ContinuousIndexType
    InputContinuousIndexType;
  typedef typename DeformationFieldInterpolatorType::OutputType InterpolatorOutputType;

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

  DeformationFieldPointer             m_DeformationField;
  DeformationFieldPointer             m_ZeroDeformationField;
  DeformationFieldInterpolatorPointer m_DeformationFieldInterpolator;

private:

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

};

}  // namespace itk

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

#endif /* __itkDeformationFieldInterpolatingTransform_h */