itkConstantVelocityFieldTransform.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkConstantVelocityFieldTransform_h
#define itkConstantVelocityFieldTransform_h
 
#include "itkDisplacementFieldTransform.h"
 
namespace itk
{

template <typename TParametersValueType, unsigned int VDimension>
class ITK_TEMPLATE_EXPORT ConstantVelocityFieldTransform
  : public DisplacementFieldTransform<TParametersValueType, VDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ConstantVelocityFieldTransform);

  using Self = ConstantVelocityFieldTransform;
  using Superclass = DisplacementFieldTransform<TParametersValueType, VDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ConstantVelocityFieldTransform);

  itkNewMacro(Self);

  using typename Superclass::InverseTransformBasePointer;

  using typename Superclass::ScalarType;

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

  using typename Superclass::TransformCategoryEnum;

  using typename Superclass::NumberOfParametersType;

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

  using typename Superclass::InputVectorType;
  using typename Superclass::OutputVectorType;
 
  using typename Superclass::InputVectorPixelType;
  using typename Superclass::OutputVectorPixelType;

  using typename Superclass::DerivativeType;

  static constexpr unsigned int ConstantVelocityFieldDimension = VDimension;

  static constexpr unsigned int Dimension = VDimension;

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

  using ConstantVelocityFieldType = Image<OutputVectorType, ConstantVelocityFieldDimension>;
  using ConstantVelocityFieldPointer = typename ConstantVelocityFieldType::Pointer;

  using IndexType = typename ConstantVelocityFieldType::IndexType;
  using RegionType = typename ConstantVelocityFieldType::RegionType;
  using SizeType = typename ConstantVelocityFieldType::SizeType;
  using SpacingType = typename ConstantVelocityFieldType::SpacingType;
  using DirectionType = typename ConstantVelocityFieldType::DirectionType;
  using PointType = typename ConstantVelocityFieldType::PointType;
  using PixelType = typename ConstantVelocityFieldType::PixelType;
 
  using VelocityFieldType = ConstantVelocityFieldType;
 
  using ConstantVelocityFieldInterpolatorType = VectorInterpolateImageFunction<ConstantVelocityFieldType, ScalarType>;
  using ConstantVelocityFieldInterpolatorPointer = typename ConstantVelocityFieldInterpolatorType::Pointer;

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

  virtual void
  SetConstantVelocityField(ConstantVelocityFieldType *);
  itkGetModifiableObjectMacro(ConstantVelocityField, ConstantVelocityFieldType);
 
  void
  SetFixedParameters(const FixedParametersType &) override;

  virtual void
  SetConstantVelocityFieldInterpolator(ConstantVelocityFieldInterpolatorType *);
  itkGetModifiableObjectMacro(ConstantVelocityFieldInterpolator, ConstantVelocityFieldInterpolatorType);

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

  bool
  GetInverse(Self * inverse) const;

  InverseTransformBasePointer
  GetInverseTransform() const override;

  virtual void
  IntegrateVelocityField();
 
  // Set/get compute number of exp. integration steps automatically
  itkSetMacro(CalculateNumberOfIntegrationStepsAutomatically, bool);
  itkGetConstMacro(CalculateNumberOfIntegrationStepsAutomatically, bool);
  itkBooleanMacro(CalculateNumberOfIntegrationStepsAutomatically);

  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:
  ConstantVelocityFieldTransform();
  ~ConstantVelocityFieldTransform() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  typename LightObject::Pointer
  InternalClone() const override;
 
  typename DisplacementFieldType::Pointer
  CopyDisplacementField(const DisplacementFieldType *) const;
 
  ConstantVelocityFieldPointer m_ConstantVelocityField{};
 
  bool m_CalculateNumberOfIntegrationStepsAutomatically{ false };

  ConstantVelocityFieldInterpolatorPointer m_ConstantVelocityFieldInterpolator{};

  ModifiedTimeType m_ConstantVelocityFieldSetTime{ 0 };
 
  ScalarType m_LowerTimeBound{};
  ScalarType m_UpperTimeBound{};
 
  unsigned int m_NumberOfIntegrationSteps{};
 
private:
  virtual void
  SetFixedParametersFromConstantVelocityField() const;
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkConstantVelocityFieldTransform.hxx"
#endif
 
#endif // itkConstantVelocityFieldTransform_h