itkBSplineExponentialDiffeomorphicTransform.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 itkBSplineExponentialDiffeomorphicTransform_h
#define itkBSplineExponentialDiffeomorphicTransform_h

#include "itkConstantVelocityFieldTransform.h"
#include "itkDisplacementFieldToBSplineImageFilter.h"
#include "itkPointSet.h"

namespace itk
{

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

  using Self = BSplineExponentialDiffeomorphicTransform;
  using Superclass = ConstantVelocityFieldTransform<TParametersValueType, NDimensions>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkTypeMacro( BSplineExponentialDiffeomorphicTransform, ConstantVelocityFieldTransform );

  itkNewMacro( Self );

  static constexpr unsigned int ConstantVelocityFieldDimension = NDimensions;

  static constexpr unsigned int Dimension = NDimensions;

  using ScalarType = typename Superclass::ScalarType;
  using DerivativeType = typename Superclass::DerivativeType;
  using DerivativeValueType = typename DerivativeType::ValueType;

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

  using DisplacementFieldType = typename Superclass::DisplacementFieldType;
  using DisplacementFieldPointer = typename Superclass::DisplacementFieldPointer;
  using ConstantVelocityFieldType = typename Superclass::ConstantVelocityFieldType;
  using ConstantVelocityFieldPointer = typename Superclass::ConstantVelocityFieldPointer;

  using DisplacementVectorType = typename DisplacementFieldType::PixelType;

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

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

  virtual ConstantVelocityFieldPointer BSplineSmoothConstantVelocityField( const ConstantVelocityFieldType *, const ArrayType & );

  itkSetMacro( SplineOrder, SplineOrderType );
  itkGetConstMacro( SplineOrder, SplineOrderType );

  itkSetMacro( NumberOfControlPointsForTheConstantVelocityField, ArrayType );
  itkGetConstMacro( NumberOfControlPointsForTheConstantVelocityField, ArrayType );

  itkSetMacro( NumberOfControlPointsForTheUpdateField, ArrayType );
  itkGetConstMacro( NumberOfControlPointsForTheUpdateField, ArrayType );

  void SetMeshSizeForTheConstantVelocityField( const ArrayType & );

  void SetMeshSizeForTheUpdateField( const ArrayType & );

protected:
  BSplineExponentialDiffeomorphicTransform();
  ~BSplineExponentialDiffeomorphicTransform() override = default;

  void PrintSelf( std::ostream &, Indent ) const override;

private:
  ArrayType                               m_NumberOfControlPointsForTheConstantVelocityField;
  ArrayType                               m_NumberOfControlPointsForTheUpdateField;

  SplineOrderType                         m_SplineOrder{ 3 };
};

} // end namespace itk

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

#endif // itkBSplineExponentialDiffeomorphicTransform_h