itkVelocityFieldTransform.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 itkVelocityFieldTransform_h
#define itkVelocityFieldTransform_h

#include "itkDisplacementFieldTransform.h"

namespace itk
{

template<typename TParametersValueType, unsigned int NDimensions>
class ITK_TEMPLATE_EXPORT VelocityFieldTransform :
  public DisplacementFieldTransform<TParametersValueType, NDimensions>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(VelocityFieldTransform);

  using Self = VelocityFieldTransform;
  using Superclass = DisplacementFieldTransform<TParametersValueType, NDimensions>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkTypeMacro( VelocityFieldTransform, DisplacementFieldTransform );

  itkNewMacro( Self );

  using InverseTransformBasePointer = typename Superclass::InverseTransformBasePointer;

  using ScalarType = typename Superclass::ScalarType;

  using FixedParametersType = typename Superclass::FixedParametersType;
  using FixedParametersValueType = typename Superclass::FixedParametersValueType;
  using ParametersType = typename Superclass::ParametersType;
  using ParametersValueType = typename Superclass::ParametersValueType;

  using TransformCategoryType = typename Superclass::TransformCategoryType;

  using NumberOfParametersType = typename Superclass::NumberOfParametersType;

  using InputPointType = typename Superclass::InputPointType;
  using OutputPointType = typename Superclass::OutputPointType;

  using InputVectorType = typename Superclass::InputVectorType;
  using OutputVectorType = typename Superclass::OutputVectorType;

  using InputVectorPixelType = typename Superclass::InputVectorPixelType;
  using OutputVectorPixelType = typename Superclass::OutputVectorPixelType;

  using DerivativeType = typename Superclass::DerivativeType;

  static constexpr unsigned int VelocityFieldDimension = NDimensions + 1;

  static constexpr unsigned int Dimension = NDimensions;

  using DisplacementFieldType = typename Superclass::DisplacementFieldType;
  using DisplacementFieldPointer = typename DisplacementFieldType::Pointer;

  using VelocityFieldType = Image<OutputVectorType, VelocityFieldDimension>;
  using VelocityFieldPointer = typename VelocityFieldType::Pointer;

  using IndexType = typename VelocityFieldType::IndexType;
  using RegionType = typename VelocityFieldType::RegionType;
  using SizeType = typename VelocityFieldType::SizeType;
  using SpacingType = typename VelocityFieldType::SpacingType;
  using DirectionType = typename VelocityFieldType::DirectionType;
  using PointType = typename VelocityFieldType::PointType;
  using PixelType = typename VelocityFieldType::PixelType;

  using VelocityFieldInterpolatorType = VectorInterpolateImageFunction<VelocityFieldType, ScalarType>;
  using VelocityFieldInterpolatorPointer = typename VelocityFieldInterpolatorType::Pointer;

  using OptimizerParametersHelperType =
      ImageVectorOptimizerParametersHelper<ScalarType, Dimension, VelocityFieldDimension>;

  virtual void SetVelocityField( VelocityFieldType * );
  itkGetModifiableObjectMacro(VelocityField, VelocityFieldType );

  void SetFixedParameters( const FixedParametersType & ) override;

  virtual void SetVelocityFieldInterpolator( VelocityFieldInterpolatorType * );
  itkGetModifiableObjectMacro(VelocityFieldInterpolator, VelocityFieldInterpolatorType );

  itkGetConstReferenceMacro( VelocityFieldSetTime, unsigned long );

  void SetDisplacementField( DisplacementFieldType * displacementField) override
    {
    itkDebugMacro("setting DisplacementField to " << displacementField);
    if ( this->m_DisplacementField != displacementField )
      {
      this->m_DisplacementField = displacementField;
      this->Modified();
      }
    }

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

  bool GetInverse( Self *inverse ) const;

  InverseTransformBasePointer GetInverseTransform() const override;

  virtual void IntegrateVelocityField() {};

  itkSetClampMacro( LowerTimeBound, ScalarType, 0.0, 1.0 );

  itkGetConstMacro( LowerTimeBound, ScalarType );

  itkSetClampMacro( UpperTimeBound, ScalarType, 0.0, 1.0 );

  itkGetConstMacro( UpperTimeBound, ScalarType );

  itkSetMacro( NumberOfIntegrationSteps, unsigned int );

  itkGetConstMacro( NumberOfIntegrationSteps, unsigned int );

protected:

  VelocityFieldTransform();
  ~VelocityFieldTransform() override = default;
  void PrintSelf( std::ostream& os, Indent indent ) const override;

  typename LightObject::Pointer InternalClone() const override;

  typename DisplacementFieldType::Pointer CopyDisplacementField( const DisplacementFieldType * ) const;

  ScalarType                                m_LowerTimeBound;
  ScalarType                                m_UpperTimeBound;

  unsigned int                              m_NumberOfIntegrationSteps;

  VelocityFieldPointer                      m_VelocityField;

  typename VelocityFieldInterpolatorType::Pointer          m_VelocityFieldInterpolator;

  unsigned long m_VelocityFieldSetTime;

private:
  virtual void SetFixedParametersFromVelocityField() const;

};
} // end namespace itk

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

#endif // itkVelocityFieldTransform_h