at.tuwien.ifs.somtoolbox.input
Class SOMPAKFormatInputReader

java.lang.Object
  extended by at.tuwien.ifs.somtoolbox.input.AbstractSOMInputReader
      extended by at.tuwien.ifs.somtoolbox.input.SOMPAKFormatInputReader
All Implemented Interfaces:
SOMInputReader

public class SOMPAKFormatInputReader
extends AbstractSOMInputReader

Reads a SOM in SOMPAK file format. For details on this format, please see http://www.cis.hut.fi/research/som_pak/som_doc.txt.

Version:
$Id: SOMPAKFormatInputReader.java 3883 2010-11-02 17:13:23Z frank $
Author:
Rudolf Mayer

Nested Class Summary
 
Nested classes/interfaces inherited from class at.tuwien.ifs.somtoolbox.input.AbstractSOMInputReader
AbstractSOMInputReader.UnitInformation
 
Field Summary
private  java.lang.String[] componentNames
           
private  java.lang.String neighbourhoodFunction
           
private  java.lang.String somPakFilename
           
private  java.lang.String topology
           
 
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
SOMPAKFormatInputReader(java.lang.String somPakFilename)
           
 
Method Summary
 java.lang.String[] getComponentNames()
           
 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 getNeighbourhoodFunction()
           
 java.lang.String getTopology()
           
 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.
 
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

componentNames

private java.lang.String[] componentNames

neighbourhoodFunction

private java.lang.String neighbourhoodFunction

somPakFilename

private java.lang.String somPakFilename

topology

private java.lang.String topology
Constructor Detail

SOMPAKFormatInputReader

public SOMPAKFormatInputReader(java.lang.String somPakFilename)
                        throws java.io.IOException
Throws:
java.io.IOException
Method Detail

getComponentNames

public java.lang.String[] getComponentNames()

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.

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.

getNeighbourhoodFunction

public java.lang.String getNeighbourhoodFunction()

getTopology

public java.lang.String getTopology()

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.

getFormatName

public static java.lang.String getFormatName()