#include <map.h>

Inheritance diagram for ClassificationMap:

Collaboration diagram for ClassificationMap:

Public Member Functions
	ClassificationMap (const ClassificationMap &op1)

	ClassificationMap (const std::string &_layout, unsigned _width, const unsigned &_height, const unsigned &_size)

	ClassificationMap (const std::string &_layout, unsigned _width, const unsigned &_height, const unsigned &_size, const double &_lower, const double &_upper)

	ClassificationMap (const std::string &_layout, unsigned _width, const unsigned &_height, const ClassicTrainingVectors &_ts, const bool _use_rand_cvs=false)

	ClassificationMap (std::istream &_is, bool _cv=true)

virtual	~ClassificationMap ()

virtual void	add (const FeatureVector &_v, const Label &_l=Label())

const std::string &	layout () const

std::vector< unsigned >	neighborhood (const SomPos &_center, double _radius) const

double	neighDist (const SomPos &_center, const SomPos &_v) const

unsigned	width () const

unsigned	height () const

const SomIn &	itemAtPos (const SomPos &_pos) const

const Label &	targetAtPos (const SomPos &_pos) const

void	clear ()

SomPos	indexToPos (const unsigned &_i) const

unsigned	PosToIndex (const SomPos &_pos) const

SomPos	codVecPos (SomIn &_v)

ClassificationMap &	operator= (const ClassificationMap &op1)

virtual void	printSelf (std::ostream &_os) const

virtual void	readSelf (std::istream &_is)

virtual void	saveObject (std::ostream &_os) const

virtual void	loadObject (std::istream &_is)

virtual const Layout &	getLayout () const

Public Member Functions inherited from CodeBook
	CodeBook (const bool &_calib=false)

	CodeBook (unsigned _n, unsigned _size, bool _cal=false)

	CodeBook (unsigned _n, unsigned _size, floatFeature _lower=0, floatFeature _upper=1, bool _cal=false)

	CodeBook (unsigned _n, const ClassicTrainingVectors &_ts, const bool _use_rand_cvs)

	CodeBook (std::istream &_is)

virtual	~CodeBook ()

virtual FeatureVector &	test (const FeatureVector &_in) const

virtual unsigned	testIndex (const FeatureVector &_in) const

virtual void	classify (const ClassicTrainingVectors *_ts)

virtual const std::vector< unsigned > &	classifAt (const unsigned &_index) const

virtual unsigned	classifSizeAt (const unsigned &_index) const

virtual Label	apply (const FeatureVector &_in) const

virtual void	calibrate (ClassicTrainingVectors &_ts, Label _def="")

virtual unsigned	output (const FeatureVector &_in) const

virtual void	readSelf (std::istream &_is, long _dim=-1, long _size=-1)

virtual void	Normalize (const std::vector< ClassicTrainingVectors::statsStruct > &_varStats)

virtual void	unNormalize (const std::vector< ClassicTrainingVectors::statsStruct > &_varStats)

virtual void	printHistogram (std::ostream &_os) const

virtual void	printQuantError (std::ostream &_os) const

Public Member Functions inherited from ClassificationDataSet< FeatureVector, Label >
	ClassificationDataSet ()

virtual	~ClassificationDataSet ()

Public Member Functions inherited from ClassificationTrainingSet< FeatureVector, Label >
	ClassificationTrainingSet (const bool &_calib=true, unsigned _n=0)

	ClassificationTrainingSet (std::istream &_is)

virtual	~ClassificationTrainingSet ()

void	setSplit (float _tp, float _vp)

splitIt	beginSubset (unsigned _um)

splitIt	endSubset (unsigned _um)
	Returns an iterator to the end of the subset. More...

virtual void	add (const FeatureVector &_i)

virtual bool	remove (unsigned int _idx)

size_t	size () const

const Label &	targetAt (unsigned _i) const

Label &	targetAt (unsigned _i)

const FeatureVector &	itemAt (unsigned _i) const

FeatureVector &	itemAt (unsigned _i)

bool	calibrated () const

void	calibrated (const bool &_calib)

void	clear ()

unsigned	numTargets () const

virtual bool	swapItems (unsigned _i, unsigned _j)

Protected Attributes
const Layout *	somLayout

