at.tuwien.ifs.somtoolbox.input

Class SOMLibFormatInputReader

java.lang.Object

at.tuwien.ifs.somtoolbox.input.AbstractSOMInputReader

at.tuwien.ifs.somtoolbox.input.SOMLibFormatInputReader

All Implemented Interfaces:

SOMInputReader

Direct Known Subclasses:

MnemonicSOMLibFormatInputReader

public class SOMLibFormatInputReader
extends AbstractSOMInputReader

Provides the functionality to read a saved network model in SOMLib format.

Version:

$Id: SOMLibFormatInputReader.java 4059 2011-02-03 10:31:34Z mayer $

Author:

Michael Dittenbach, Rudolf Mayer

Nested Class Summary

Nested classes/interfaces inherited from class at.tuwien.ifs.somtoolbox.input.AbstractSOMInputReader

AbstractSOMInputReader.UnitInformation

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	mapDescriptionFileName
static java.lang.String	mapFileNameSuffix The suffix of the map description files
private java.lang.String	unitDescriptionFileName
static java.lang.String	unitFileNameSuffix The suffix of the unit description files
static java.lang.String	weightFileNameSuffix The suffix of the weight vector files
private java.lang.String	weightVectorFileName

Fields inherited from class at.tuwien.ifs.somtoolbox.input.AbstractSOMInputReader

allVectorNames, commonLabelPrefix, contentType, dim, gridLayout, gridTopology, labelled, metricName, unitInfo, xSize, ySize, zSize

Fields inherited from interface at.tuwien.ifs.somtoolbox.input.SOMInputReader

MAP_FILE, UNIT_FILE, WEIGHT_VECTOR

Constructor Summary

Constructors

Constructor and Description
SOMLibFormatInputReader(java.lang.String weightVectorFileName, java.lang.String unitDescriptionFileName, java.lang.String mapDescriptionFileName) Sole constructor taking the name of the weight vector file, the unit description file and the map description file as arguments.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFilePath() Returns the name of the path where the files are located.
static java.lang.String	getFormatName()
java.lang.String	getMapDescriptionFileName() Returns the name of the map description file, or null if not loaded.
java.lang.String	getUnitDescriptionFileName() Returns the name of the unit description file, or null if not loaded.
java.lang.String	getWeightVectorFileName() Returns the name of the weight vector file, or null if not loaded.
protected void	processUnitElement(java.lang.String line, int k, int j, int i)
protected void	readMapDescriptionFile(java.lang.String fileName) Reads a SOMLib map description file with the given name.
protected void	readUnitDescriptionFile(java.lang.String fileName) Reads a SOMLib unit description file with the given name.
private void	readWeightVectorFile(java.lang.String fileName) Reads a SOMLib weight vector file with the given name.

Methods inherited from class at.tuwien.ifs.somtoolbox.input.AbstractSOMInputReader

getBestContextUnitLabels, getBestContextUnitLabels, getCommonVectorLabelPrefix, getContentType, getContextGateUnitLabels, getContextGateUnitLabels, getDim, getGridLayout, getGridTopology, getKaskiGateUnitLabels, getKaskiGateUnitLabels, getKaskiGateUnitLabelsWgt, getKaskiGateUnitLabelsWgt, getKaskiUnitLabels, getKaskiUnitLabels, getKaskiUnitLabelsWgt, getKaskiUnitLabelsWgt, getMappedVecs, getMappedVecs, getMappedVecsDist, getMappedVecsDist, getMetricName, getNrBestContext, getNrBestContext, getNrContextGateLabels, getNrContextGateLabels, getNrGateWeights, getNrGateWeights, getNrKaskiGateLabels, getNrKaskiGateLabels, getNrKaskiLabels, getNrKaskiLabels, getNrKaskiWeights, getNrKaskiWeights, getNrSomsMapped, getNrSomsMapped, getNrUnitLabels, getNrUnitLabels, getNrVecMapped, getNrVecMapped, getQuantErrorUnit, getQuantErrorUnit, getQuantErrorUnitAvg, getQuantErrorUnitAvg, getUnitLabels, getUnitLabels, getUnitLabelsQe, getUnitLabelsQe, getUnitLabelsWgt, getUnitLabelsWgt, getUrlMappedSoms, getUrlMappedSoms, getVectors, getXSize, getYSize, getZSize, initUnitInformation, isLabelled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mapFileNameSuffix

