at.tuwien.ifs.somtoolbox.input
Class AbstractSOMInputReader

java.lang.Object
  extended by at.tuwien.ifs.somtoolbox.input.AbstractSOMInputReader
All Implemented Interfaces:
SOMInputReader
Direct Known Subclasses:
ESOMFormatInputReader, SOMLibFormatInputReader, SOMPAKFormatInputReader

public abstract class AbstractSOMInputReader
extends Object
implements SOMInputReader

Provides generic functionality to read a saved network model.

Version:
$Id: AbstractSOMInputReader.java 3883 2010-11-02 17:13:23Z frank $
Author:
Michael Dittenbach, Rudolf Mayer

Nested Class Summary
protected  class AbstractSOMInputReader.UnitInformation
          Inner class holding the information about a specific unit.
 
Field Summary
protected  ArrayList<String> allVectorNames
           
protected  String commonLabelPrefix
          The common prefix of all input vector labels.
protected  int dim
           
protected  Layer.GridLayout gridLayout
           
protected  Layer.GridTopology gridTopology
           
protected  boolean labelled
           
protected  String metricName
           
protected  AbstractSOMInputReader.UnitInformation[][][] unitInfo
           
protected  int xSize
           
protected  int ySize
           
protected  int zSize
           
 
Fields inherited from interface at.tuwien.ifs.somtoolbox.input.SOMInputReader
MAP_FILE, UNIT_FILE, WEIGHT_VECTOR
 
Constructor Summary
AbstractSOMInputReader()
           
 
Method Summary
 String[] getBestContextUnitLabels(int x, int y)
           
 String[] getBestContextUnitLabels(int x, int y, int z)
           
 String getCommonVectorLabelPrefix()
          Returns the longest substring that is common for all input data items.
 String[] getContextGateUnitLabels(int x, int y)
           
 String[] getContextGateUnitLabels(int x, int y, int z)
           
 int getDim()
          Returns the dimensionality of the weight vectors.
 Layer.GridLayout getGridLayout()
           
 Layer.GridTopology getGridTopology()
           
 String[] getKaskiGateUnitLabels(int x, int y)
           
 String[] getKaskiGateUnitLabels(int x, int y, int z)
           
 double[] getKaskiGateUnitLabelsWgt(int x, int y)
           
 double[] getKaskiGateUnitLabelsWgt(int x, int y, int z)
           
 String[] getKaskiUnitLabels(int x, int y)
           
 String[] getKaskiUnitLabels(int x, int y, int z)
           
 double[] getKaskiUnitLabelsWgt(int x, int y)
           
 double[] getKaskiUnitLabelsWgt(int x, int y, int z)
           
 String[] getMappedVecs(int x, int y)
          Returns an array of strings containing the names of vectors mapped onto a certain unit specified by coordinates x and y.
 String[] getMappedVecs(int x, int y, int z)
          Returns an array of strings containing the names of vectors mapped onto a certain unit specified by coordinates x and y.
 double[] getMappedVecsDist(int x, int y)
          Returns an array of double values containing the distances between mapped vectors and the unit specified by coordinates x and y.
 double[] getMappedVecsDist(int x, int y, int z)
          Returns an array of double values containing the distances between mapped vectors and the unit specified by coordinates x and y.
 String getMetricName()
          Returns the name of the metric used for distance calculation.
 int getNrBestContext(int x, int y)
           
 int getNrBestContext(int x, int y, int z)
           
 int getNrContextGateLabels(int x, int y)
           
 int getNrContextGateLabels(int x, int y, int z)
           
 int getNrGateWeights(int x, int y)
           
 int getNrGateWeights(int x, int y, int z)
           
 int getNrKaskiGateLabels(int x, int y)
           
 int getNrKaskiGateLabels(int x, int y, int z)
           
 int getNrKaskiLabels(int x, int y)
           
 int getNrKaskiLabels(int x, int y, int z)
           
 int getNrKaskiWeights(int x, int y)
           
 int getNrKaskiWeights(int x, int y, int z)
           
 int getNrSomsMapped(int x, int y)
          Returns the number of subordinate maps of a certain unit specified by coordinates x and y.
 int getNrSomsMapped(int x, int y, int z)
          Returns the number of subordinate maps of a certain unit specified by coordinates x and y.
 int getNrUnitLabels(int x, int y)
          Returns the number of labels of a certain unit specified by coordinates x and y.
 int getNrUnitLabels(int x, int y, int z)
          Returns the number of labels of a certain unit specified by coordinates x and y.
 int getNrVecMapped(int x, int y)
          Returns the number of vectors mapped onto a certain unit specified by coordinates x and y.
 int getNrVecMapped(int x, int y, int z)
          Returns the number of vectors mapped onto a certain unit specified by coordinates x and y.
 double getQuantErrorUnit(int x, int y)
          Returns the quantization error of a certain unit specified by coordinates x and y.
 double getQuantErrorUnit(int x, int y, int z)
          Returns the quantization error of a certain unit specified by coordinates x and y.
 double getQuantErrorUnitAvg(int x, int y)
          Returns the mean quantization error of a certain unit specified by coordinates x and y.
 double getQuantErrorUnitAvg(int x, int y, int z)
          Returns the mean quantization error of a certain unit specified by coordinates x and y.
 String[] getUnitLabels(int x, int y)
          Returns an array of strings containing the names of labels of a certain unit specified by coordinates x and y.
 String[] getUnitLabels(int x, int y, int z)
          Returns an array of strings containing the names of labels of a certain unit specified by coordinates x and y.
 double[] getUnitLabelsQe(int x, int y)
          Returns an array of double values containing the quantization error of the labels of a unit specified by coordinates x and y.
 double[] getUnitLabelsQe(int x, int y, int z)
          Returns an array of double values containing the quantization error of the labels of a unit specified by coordinates x and y.
 double[] getUnitLabelsWgt(int x, int y)
          Returns an array of double values containing the mean values of the labels of a unit specified by coordinates x and y .
 double[] getUnitLabelsWgt(int x, int y, int z)
          Returns an array of double values containing the mean values of the labels of a unit specified by coordinates x and y .
 String[] getUrlMappedSoms(int x, int y)
          Returns an array of strings containing the file names of subordinate maps of a certain unit specified by coordinates x and y.
 String[] getUrlMappedSoms(int x, int y, int z)
          Returns an array of strings containing the file names of subordinate maps of a certain unit specified by coordinates x and y.
 double[][][][] getVectors()
          Returns a 4-dimensional double array of the weight vectors.
 int getXSize()
          Returns the number of units in horizontal direction.
 int getYSize()
          Returns the number of units in vertical direction.
 int getZSize()
          Returns the number of units in depth.