unsigned	somWidth

unsigned	somHeight

Protected Attributes inherited from ClassificationTrainingSet< FeatureVector, Label >
bool	isCalibrated

splitTS	splitTrainingSet

unsigned	nTargets

Friends
std::ostream &	operator<< (std::ostream &_os, const ClassificationMap &_som)

std::istream &	operator>> (std::istream &_is, ClassificationMap &_som)

Additional Inherited Members
Public Types inherited from ClassificationDataSet< FeatureVector, Label >
typedef FeatureVector	In
	Class of input vectors. Usually a FeatureVector (vector of Feature) More...

typedef Label	Out
	Class of the target. Can be a double, string, unsigned, even a vector ... More...

typedef ClassificationTrainingSet< In, Out >	TS
	Training set. Set of vectors (training vectors), probably classified. More...

Public Types inherited from ClassificationTrainingSet< FeatureVector, Label >
enum	splitMode
	Ways the training set can be used. More...

enum	useMode
	use of samples More...

typedef std::multimap< unsigned, unsigned, std::less< unsigned > >	splitTS
	Training sets mode. More...

typedef splitTS::iterator	splitIt
	iterator More...

Public Attributes inherited from CodeBook
std::vector< std::vector< unsigned > >	classifVectors

std::vector< double >	aveDistances

Public Attributes inherited from ClassificationTrainingSet< FeatureVector, Label >
std::vector< FeatureVector >	theItems

std::vector< Label >	theTargets

Protected Member Functions inherited from CodeBook
void	readClassifVectors (std::istream &_is)

void	writeClassifVectors (std::ostream &_os) const

Protected Member Functions inherited from ClassificationTrainingSet< FeatureVector, Label >
void	computeNumTargets ()

void	checkCalibrated (std::istream &_is)

void	readItems (std::istream &_is)

void	writeCalibrated (std::ostream &_os) const

void	writeItems (std::ostream &_os, bool _delim=false) const

void	skipComments (std::istream &_is) const

std::vector< FeatureVector >::const_iterator	itemsBegin () const

std::vector< FeatureVector >::const_iterator	itemsEnd () const

std::vector< Label >::const_iterator	targetsBegin () const

std::vector< Label >::const_iterator	targetsEnd () const

Detailed Description

This class implements a Map of the type used by Kohonen Algorithms

Definition at line 57 of file map.h.

Constructor & Destructor Documentation

◆ ClassificationMap() [1/5]

ClassificationMap::ClassificationMap ( const ClassificationMap & other )

explicit

Constructs an empty SOM

Constructs a SOM from other SOM Parameter: other other SOM

Definition at line 64 of file map.cpp.

                                                                    : CodeBook() {
     *this = other;
  }

◆ ClassificationMap() [2/5]

ClassificationMap::ClassificationMap	(	const std::string &	_layout,
		unsigned	_width,
		const unsigned &	_height,
		const unsigned &	_size
	)

Constructs a SOM with initial code vectors filled with zero. Parameter: _layout Type of layout Parameter: _width Width of the output plane Parameter: _height Height of the output plane Parameter: _size Size of code vectors

Definition at line 43 of file map.cpp.

         : CodeBook(_width*_height, _size, false), somWidth(_width), somHeight(_height)
 {
     if (_layout == "HEXA")
     {
         auto *tmpLayout = new HEXALayout();
         somLayout = tmpLayout;
     }
     else
     {
         auto *tmpLayout = new RECTLayout();
         somLayout = tmpLayout;
     }
 }

◆ ClassificationMap() [3/5]

ClassificationMap::ClassificationMap	(	const std::string &	_layout,
		unsigned	_width,
		const unsigned &	_height,
		const unsigned &	_size,
		const double &	_lower,
		const double &	_upper
	)

Constructs a SOM with random initial code vectors Parameter: _layout Type of layout Parameter: _width Width of the output plane Parameter: _height Height of the output plane Parameter: _size Size of code vectors Parameter: _lower Lower value for random elements Parameter: _upper Upper value for random elements

