itkBSplineTransform.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 itkBSplineTransform_h
#define itkBSplineTransform_h
 
#include "itkBSplineBaseTransform.h"
 
namespace itk
{
template <typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
class ITK_TEMPLATE_EXPORT BSplineTransform : public BSplineBaseTransform<TParametersValueType, VDimension, VSplineOrder>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BSplineTransform);

  using Self = BSplineTransform;
  using Superclass = BSplineBaseTransform<TParametersValueType, VDimension, VSplineOrder>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(BSplineTransform);

  static constexpr unsigned int SpaceDimension = VDimension;

  static constexpr unsigned int SplineOrder = VSplineOrder;

  using typename Superclass::ScalarType;

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

  using typename Superclass::JacobianType;
  using typename Superclass::JacobianPositionType;
  using typename Superclass::InverseJacobianPositionType;

  using typename Superclass::NumberOfParametersType;

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

  using typename Superclass::InputCovariantVectorType;
  using typename Superclass::OutputCovariantVectorType;

  using typename Superclass::InputVnlVectorType;
  using typename Superclass::OutputVnlVectorType;

  using typename Superclass::InputPointType;
  using typename Superclass::OutputPointType;
 
 
  std::string
  GetTransformTypeAsString() const override;

  void
  SetFixedParameters(const FixedParametersType & passedParameters) override;

  using typename Superclass::ImageType;
  using typename Superclass::ImagePointer;
  using typename Superclass::CoefficientImageArray;

  void
  SetCoefficientImages(const CoefficientImageArray & images) override;

  using typename Superclass::RegionType;
 
  using typename Superclass::IndexType;
  using typename Superclass::SizeType;
  using typename Superclass::SpacingType;
  using typename Superclass::DirectionType;
  using typename Superclass::OriginType;

  using typename Superclass::WeightsFunctionType;
 
  using typename Superclass::WeightsType;
  using typename Superclass::ContinuousIndexType;

  using typename Superclass::ParameterIndexArrayType;

  using Superclass::TransformPoint;
  void
  TransformPoint(const InputPointType &    point,
                 OutputPointType &         outputPoint,
                 WeightsType &             weights,
                 ParameterIndexArrayType & indices,
                 bool &                    inside) const override;
  void
  ComputeJacobianWithRespectToParameters(const InputPointType &, JacobianType &) const override;

  NumberOfParametersType
  GetNumberOfParameters() const override;

  NumberOfParametersType
  GetNumberOfParametersPerDimension() const override;
 
  using PhysicalDimensionsType = typename Superclass::SpacingType;
  using typename Superclass::PixelType;
 
  using typename Superclass::MeshSizeType;

  virtual void
  SetTransformDomainOrigin(const OriginType &);

  virtual OriginType
  GetTransformDomainOrigin() const;

  virtual void
  SetTransformDomainPhysicalDimensions(const PhysicalDimensionsType &);

  virtual PhysicalDimensionsType
  GetTransformDomainPhysicalDimensions() const;

  virtual void
  SetTransformDomainDirection(const DirectionType &);

  virtual DirectionType
  GetTransformDomainDirection() const;

  virtual void
  SetTransformDomainMeshSize(const MeshSizeType &);

  virtual MeshSizeType
  GetTransformDomainMeshSize() const;
 
protected:
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  BSplineTransform();
  ~BSplineTransform() override = default;
 
private:
  void
  SetCoefficientImageInformationFromFixedParameters() override;

  void
  SetFixedParametersGridSizeFromTransformDomainInformation() const override
  {}
  void
  SetFixedParametersGridOriginFromTransformDomainInformation() const override
  {}
  void
  SetFixedParametersGridSpacingFromTransformDomainInformation() const override
  {}
  void
  SetFixedParametersGridDirectionFromTransformDomainInformation() const override
  {}

  bool
  InsideValidRegion(ContinuousIndexType &) const override;
 
  void
  SetFixedParametersFromCoefficientImageInformation();
 
  void
  SetFixedParametersFromTransformDomainInformation(const OriginType &             meshOrigin,
                                                   const PhysicalDimensionsType & meshPhysical,
                                                   const DirectionType &          meshDirection,
                                                   const MeshSizeType &           meshSize);
 
}; // class BSplineTransform
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBSplineTransform.hxx"
#endif
 
#endif /* itkBSplineTransform_h */