otbSharkRandomForestsMachineLearningModel.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 otbSharkRandomForestsMachineLearningModel_h
#define otbSharkRandomForestsMachineLearningModel_h
 
#include "itkLightObject.h"
#include "otbMachineLearningModel.h"
 
// Quiet a deprecation warning
#define BOOST_BIND_GLOBAL_PLACEHOLDERS
 
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic push
 
#if (defined (__GNUC__) && (__GNUC__ >= 9)) || (defined (__clang__) && (__clang_major__ >= 10))
#pragma GCC diagnostic ignored "-Wdeprecated-copy"
#endif
#pragma GCC diagnostic ignored "-Wshadow"
#pragma GCC diagnostic ignored "-Wunused-parameter"
#pragma GCC diagnostic ignored "-Woverloaded-virtual"
#pragma GCC diagnostic ignored "-Wignored-qualifiers"
#pragma GCC diagnostic ignored "-Wsign-compare"
#pragma GCC diagnostic ignored "-Wcast-align"
#pragma GCC diagnostic ignored "-Wunknown-pragmas"
#pragma GCC diagnostic ignored "-Wmissing-field-initializers"
#pragma GCC diagnostic ignored "-Wunused-local-typedefs"
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wheader-guard"
#pragma clang diagnostic ignored "-Wexpansion-to-defined"
#else
#pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
#endif
#endif
#include <shark/Models/Classifier.h>
#include "otb_shark.h"
#include "shark/Algorithms/Trainers/RFTrainer.h"
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic pop
#endif
 
 
namespace otb
{
template <class TInputValue, class TTargetValue>
class ITK_EXPORT SharkRandomForestsMachineLearningModel : public MachineLearningModel<TInputValue, TTargetValue>
{
public:
  typedef SharkRandomForestsMachineLearningModel          Self;
  typedef MachineLearningModel<TInputValue, TTargetValue> Superclass;
  typedef itk::SmartPointer<Self>                         Pointer;
  typedef itk::SmartPointer<const Self>                   ConstPointer;
 
  typedef typename Superclass::InputValueType           InputValueType;
  typedef typename Superclass::InputSampleType          InputSampleType;
  typedef typename Superclass::InputListSampleType      InputListSampleType;
  typedef typename Superclass::TargetValueType          TargetValueType;
  typedef typename Superclass::TargetSampleType         TargetSampleType;
  typedef typename Superclass::TargetListSampleType     TargetListSampleType;
  typedef typename Superclass::ConfidenceValueType      ConfidenceValueType;
  typedef typename Superclass::ConfidenceSampleType     ConfidenceSampleType;
  typedef typename Superclass::ConfidenceListSampleType ConfidenceListSampleType;
  typedef typename Superclass::ProbaSampleType          ProbaSampleType;
  typedef typename Superclass::ProbaListSampleType      ProbaListSampleType;
  itkNewMacro(Self);
  itkTypeMacro(SharkRandomForestsMachineLearningModel, MachineLearningModel);
 
  virtual void Train() override;
 
  virtual void Save(const std::string& filename, const std::string& name = "") override;
 
  virtual void Load(const std::string& filename, const std::string& name = "") override;
 
 
  virtual bool CanReadFile(const std::string&) override;
 
  virtual bool CanWriteFile(const std::string&) override;
 
  itkGetMacro(NumberOfTrees, unsigned int);
 
  itkSetMacro(NumberOfTrees, unsigned int);
 
  itkGetMacro(MTry, unsigned int);
 
  itkSetMacro(MTry, unsigned int);
 
  itkGetMacro(NodeSize, unsigned int);
 
  itkSetMacro(NodeSize, unsigned int);
 
  itkGetMacro(OobRatio, float);
 
  itkSetMacro(OobRatio, float);
 
  itkGetMacro(ComputeMargin, bool);
 
  itkSetMacro(ComputeMargin, bool);
 
  itkGetMacro(NormalizeClassLabels, bool);
  itkSetMacro(NormalizeClassLabels, bool);
 
protected:
  SharkRandomForestsMachineLearningModel();
 
  ~SharkRandomForestsMachineLearningModel() override = default;
 
  TargetSampleType DoPredict(const InputSampleType& input, ConfidenceValueType* quality = nullptr, ProbaSampleType* proba = nullptr) const override;
 
  void DoPredictBatch(const InputListSampleType*, const unsigned int& startIndex, const unsigned int& size, TargetListSampleType*,
                      ConfidenceListSampleType* = nullptr, ProbaListSampleType* = nullptr) const override;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  SharkRandomForestsMachineLearningModel(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  shark::RFClassifier<unsigned int> m_RFModel;
  shark::RFTrainer<unsigned int>    m_RFTrainer;
  std::vector<unsigned int>         m_ClassDictionary;
  bool                              m_NormalizeClassLabels;
 
  unsigned int m_NumberOfTrees;
  unsigned int m_MTry;
  unsigned int m_NodeSize;
  float        m_OobRatio;
  bool         m_ComputeMargin;
 
  ConfidenceValueType ComputeConfidence(shark::RealVector& probas, bool computeMargin) const;
};
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbSharkRandomForestsMachineLearningModel.hxx"
#endif
 
#endif