itkTimeVaryingBSplineVelocityFieldTransform.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 itkTimeVaryingBSplineVelocityFieldTransform_h
#define itkTimeVaryingBSplineVelocityFieldTransform_h
 
#include "itkVelocityFieldTransform.h"
 
namespace itk
{

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

  using Self = TimeVaryingBSplineVelocityFieldTransform;
  using Superclass = VelocityFieldTransform<TParametersValueType, VDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(TimeVaryingBSplineVelocityFieldTransform);

  itkNewMacro(Self);

  using typename Superclass::InverseTransformBasePointer;

  using typename Superclass::InterpolatorType;
  using VelocityFieldIntegratorType = typename Superclass::VelocityFieldInterpolatorType;

  using typename Superclass::DisplacementFieldType;
  using typename Superclass::VelocityFieldType;

  using typename Superclass::ScalarType;

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

  using typename Superclass::DerivativeType;

  static constexpr unsigned int Dimension = VDimension;

  static constexpr unsigned int VelocityFieldDimension = VDimension + 1;
 
  using VelocityFieldPointType = typename VelocityFieldType::PointType;
  using VelocityFieldSizeType = typename VelocityFieldType::SizeType;
  using VelocityFieldSpacingType = typename VelocityFieldType::SpacingType;
  using VelocityFieldDirectionType = typename VelocityFieldType::DirectionType;
 
  using TimeVaryingVelocityFieldControlPointLatticeType = VelocityFieldType;
  using TimeVaryingVelocityFieldControlPointLatticePointer = typename VelocityFieldType::Pointer;
 
  using DisplacementVectorType = typename DisplacementFieldType::PixelType;
  using DisplacementFieldSizeType = typename DisplacementFieldType::SizeType;
  using DisplacementFieldSpacingType = typename DisplacementFieldType::SpacingType;
  using DisplacementFieldPointType = typename DisplacementFieldType::PointType;
  using DisplacementFieldDirectionType = typename DisplacementFieldType::DirectionType;

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

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

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

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