SOM.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLMath/src/ICLMath/SOM.h                              **
** Module : ICLMath                                                **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/Range.h>
#include <ICLUtils/SmartPtr.h>
#include <vector>

namespace icl{
  namespace math{
  

    class ICLMath_API SOM{
      public:

      struct ICLMath_API Neuron{
        typedef utils::SmartPtr<float> vector_type;
        
        Neuron(){}

        Neuron(vector_type gridpos,vector_type prototype,unsigned int griddim, unsigned int datadim);
  
        vector_type gridpos;
        
        vector_type prototype;
  
        unsigned int griddim;
        
        unsigned int datadim;
        
        void *meta;
        
        inline bool isNull() const { return !!gridpos; }
      };
      

      SOM(unsigned int dataDim, const std::vector<unsigned int> &dims,
          const std::vector<utils::Range<float> > &prototypeBounds, 
          float epsilon=0.1, float sigma=1);
  
      ~SOM();
      
      void train(const float *input);
      
      const Neuron &getWinner(const float *input) const;
  
      Neuron &getWinner(const float *input);
      
      const std::vector<Neuron> &getNeurons() const; 
      
      std::vector<Neuron> &getNeurons();
      
      const Neuron &getNeuron(const std::vector<int> &dims) const;
  
      Neuron &getNeuron(const std::vector<int> &dims);
      
      unsigned int getDataDim() const { return m_uiDataDim; }
  
      unsigned int getSomDim() const { return m_uiSomDim; }
      
      const std::vector<unsigned int> getDimensions() const { return m_vecDimensions; }
  
      void setEpsilon(float epsilon);
      
      void setSigma(float sigma);
      
      protected:
      
      unsigned int m_uiDataDim;
      
      unsigned int m_uiSomDim;
      
      std::vector<unsigned int> m_vecDimensions;
      
      std::vector<utils::Range<float> > m_vecPrototypeBounds;
      
      std::vector<Neuron> m_vecNeurons;
      
      std::vector<unsigned int> m_vecDimOffsets;
      
      float m_fEpsilon; 
  
      float m_fSigma;   
    };
    
  
  } // namespace math
}