protected  void initUnitInformation()
           
 boolean isLabelled()
          Returns whether the SOM is labelled.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface at.tuwien.ifs.somtoolbox.input.SOMInputReader
getFilePath, getMapDescriptionFileName, getUnitDescriptionFileName, getWeightVectorFileName
 

Field Detail

gridLayout

protected Layer.GridLayout gridLayout

gridTopology

protected Layer.GridTopology gridTopology

labelled

protected boolean labelled

dim

protected int dim

metricName

protected String metricName

unitInfo

protected AbstractSOMInputReader.UnitInformation[][][] unitInfo

xSize

protected int xSize

ySize

protected int ySize

zSize

protected int zSize

commonLabelPrefix

protected String commonLabelPrefix
The common prefix of all input vector labels. Will be once computed in getCommonVectorLabelPrefix(), and then cached.


allVectorNames

protected ArrayList<String> allVectorNames
Constructor Detail

AbstractSOMInputReader

public AbstractSOMInputReader()
Method Detail

getBestContextUnitLabels

public String[] getBestContextUnitLabels(int x,
                                         int y)
Specified by:
getBestContextUnitLabels in interface SOMInputReader

getBestContextUnitLabels

public String[] getBestContextUnitLabels(int x,
                                         int y,
                                         int z)
Specified by:
getBestContextUnitLabels in interface SOMInputReader

getContextGateUnitLabels

public String[] getContextGateUnitLabels(int x,
                                         int y)
Specified by:
getContextGateUnitLabels in interface SOMInputReader

