/*
 *  FeaturePlugin
 *
 *  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_FEATUREPLUGIN_H__
#define __CERT_FEATUREPLUGIN_H__

#include <string>
#include <vector>

#include "PluginBase.h"
#include "CERT_Config.h"

#include "OWFProcessor.h"

class ObjectWithFeatures;

namespace CERT
{

/** A base class for FeatureDetector plugins.
 * Each feature in the config file corresponds to an object of this class.
 * Examples: left eye, left eye nasal, left eye temporal, right eye, etc.
 * The objects themselves do little other than hold the paths to the data files that
 *   define the feature and gather the results after the FeatureDetector runs.
 * The MP_CERT object will use those paths to set up the FeatureDetector.
 * There are a couple of classes that inherit from FeaturePlugin that are more complex and
 *   often return empty paths to indicate that they don't represent normal features.
 *   E.g. FeatureImproverPlugin.
 */
class FeaturePlugin : public PluginBase
{
public:
    FeaturePlugin( ConfigItem *_config );
    virtual ~FeaturePlugin();

    virtual PluginBase *copy();

    virtual std::string getFeatureFile() const { return featureFile; } ///< Path to the feature data file.
    virtual std::string getGpriorFile() const { return gpriorFile; } ///< Path to the Gprior data file.

    virtual PluginResultsType resultsFromObject( ObjectWithFeatures *obj ); ///< Feature location results for this feature, pulled from the ObjectWithFeatures found by the FeatureDetector.

    virtual PluginResultsType getResultsForLabel( const std::string &label ) const;

    virtual std::string invalidResultsString() const;

    virtual mpt::OWF::ProcessorBase *getProcessor(); ///< Method used by some FeaturePlugin sub-classes. Used by the FeatureImproverPlugin to return a processor that improves feature locations. Most normal features will return NULL.

private:
    std::string featureFile;
    std::string gpriorFile;
};

} // end namespace CERT
#endif // __CERT_FEATUREPLUGIN_H__