itkTimeVaryingVelocityFieldTransform.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 __itkTimeVaryingVelocityFieldTransform_h
#define __itkTimeVaryingVelocityFieldTransform_h

#include "itkDisplacementFieldTransform.h"

#include "itkImageVectorOptimizerParametersHelper.h"

namespace itk
{

template<class TScalar, unsigned int NDimensions>
class ITK_EXPORT TimeVaryingVelocityFieldTransform :
  public DisplacementFieldTransform<TScalar, NDimensions>
{
public:
  typedef TimeVaryingVelocityFieldTransform                 Self;
  typedef DisplacementFieldTransform<TScalar, NDimensions>  Superclass;
  typedef SmartPointer<Self>                                Pointer;
  typedef SmartPointer<const Self>                          ConstPointer;

  itkTypeMacro( TimeVaryingVelocityFieldTransform, DisplacementFieldTransform );

  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>  TimeVaryingVelocityFieldType;
  typedef typename TimeVaryingVelocityFieldType::Pointer              TimeVaryingVelocityFieldPointer;

  typedef VectorInterpolateImageFunction<TimeVaryingVelocityFieldType, ScalarType>  TimeVaryingVelocityFieldInterpolatorType;
  typedef typename TimeVaryingVelocityFieldInterpolatorType::Pointer                TimeVaryingVelocityFieldInterpolatorPointer;

  typedef typename TimeVaryingVelocityFieldType::SizeType          SizeType;
  typedef typename TimeVaryingVelocityFieldType::PointType         PointType;
  typedef typename TimeVaryingVelocityFieldType::SpacingType       SpacingType;
  typedef typename TimeVaryingVelocityFieldType::DirectionType     DirectionType;

  typedef typename Superclass::DisplacementFieldType               DisplacementFieldType;
  typedef typename DisplacementFieldType::PixelType                DisplacementVectorType;

  typedef ImageVectorOptimizerParametersHelper
    <ScalarType, OutputVectorType::Dimension,
    itkGetStaticConstMacro( Dimension ) + 1>      OptimizerParametersHelperType;

  itkGetObjectMacro( TimeVaryingVelocityField, TimeVaryingVelocityFieldType );

  virtual void SetTimeVaryingVelocityField( TimeVaryingVelocityFieldType * );

  itkSetObjectMacro( TimeVaryingVelocityFieldInterpolator,
    TimeVaryingVelocityFieldInterpolatorType );

  itkGetConstObjectMacro( TimeVaryingVelocityFieldInterpolator,
    TimeVaryingVelocityFieldInterpolatorType );

  itkGetConstMacro( TimeVaryingVelocityFieldSetTime, unsigned long );

  itkSetObjectMacro( DisplacementField, DisplacementFieldType );

  itkSetMacro( IntegrateTimeVaryingVelocityField, bool );

  itkGetConstMacro( IntegrateTimeVaryingVelocityField, bool );

  itkBooleanMacro( IntegrateTimeVaryingVelocityField );

  virtual void SetParameters( const ParametersType & );

  virtual void IntegrateVelocityField();

  virtual void SetFixedParameters( const ParametersType & );

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

  bool GetInverse( Self *inverse ) const;

  virtual InverseTransformBasePointer GetInverseTransform() const;

  virtual bool IsLinear() const { return false; }

  NumberOfParametersType GetNumberOfLocalParameters() const
    {
    return Dimension;
    }

  virtual bool HasLocalSupport() const
    {
    return true;
    }

  itkSetClampMacro( LowerTimeBound, ScalarType, 0, 1 );

  itkGetConstMacro( LowerTimeBound, ScalarType );

  itkSetClampMacro( UpperTimeBound, ScalarType, 0, 1 );

  itkGetConstMacro( UpperTimeBound, ScalarType );

  itkSetMacro( NumberOfIntegrationSteps, unsigned int );

  itkGetConstMacro( NumberOfIntegrationSteps, unsigned int );

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

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

  typename TimeVaryingVelocityFieldType::Pointer    m_TimeVaryingVelocityField;

  TimeVaryingVelocityFieldInterpolatorPointer
                                         m_TimeVaryingVelocityFieldInterpolator;

  ScalarType                                m_LowerTimeBound;
  ScalarType                                m_UpperTimeBound;

  unsigned int                              m_NumberOfIntegrationSteps;
  bool                                      m_IntegrateTimeVaryingVelocityField;
  unsigned long                             m_TimeVaryingVelocityFieldSetTime;
};

} // end namespace itk

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

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

#endif // __itkTimeVaryingVelocityFieldTransform_h