MAModel.hpp

/*
 *  This file is part of the AiBO+ project
 *
 *  Copyright (C) 2005-2016 Csaba Kertész (csaba.kertesz@gmail.com)
 *
 *  AiBO+ is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  AiBO+ is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.
 *
 */

#pragma once

#include "core/MACoreTypes.hpp"
#include "MAClassifier.hpp"

#include <boost/scoped_ptr.hpp>

#include <string>

class CvEmWrapper;
class CvStatModel;
class DlibWrapper;
class MAClassifier;
class MAModel;

namespace MA
{
typedef boost::shared_ptr<MAModel> ModelSPtr;
}

class MAModel
{
  friend class MAClassifier;

  /*
   * @brief Class constructor
   *
   * @param model_str XML string (OpenCV) or serialized (Dlib) representation of the classifier
   *
   */

  explicit MAModel(const std::string& model_str);

public:

  ~MAModel();

private:

  /*
   * @brief Decode an OpenCV classifier from XML format
   *
   * @param model_str XML string representation of the OpenCV classifier
   *
   * @return True if the operation is successful otherwise false.
   *
   */

  bool LoadFromOpenCVXmlFormat(const std::string& model_str);

  /*
   * @brief Decode a Dlib classifier from serialized format
   *
   * @param model_str Serialized representation of a Dlib classifier
   *
   * @return True if the operation is successful otherwise false.
   *
   */

  bool LoadFromDlibFormat(const std::string& model_str);

public:

  /*
   * @brief Get the size of the serialized string size
   *
   * @return The size of the serialized string size
   *
   */

  unsigned int GetSerializedStringSize() const;

  /*
   * @brief Get the feature count
   *
   * @return The feature count in a feature vector
   *
   */

  unsigned int GetFeatureCount() const;

  /*
   * @brief Get list of labels in the model
   *
   * @return Reference to the label list in the model
   *
   */

  MC::FloatList& GetModelLabels();

  /*
   * @brief Predict some samples with labels
   *
   * @param input_vectors Input samples for prediction
   * @param[out] confidences Confidence values for the predictions
   *
   * @return Predicted labels
   *
   */

  MC::FloatList Predict(const MC::FloatTable& input_vectors, MC::FloatList& confidences);

  /*
   * @brief Predict one sample with a label
   *
   * @param input_vector One input sample for prediction
   * @param[out] confidence Confidence value for the prediction
   *
   * @return Predicted label
   *
   */

  float Predict(const MC::FloatList& input_vector, MC::FloatList& confidence);

  /*
   * @brief Get the variable importances
   *
   * @return Variable importances for decision trees and random forest
   *
   */

  MC::FloatList GetVariableImportances();

  /*
   * @brief Encode the model into binary data
   *
   * @return Binary data
   *
   */

  MCBinaryData* Encode() const;

  /*
   * @brief Export the model into XML format
   *
   * @return Binary data
   *
   */

  MCBinaryData* ExportInRawFormat() const;

  /*
   * @brief Decode the model from binary data
   *
   * @param data Binary data
   *
   * @return Decoded model otherwise NULL.
   *
   */

  static MAModel* Decode(const MCBinaryData& data);

private:
  unsigned int SerializedStringSize;
  MC::FloatList Labels;
  boost::scoped_ptr<CvStatModel> Model;
  boost::scoped_ptr<CvEmWrapper> EmModel;
  boost::scoped_ptr<DlibWrapper> DlibFunctions;
  int FeatureCount;
  MA::FeaturePreprocessingType PreprocessingMode;
  MC::FloatTable PreprocessingCoefficients;
  MA::CRMethodType Classifier;
};