Definition at line 78 of file map.cpp.

         : CodeBook(_width*_height, _size, _lower, _upper, false), somWidth(_width), somHeight(_height)
 {
     if (_layout == "HEXA")
     {
         auto *tmpLayout = new HEXALayout();
         somLayout = tmpLayout;
     }
     else
     {
         auto *tmpLayout = new RECTLayout();
         somLayout = tmpLayout;
     }
 }

◆ ClassificationMap() [4/5]

ClassificationMap::ClassificationMap	(	const std::string &	_layout,
		unsigned	_width,
		const unsigned &	_height,
		const ClassicTrainingVectors &	_ts,
		const bool	_use_rand_cvs = `false`
	)

Constructs a SOM with initial code vectors taken randomly from the training file. Parameter: _layout Type of layout Parameter: _width Width of the output plane Parameter: _height Height of the output plane Parameter: _ts Training set; will be used to get initial values Parameter: _use_rand_cvs Use random code vector values

Constructs a SOM with initial code vectors taken randomly from the training file. Parameter: _layout Type of layout Parameter: _width Width of the output plane Parameter: _height Height of the output plane Parameter: _ts Training set; will be used to get initial values Parameter: _use_rand_cvs Use random code vector pixel values

Definition at line 109 of file map.cpp.

         : CodeBook(_width*_height, _ts, _use_rand_cvs),
         somWidth(_width), somHeight(_height)
 {
     if (_layout == "HEXA")
     {
         auto *tmpLayout = new HEXALayout();
         somLayout = tmpLayout;
     }
     else
     {
         auto *tmpLayout = new RECTLayout();
         somLayout = tmpLayout;
     }
 }

◆ ClassificationMap() [5/5]

ClassificationMap::ClassificationMap	(	std::istream &	_is,
		bool	_cv = `true`
	)

Construct a SOM from the code vectors in a stream Parameter: _is The stream Parameter: _cv If the stream holds a codevector file or a whole codebook file

Exceptions

runtime_error If there are problems with the stream

Construct a SOM from the code vectors in a stream Parameter: _is The stream

Exceptions

runtime_error If there are problems with the stream

Definition at line 134 of file map.cpp.

                                                               : CodeBook(false)
 {
     somLayout = NULL;
     if (_cv)
         readSelf(_is);
     else
         loadObject(_is);
 }

◆ ~ClassificationMap()

virtual ClassificationMap::~ClassificationMap ( )

inlinevirtual

Virtual destructor is needed

Definition at line 118 of file map.h.

119 {};

Member Function Documentation

◆ add()

void ClassificationMap::add	(	const FeatureVector &	_v,
		const Label &	_l = `Label()`
	)

virtual

This method throws an exception if called. There is no sense in adding vectors to a som

Exceptions

range_error If this method is called

Reimplemented from ClassificationTrainingSet< FeatureVector, Label >.

Definition at line 149 of file map.cpp.

 {
     throw std::runtime_error("You can't add vectors to a S.O.M.");
 }

◆ clear()

void ClassificationMap::clear ( )

Clears the Som

Definition at line 291 of file map.cpp.

 {
     CodeBook::clear();
     somLayout = NULL;
     if (somLayout)
         delete somLayout;
     somWidth = 0;
     somHeight = 0;
 }

◆ codVecPos()

SomPos ClassificationMap::codVecPos ( SomIn & _v )

Returns the position in the som of a code vector Parameter: _v Reference to the code vector

Definition at line 341 of file map.cpp.

 {
     return indexToPos(&_v - &(itemAt(0)));
 }

◆ getLayout()

virtual const Layout& ClassificationMap::getLayout ( ) const

inlinevirtual

Const Reference to the Map Layout

Definition at line 286 of file map.h.

     {
         return (Layout&) *somLayout;
     };

◆ height()

unsigned ClassificationMap::height ( ) const

Returns the height of the SOM

Definition at line 194 of file map.cpp.

 {
     return somHeight;
 }

◆ indexToPos()

SomPos ClassificationMap::indexToPos ( const unsigned & _i ) const

Return the position associated to an index Parameter: _i Index of the code vector

Exceptions

out_of _range If _i is out of range

Definition at line 306 of file map.cpp.

 {
     if (_i >= somWidth * somHeight)
     {
         std::ostringstream msg;
         msg << "Out of range. No item at position " << _i;
 
         throw std::out_of_range(msg.str());
     }
 
     return SomPos(_i % somWidth, _i / somWidth);
 }

