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 "itkVelocityFieldTransform.h"

namespace itk
{

template<typename TParametersValueType, unsigned int NDimensions>
class TimeVaryingBSplineVelocityFieldTransform :
  public VelocityFieldTransform<TParametersValueType, NDimensions>
{
public:

  typedef TimeVaryingBSplineVelocityFieldTransform                  Self;
  typedef VelocityFieldTransform<TParametersValueType, NDimensions> Superclass;
  typedef SmartPointer<Self>                                        Pointer;
  typedef SmartPointer<const Self>                                  ConstPointer;

  itkTypeMacro( TimeVaryingBSplineVelocityFieldTransform, VelocityFieldTransform );

  itkNewMacro( Self );

  typedef typename Superclass::InverseTransformBasePointer InverseTransformBasePointer;

  typedef typename Superclass::InterpolatorType                     InterpolatorType;
  typedef typename Superclass::VelocityFieldInterpolatorType        VelocityFieldIntegratorType;

  typedef typename Superclass::DisplacementFieldType                DisplacementFieldType;
  typedef typename Superclass::VelocityFieldType                    VelocityFieldType;

  typedef typename Superclass::ScalarType          ScalarType;

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

  typedef typename Superclass::DerivativeType       DerivativeType;

  itkStaticConstMacro( Dimension, unsigned int, NDimensions );

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

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

  typedef VelocityFieldType                             TimeVaryingVelocityFieldControlPointLatticeType;
  typedef typename VelocityFieldType::Pointer           TimeVaryingVelocityFieldControlPointLatticePointer;

  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;

  VelocityFieldType * GetTimeVaryingVelocityFieldControlPointLattice()
    {
    return this->GetModifiableVelocityField();
    }

  virtual void SetTimeVaryingVelocityFieldControlPointLattice( VelocityFieldType * fieldLattice )
    {
    this->SetVelocityField( fieldLattice );
    }

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

  virtual void IntegrateVelocityField() ITK_OVERRIDE;

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

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

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

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

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

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

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

  unsigned int                                                   m_SplineOrder;
  bool                                                           m_TemporalPeriodicity;

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

} // end namespace itk

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

#endif // itkTimeVaryingBSplineVelocityFieldTransform_h