public static final java.lang.String mapFileNameSuffix

The suffix of the map description files

See Also:

Constant Field Values

weightFileNameSuffix

public static final java.lang.String weightFileNameSuffix

The suffix of the weight vector files

See Also:

Constant Field Values

unitFileNameSuffix

public static final java.lang.String unitFileNameSuffix

The suffix of the unit description files

See Also:

Constant Field Values

mapDescriptionFileName

private java.lang.String mapDescriptionFileName

unitDescriptionFileName

private java.lang.String unitDescriptionFileName

weightVectorFileName

private java.lang.String weightVectorFileName

Constructor Detail

SOMLibFormatInputReader

public SOMLibFormatInputReader(java.lang.String weightVectorFileName,
                               java.lang.String unitDescriptionFileName,
                               java.lang.String mapDescriptionFileName)
                        throws java.io.FileNotFoundException,
                               SOMLibFileFormatException

Sole constructor taking the name of the weight vector file, the unit description file and the map description file as arguments.

Parameters:

weightVectorFileName - the name of the weight vector file.

unitDescriptionFileName - the name of the unit description file.

mapDescriptionFileName - the name of the map description file.

Throws:

java.io.FileNotFoundException - if one of the files with the given name is not found.

SOMLibFileFormatException - if the format of one of the file is corrupt.

Method Detail

getFilePath

public java.lang.String getFilePath()

Description copied from interface: SOMInputReader

Returns the name of the path where the files are located.

Returns:

the name of the path where the files are located.

See Also:

SOMInputReader.getFilePath()

getMapDescriptionFileName

public java.lang.String getMapDescriptionFileName()

Description copied from interface: SOMInputReader

Returns the name of the map description file, or null if not loaded.

Returns:

the name of the map description file, or null if not loaded.

getUnitDescriptionFileName

public java.lang.String getUnitDescriptionFileName()

Description copied from interface: SOMInputReader

Returns the name of the unit description file, or null if not loaded.

Returns:

the name of the unit description file, or null if not loaded.

getWeightVectorFileName

public java.lang.String getWeightVectorFileName()

Description copied from interface: SOMInputReader

Returns the name of the weight vector file, or null if not loaded.

Returns:

the name of the weight vector file, or null if not loaded.

readMapDescriptionFile

protected void readMapDescriptionFile(java.lang.String fileName)
                               throws java.io.FileNotFoundException,
                                      SOMLibFileFormatException

Reads a SOMLib map description file with the given name.

Parameters:

fileName - the name of the file to open.

Throws:

java.io.FileNotFoundException

SOMLibFileFormatException

readUnitDescriptionFile

protected void readUnitDescriptionFile(java.lang.String fileName)
                                throws java.io.FileNotFoundException,
                                       SOMLibFileFormatException

Reads a SOMLib unit description file with the given name.

Parameters:

fileName - the name of the file to open.

Throws:

java.io.FileNotFoundException

SOMLibFileFormatException

readWeightVectorFile

private void readWeightVectorFile(java.lang.String fileName)
                           throws java.io.FileNotFoundException,
                                  SOMLibFileFormatException

Reads a SOMLib weight vector file with the given name.

Parameters:

fileName - the name of the file to open.

Throws:

java.io.FileNotFoundException

SOMLibFileFormatException

processUnitElement

protected void processUnitElement(java.lang.String line,
                                  int k,
                                  int j,
                                  int i)

getFormatName

public static java.lang.String getFormatName()