getContextGateUnitLabels

public String[] getContextGateUnitLabels(int x,
                                         int y,
                                         int z)
Specified by:
getContextGateUnitLabels in interface SOMInputReader

getDim

public int getDim()
Description copied from interface: SOMInputReader
Returns the dimensionality of the weight vectors.

Specified by:
getDim in interface SOMInputReader
Returns:
the dimensionality of the weight vectors.
See Also:
SOMInputReader.getDim()

getKaskiGateUnitLabels

public String[] getKaskiGateUnitLabels(int x,
                                       int y)
Specified by:
getKaskiGateUnitLabels in interface SOMInputReader

getKaskiGateUnitLabels

public String[] getKaskiGateUnitLabels(int x,
                                       int y,
                                       int z)
Specified by:
getKaskiGateUnitLabels in interface SOMInputReader

getKaskiGateUnitLabelsWgt

public double[] getKaskiGateUnitLabelsWgt(int x,
                                          int y)
Specified by:
getKaskiGateUnitLabelsWgt in interface SOMInputReader

getKaskiGateUnitLabelsWgt

public double[] getKaskiGateUnitLabelsWgt(int x,
                                          int y,
                                          int z)
Specified by:
getKaskiGateUnitLabelsWgt in interface SOMInputReader

getKaskiUnitLabels

public String[] getKaskiUnitLabels(int x,
                                   int y)
Specified by:
getKaskiUnitLabels in interface SOMInputReader

getKaskiUnitLabels

public String[] getKaskiUnitLabels(int x,
                                   int y,
                                   int z)
Specified by:
getKaskiUnitLabels in interface SOMInputReader

getKaskiUnitLabelsWgt

public double[] getKaskiUnitLabelsWgt(int x,
                                      int y)
Specified by:
getKaskiUnitLabelsWgt in interface SOMInputReader

getKaskiUnitLabelsWgt

public double[] getKaskiUnitLabelsWgt(int x,
                                      int y,
                                      int z)
Specified by:
getKaskiUnitLabelsWgt in interface SOMInputReader

getMappedVecs

public String[] getMappedVecs(int x,
                              int y)
Description copied from interface: SOMInputReader
Returns an array of strings containing the names of vectors mapped onto a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getMappedVecs in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
an array of strings containing the names of vectors mapped onto a certain unit specified by coordinates x and y.

getMappedVecs

public String[] getMappedVecs(int x,
                              int y,
                              int z)
Description copied from interface: SOMInputReader
Returns an array of strings containing the names of vectors mapped onto a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getMappedVecs in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
an array of strings containing the names of vectors mapped onto a certain unit specified by coordinates x and y.

getMappedVecsDist

public double[] getMappedVecsDist(int x,
                                  int y)
Description copied from interface: SOMInputReader
Returns an array of double values containing the distances between mapped vectors and the unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getMappedVecsDist in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
an array of double values containing the distances between mapped vectors and the unit specified by coordinates x and y.

getMappedVecsDist

public double[] getMappedVecsDist(int x,
                                  int y,
                                  int z)
Description copied from interface: SOMInputReader
Returns an array of double values containing the distances between mapped vectors and the unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getMappedVecsDist in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
an array of double values containing the distances between mapped vectors and the unit specified by coordinates x and y.

getMetricName

public String getMetricName()
Description copied from interface: SOMInputReader
Returns the name of the metric used for distance calculation.

Specified by:
getMetricName in interface SOMInputReader
Returns:
the name of the metric used for distance calculation.

getNrBestContext

public int getNrBestContext(int x,
                            int y)
Specified by:
getNrBestContext in interface SOMInputReader

getNrBestContext

public int getNrBestContext(int x,
                            int y,
                            int z)
Specified by:
getNrBestContext in interface SOMInputReader

getNrContextGateLabels

public int getNrContextGateLabels(int x,
                                  int y)
Specified by:
getNrContextGateLabels in interface SOMInputReader

getNrContextGateLabels

public int getNrContextGateLabels(int x,
                                  int y,
                                  int z)
Specified by:
getNrContextGateLabels in interface SOMInputReader

getNrGateWeights

public int getNrGateWeights(int x,
                            int y)
