at.tuwien.ifs.somtoolbox.input.AbstractSOMInputReader
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public abstract class AbstractSOMInputReader
Provides generic functionality to read a saved network model.
| 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 ContentType |
contentType
|
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. |
ContentType |
getContentType()
Returns the content type of the data, stored in the Map description file |
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 |
|---|
protected Layer.GridLayout gridLayout
protected Layer.GridTopology gridTopology
protected boolean labelled
protected int dim
protected String metricName
protected ContentType contentType
protected AbstractSOMInputReader.UnitInformation[][][] unitInfo
protected int xSize
protected int ySize
protected int zSize
protected String commonLabelPrefix
getCommonVectorLabelPrefix(), and
then cached.
protected ArrayList<String> allVectorNames
| Constructor Detail |
|---|
public AbstractSOMInputReader()
| Method Detail |
|---|
public String[] getBestContextUnitLabels(int x,
int y)
getBestContextUnitLabels in interface SOMInputReader
public String[] getBestContextUnitLabels(int x,
int y,
int z)
getBestContextUnitLabels in interface SOMInputReader
public String[] getContextGateUnitLabels(int x,
int y)
getContextGateUnitLabels in interface SOMInputReader
public String[] getContextGateUnitLabels(int x,
int y,
int z)
getContextGateUnitLabels in interface SOMInputReaderpublic int getDim()
SOMInputReader
getDim in interface SOMInputReaderSOMInputReader.getDim()
public String[] getKaskiGateUnitLabels(int x,
int y)
getKaskiGateUnitLabels in interface SOMInputReader
public String[] getKaskiGateUnitLabels(int x,
int y,
int z)
getKaskiGateUnitLabels in interface SOMInputReader
public double[] getKaskiGateUnitLabelsWgt(int x,
int y)
getKaskiGateUnitLabelsWgt in interface SOMInputReader
public double[] getKaskiGateUnitLabelsWgt(int x,
int y,
int z)
getKaskiGateUnitLabelsWgt in interface SOMInputReader
public String[] getKaskiUnitLabels(int x,
int y)
getKaskiUnitLabels in interface SOMInputReader
public String[] getKaskiUnitLabels(int x,
int y,
int z)
getKaskiUnitLabels in interface SOMInputReader
public double[] getKaskiUnitLabelsWgt(int x,
int y)
getKaskiUnitLabelsWgt in interface SOMInputReader
public double[] getKaskiUnitLabelsWgt(int x,
int y,
int z)
getKaskiUnitLabelsWgt in interface SOMInputReader
public String[] getMappedVecs(int x,
int y)
SOMInputReaderx and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.
getMappedVecs in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and y.
public String[] getMappedVecs(int x,
int y,
int z)
SOMInputReaderx and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.
getMappedVecs in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and y.
public double[] getMappedVecsDist(int x,
int y)
SOMInputReaderx and y. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.
getMappedVecsDist in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and y.
public double[] getMappedVecsDist(int x,
int y,
int z)
SOMInputReaderx and y. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.
getMappedVecsDist in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and y.public String getMetricName()
SOMInputReader
getMetricName in interface SOMInputReader
public int getNrBestContext(int x,
int y)
getNrBestContext in interface SOMInputReader
public int getNrBestContext(int x,
int y,
int z)
getNrBestContext in interface SOMInputReader
public int getNrContextGateLabels(int x,
int y)
getNrContextGateLabels in interface SOMInputReader
public int getNrContextGateLabels(int x,
int y,
int z)
getNrContextGateLabels in interface SOMInputReader
public int getNrGateWeights(int x,
int y)
getNrGateWeights in interface SOMInputReader
public int getNrGateWeights(int x,
int y,
int z)
getNrGateWeights in interface SOMInputReader
public int getNrKaskiGateLabels(int x,
int y)
getNrKaskiGateLabels in interface SOMInputReader
public int getNrKaskiGateLabels(int x,
int y,
int z)
getNrKaskiGateLabels in interface SOMInputReader
public int getNrKaskiLabels(int x,
int y)
getNrKaskiLabels in interface SOMInputReader
public int getNrKaskiLabels(int x,
int y,
int z)
getNrKaskiLabels in interface SOMInputReader
public int getNrKaskiWeights(int x,
int y)
getNrKaskiWeights in interface SOMInputReader
public int getNrKaskiWeights(int x,
int y,
int z)
getNrKaskiWeights in interface SOMInputReader
public int getNrSomsMapped(int x,
int y)
SOMInputReaderx and
y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown.
The calling function is not obliged to catch it.
getNrSomsMapped in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and
y.
public int getNrSomsMapped(int x,
int y,
int z)
SOMInputReaderx and
y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown.
The calling function is not obliged to catch it.
getNrSomsMapped in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and
y.
public int getNrUnitLabels(int x,
int y)
SOMInputReaderx and y. If the
coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is
not obliged to catch it.
getNrUnitLabels in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and y.
public int getNrUnitLabels(int x,
int y,
int z)
SOMInputReaderx and y. If the
coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function is
not obliged to catch it.
getNrUnitLabels in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and y.
public int getNrVecMapped(int x,
int y)
SOMInputReaderx and
y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown.
The calling function is not obliged to catch it.
getNrVecMapped in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and
y.
public int getNrVecMapped(int x,
int y,
int z)
SOMInputReaderx and
y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown.
The calling function is not obliged to catch it.
getNrVecMapped in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and
y.
public double getQuantErrorUnit(int x,
int y)
SOMInputReaderx and y. If
the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function
is not obliged to catch it.
getQuantErrorUnit in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and y.
public double getQuantErrorUnit(int x,
int y,
int z)
SOMInputReaderx and y. If
the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling function
is not obliged to catch it.
getQuantErrorUnit in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and y.
public double getQuantErrorUnitAvg(int x,
int y)
SOMInputReaderx and y.
If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling
function is not obliged to catch it.
getQuantErrorUnitAvg in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and y.
public double getQuantErrorUnitAvg(int x,
int y,
int z)
SOMInputReaderx and y.
If the coordinates are invalid, an ArrayIndexOutOfBoundsException will be thrown. The calling
function is not obliged to catch it.
getQuantErrorUnitAvg in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and y.
public String[] getUnitLabels(int x,
int y)
SOMInputReaderx and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.
getUnitLabels in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and y.
public String[] getUnitLabels(int x,
int y,
int z)
SOMInputReaderx and y. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.
getUnitLabels in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and y.
public double[] getUnitLabelsQe(int x,
int y)
SOMInputReaderx and y. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.
getUnitLabelsQe in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and y.
public double[] getUnitLabelsQe(int x,
int y,
int z)
SOMInputReaderx and y. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.
getUnitLabelsQe in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and y.
public double[] getUnitLabelsWgt(int x,
int y)
SOMInputReaderx and y . If the coordinates are invalid, an
ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.
getUnitLabelsWgt in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and y .
public double[] getUnitLabelsWgt(int x,
int y,
int z)
SOMInputReaderx and y . If the coordinates are invalid, an
ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.
getUnitLabelsWgt in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and y .
public String[] getUrlMappedSoms(int x,
int y)
SOMInputReaderx and y. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.
getUrlMappedSoms in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.
x and y.
public String[] getUrlMappedSoms(int x,
int y,
int z)
SOMInputReaderx and y. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException will be thrown. The calling function is not obliged to catch it.
getUrlMappedSoms in interface SOMInputReaderx - horizontal position of the unit on the map.y - vertical position of the unit on the map.z - TODO
x and y.public double[][][][] getVectors()
SOMInputReader
getVectors in interface SOMInputReaderpublic int getXSize()
SOMInputReader
getXSize in interface SOMInputReaderpublic int getYSize()
SOMInputReader
getYSize in interface SOMInputReaderpublic int getZSize()
SOMInputReader
getZSize in interface SOMInputReaderprotected void initUnitInformation()
public String getCommonVectorLabelPrefix()
SOMInputReader
getCommonVectorLabelPrefix in interface SOMInputReaderpublic boolean isLabelled()
SOMInputReader
isLabelled in interface SOMInputReaderpublic Layer.GridLayout getGridLayout()
getGridLayout in interface SOMInputReaderpublic Layer.GridTopology getGridTopology()
getGridTopology in interface SOMInputReaderpublic ContentType getContentType()
SOMInputReader
getContentType in interface SOMInputReader
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||