◆ itemAtPos()

const SomIn & ClassificationMap::itemAtPos ( const SomPos & _pos ) const

Returns a const reference to a code vector given its position Parameter: _pos The position of the code vector

Exceptions

out_of _range If _pos is out of range

Definition at line 224 of file map.cpp.

 {
     if (_pos.first >= (signed)somWidth || _pos.second >= (signed)somHeight)
     {
         std::ostringstream msg;
         msg << "Out of range. No item at position (" << _pos.first << ", " << _pos.second << ")";
         throw std::out_of_range(msg.str());
     }
 
     return itemAt((somWidth * _pos.second) + _pos.first);
 }

◆ layout()

const std::string & ClassificationMap::layout ( ) const

Returns the id of layout that som has

Definition at line 157 of file map.cpp.

 {
     return somLayout->id();
 }

◆ loadObject()

void ClassificationMap::loadObject ( std::istream & _is )

virtual

Loads the ClassificationMap class from a stream. this method can be used to load the status of the class. Parameter: _is The output stream

Reimplemented from CodeBook.

Definition at line 451 of file map.cpp.

 {
     clear();
     std::string layout;
     _is >> layout;
     if (layout == "HEXA")
     {
         auto *tmpLayout = new HEXALayout();
         somLayout = tmpLayout;
     }
     else
     {
         auto *tmpLayout = new RECTLayout();
         somLayout = tmpLayout;
     }
     _is >> somWidth;
     _is >> somHeight;
     readClassifVectors(_is);
     ClassificationTrainingSet<FeatureVector, Label>::loadObject(_is);
 }

◆ neighborhood()

std::vector< unsigned > ClassificationMap::neighborhood	(	const SomPos &	_center,
		double	_radius
	)		const

Returns the neighborhood of a neuron Parameter: _center Reference to the center of neighborhood Parameter: _radius Radius of neighbohood

Definition at line 167 of file map.cpp.

 {
     return somLayout->neighborhood(this, _center, _radius);
 }

◆ neighDist()

double ClassificationMap::neighDist	(	const SomPos &	_center,
		const SomPos &	_v
	)		const

Returns the distance between two neurons according to the Layout Parameter: _center Reference to the center of neighborhood Parameter: _v Position of the code vector

Definition at line 177 of file map.cpp.

 {
     return somLayout->dist(_center, _v);
 }

◆ operator=()

ClassificationMap & ClassificationMap::operator= ( const ClassificationMap & op1 )

Operator "=" Parameter: op1 ClassificationMap

Definition at line 363 of file map.cpp.

 {
     std::stringstream _str;
     op1.printSelf(_str);
     readSelf(_str);
     return *this;
 }

◆ PosToIndex()

unsigned ClassificationMap::PosToIndex ( const SomPos & _pos ) const

Return the index associated to a position Parameter: _pos Position of the code vector

Exceptions

out_of _range If _i is out of range

Definition at line 324 of file map.cpp.

 {
     if (_pos.first >= (signed)somWidth || _pos.second >= (signed)somHeight)
     {
         std::ostringstream msg;
         msg << "Out of range. No item at position (" << _pos.first << ", " << _pos.second << ")";
         throw std::out_of_range(msg.str());
     }
 
     return (unsigned)((somWidth * _pos.second) + _pos.first);
 }

◆ printSelf()

void ClassificationMap::printSelf ( std::ostream & _os ) const

virtual

Standard output for a map Parameter: _os The output stream

Standard output for a SOM Parameter: _os The output stream

Reimplemented from CodeBook.

Definition at line 375 of file map.cpp.

 {
     _os << itemAt(0).size() << " " <<
     somLayout->id() << " " << somWidth << " " << somHeight << " gaussian" << std::endl;
     writeItems(_os);
 }

◆ readSelf()

void ClassificationMap::readSelf ( std::istream & _is )

virtual

Standard input for a map Parameter: _is The input stream

Standard input for a SOM Parameter: _is The input stream

Reimplemented from ClassificationTrainingSet< FeatureVector, Label >.

