public interface SOMInputReader
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
MAP_FILE |
static java.lang.String |
UNIT_FILE |
static java.lang.String |
WEIGHT_VECTOR |
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getBestContextUnitLabels(int x,
int y) |
java.lang.String[] |
getBestContextUnitLabels(int x,
int y,
int z) |
java.lang.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
|
java.lang.String[] |
getContextGateUnitLabels(int x,
int y) |
java.lang.String[] |
getContextGateUnitLabels(int x,
int y,
int z) |
int |
getDim()
Returns the dimensionality of the weight vectors.
|
java.lang.String |
getFilePath()
Returns the name of the path where the files are located.
|
Layer.GridLayout |
getGridLayout() |
Layer.GridTopology |
getGridTopology() |
java.lang.String[] |
getKaskiGateUnitLabels(int x,
int y) |
java.lang.String[] |
getKaskiGateUnitLabels(int x,
int y,
int z) |
double[] |
getKaskiGateUnitLabelsWgt(int x,
int y) |
double[] |
getKaskiGateUnitLabelsWgt(int x,
int y,
int z) |
java.lang.String[] |
getKaskiUnitLabels(int x,
int y) |
java.lang.String[] |
getKaskiUnitLabels(int x,
int y,
int z) |
double[] |
getKaskiUnitLabelsWgt(int x,
int y) |
double[] |
getKaskiUnitLabelsWgt(int x,
int y,
int z) |
java.lang.String |
getMapDescriptionFileName()
Returns the name of the map description file, or null if not loaded.
|
java.lang.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 . |
java.lang.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 . |
java.lang.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 . |
java.lang.String |
getUnitDescriptionFileName()
Returns the name of the unit description file, or
null if not loaded. |
java.lang.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 . |
java.lang.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 . |
java.lang.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 . |
java.lang.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.
|
java.lang.String |
getWeightVectorFileName()
Returns the name of the weight vector file, or
null if not loaded. |
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.
|
boolean |
isLabelled()
Returns whether the SOM is labelled.
|
static final java.lang.String UNIT_FILE
static final java.lang.String WEIGHT_VECTOR
static final java.lang.String MAP_FILE
int getDim()
java.lang.String getFilePath()
java.lang.String getMapDescriptionFileName()
java.lang.String[] getMappedVecs(int x, int y)
x
and y
. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and y
.java.lang.String[] getMappedVecs(int x, int y, int z)
x
and y
. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and y
.double[] getMappedVecsDist(int x, int y)
x
and y
. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and y
.double[] getMappedVecsDist(int x, int y, int z)
x
and y
. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and y
.java.lang.String getMetricName()
int getNrSomsMapped(int x, int y)
x
and
y
. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown.
The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and
y
.int getNrSomsMapped(int x, int y, int z)
x
and
y
. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown.
The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and
y
.int getNrUnitLabels(int x, int y)
x
and y
. If the
coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function is
not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and y
.int getNrUnitLabels(int x, int y, int z)
x
and y
. If the
coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function is
not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and y
.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 getNrContextGateLabels(int x, int y)
int getNrContextGateLabels(int x, int y, int z)
int getNrKaskiWeights(int x, int y)
int getNrKaskiWeights(int x, int y, int z)
int getNrGateWeights(int x, int y)
int getNrGateWeights(int x, int y, int z)
int getNrBestContext(int x, int y)
int getNrBestContext(int x, int y, int z)
int getNrVecMapped(int x, int y)
x
and
y
. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown.
The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and
y
.int getNrVecMapped(int x, int y, int z)
x
and
y
. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown.
The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and
y
.double getQuantErrorUnit(int x, int y)
x
and y
. If
the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function
is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and y
.double getQuantErrorUnit(int x, int y, int z)
x
and y
. If
the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function
is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and y
.double getQuantErrorUnitAvg(int x, int y)
x
and y
.
If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling
function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and y
.double getQuantErrorUnitAvg(int x, int y, int z)
x
and y
.
If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling
function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and y
.java.lang.String getUnitDescriptionFileName()
null
if not loaded.null
if not loaded.java.lang.String[] getUnitLabels(int x, int y)
x
and y
. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and y
.java.lang.String[] getUnitLabels(int x, int y, int z)
x
and y
. If the coordinates are invalid, an ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and y
.java.lang.String[] getKaskiGateUnitLabels(int x, int y)
java.lang.String[] getKaskiGateUnitLabels(int x, int y, int z)
java.lang.String[] getContextGateUnitLabels(int x, int y)
java.lang.String[] getContextGateUnitLabels(int x, int y, int z)
java.lang.String[] getKaskiUnitLabels(int x, int y)
java.lang.String[] getKaskiUnitLabels(int x, int y, int z)
java.lang.String[] getBestContextUnitLabels(int x, int y)
java.lang.String[] getBestContextUnitLabels(int x, int y, int z)
double[] getUnitLabelsQe(int x, int y)
x
and y
. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and y
.double[] getUnitLabelsQe(int x, int y, int z)
x
and y
. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and y
.double[] getUnitLabelsWgt(int x, int y)
x
and y
. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and y
.double[] getUnitLabelsWgt(int x, int y, int z)
x
and y
. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and y
.double[] getKaskiUnitLabelsWgt(int x, int y)
double[] getKaskiUnitLabelsWgt(int x, int y, int z)
double[] getKaskiGateUnitLabelsWgt(int x, int y)
double[] getKaskiGateUnitLabelsWgt(int x, int y, int z)
java.lang.String[] getUrlMappedSoms(int x, int y)
x
and y
. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.x
and y
.java.lang.String[] getUrlMappedSoms(int x, int y, int z)
x
and y
. If the coordinates are invalid, an
ArrayIndexOutOfBoundsException
will be thrown. The calling function is not obliged to catch it.x
- horizontal position of the unit on the map.y
- vertical position of the unit on the map.z
- TODOx
and y
.double[][][][] getVectors()
java.lang.String getWeightVectorFileName()
null
if not loaded.null
if not loaded.int getXSize()
int getYSize()
int getZSize()
Layer.GridTopology getGridTopology()
Layer.GridLayout getGridLayout()
java.lang.String getCommonVectorLabelPrefix()
boolean isLabelled()
ContentType getContentType()