fuzzy_som.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Authors:     Alberto Pascual Montano (pascual@cnb.csic.es)
 *
 * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 * 02111-1307  USA
 *
 *  All comments concerning this program package may be sent to the
 *  e-mail address 'xmipp@cnb.csic.es'
 ***************************************************************************/

//-----------------------------------------------------------------------------
// FuzzySOM.hh
// Implements Smoothly Distributed Fuzzy c-means Self-Organizing Map
//-----------------------------------------------------------------------------

#ifndef XMIPPFUZZYSOM_H
#define XMIPPFUZZYSOM_H

#include "base_algorithm.h"
#include "map.h"

class FuzzySOM : public ClassificationAlgorithm<FuzzyMap>
{
public:

    FuzzySOM(double _m0, double _m1, unsigned long _annSteps,
                  double _reg, double _epsilon, unsigned long _nSteps)
            : ClassificationAlgorithm<FuzzyMap>(), m0(_m0), m1(_m1), annSteps(_annSteps),
            reg(_reg), epsilon(_epsilon), somNSteps(_nSteps)
    {};

    virtual ~FuzzySOM()
    {};

#ifdef UNUSED // detected as unused 29.6.2018

    void nSteps(const unsigned long& _nSteps);

    void initialFuzzyMembership(const double& _m0);


    void finalFuzzyMembership(const double& _m1);


    void setAnnSteps(const unsigned long& _annSteps);



    void regularization(const double& _reg);
#endif

    virtual void train(FuzzyMap& _som, const TS& _examples);

    virtual double test(const FuzzyMap& _som, const TS& _examples) const;

    virtual double functional(const TS& _examples, const FuzzyMap& _som, double _m, double _reg, double& _fidelity, double& _penalty);



private:
    double m0;                 // Initial Fuzzy Membership
    double m1;                 // Final Fuzzy Membership
    unsigned long annSteps;           // number of deterministic annealing steps
    double reg;                 // Regularization constant
    double epsilon;       // Stopping criterion Error < epsilon
    unsigned long somNSteps;           // number of steps

    virtual void train(FuzzyMap& _som, const TS& _examples) const
        {};

    double updateU(FuzzyMap& _som, const TS& _examples, const double& _m);

    // Update Fuzzy Code vectors
    void updateV(FuzzyMap& _som, const TS& _examples, const double& _m);

    // Local Average of the code vectors
    void LocalAve(FuzzyMap& _som, FeatureVector& tmpV, int tmpi, int tmpj);

    // Internal Scratch

    unsigned numNeurons;
    unsigned numVectors;
    unsigned dim;
    std::vector<double> tmpV;
    std::vector<double> tmpD;
    std::vector<double> tmpDens;
    std::vector < std::vector<double> > tmpMap;
#ifdef UNUSED // detected as unused 29.6.2018
    void showX(const TS& _ts);

    void showV(FuzzyMap& _som);

    void showU(FuzzyMap& _som, const TS& _ts);
#endif

};
#endif