otbConfusionMatrixToMassOfBelief.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 otbConfusionMatrixToMassOfBelief_h
#define otbConfusionMatrixToMassOfBelief_h
 
// First make sure that the configuration is available.
// This line can be removed once the optimized versions
// gets integrated into the main directories.
#include "itkConfigure.h"
 
#include "itkProcessObject.h"
#include "otbConfusionMatrixMeasurements.h"
 
 
namespace otb
{
template <class TConfusionMatrix = itk::VariableSizeMatrix<double>, class TLabel = int>
class ITK_EXPORT ConfusionMatrixToMassOfBelief : public itk::ProcessObject
{
public:
  typedef ConfusionMatrixToMassOfBelief Self;
  typedef itk::ProcessObject            Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(ConfusionMatrixToMassOfBelief, itk::ProcessObject);
 
  itkNewMacro(Self);
 
 
  typedef TConfusionMatrix ConfusionMatrixType;
 
  typedef TLabel ClassLabelType;
 
  typedef otb::ConfusionMatrixMeasurements<ConfusionMatrixType, ClassLabelType> ConfusionMatrixMeasurementsType;
  typedef typename ConfusionMatrixMeasurementsType::MapOfClassesType MapOfClassesType;
  typedef typename ConfusionMatrixMeasurementsType::MapOfIndicesType MapOfIndicesType;
 
  typedef double MassType;
  typedef std::map<ClassLabelType, MassType> LabelMassMapType;
 
  enum MassOfBeliefDefinitionMethod
  {
    PRECISION,
    RECALL,
    ACCURACY,
    KAPPA
  };
 
  void Update() override;
 
  itkSetMacro(ConfusionMatrix, ConfusionMatrixType);
  itkSetMacro(DefinitionMethod, MassOfBeliefDefinitionMethod);
 
  /* Gives the correspondence between a class label
   * and its index in the confusion matrix
   */
  virtual void SetMapOfClasses(const MapOfClassesType _arg)
  {
    m_MapOfClasses = _arg;
    typename MapOfClassesType::iterator itMapOfClasses;
    m_MapOfIndices.clear();
    for (itMapOfClasses = m_MapOfClasses.begin(); itMapOfClasses != m_MapOfClasses.end(); ++itMapOfClasses)
    {
      m_MapOfIndices[itMapOfClasses->second] = itMapOfClasses->first;
    }
  }
 
  MapOfClassesType GetMapOfClasses() const
  {
    return m_MapOfClasses;
  }
 
  /* Gives the correspondence between an index in the
   * confusion matrix and the class label
   */
  virtual void SetMapOfIndices(const MapOfIndicesType _arg)
  {
    m_MapOfIndices = _arg;
    typename MapOfIndicesType::iterator itMapOfIndices;
    m_MapOfClasses.clear();
    for (itMapOfIndices = m_MapOfIndices.begin(); itMapOfIndices != m_MapOfIndices.end(); ++itMapOfIndices)
    {
      m_MapOfClasses[itMapOfIndices->second] = itMapOfIndices->first;
    }
  }
 
  MapOfIndicesType GetMapOfIndices() const
  {
    return m_MapOfIndices;
  }
 
 
  LabelMassMapType GetMapMassOfBelief() const
  {
    return m_MapMassOfBelief;
  }
 
 
protected:
  ConfusionMatrixToMassOfBelief();
 
  ~ConfusionMatrixToMassOfBelief() override{};
 
  void GenerateData(void) override;
 
private:
  ConfusionMatrixToMassOfBelief(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  ConfusionMatrixType                               m_ConfusionMatrix;
  typename ConfusionMatrixMeasurementsType::Pointer m_ConfMatMeasurements;
 
  MapOfClassesType m_MapOfClasses;
  MapOfIndicesType m_MapOfIndices;
 
  MassOfBeliefDefinitionMethod m_DefinitionMethod;
  LabelMassMapType             m_MapMassOfBelief;
};
 
} // end namespace otb
 
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbConfusionMatrixToMassOfBelief.hxx"
#endif
 
#endif