xmmHmmParameters.hpp

Go to the documentation of this file.

/*
 * xmmHmmParameters.hpp
 *
 * Parameters of Hidden Markov Models
 *
 * 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 xmmHmmParameters_hpp
#define xmmHmmParameters_hpp

#include "../../core/distributions/xmmGaussianDistribution.hpp"
#include "../../core/model/xmmModelParameters.hpp"

namespace xmm {
class HMM {
  public:
    enum class TransitionMode {
        Ergodic = 0,

        LeftRight = 1
    };

    enum class RegressionEstimator {
        Full = 0,

        Windowed = 1,

        Likeliest = 2
    };
};

template <>
class ClassParameters<HMM> {
  public:
    ClassParameters();

    ClassParameters(ClassParameters const& src);

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

    ClassParameters& operator=(ClassParameters const& src);


    Json::Value toJson() const;

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


    bool changed = false;

    Attribute<unsigned int> states;

    Attribute<unsigned int> gaussians;

    Attribute<double> relative_regularization;

    Attribute<double> absolute_regularization;

    Attribute<GaussianDistribution::CovarianceMode> covariance_mode;

    Attribute<HMM::TransitionMode> transition_mode;

    Attribute<HMM::RegressionEstimator> regression_estimator;

    Attribute<bool> hierarchical;

  protected:
    virtual void onAttributeChange(AttributeBase* attr_pointer);
};

template <>
void checkLimits<HMM::TransitionMode>(HMM::TransitionMode const& value,
                                      HMM::TransitionMode const& limit_min,
                                      HMM::TransitionMode const& limit_max);

template <>
HMM::TransitionMode Attribute<HMM::TransitionMode>::defaultLimitMax();

template <>
void checkLimits<HMM::RegressionEstimator>(
    HMM::RegressionEstimator const& value,
    HMM::RegressionEstimator const& limit_min,
    HMM::RegressionEstimator const& limit_max);

template <>
HMM::RegressionEstimator Attribute<HMM::RegressionEstimator>::defaultLimitMax();
}

#endif