MAWeakModel.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 "MAModel.hpp"

#include <string>

#include <boost/scoped_ptr.hpp>

class MAWeakModel;

namespace MA
{
typedef std::vector<ModelSPtr> OpenCVModelPtrList;

typedef boost::scoped_ptr<MAWeakModel> WeakModelSPtr;
}

class MAWeakModel
{
public:
  /*
   * @brief Class constructor
   *
   * @param classifier First classifier in the weak model
   *
   * Note: The ownership of the classifier is taken and destroyed along with this object.
   *
   */

  explicit MAWeakModel(MAModel& classifier);
  ~MAWeakModel();

  /*
   * @brief Get feature vector size
   *
   * @return Composite vector size of all classifiers
   *
   */

  unsigned int GetFeatureCount() const;

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

  MC::FloatList& GetModelLabels();

  /*
   * @brief Add an other classifier to the weak model
   *
   * @param classifier New classifier
   *
   * Note: The ownership of the classifier is taken and destroyed along with this object.
   *
   */

  void AddClassifier(MAModel& classifier);

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

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

  /*
   * @brief Predict one sample with multiple weak labels
   *
   * @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 Predict some samples with labels
   *
   * @param input_vectors Input samples for prediction
   *
   * @return Predicted weak labels for each vector
   *
   */

  MC::FloatTable Predict(const MC::FloatTable& input_vectors);

  /*
   * @brief Predict one sample with multiple weak labels
   *
   * @param input_vector One input sample for prediction
   *
   * @return Predicted weak labels
   *
   */

  MC::FloatList Predict(const MC::FloatList& input_vector);

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

  MCBinaryData* Encode() const;

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

  static MAWeakModel* Decode(const MCBinaryData& data);

private:
  MA::OpenCVModelPtrList Classifiers;
};