xmmTrainingSet.hpp

Go to the documentation of this file.

/*
 * xmmTrainingSet.hpp
 *
 * Multimodal Training Set
 *
 * Contact:
 * - Jules Francoise <jules.francoise@ircam.fr>
 *
 * This code has been initially authored by Jules Francoise
 * <http://julesfrancoise.com> during his PhD thesis, supervised by Frederic
 * Bevilacqua <href="http://frederic-bevilacqua.net>, in the Sound Music
 * Movement Interaction team <http://ismm.ircam.fr> of the
 * STMS Lab - IRCAM, CNRS, UPMC (2011-2015).
 *
 * Copyright (C) 2015 UPMC, Ircam-Centre Pompidou.
 *
 * This File is part of XMM.
 *
 * XMM 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 3 of the License, or
 * (at your option) any later version.
 *
 * XMM 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 XMM.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef xmmTrainingSet_h
#define xmmTrainingSet_h

#include "xmmPhrase.hpp"
#include <map>
#include <set>

namespace xmm {
class TrainingSet : public Writable {
  public:
    TrainingSet(MemoryMode memoryMode = MemoryMode::OwnMemory,
                Multimodality multimodality = Multimodality::Unimodal);

    TrainingSet(TrainingSet const& src);

    explicit TrainingSet(Json::Value const& root);

    TrainingSet& operator=(TrainingSet const& src);

    virtual ~TrainingSet();


    bool ownMemory() const;

    bool bimodal() const;



    bool empty() const;

    unsigned int size() const;

    std::map<int, std::shared_ptr<xmm::Phrase>>::iterator begin();

    std::map<int, std::shared_ptr<xmm::Phrase>>::iterator end();

    std::map<int, std::shared_ptr<xmm::Phrase>>::reverse_iterator rbegin();

    std::map<int, std::shared_ptr<xmm::Phrase>>::reverse_iterator rend();

    std::map<int, std::shared_ptr<xmm::Phrase>>::const_iterator cbegin() const;

    std::map<int, std::shared_ptr<xmm::Phrase>>::const_iterator cend() const;

    std::map<int, std::shared_ptr<xmm::Phrase>>::const_reverse_iterator
    crbegin() const;

    std::map<int, std::shared_ptr<xmm::Phrase>>::const_reverse_iterator crend()
        const;

    void addPhrase(int phraseIndex, std::string label = "");

    void addPhrase(int phraseIndex, Phrase const& phrase);

    void addPhrase(int phraseIndex, std::shared_ptr<Phrase> phrase);

    void removePhrase(int phraseIndex);

    void removePhrasesOfClass(std::string const& label);

    std::shared_ptr<xmm::Phrase> getPhrase(int phraseIndex) const;

    TrainingSet* getPhrasesOfClass(std::string const& label);

    void clear();

    const std::set<std::string>& labels() const { return labels_; }



    Json::Value toJson() const;

    void fromJson(Json::Value const& root);



    std::vector<float> mean() const;

    std::vector<float> standardDeviation() const;

    std::vector<std::pair<float, float>> minmax() const;

    void rescale(std::vector<float> offset, std::vector<float> gain);

    void normalize();


    Attribute<unsigned int> dimension;

    Attribute<unsigned int> dimension_input;

    Attribute<std::vector<std::string>> column_names;

  protected:
    void onPhraseEvent(PhraseEvent const& e);

    virtual void onAttributeChange(AttributeBase* attr_pointer);

    virtual void update();

    bool own_memory_;

    bool bimodal_;

    std::set<std::string> labels_;

    std::map<int, std::shared_ptr<Phrase>> phrases_;

    std::map<std::string, TrainingSet> sub_training_sets_;
};
}

#endif