otbSharkKMeansMachineLearningModel.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2022 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 otbSharkKMeansMachineLearningModel_h
#define otbSharkKMeansMachineLearningModel_h
 
#include <memory>
 
#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 "-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 "otb_shark.h"
#include "shark/Models/Clustering/HardClusteringModel.h"
#include "shark/Models/Clustering/SoftClusteringModel.h"
#include "shark/Models/Clustering/Centroids.h"
#include "shark/Models/Clustering/ClusteringModel.h"
#include "shark/Algorithms/KMeans.h"
#include "shark/Models/Normalizer.h"
 
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic pop
#endif
 
namespace otb
{
template <class TInputValue, class TTargetValue>
class ITK_EXPORT SharkKMeansMachineLearningModel : public MachineLearningModel<TInputValue, TTargetValue>
{
public:
  typedef SharkKMeansMachineLearningModel                 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;
  typedef shark::HardClusteringModel<shark::RealVector> ClusteringModelType;
  typedef ClusteringModelType::OutputType               ClusteringOutputType;
 
  itkNewMacro(Self);
  itkTypeMacro(SharkKMeansMachineLearningModel, 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(MaximumNumberOfIterations, unsigned);
 
  itkSetMacro(MaximumNumberOfIterations, unsigned);
 
  itkGetMacro(K, unsigned);
 
  itkSetMacro(K, unsigned);
 
  void SetCentroidsFromData(const shark::Data<shark::RealVector>& data)
  {
    m_Centroids.setCentroids(data);
    this->Modified();
  }
 
  void ExportCentroids(const std::string& filename);
 
protected:
  SharkKMeansMachineLearningModel();
 
  virtual ~SharkKMeansMachineLearningModel();
 
  virtual TargetSampleType DoPredict(const InputSampleType& input, ConfidenceValueType* quality = nullptr, ProbaSampleType* proba = nullptr) const override;
 
  virtual 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:
  SharkKMeansMachineLearningModel(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  // Parameters set by the user
  unsigned int m_K;
  unsigned int m_MaximumNumberOfIterations;
  bool         m_CanRead;
 
  shark::Centroids m_Centroids;
 
  std::shared_ptr<ClusteringModelType> m_ClusteringModel;
};
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
 
#include "otbSharkKMeansMachineLearningModel.hxx"
 
#endif
 
#endif