/*
 *  GKRPlugin
 *
 *  Author: Andrew Salamon
 *
 *  Copyright (c) 2008 Machine Perception Laboratory
 *  University of California San Diego.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *    3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef __CERT_GKRPLUGIN_H__
#define __CERT_GKRPLUGIN_H__

#include <string>
#include <vector>
#include <map>
#include <iostream>

#include "PluginBase.h"
#include "AfterFacePlugin.h"
#include "rimage.h"

#include "simplematrix.hpp"
#include "GKR_Models.h"
//#include "GKR_Model.h"
//#include "GKR_Trainer.h"

namespace CERT
{

class ConfigItem;

/** The GKR plugin can do up to three post-processing steps on output from other plugins.
 * See GKR::Model and GKR::Models for more details of the three processing steps: GKR (spatial), logistic and CKF (temportal).
 * Although this plugin and the model classes all use the GKR name, CKF (Conditional Kalman Filter)
 * is a more accurate name and is used in all of the sample config files.
 */
class GKRPlugin : public AfterFacePlugin
{
public:
    GKRPlugin( ConfigItem *_config );
    virtual ~GKRPlugin();

    virtual PluginBase *copy();

    virtual std::vector<std::string> getLabels() const;

    virtual void processImageUsingCert( RImage<float> &image, MP_CERT &cert );
    virtual bool areResultsValid();
    virtual double getResultsDouble();
    virtual std::string invalidResultsString() const;
    virtual void outputResults();

private:

    bool training;
    std::string modelPath;
    std::vector< std::string > labels;
    GKR::Models models;

    /// Any combination of the GKR (spatial), logistic and temporal modes can be run
    bool temporal;
    bool GKR;
    bool logistic;
    std::string auid; ///< The id of the Plugin we should run GKR on. This is set in the config file.

    std::string nans;

    std::ostream & mout();

    bool floatFromString( const std::string &str, float &fl );
    bool setCKFValuesFromConfig();
};

} // end namespace CERT
#endif // __CERT_GKRPLUGIN_H__