itkPointSetToPointSetMetricWithIndexv4.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 itkPointSetToPointSetMetricWithIndexv4_h
#define itkPointSetToPointSetMetricWithIndexv4_h
 
#include "itkObjectToObjectMetric.h"
 
#include "itkFixedArray.h"
#include "itkPointsLocator.h"
#include "itkPointSet.h"
 
namespace itk
{
 
template <typename TFixedPointSet,
          typename TMovingPointSet = TFixedPointSet,
          class TInternalComputationValueType = double>
class ITK_TEMPLATE_EXPORT PointSetToPointSetMetricWithIndexv4
  : public ObjectToObjectMetric<TFixedPointSet::PointDimension,
                                TMovingPointSet::PointDimension,
                                Image<TInternalComputationValueType, TFixedPointSet::PointDimension>,
                                TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PointSetToPointSetMetricWithIndexv4);

  using Self = PointSetToPointSetMetricWithIndexv4;
  using Superclass = ObjectToObjectMetric<TFixedPointSet::PointDimension,
                                          TMovingPointSet::PointDimension,
                                          Image<TInternalComputationValueType, TFixedPointSet::PointDimension>,
                                          TInternalComputationValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(PointSetToPointSetMetricWithIndexv4);

  using typename Superclass::MeasureType;

  using typename Superclass::ParametersType;
  using typename Superclass::ParametersValueType;
  using typename Superclass::NumberOfParametersType;

  using typename Superclass::DerivativeType;

  using typename Superclass::FixedTransformType;
  using typename Superclass::FixedTransformPointer;
  using typename Superclass::FixedInputPointType;
  using typename Superclass::FixedOutputPointType;
  using typename Superclass::FixedTransformParametersType;
 
  using typename Superclass::MovingTransformType;
  using typename Superclass::MovingTransformPointer;
  using typename Superclass::MovingInputPointType;
  using typename Superclass::MovingOutputPointType;
  using typename Superclass::MovingTransformParametersType;
 
  using typename Superclass::JacobianType;
  using typename Superclass::FixedTransformJacobianType;
  using typename Superclass::MovingTransformJacobianType;
 
  using DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType;
 
  using ObjectType = typename Superclass::ObjectType;

  using typename Superclass::DimensionType;

  using FixedPointSetType = TFixedPointSet;
  using FixedPointType = typename TFixedPointSet::PointType;
  using FixedPixelType = typename TFixedPointSet::PixelType;
  using FixedPointsContainer = typename TFixedPointSet::PointsContainer;
 
  static constexpr DimensionType FixedPointDimension = Superclass::FixedDimension;

  using MovingPointSetType = TMovingPointSet;
  using MovingPointType = typename TMovingPointSet::PointType;
  using MovingPixelType = typename TMovingPointSet::PixelType;
  using MovingPointsContainer = typename TMovingPointSet::PointsContainer;
 
  static constexpr DimensionType MovingPointDimension = Superclass::MovingDimension;

  static constexpr DimensionType PointDimension = Superclass::FixedDimension;
 
  using PointType = FixedPointType;
  using PixelType = FixedPixelType;
  using CoordinateType = typename PointType::CoordinateType;
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#endif
  using PointsContainer = FixedPointsContainer;
  using PointsConstIterator = typename PointsContainer::ConstIterator;
  using PointIdentifier = typename PointsContainer::ElementIdentifier;

  using PointsLocatorType = PointsLocator<PointsContainer>;
  using NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType;
 
  using FixedTransformedPointSetType = PointSet<FixedPixelType, Self::PointDimension>;
  using MovingTransformedPointSetType = PointSet<MovingPixelType, Self::PointDimension>;
 
  using DerivativeValueType = typename DerivativeType::ValueType;
  using LocalDerivativeType = FixedArray<DerivativeValueType, Self::PointDimension>;

  using VirtualImageType = typename Superclass::VirtualImageType;
  using typename Superclass::VirtualImagePointer;
  using typename Superclass::VirtualPixelType;
  using typename Superclass::VirtualRegionType;
  using typename Superclass::VirtualSizeType;
  using typename Superclass::VirtualSpacingType;
  using VirtualOriginType = typename Superclass::VirtualPointType;
  using typename Superclass::VirtualPointType;
  using typename Superclass::VirtualDirectionType;
  using VirtualRadiusType = typename Superclass::VirtualSizeType;
  using typename Superclass::VirtualIndexType;
  using typename Superclass::VirtualPointSetType;
  using typename Superclass::VirtualPointSetPointer;

  void
  SetFixedObject(const ObjectType * object) override
  {
    auto * pointSet = dynamic_cast<FixedPointSetType *>(const_cast<ObjectType *>(object));
    if (pointSet != nullptr)
    {
      this->SetFixedPointSet(pointSet);
    }
    else
    {
      itkExceptionMacro("Incorrect object type.  Should be a point set.");
    }
  }

  void
  SetMovingObject(const ObjectType * object) override
  {
    auto * pointSet = dynamic_cast<MovingPointSetType *>(const_cast<ObjectType *>(object));
    if (pointSet != nullptr)
    {
      this->SetMovingPointSet(pointSet);
    }
    else
    {
      itkExceptionMacro("Incorrect object type.  Should be a point set.");
    }
  }

  itkSetConstObjectMacro(FixedPointSet, FixedPointSetType);
  itkGetConstObjectMacro(FixedPointSet, FixedPointSetType);

  itkGetModifiableObjectMacro(FixedTransformedPointSet, FixedTransformedPointSetType);

  itkSetConstObjectMacro(MovingPointSet, MovingPointSetType);
  itkGetConstObjectMacro(MovingPointSet, MovingPointSetType);

  itkGetModifiableObjectMacro(MovingTransformedPointSet, MovingTransformedPointSetType);

  SizeValueType
  GetNumberOfComponents() const;

  MeasureType
  GetValue() const override;

  void
  GetDerivative(DerivativeType &) const override;

  void
  GetValueAndDerivative(MeasureType &, DerivativeType &) const override;

  const VirtualPointSetType *
  GetVirtualTransformedPointSet() const;

  void
  Initialize() override;
 
  bool
  SupportsArbitraryVirtualDomainSamples() const override
  {
    /* An arbitrary point in the virtual domain will not always
     * correspond to a point within either point set. */
    return false;
  }

  itkSetMacro(StoreDerivativeAsSparseFieldForLocalSupportTransforms, bool);
  itkGetConstMacro(StoreDerivativeAsSparseFieldForLocalSupportTransforms, bool);
  itkBooleanMacro(StoreDerivativeAsSparseFieldForLocalSupportTransforms);

  itkSetMacro(CalculateValueAndDerivativeInTangentSpace, bool);
  itkGetConstMacro(CalculateValueAndDerivativeInTangentSpace, bool);
  itkBooleanMacro(CalculateValueAndDerivativeInTangentSpace);
 