Definition at line 386 of file map.cpp.

 {
     clear();
     int dim;
     std::string layout;
     std::string str;
     _is >> dim;
     _is >> layout;
     toLower(layout);
 
     if (layout == "hexa")
     {
         auto *tmpLayout = new HEXALayout();
         somLayout = tmpLayout;
     }
     else
     {
         auto *tmpLayout = new RECTLayout();
         somLayout = tmpLayout;
     }
     _is >> somWidth;
     _is >> somHeight;
     /* IT DOESN'T WORK PROPERLY
     str = integerToString(dim);
     str += " ";
     str += integerToString(somWidth*somHeight);
     str += " ";
     for (int i = str.size() - 1; i >= 0; i--)
     if (_is) _is.putback((char) str[i]);
     */
     CodeBook::readSelf(_is, dim, somWidth*somHeight);
 
     /*  IT DOESN'T WORK PROPERLY
 
          _is >> somWidth;
          _is >> somHeight;
 
        char aux[128];
          strstream ostr(aux,sizeof(aux));
          ostr << dim << " " << (somWidth*somHeight) << " " <<
             somWidth << " " << somHeight << std::endl;
          while (_is.good())
             ostr.put (_is.get());
          CodeBook::readSelf(ostr);*/
 }

◆ saveObject()

void ClassificationMap::saveObject ( std::ostream & _os ) const

virtual

Saves the ClassificationMap class into a stream. this method can be used to save the status of the class. Parameter: _os The output stream

Reimplemented from CodeBook.

Definition at line 438 of file map.cpp.

 {
     _os << somLayout->id() << " " << somWidth << " " << somHeight << std::endl;
     writeClassifVectors(_os);
     ClassificationTrainingSet<FeatureVector, Label>::saveObject(_os);
 }

◆ targetAtPos()

const Label & ClassificationMap::targetAtPos ( const SomPos & _pos ) const

Returns a const target of a code vector given its position Parameter: _pos The position of the code vector

Definition at line 266 of file map.cpp.

 {
     if (!calibrated())
     {
         std::ostringstream msg;
         msg << "The S.O.M. is not calibrated. No target at position ("
         << _pos.first << ", " << _pos.second << ")";
         throw std::out_of_range(msg.str());
     }
     if (_pos.first >= (signed)somWidth || _pos.second >= (signed)somHeight)
     {
         std::ostringstream msg;
         msg << "Out of range. No target at position (" << _pos.first << ", "
         << _pos.second << ")";
         throw std::out_of_range(msg.str());
     }
 
     return targetAt((somWidth * _pos.second) + _pos.first);
 }

◆ width()

unsigned ClassificationMap::width ( ) const

Returns the width of the SOM

Definition at line 186 of file map.cpp.

 {
     return somWidth;
 }

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	_os,
		const ClassificationMap &	_som
	)

friend

Definition at line 230 of file map.h.

     {
         _som.printSelf(_os);
         return _os;
     };

◆ operator>>

std::istream& operator>>	(	std::istream &	_is,
		ClassificationMap &	_som
	)

friend

Definition at line 242 of file map.h.

     {
         _som.readSelf(_is);
         return _is;
     };

Member Data Documentation

◆ somHeight

unsigned ClassificationMap::somHeight

protected

Definition at line 296 of file map.h.

◆ somLayout

const Layout* ClassificationMap::somLayout

protected

Definition at line 289 of file map.h.

◆ somWidth

unsigned ClassificationMap::somWidth

protected

Definition at line 295 of file map.h.

The documentation for this class was generated from the following files:

xmipp/libraries/classification/map.h
xmipp/libraries/classification/map.cpp

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClassificationMap() [1/5]

◆ ClassificationMap() [2/5]

◆ ClassificationMap() [3/5]

◆ ClassificationMap() [4/5]

◆ ClassificationMap() [5/5]

◆ ~ClassificationMap()

Member Function Documentation

◆ add()

◆ clear()

◆ codVecPos()

◆ getLayout()

◆ height()

◆ indexToPos()

◆ itemAtPos()

◆ layout()

◆ loadObject()

◆ neighborhood()

◆ neighDist()

◆ operator=()

◆ PosToIndex()

◆ printSelf()

◆ readSelf()

◆ saveObject()

◆ targetAtPos()

◆ width()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ somHeight

◆ somLayout

◆ somWidth