itkObjectToObjectMetricBase.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 itkObjectToObjectMetricBase_h
#define itkObjectToObjectMetricBase_h
 
#include "itkTransformBase.h"
#include "itkSingleValuedCostFunctionv4.h"
#include "ITKOptimizersv4Export.h"
 
namespace itk
{
class ObjectToObjectMetricBaseTemplateEnums
{
public:
  enum class GradientSource : uint8_t
  {
    GRADIENT_SOURCE_FIXED = 0,
    GRADIENT_SOURCE_MOVING,
    GRADIENT_SOURCE_BOTH
  };

  enum class MetricCategory : uint8_t
  {
    UNKNOWN_METRIC = 0,
    OBJECT_METRIC = 1,
    IMAGE_METRIC = 2,
    POINT_SET_METRIC = 3,
    MULTI_METRIC = 4
  };
};
// Define how to print enumeration
extern ITKOptimizersv4_EXPORT std::ostream &
operator<<(std::ostream & out, const ObjectToObjectMetricBaseTemplateEnums::GradientSource value);
extern ITKOptimizersv4_EXPORT std::ostream &
operator<<(std::ostream & out, const ObjectToObjectMetricBaseTemplateEnums::MetricCategory value);

template <typename TInternalComputationValueType = double>
class ITK_TEMPLATE_EXPORT ObjectToObjectMetricBaseTemplate
  : public SingleValuedCostFunctionv4Template<TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ObjectToObjectMetricBaseTemplate);

  using Self = ObjectToObjectMetricBaseTemplate;
  using Superclass = SingleValuedCostFunctionv4Template<TInternalComputationValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ObjectToObjectMetricBaseTemplate);

  using CoordinateRepresentationType = TInternalComputationValueType;

  using typename Superclass::MeasureType;

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

  using typename Superclass::ParametersType;
  using ParametersValueType = TInternalComputationValueType;

  using ObjectType = Object;
  using ObjectConstPointer = typename ObjectType::ConstPointer;

  itkSetConstObjectMacro(FixedObject, ObjectType);
  itkGetConstObjectMacro(FixedObject, ObjectType);

  itkSetConstObjectMacro(MovingObject, ObjectType);
  itkGetConstObjectMacro(MovingObject, ObjectType);
 
  using GradientSourceEnum = itk::ObjectToObjectMetricBaseTemplateEnums::GradientSource;
#if !defined(ITK_LEGACY_REMOVE)
  // We need to expose the enum values at the class level
  // for backwards compatibility
  static constexpr GradientSourceEnum GRADIENT_SOURCE_FIXED = GradientSourceEnum::GRADIENT_SOURCE_FIXED;
  static constexpr GradientSourceEnum GRADIENT_SOURCE_MOVING = GradientSourceEnum::GRADIENT_SOURCE_MOVING;
  static constexpr GradientSourceEnum GRADIENT_SOURCE_BOTH = GradientSourceEnum::GRADIENT_SOURCE_BOTH;
#endif

  itkSetMacro(GradientSource, GradientSourceEnum);

  itkGetConstMacro(GradientSource, GradientSourceEnum);

  bool
  GetGradientSourceIncludesFixed() const;

  bool
  GetGradientSourceIncludesMoving() const;

  virtual void
  Initialize() = 0;

  using NumberOfParametersType = unsigned int;

  MeasureType
  GetValue() const override = 0;

  virtual void
  GetDerivative(DerivativeType &) const = 0;

  void
  GetValueAndDerivative(MeasureType & value, DerivativeType & derivative) const override = 0;

  NumberOfParametersType
  GetNumberOfParameters() const override = 0;
  virtual NumberOfParametersType
  GetNumberOfLocalParameters() const = 0;

  virtual void
  SetParameters(ParametersType & params) = 0;

  virtual const ParametersType &
  GetParameters() const = 0;

  virtual bool
  HasLocalSupport() const = 0;

  virtual void
  UpdateTransformParameters(const DerivativeType & derivative,
                            ParametersValueType    factor = NumericTraits<ParametersValueType>::OneValue()) = 0;

  MeasureType
  GetCurrentValue() const;
 
  using MetricCategoryEnum = itk::ObjectToObjectMetricBaseTemplateEnums::MetricCategory;
#if !defined(ITK_LEGACY_REMOVE)
  static constexpr MetricCategoryEnum UNKNOWN_METRIC = MetricCategoryEnum::UNKNOWN_METRIC;
  static constexpr MetricCategoryEnum OBJECT_METRIC = MetricCategoryEnum::OBJECT_METRIC;
  static constexpr MetricCategoryEnum IMAGE_METRIC = MetricCategoryEnum::IMAGE_METRIC;
  static constexpr MetricCategoryEnum POINT_SET_METRIC = MetricCategoryEnum::POINT_SET_METRIC;
  static constexpr MetricCategoryEnum MULTI_METRIC = MetricCategoryEnum::MULTI_METRIC;
#endif

  virtual MetricCategoryEnum
  GetMetricCategory() const
  {
    return MetricCategoryEnum::UNKNOWN_METRIC;
  }
 
protected:
  ObjectToObjectMetricBaseTemplate();
  ~ObjectToObjectMetricBaseTemplate() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  ObjectConstPointer m_FixedObject{};
  ObjectConstPointer m_MovingObject{};
 
  GradientSourceEnum m_GradientSource{};

  mutable MeasureType m_Value{};
};

using ObjectToObjectMetricBase = ObjectToObjectMetricBaseTemplate<double>;
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkObjectToObjectMetricBase.hxx"
#endif
 
#endif