protected:
  PointSetToPointSetMetricWithIndexv4();
  ~PointSetToPointSetMetricWithIndexv4() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  typename FixedPointSetType::ConstPointer               m_FixedPointSet{};
  mutable typename FixedTransformedPointSetType::Pointer m_FixedTransformedPointSet{};
 
  mutable typename PointsLocatorType::Pointer m_FixedTransformedPointsLocator{};
 
  typename MovingPointSetType::ConstPointer               m_MovingPointSet{};
  mutable typename MovingTransformedPointSetType::Pointer m_MovingTransformedPointSet{};
 
  mutable typename PointsLocatorType::Pointer m_MovingTransformedPointsLocator{};

  mutable VirtualPointSetPointer m_VirtualTransformedPointSet{};

  bool m_UsePointSetData{};

  bool m_CalculateValueAndDerivativeInTangentSpace{};

  virtual void
  InitializePointSets() const;

  virtual void
  InitializeForIteration() const;

  virtual SizeValueType
  CalculateNumberOfValidFixedPoints() const;

  void
  CalculateValueAndDerivative(MeasureType & calculatedValue, DerivativeType & derivative, bool calculateValue) const;

  void
  TransformFixedAndCreateVirtualPointSet() const;

  void
  TransformMovingPointSet() const;

  void
  InitializePointsLocators() const;

  void
  StorePointDerivative(const VirtualPointType &, const DerivativeType &, DerivativeType &) const;
 
  using typename Superclass::MetricCategoryType;

  MetricCategoryType
  GetMetricCategory() const override
  {
    return MetricCategoryType::POINT_SET_METRIC;
  }
 
  virtual bool
  RequiresMovingPointsLocator() const
  {
    return true;
  }
 
  virtual bool
  RequiresFixedPointsLocator() const
  {
    return true;
  }

  virtual MeasureType
  GetLocalNeighborhoodValueWithIndex(const PointIdentifier &, const PointType &, const PixelType & pixel) const = 0;

  virtual LocalDerivativeType
  GetLocalNeighborhoodDerivativeWithIndex(const PointIdentifier &, const PointType &, const PixelType & pixel) const;

  virtual void
  GetLocalNeighborhoodValueAndDerivativeWithIndex(const PointIdentifier &,
                                                  const PointType &,
                                                  MeasureType &,
                                                  LocalDerivativeType &,
                                                  const PixelType & pixel) const = 0;
 
private:
  mutable bool m_MovingTransformPointLocatorsNeedInitialization{};
  mutable bool m_FixedTransformPointLocatorsNeedInitialization{};
 
  // Flag to keep track of whether a warning has already been issued
  // regarding the number of valid points.
  mutable bool m_HaveWarnedAboutNumberOfValidPoints{};
 
  // Flag to store derivatives at fixed point locations with the rest being zero gradient
  // (default = true).
  bool m_StoreDerivativeAsSparseFieldForLocalSupportTransforms{};
 
  mutable ModifiedTimeType m_MovingTransformedPointSetTime{};
  mutable ModifiedTimeType m_FixedTransformedPointSetTime{};
 
  // Create ranges over the point set for multithreaded computation of value and derivatives
  using PointIdentifierPair = std::pair<PointIdentifier, PointIdentifier>;
  using PointIdentifierRanges = std::vector<PointIdentifierPair>;
  const PointIdentifierRanges
  CreateRanges() const;
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkPointSetToPointSetMetricWithIndexv4.hxx"
#endif
 
#endif