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

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

  // Explicit New() method, used here because we need to split the itkNewMacro()
  // in order to overload the CreateAnother() method so that we can copy the m_BulkTransform
  // explicitly.
  // TODO: shouldn't it be done with the Clone() method?
  itkSimpleNewMacro(Self);
  itk::LightObject::Pointer
  CreateAnother() const override
  {
    itk::LightObject::Pointer smartPtr;
    const Pointer             copyPtr = Self::New().GetPointer();
    // THE FOLLOWING LINE IS DIFFERENT FROM THE DEFAULT MACRO!
    copyPtr->m_BulkTransform = this->GetBulkTransform();
    smartPtr = static_cast<Pointer>(copyPtr);
    return smartPtr;
  }


  itkCloneMacro(Self);

  itkOverrideGetNameOfClassMacro(BSplineDeformableTransform);

  static constexpr unsigned int SpaceDimension = VDimension;

  static constexpr unsigned int SplineOrder = VSplineOrder;

  using ScalarType = TParametersValueType;

  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 InputPointType = Point<TParametersValueType, Self::SpaceDimension>;
  using OutputPointType = Point<TParametersValueType, Self::SpaceDimension>;
 

  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 &    inputPoint,
                 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
  SetGridOrigin(const OriginType &);

  itkGetConstMacro(GridOrigin, OriginType);

  virtual void
  SetGridSpacing(const SpacingType &);

  itkGetConstMacro(GridSpacing, SpacingType);

  virtual void
  SetGridDirection(const DirectionType &);

  itkGetConstMacro(GridDirection, DirectionType);

  virtual void
  SetGridRegion(const RegionType &);

  itkGetConstMacro(GridRegion, RegionType);
 
  using BulkTransformType = Transform<TParametersValueType, Self::SpaceDimension, Self::SpaceDimension>;
  using BulkTransformPointer = typename BulkTransformType::ConstPointer;
  itkSetConstObjectMacro(BulkTransform, BulkTransformType);
  itkGetConstObjectMacro(BulkTransform, BulkTransformType);

  itkGetConstReferenceMacro(ValidRegion, RegionType);
 
protected:
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  BSplineDeformableTransform();
  ~BSplineDeformableTransform() override = default;
 
private:
  void
  SetFixedParametersGridSizeFromTransformDomainInformation() const override;

  void
  SetFixedParametersGridOriginFromTransformDomainInformation() const override;

  void
  SetFixedParametersGridSpacingFromTransformDomainInformation() const override;

  void
  SetFixedParametersGridDirectionFromTransformDomainInformation() const override;

  void
  SetCoefficientImageInformationFromFixedParameters() override;

  bool
  InsideValidRegion(ContinuousIndexType &) const override;

  const RegionType &    m_GridRegion{};
  const OriginType &    m_GridOrigin{};
  const SpacingType &   m_GridSpacing{};
  const DirectionType & m_GridDirection;

  BulkTransformPointer m_BulkTransform{};
 
  RegionType m_ValidRegion{};

  unsigned long m_Offset{};
  bool          m_SplineOrderOdd{};
  IndexType     m_ValidRegionLast{};
  IndexType     m_ValidRegionFirst{};
 
  void
  UpdateValidGridRegion();
 
}; // class BSplineDeformableTransform
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBSplineDeformableTransform.hxx"
#endif
 
#endif /* itkBSplineDeformableTransform_h */