itkBSplineSmoothingOnUpdateDisplacementFieldTransform.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 itkBSplineSmoothingOnUpdateDisplacementFieldTransform_h
#define itkBSplineSmoothingOnUpdateDisplacementFieldTransform_h
 
#include "itkDisplacementFieldTransform.h"
 
#include "itkDisplacementFieldToBSplineImageFilter.h"
#include "itkPointSet.h"
 
namespace itk
{

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

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

  itkOverrideGetNameOfClassMacro(BSplineSmoothingOnUpdateDisplacementFieldTransform);

  itkNewMacro(Self);

  static constexpr unsigned int Dimension = VDimension;

  using typename Superclass::ScalarType;
  using typename Superclass::DerivativeType;
  using DerivativeValueType = typename DerivativeType::ValueType;
  using typename Superclass::DisplacementFieldType;
  using typename Superclass::DisplacementFieldPointer;
  using typename Superclass::DisplacementFieldConstPointer;
 
  using TransformPointer = typename Transform<TParametersValueType, VDimension, VDimension>::Pointer;

  using DisplacementVectorType = typename DisplacementFieldType::PixelType;
  using PointSetType = PointSet<DisplacementVectorType, Dimension>;
  using SplineOrderType = unsigned int;
  using BSplineFilterType = DisplacementFieldToBSplineImageFilter<DisplacementFieldType>;
  using WeightsContainerType = typename BSplineFilterType::WeightsContainerType;
  using DisplacementFieldControlPointLatticeType = DisplacementFieldType;
  using ArrayType = typename BSplineFilterType::ArrayType;
  using ArrayValueType = typename ArrayType::ValueType;

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

  itkSetMacro(SplineOrder, SplineOrderType);

  itkGetConstMacro(SplineOrder, SplineOrderType);

  itkSetMacro(NumberOfControlPointsForTheUpdateField, ArrayType);

  itkGetConstMacro(NumberOfControlPointsForTheUpdateField, ArrayType);

  void
  SetMeshSizeForTheUpdateField(const ArrayType &);

  itkSetMacro(NumberOfControlPointsForTheTotalField, ArrayType);

  itkGetConstMacro(NumberOfControlPointsForTheTotalField, ArrayType);

  void
  SetMeshSizeForTheTotalField(const ArrayType &);

  itkBooleanMacro(EnforceStationaryBoundary);
  itkSetMacro(EnforceStationaryBoundary, bool);
  itkGetConstMacro(EnforceStationaryBoundary, bool);
protected:
  BSplineSmoothingOnUpdateDisplacementFieldTransform();
  ~BSplineSmoothingOnUpdateDisplacementFieldTransform() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  typename LightObject::Pointer
  InternalClone() const override;

  DisplacementFieldPointer
  BSplineSmoothDisplacementField(const DisplacementFieldType *, const ArrayType &);
 
private:
  SplineOrderType m_SplineOrder{ 3 };
  bool            m_EnforceStationaryBoundary{ true };
  ArrayType       m_NumberOfControlPointsForTheUpdateField{};
  ArrayType       m_NumberOfControlPointsForTheTotalField{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBSplineSmoothingOnUpdateDisplacementFieldTransform.hxx"
#endif
 
#endif // itkBSplineSmoothingOnUpdateDisplacementFieldTransform_h