Specified by:
getNrGateWeights in interface SOMInputReader

getNrGateWeights

public int getNrGateWeights(int x,
                            int y,
                            int z)
Specified by:
getNrGateWeights in interface SOMInputReader

getNrKaskiGateLabels

public int getNrKaskiGateLabels(int x,
                                int y)
Specified by:
getNrKaskiGateLabels in interface SOMInputReader

getNrKaskiGateLabels

public int getNrKaskiGateLabels(int x,
                                int y,
                                int z)
Specified by:
getNrKaskiGateLabels in interface SOMInputReader

getNrKaskiLabels

public int getNrKaskiLabels(int x,
                            int y)
Specified by:
getNrKaskiLabels in interface SOMInputReader

getNrKaskiLabels

public int getNrKaskiLabels(int x,
                            int y,
                            int z)
Specified by:
getNrKaskiLabels in interface SOMInputReader

getNrKaskiWeights

public int getNrKaskiWeights(int x,
                             int y)
Specified by:
getNrKaskiWeights in interface SOMInputReader

getNrKaskiWeights

public int getNrKaskiWeights(int x,
                             int y,
                             int z)
Specified by:
getNrKaskiWeights in interface SOMInputReader

getNrSomsMapped

public int getNrSomsMapped(int x,
                           int y)
Description copied from interface: SOMInputReader
Returns the number of subordinate maps of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getNrSomsMapped in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
the number of subordinate maps of a certain unit specified by coordinates x and y.

getNrSomsMapped

public int getNrSomsMapped(int x,
                           int y,
                           int z)
Description copied from interface: SOMInputReader
Returns the number of subordinate maps of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getNrSomsMapped in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
the number of subordinate maps of a certain unit specified by coordinates x and y.

getNrUnitLabels

public int getNrUnitLabels(int x,
                           int y)
Description copied from interface: SOMInputReader
Returns the number of labels of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getNrUnitLabels in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
the number of labels of a certain unit specified by coordinates x and y.

getNrUnitLabels

public int getNrUnitLabels(int x,
                           int y,
                           int z)
Description copied from interface: SOMInputReader
Returns the number of labels of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getNrUnitLabels in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
the number of labels of a certain unit specified by coordinates x and y.

getNrVecMapped

public int getNrVecMapped(int x,
                          int y)
Description copied from interface: SOMInputReader
Returns the number of vectors mapped onto a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getNrVecMapped in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
the number of vectors mapped onto a certain unit specified by coordinates x and y.

getNrVecMapped

public int getNrVecMapped(int x,
                          int y,
                          int z)
Description copied from interface: SOMInputReader
Returns the number of vectors mapped onto a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getNrVecMapped in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
the number of vectors mapped onto a certain unit specified by coordinates x and y.

getQuantErrorUnit

public double getQuantErrorUnit(int x,
                                int y)
Description copied from interface: SOMInputReader
Returns the quantization error of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getQuantErrorUnit in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
the quantization error of a certain unit specified by coordinates x and y.

getQuantErrorUnit

public double getQuantErrorUnit(int x,
                                int y,
                                int z)
Description copied from interface: SOMInputReader
Returns the quantization error of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getQuantErrorUnit in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
the quantization error of a certain unit specified by coordinates x and y.

getQuantErrorUnitAvg

public double getQuantErrorUnitAvg(int x,
                                   int y)
Description copied from interface: SOMInputReader
Returns the mean quantization error of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getQuantErrorUnitAvg in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
the mean quantization error of a certain unit specified by coordinates x and y.

getQuantErrorUnitAvg

public double getQuantErrorUnitAvg(int x,
                                   int y,
                                   int z)
Description copied from interface: SOMInputReader
Returns the mean quantization error of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getQuantErrorUnitAvg in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
the mean quantization error of a certain unit specified by coordinates x and y.

getUnitLabels

public String[] getUnitLabels(int x,
                              int y)
Description copied from interface: SOMInputReader
Returns an array of strings containing the names of labels of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getUnitLabels in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
an array of strings containing the names of labels of a certain unit specified by coordinates x and y.

getUnitLabels

