itkBSplineDeformableTransform.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 __itkBSplineDeformableTransform_h
#define __itkBSplineDeformableTransform_h

#include "itkConfigure.h" // Needed to determine value of ITKV3_COMPATIBILITY
#include "itkBSplineBaseTransform.h"

namespace itk
{
template <class TScalarType = double, unsigned int NDimensions = 3,
          unsigned int VSplineOrder = 3>
class ITK_EXPORT BSplineDeformableTransform :
  public BSplineBaseTransform<TScalarType,NDimensions,VSplineOrder>
{
public:
  typedef BSplineDeformableTransform                                 Self;
  typedef BSplineBaseTransform<TScalarType,NDimensions,VSplineOrder> Superclass;
  typedef SmartPointer<Self>                                         Pointer;
  typedef SmartPointer<const Self>                                   ConstPointer;

  // Explicit New() method, used here because we need to split the itkNewMacro()
  // in order to overload the CreateAnother() method so that we can copy the m_BulkTransform
  // explicitly.
  // TODO: shouldn't it be done with the Clone() method?
  itkSimpleNewMacro(Self);
  virtual ::itk::LightObject::Pointer CreateAnother(void) const
    {
    ::itk::LightObject::Pointer smartPtr;
    Pointer copyPtr = Self::New().GetPointer();
    //THE FOLLOWING LINE IS DIFFERENT FROM THE DEFAULT MACRO!
    copyPtr->m_BulkTransform =  this->GetBulkTransform();
    smartPtr = static_cast<Pointer>( copyPtr );
    return smartPtr;
    }

  itkCloneMacro(Self);

  itkTypeMacro( BSplineDeformableTransform, BSplineBaseTransform );

  itkStaticConstMacro( SpaceDimension, unsigned int, NDimensions );

  itkStaticConstMacro( SplineOrder, unsigned int, VSplineOrder );

  typedef typename Superclass::ScalarType ScalarType;

  typedef typename Superclass::ParametersType ParametersType;

  typedef typename Superclass::JacobianType JacobianType;

  typedef typename Superclass::NumberOfParametersType NumberOfParametersType;

  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 Point <TScalarType, itkGetStaticConstMacro( SpaceDimension )> InputPointType;
  typedef Point <TScalarType, itkGetStaticConstMacro( SpaceDimension )> OutputPointType;


  virtual void SetFixedParameters( const ParametersType & parameters );

  typedef typename Superclass::ParametersValueType   ParametersValueType;
  typedef typename Superclass::ImageType             ImageType;
  typedef typename Superclass::ImagePointer          ImagePointer;
  typedef typename Superclass::CoefficientImageArray CoefficientImageArray;

  virtual void SetCoefficientImages( const CoefficientImageArray & images );

#ifdef ITKV3_COMPATIBILITY
  virtual void SetCoefficientImage( const CoefficientImageArray & images )
    {
    this->SetCoefficientImages( images );
    }
  /* Only for backwards compatibility with ITKv3. */
  CoefficientImageArray GetCoefficientImage()
    {
    return this->GetCoefficientImages();
    }
#endif

  typedef typename Superclass::RegionType    RegionType;

  typedef typename Superclass::IndexType     IndexType;
  typedef typename Superclass::SizeType      SizeType;
  typedef typename Superclass::SpacingType   SpacingType;
  typedef typename Superclass::DirectionType DirectionType;
  typedef typename Superclass::OriginType    OriginType;

  typedef typename Superclass::WeightsFunctionType WeightsFunctionType;

  typedef typename Superclass::WeightsType         WeightsType;
  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;

  typedef typename Superclass::ParameterIndexArrayType ParameterIndexArrayType;

  using Superclass::TransformPoint;
  virtual void TransformPoint( const InputPointType & inputPoint, OutputPointType & outputPoint,
    WeightsType & weights, ParameterIndexArrayType & indices, bool & inside ) const;

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

  virtual NumberOfParametersType GetNumberOfParameters() const;

  NumberOfParametersType GetNumberOfParametersPerDimension() const;

  typedef typename Superclass::SpacingType   PhysicalDimensionsType;
  typedef typename Superclass::PixelType     PixelType;

  typedef typename Superclass::MeshSizeType MeshSizeType;

  virtual void SetGridOrigin( const OriginType & );

  itkGetConstMacro( GridOrigin, OriginType );

  virtual void SetGridSpacing( const SpacingType & );

  itkGetConstMacro( GridSpacing, SpacingType );

  virtual void SetGridDirection( const DirectionType & );

  itkGetConstMacro( GridDirection, DirectionType );

  virtual void SetGridRegion( const RegionType & );

  itkGetConstMacro( GridRegion, RegionType );

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

  itkGetConstReferenceMacro(ValidRegion, RegionType);

  virtual NumberOfParametersType GetNumberOfLocalParameters() const
  {
    itkExceptionMacro("GetNumberOfLocalParameters not yet implemented.");
  }

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

  BSplineDeformableTransform();
  virtual ~BSplineDeformableTransform();

private:

  virtual void SetFixedParametersGridSizeFromTransformDomainInformation() const;

  virtual void SetFixedParametersGridOriginFromTransformDomainInformation() const;

  virtual void SetFixedParametersGridSpacingFromTransformDomainInformation() const;

  virtual void SetFixedParametersGridDirectionFromTransformDomainInformation() const;

  virtual void SetCoefficientImageInformationFromFixedParameters();

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

  virtual bool InsideValidRegion( ContinuousIndexType & ) const;

  const RegionType &    m_GridRegion;
  const OriginType &    m_GridOrigin;
  const SpacingType &   m_GridSpacing;
  const DirectionType & m_GridDirection;

  BulkTransformPointer m_BulkTransform;

  RegionType m_ValidRegion;

  unsigned long m_Offset;
  bool          m_SplineOrderOdd;
  IndexType     m_ValidRegionLast;
  IndexType     m_ValidRegionFirst;

  void UpdateValidGridRegion();

}; // class BSplineDeformableTransform
}  // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_BSplineDeformableTransform(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                              \
  {                                                                          \
  _( 3 ( class EXPORT BSplineDeformableTransform<ITK_TEMPLATE_3 TypeX> ) ) \
  namespace Templates                                                        \
  {                                                                          \
  typedef BSplineDeformableTransform<ITK_TEMPLATE_3 TypeX>                 \
  BSplineDeformableTransform##TypeY;                                       \
  }                                                                          \
  }

#if ITK_TEMPLATE_EXPLICIT
// template < class TScalarType, unsigned int NDimensions, unsigned int
// VSplineOrder >
//   const unsigned int itk::BSplineDeformableTransform<TScalarType,
// NDimensions, VSplineOrder >::SpaceDimension;
// template < class TScalarType, unsigned int NDimensions, unsigned int
// VSplineOrder >
//   const unsigned int itk::BSplineDeformableTransform<TScalarType,
// NDimensions, VSplineOrder >::SplineOrder;
#include "Templates/itkBSplineDeformableTransform+-.h"
#endif

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

#endif /* __itkBSplineDeformableTransform_h */