itkObjectToObjectMultiMetricv4.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 itkObjectToObjectMultiMetricv4_h
#define itkObjectToObjectMultiMetricv4_h
 
#include "itkObjectToObjectMetric.h"
#include "itkArray.h"
#include <deque>
 
namespace itk
{
template <unsigned int TFixedDimension,
          unsigned int TMovingDimension,
          typename TVirtualImage = Image<double, TFixedDimension>,
          class TInternalComputationValueType = double>
class ITK_TEMPLATE_EXPORT ObjectToObjectMultiMetricv4
  : public ObjectToObjectMetric<TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ObjectToObjectMultiMetricv4);

  using Self = ObjectToObjectMultiMetricv4;
  using Superclass =
    ObjectToObjectMetric<TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ObjectToObjectMultiMetricv4);

  itkNewMacro(Self);

  using typename Superclass::MeasureType;
  using typename Superclass::DerivativeType;
  using typename Superclass::DerivativeValueType;
  using typename Superclass::ParametersType;
  using typename Superclass::ParametersValueType;
  using typename Superclass::NumberOfParametersType;
  using typename Superclass::CoordinateRepresentationType;
  using typename Superclass::MovingTransformType;
  using typename Superclass::FixedTransformType;

  using MetricType = Superclass;
  using MetricBasePointer = typename MetricType::Pointer;
  using MetricBaseConstPointer = typename MetricType::ConstPointer;
  using MetricQueueType = std::deque<MetricBasePointer>;
 
  using ObjectType = typename Superclass::ObjectType;
 
  using WeightValueType = typename DerivativeType::ValueType;
  using WeightsArrayType = Array<WeightValueType>;
  using MetricValueArrayType = Array<MeasureType>;
 
  itkSetMacro(MetricWeights, WeightsArrayType);
  itkGetMacro(MetricWeights, WeightsArrayType);

  void
  AddMetric(MetricType * metric);

  void
  ClearMetricQueue();

  SizeValueType
  GetNumberOfMetrics() const;
 
  void
  Initialize() override;

  void
  SetFixedObject(const ObjectType * itkNotUsed(object)) override
  {
    itkExceptionMacro("A single object should not be specified for the multi metric.");
  }

  void
  SetMovingObject(const ObjectType * itkNotUsed(object)) override
  {
    itkExceptionMacro("A single object should not be specified for the multi metric.");
  }

  void
  SetMovingTransform(MovingTransformType *) override;

  void
  SetFixedTransform(FixedTransformType *) override;

  MeasureType
  GetValue() const override;
 
  void
  GetDerivative(DerivativeType &) const override;

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

  MetricValueArrayType
  GetValueArray() const;

  MeasureType
  GetWeightedValue() const;

  const MetricQueueType &
  GetMetricQueue() const;
 
  bool
  SupportsArbitraryVirtualDomainSamples() const override;
 
  using typename Superclass::MetricCategoryType;

  MetricCategoryType
  GetMetricCategory() const override
  {
    return MetricCategoryType::MULTI_METRIC;
  }
 
protected:
  ObjectToObjectMultiMetricv4();
  ~ObjectToObjectMultiMetricv4() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  MetricQueueType              m_MetricQueue{};
  WeightsArrayType             m_MetricWeights{};
  mutable MetricValueArrayType m_MetricValueArray{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkObjectToObjectMultiMetricv4.hxx"
#endif
 
#endif