itkTimeVaryingBSplineVelocityFieldTransform.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 __itkTimeVaryingBSplineVelocityFieldTransform_h
#define __itkTimeVaryingBSplineVelocityFieldTransform_h

#include "itkTimeVaryingVelocityFieldTransform.h"

namespace itk
{

template<class TScalar, unsigned int NDimensions>
class ITK_EXPORT TimeVaryingBSplineVelocityFieldTransform :
  public TimeVaryingVelocityFieldTransform<TScalar, NDimensions>
{
public:

  typedef TimeVaryingBSplineVelocityFieldTransform                 Self;
  typedef TimeVaryingVelocityFieldTransform<TScalar, NDimensions>  Superclass;
  typedef SmartPointer<Self>                                       Pointer;
  typedef SmartPointer<const Self>                                 ConstPointer;

  itkTypeMacro( TimeVaryingBSplineVelocityFieldTransform, TimeVaryingVelocityFieldTransform );

  itkSimpleNewMacro( Self );

  typedef typename Superclass::InverseTransformBasePointer InverseTransformBasePointer;

  typedef typename Superclass::ScalarType              ScalarType;

  typedef typename Superclass::ParametersType          ParametersType;
  typedef typename ParametersType::ValueType           ParametersValueType;
  typedef typename Superclass::NumberOfParametersType  NumberOfParametersType;

  typedef typename Superclass::JacobianType        JacobianType;

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

  typedef typename Superclass::InputVectorType     InputVectorType;
  typedef typename Superclass::OutputVectorType    OutputVectorType;

  typedef typename Superclass::DerivativeType       DerivativeType;

  itkStaticConstMacro( Dimension, unsigned int, NDimensions );

  itkStaticConstMacro( TimeVaryingVelocityFieldDimension, unsigned int, NDimensions+1 );

  typedef Image<OutputVectorType, TimeVaryingVelocityFieldDimension>          TimeVaryingVelocityFieldControlPointLatticeType;
  typedef typename TimeVaryingVelocityFieldControlPointLatticeType::Pointer   TimeVaryingVelocityFieldControlPointLatticePointer;
  typedef TimeVaryingVelocityFieldControlPointLatticeType                     TimeVaryingVelocityFieldType;

  typedef typename TimeVaryingVelocityFieldControlPointLatticeType::PointType         VelocityFieldPointType;
  typedef typename TimeVaryingVelocityFieldControlPointLatticeType::SizeType          VelocityFieldSizeType;
  typedef typename TimeVaryingVelocityFieldControlPointLatticeType::SpacingType       VelocityFieldSpacingType;
  typedef typename TimeVaryingVelocityFieldControlPointLatticeType::DirectionType     VelocityFieldDirectionType;

  typedef typename Superclass::DisplacementFieldType                       DisplacementFieldControlPointLatticeType;
  typedef typename Superclass::DisplacementFieldType                       DisplacementFieldType;
  typedef typename DisplacementFieldType::PixelType                        DisplacementVectorType;
  typedef typename DisplacementFieldType::SizeType                         DisplacementFieldSizeType;
  typedef typename DisplacementFieldType::SpacingType                      DisplacementFieldSpacingType;
  typedef typename DisplacementFieldType::PointType                        DisplacementFieldPointType;
  typedef typename DisplacementFieldType::DirectionType                    DisplacementFieldDirectionType;

  itkGetObjectMacro( TimeVaryingVelocityFieldControlPointLattice, TimeVaryingVelocityFieldControlPointLatticeType );

  virtual void SetTimeVaryingVelocityFieldControlPointLattice( TimeVaryingVelocityFieldControlPointLatticeType * );

  virtual void SetFixedParameters( const ParametersType & );

  virtual void UpdateTransformParameters( DerivativeType & update, ScalarType factor = 1.0 );

  virtual void IntegrateVelocityField();

  bool GetInverse( Self *inverse ) const;

  virtual InverseTransformBasePointer GetInverseTransform() const;

  itkSetMacro( SplineOrder, unsigned int );
  itkGetConstMacro( SplineOrder, unsigned int );

  itkSetMacro( TemporalPeriodicity, bool );
  itkGetConstMacro( TemporalPeriodicity, bool );
  itkBooleanMacro( TemporalPeriodicity );

  itkSetMacro( VelocityFieldOrigin, VelocityFieldPointType );
  itkGetConstMacro( VelocityFieldOrigin, VelocityFieldPointType );

  itkSetMacro( VelocityFieldSpacing, VelocityFieldSpacingType );
  itkGetConstMacro( VelocityFieldSpacing, VelocityFieldSpacingType );

  itkSetMacro( VelocityFieldSize, VelocityFieldSizeType );
  itkGetConstMacro( VelocityFieldSize, VelocityFieldSizeType );

  itkSetMacro( VelocityFieldDirection, VelocityFieldDirectionType );
  itkGetConstMacro( VelocityFieldDirection, VelocityFieldDirectionType );

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

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

  TimeVaryingVelocityFieldControlPointLatticePointer             m_TimeVaryingVelocityFieldControlPointLattice;

  unsigned int                                                   m_SplineOrder;
  bool                                                           m_TemporalPeriodicity;

  VelocityFieldPointType                                         m_VelocityFieldOrigin;
  VelocityFieldSpacingType                                       m_VelocityFieldSpacing;
  VelocityFieldDirectionType                                     m_VelocityFieldDirection;
  VelocityFieldSizeType                                          m_VelocityFieldSize;
};

} // end namespace itk

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

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

#endif // __itkTimeVaryingBSplineVelocityFieldTransform_h