public String[] getUnitLabels(int x,
                              int y,
                              int z)
Description copied from interface: SOMInputReader
Returns an array of strings containing the names of labels of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getUnitLabels in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
an array of strings containing the names of labels of a certain unit specified by coordinates x and y.

getUnitLabelsQe

public double[] getUnitLabelsQe(int x,
                                int y)
Description copied from interface: SOMInputReader
Returns an array of double values containing the quantization error of the labels of a unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getUnitLabelsQe in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
an array of double values containing the quantization error of the labels of a unit specified by coordinates x and y.

getUnitLabelsQe

public double[] getUnitLabelsQe(int x,
                                int y,
                                int z)
Description copied from interface: SOMInputReader
Returns an array of double values containing the quantization error of the labels of a unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getUnitLabelsQe in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
an array of double values containing the quantization error of the labels of a unit specified by coordinates x and y.

getUnitLabelsWgt

public double[] getUnitLabelsWgt(int x,
                                 int y)
Description copied from interface: SOMInputReader
Returns an array of double values containing the mean values of the labels of a unit specified by coordinates x and y . If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getUnitLabelsWgt in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
an array of double values containing the mean values of the labels of a unit specified by coordinates x and y .

getUnitLabelsWgt

public double[] getUnitLabelsWgt(int x,
                                 int y,
                                 int z)
Description copied from interface: SOMInputReader
Returns an array of double values containing the mean values of the labels of a unit specified by coordinates x and y . If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getUnitLabelsWgt in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
an array of double values containing the mean values of the labels of a unit specified by coordinates x and y .

getUrlMappedSoms

public String[] getUrlMappedSoms(int x,
                                 int y)
Description copied from interface: SOMInputReader
Returns an array of strings containing the file names of subordinate maps of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getUrlMappedSoms in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
Returns:
an array of strings containing the file names of subordinate maps of a certain unit specified by coordinates x and y.

getUrlMappedSoms

public String[] getUrlMappedSoms(int x,
                                 int y,
                                 int z)
Description copied from interface: SOMInputReader
Returns an array of strings containing the file names of subordinate maps of a certain unit specified by coordinates x and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.

Specified by:
getUrlMappedSoms in interface SOMInputReader
Parameters:
x - horizontal position of the unit on the map.
y - vertical position of the unit on the map.
z - TODO
Returns:
an array of strings containing the file names of subordinate maps of a certain unit specified by coordinates x and y.

getVectors

public double[][][][] getVectors()
Description copied from interface: SOMInputReader
Returns a 4-dimensional double array of the weight vectors. The first dimension represents units of a map in horizontal direction, the second dimension represents the units of a map in vertical direction and the third dimension represents units of a map in depth.

Specified by:
getVectors in interface SOMInputReader
Returns:
a 4-dimensional double array of the weight vectors.

getXSize

public int getXSize()
Description copied from interface: SOMInputReader
Returns the number of units in horizontal direction.

Specified by:
getXSize in interface SOMInputReader
Returns:
the number of units in horizontal direction.

getYSize

public int getYSize()
Description copied from interface: SOMInputReader
Returns the number of units in vertical direction.

Specified by:
getYSize in interface SOMInputReader
Returns:
the number of units in vertical direction.

getZSize

public int getZSize()
Description copied from interface: SOMInputReader
Returns the number of units in depth.

Specified by:
getZSize in interface SOMInputReader
Returns:
the number of units in depth.

initUnitInformation

protected void initUnitInformation()

getCommonVectorLabelPrefix

public String getCommonVectorLabelPrefix()
Description copied from interface: SOMInputReader
Returns the longest substring that is common for all input data items. Use this to improve the visual display of vector labels.

Specified by:
getCommonVectorLabelPrefix in interface SOMInputReader

isLabelled

public boolean isLabelled()
Description copied from interface: SOMInputReader
Returns whether the SOM is labelled.

Specified by:
isLabelled in interface SOMInputReader

getGridLayout

public Layer.GridLayout getGridLayout()
Specified by:
getGridLayout in interface SOMInputReader

getGridTopology

public Layer.GridTopology getGridTopology()
Specified by:
getGridTopology in interface SOMInputReader