itkAdvancedBSplineDeformableTransformBase.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 __itkAdvancedBSplineDeformableTransformBase_h
#define __itkAdvancedBSplineDeformableTransformBase_h

#include "itkAdvancedTransform.h"
#include "itkImage.h"
#include "itkImageRegion.h"


namespace itk
{

template <
    class TScalarType = double,          // Data type for scalars
    unsigned int NDimensions = 3 >       // Number of dimensions
class ITK_EXPORT AdvancedBSplineDeformableTransformBase
  : public AdvancedTransform< TScalarType, NDimensions, NDimensions >
{
public:
  typedef AdvancedBSplineDeformableTransformBase    Self;
  typedef AdvancedTransform<
    TScalarType, NDimensions, NDimensions >         Superclass;
  typedef SmartPointer<Self>                        Pointer;
  typedef SmartPointer<const Self>                  ConstPointer;

  itkTypeMacro( AdvancedBSplineDeformableTransformBase, AdvancedTransform );

  itkStaticConstMacro( SpaceDimension, unsigned int, NDimensions );

  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
    ::NonZeroJacobianIndicesType                    NonZeroJacobianIndicesType;
  typedef typename Superclass::SpatialJacobianType  SpatialJacobianType;
  typedef typename Superclass
    ::JacobianOfSpatialJacobianType                 JacobianOfSpatialJacobianType;
  typedef typename Superclass::SpatialHessianType   SpatialHessianType;
  typedef typename Superclass
    ::JacobianOfSpatialHessianType                  JacobianOfSpatialHessianType;
  typedef typename Superclass::InternalMatrixType   InternalMatrixType;

  void SetParameters( const ParametersType & parameters );

  void SetFixedParameters( const ParametersType & parameters );

  void SetParametersByValue( const ParametersType & parameters );

  void SetIdentity( void );

  virtual const ParametersType& GetParameters( void ) const;

  virtual const ParametersType& GetFixedParameters( void ) const;

  typedef typename ParametersType::ValueType            PixelType;
  typedef Image< PixelType,
    itkGetStaticConstMacro( SpaceDimension )>           ImageType;
  typedef typename ImageType::Pointer                   ImagePointer;

  virtual ImagePointer * GetCoefficientImage( void )
    { return this->m_CoefficientImage; }
  virtual const ImagePointer * GetCoefficientImage( void ) const
    { return this->m_CoefficientImage; }

  virtual void SetCoefficientImage( ImagePointer images[] );

  typedef ImageRegion< itkGetStaticConstMacro( SpaceDimension ) > RegionType;

  typedef typename RegionType::IndexType    IndexType;
  typedef typename RegionType::SizeType     SizeType;
  typedef typename ImageType::SpacingType   SpacingType;
  typedef typename ImageType::DirectionType DirectionType;
  typedef typename ImageType::PointType     OriginType;
  typedef IndexType                         GridOffsetType;

  virtual void SetGridRegion( const RegionType& region ) = 0;
  itkGetMacro( GridRegion, RegionType );
  itkGetConstMacro( GridRegion, RegionType );

  virtual void SetGridSpacing( const SpacingType & spacing );
  itkGetMacro( GridSpacing, SpacingType );
  itkGetConstMacro( GridSpacing, SpacingType );

  virtual void SetGridDirection( const DirectionType & spacing );
  itkGetMacro( GridDirection, DirectionType );
  itkGetConstMacro( GridDirection, DirectionType );

  virtual void SetGridOrigin( const OriginType& origin );
  itkGetMacro( GridOrigin, OriginType );
  itkGetConstMacro( GridOrigin, OriginType );

  typedef Transform< ScalarType,
    itkGetStaticConstMacro( SpaceDimension ),
    itkGetStaticConstMacro( SpaceDimension ) >          BulkTransformType;
  typedef typename BulkTransformType::ConstPointer      BulkTransformPointer;

  itkSetConstObjectMacro( BulkTransform, BulkTransformType );
  itkGetConstObjectMacro( BulkTransform, BulkTransformType );

  typedef Array<unsigned long> ParameterIndexArrayType;

  virtual OutputVectorType TransformVector( const InputVectorType & ) const
    {
    itkExceptionMacro( << "Method not applicable for deformable transform." );
    return OutputVectorType();
    }

  virtual OutputVnlVectorType TransformVector(const InputVnlVectorType & ) const
    {
    itkExceptionMacro( << "Method not applicable for deformable transform. ");
    return OutputVnlVectorType();
    }

  virtual OutputCovariantVectorType TransformCovariantVector(
    const InputCovariantVectorType & ) const
    {
    itkExceptionMacro( << "Method not applicable for deformable transform. ");
    return OutputCovariantVectorType();
    }

  virtual unsigned int GetNumberOfParameters( void ) const;

  virtual unsigned int GetNumberOfParametersPerDimension( void ) const;

  itkGetConstReferenceMacro( ValidRegion, RegionType );

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

  virtual unsigned int GetNumberOfAffectedWeights( void ) const = 0;

  virtual unsigned long GetNumberOfNonZeroJacobianIndices( void ) const = 0;

  typedef ContinuousIndex<ScalarType, SpaceDimension> ContinuousIndexType;

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

  AdvancedBSplineDeformableTransformBase();
  virtual ~AdvancedBSplineDeformableTransformBase();

  void WrapAsImages( void );

  void TransformPointToContinuousGridIndex(
   const InputPointType & point, ContinuousIndexType & index ) const;

  virtual void ComputeNonZeroJacobianIndices(
    NonZeroJacobianIndicesType & nonZeroJacobianIndices,
    const RegionType & supportRegion ) const = 0;

  virtual bool InsideValidRegion( const ContinuousIndexType& index ) const;

  BulkTransformPointer  m_BulkTransform;

  ImagePointer    m_CoefficientImage[ NDimensions ];

  RegionType          m_GridRegion;
  SpacingType         m_GridSpacing;
  DirectionType       m_GridDirection;
  OriginType          m_GridOrigin;
  GridOffsetType      m_GridOffsetTable;

  DirectionType       m_PointToIndexMatrix;
  SpatialJacobianType m_PointToIndexMatrix2;
  DirectionType       m_PointToIndexMatrixTransposed;
  SpatialJacobianType m_PointToIndexMatrixTransposed2;
  DirectionType       m_IndexToPoint;

  RegionType      m_ValidRegion;

  unsigned long   m_Offset;
  SizeType        m_SupportSize;
  ContinuousIndexType m_ValidRegionBegin;
  ContinuousIndexType m_ValidRegionEnd;

  bool m_SplineOrderOdd;

  const ParametersType *  m_InputParametersPointer;

  typedef typename JacobianType::ValueType      JacobianPixelType;
  typedef Image< JacobianPixelType,
    itkGetStaticConstMacro( SpaceDimension ) >  JacobianImageType;

  typename JacobianImageType::Pointer m_JacobianImage[ NDimensions ];

  mutable IndexType m_LastJacobianIndex;

  ImagePointer    m_WrappedImage[ NDimensions ];

  ParametersType          m_InternalParametersBuffer;

  void UpdateGridOffsetTable( void );

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

}; //class AdvancedBSplineDeformableTransformBase


}  // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_AdvancedBSplineDeformableTransformBase(_, EXPORT, x, y) namespace itk { \
  _(3(class EXPORT AdvancedBSplineDeformableTransformBase< ITK_TEMPLATE_3 x >)) \
  namespace Templates { typedef AdvancedBSplineDeformableTransformBase< ITK_TEMPLATE_3 x > \
                                                   AdvancedBSplineDeformableTransformBase##y; } \
  }

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

#if ITK_TEMPLATE_TXX
# include "itkAdvancedBSplineDeformableTransformBase.txx"
#endif

#endif /* __itkAdvancedBSplineDeformableTransformBase_h */