ParticleClassifier.h

/*
GRT MIT License
Copyright (c) <2012> <Nicholas Gillian, Media Lab, MIT>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef GRT_PARTICLE_CLASSIFIER_HEADER
#define GRT_PARTICLE_CLASSIFIER_HEADER

#include "../../CoreModules/Classifier.h"
#include "ParticleClassifierParticleFilter.h"

GRT_BEGIN_NAMESPACE

class GRT_API ParticleClassifier : public Classifier
{
public:
    
    ParticleClassifier(const unsigned int numParticles = 2000,const Float sensorNoise = 20.0,const Float transitionSigma = 0.005,const Float phaseSigma = 0.1,const Float velocitySigma = 0.01);
    
    ParticleClassifier(const ParticleClassifier &rhs);
    
    virtual ~ParticleClassifier(void);
    
    ParticleClassifier& operator=(const ParticleClassifier &rhs);
    
    virtual bool deepCopyFrom(const Classifier *classifier);
    
    virtual bool train_(TimeSeriesClassificationData &trainingData);
    
    virtual bool predict_(VectorFloat &inputVector);
    
    virtual bool save( std::fstream &file ) const;
    
    virtual bool load( std::fstream &file );
    
    virtual bool clear();
    
    virtual bool reset();
    
    static std::string getId();

    const Vector< ParticleClassifierGestureTemplate >& getGestureTemplates() const;
    
    const ParticleClassifierParticleFilter& getParticleFilter() const;
    
    VectorFloat getStateEstimation() const;
    
    Float getPhase() const;
    
    Float getVelocity() const;
    
    bool setNumParticles(const unsigned int numParticles);
    
    bool setSensorNoise(const unsigned int sensorNoise);
    
    bool setTransitionSigma(const unsigned int transitionSigma);
    
    bool setPhaseSigma(const unsigned int phaseSigma);
    
    bool setVelocitySigma(const unsigned int velocitySigma);
    
    using MLBase::predict_;
    using MLBase::train_;
    
protected:
    unsigned int numParticles;
    Float sensorNoise;
    Float transitionSigma;
    Float phaseSigma;
    Float velocitySigma;
    ParticleClassifierParticleFilter particleFilter;
    
private:
    static const std::string id;
    static RegisterClassifierModule< ParticleClassifier > registerModule;
    
};

GRT_END_NAMESPACE

#endif