at.tuwien.ifs.somtoolbox.output

Class SOMLibMapOutputter

java.lang.Object

at.tuwien.ifs.somtoolbox.output.SOMLibMapOutputter

Direct Known Subclasses:

GrowingCellStructuresMapOutputter

public class SOMLibMapOutputter
extends java.lang.Object

Gathers methods to write trained maps in the SOMLib file format

Version:

$Id: SOMLibMapOutputter.java 4342 2015-03-06 15:56:51Z mayer $

Author:

Michael Dittenbach

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SOMLibMapOutputter.DataWinnerMappingThread

Constructor Summary

Constructors

Constructor and Description
SOMLibMapOutputter()

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	getDataWinnerMappingFileName(java.lang.String fDir, java.lang.String fName, java.lang.String idString, boolean gzipped)
protected static java.lang.String	getMapDescriptionFileName(java.lang.String fDir, java.lang.String fName, java.lang.String idString, boolean gzipped)
protected static java.lang.String	getUnitDescriptionFileName(java.lang.String fDir, java.lang.String fName, java.lang.String idString, boolean gzipped)
protected static java.lang.String	getWeightVectorFileName(java.lang.String fDir, java.lang.String fName, java.lang.String idString, boolean gzipped)
private static java.io.BufferedWriter	openAndWriteUnitFileHeader(java.lang.String fDir, java.lang.String fName, java.lang.String id, int xSize, int ySize, int zSize, Layer.GridLayout gridLayout, Layer.GridTopology gridTopology, boolean gzipped)
static void	write(GHSOM ghsom, java.lang.String fDir, java.lang.String fName, boolean gzipped, SOMProperties somProps, FileProperties fileProps)
static void	write(GrowingSOM gsom, java.lang.String fDir, java.lang.String fName, boolean gzipped, SOMProperties somProps, FileProperties fileProps) Writes a SOM (or SOM-like) structure to SOMLib format.
static void	writeDataWinnerMappingFile(GHSOM ghsom, InputData data, int numWinners, java.lang.String fDir, java.lang.String fName, boolean gzipped)
static void	writeDataWinnerMappingFile(GrowingSOM gsom, InputData data, int numWinners, java.lang.String fDir, java.lang.String fName, boolean gzipped)
static void	writeDataWinnerMappingFile(SOMLibDataWinnerMapping dwm, java.lang.String fDir, java.lang.String fName, boolean gzip)
static void	writeMapDescriptionFile(GrowingSOM topLevelMap, java.lang.String fDir, java.lang.String fName, SOMProperties somProps, FileProperties fileProps)
static void	writeMapDescriptionFile(int xSize, int ySize, int zSize, int dim, int numVectors, java.lang.String fDir, java.lang.String fName) Simple SOMLib Map description file writer, if you don't have a GrowingSOM object at hand, e.g.
protected static void	writeMappedVectors(java.io.BufferedWriter bw, java.lang.String[] datalabels, double[] dataDistances)
static void	writeUnitDescriptionFile(GrowingSOM gsom, java.lang.String fDir, java.lang.String fName, boolean gzipped) Writes the Unit Description File.
static void	writeUnitDescriptionFile(int xdim, int ydim, Layer.GridLayout gridLayout, Layer.GridTopology gridTopology, java.lang.String fDir, java.lang.String fName, boolean gzipped) Method to write a unit description file of an empty map.
static void	writeUnitDescriptionFile(java.lang.String[][][] labels, Layer.GridLayout gridLayout, Layer.GridTopology gridTopology, java.lang.String fDir, java.lang.String fName, boolean gzipped)
protected static void	writeUnitInfoBegin(java.lang.String fName, java.io.BufferedWriter bw, int j, int i, int k, int zSize)
static void	writeWeightVectorFile(double[][][][] weights, Layer.GridLayout gridLayout, Layer.GridTopology gridTopology, java.lang.String fDir, java.lang.String fName, boolean gzipped) Writes the Weight Vector File from given weight values, used e.g.
static void	writeWeightVectorFile(GrowingSOM gsom, java.lang.String fDir, java.lang.String fName, boolean gzipped, java.lang.String... extraHeaders) Writes the Weight Vector File.
protected static java.io.BufferedWriter	writeWeightVectorFileHeader(java.lang.String fDir, java.lang.String fName, boolean gzipped, int xDim, int yDim, int zDim, Layer.GridLayout gridLayout, Layer.GridTopology gridTopology, int vecDim, java.lang.String idString, java.lang.String... extraHeaders) Writes the header part of the weight vector file.

Methods inherited from class java.lang.Object

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

Constructor Detail

SOMLibMapOutputter

public SOMLibMapOutputter()

Method Detail

write

public static void write(GrowingSOM gsom,
                         java.lang.String fDir,
                         java.lang.String fName,
                         boolean gzipped,
                         SOMProperties somProps,
                         FileProperties fileProps)
                  throws java.io.IOException

Writes a SOM (or SOM-like) structure to SOMLib format. Usually writes a Map Description File, Weight Vector File and Unit Description File.

Parameters:

gsom - The growing SOM to be written.

fDir - Directory where to write the files to.

fName - Filename without suffix. Usually the name of the training run.

gzipped - Determines whether the written files should be gzipped or not. A ".gz" suffix is automatically appended.

Throws:

java.io.IOException

write

public static void write(GHSOM ghsom,
                         java.lang.String fDir,
                         java.lang.String fName,
                         boolean gzipped,
                         SOMProperties somProps,
                         FileProperties fileProps)
                  throws java.io.IOException

Throws:

java.io.IOException

writeWeightVectorFile

public static void writeWeightVectorFile(GrowingSOM gsom,
                                         java.lang.String fDir,
                                         java.lang.String fName,
                                         boolean gzipped,
                                         java.lang.String... extraHeaders)
                                  throws java.io.IOException

Writes the Weight Vector File.

Parameters:

gsom - The growing SOM to be written.

fDir - Directory where to write the file to.

fName - fName Filename without suffix. Usually the name of the training run.

gzipped - Determines whether the written files should be gzipped or not. A ".gz" suffix is automatically appended.

Throws:

java.io.IOException

writeWeightVectorFile

public static void writeWeightVectorFile(double[][][][] weights,
                                         Layer.GridLayout gridLayout,
                                         Layer.GridTopology gridTopology,
                                         java.lang.String fDir,
                                         java.lang.String fName,
                                         boolean gzipped)
                                  throws java.io.IOException

Writes the Weight Vector File from given weight values, used e.g. when interpolating a SOM.

Throws:

java.io.IOException

writeWeightVectorFileHeader

protected static java.io.BufferedWriter writeWeightVectorFileHeader(java.lang.String fDir,
                                                                    java.lang.String fName,
                                                                    boolean gzipped,
                                                                    int xDim,
                                                                    int yDim,
                                                                    int zDim,
                                                                    Layer.GridLayout gridLayout,
                                                                    Layer.GridTopology gridTopology,
                                                                    int vecDim,
                                                                    java.lang.String idString,
                                                                    java.lang.String... extraHeaders)
                                                             throws java.io.IOException,
                                                                    java.io.FileNotFoundException

Writes the header part of the weight vector file.

Throws:

java.io.IOException

java.io.FileNotFoundException

openAndWriteUnitFileHeader

private static java.io.BufferedWriter openAndWriteUnitFileHeader(java.lang.String fDir,
                                                                 java.lang.String fName,
                                                                 java.lang.String id,
                                                                 int xSize,
                                                                 int ySize,
                                                                 int zSize,
                                                                 Layer.GridLayout gridLayout,
                                                                 Layer.GridTopology gridTopology,
                                                                 boolean gzipped)
                                                          throws java.io.IOException

Throws:

java.io.IOException

writeUnitDescriptionFile

public static void writeUnitDescriptionFile(GrowingSOM gsom,
                                            java.lang.String fDir,
                                            java.lang.String fName,
                                            boolean gzipped)
                                     throws java.io.IOException

Writes the Unit Description File.

Parameters:

gsom - The growing SOM to be written.

fDir - Directory where to write the file to.

fName - fName Filename without suffix. Usually the name of the training run.

gzipped - Determines whether the written files should be gzipped or not. A ".gz" suffix is automatically appended.

Throws:

java.io.IOException

writeUnitInfoBegin

protected static void writeUnitInfoBegin(java.lang.String fName,
                                         java.io.BufferedWriter bw,
                                         int j,
                                         int i,
                                         int k,
                                         int zSize)
                                  throws java.io.IOException

Throws:

java.io.IOException

writeMappedVectors

protected static void writeMappedVectors(java.io.BufferedWriter bw,
                                         java.lang.String[] datalabels,
                                         double[] dataDistances)
                                  throws java.io.IOException

Throws:

java.io.IOException

writeUnitDescriptionFile

public static void writeUnitDescriptionFile(int xdim,
                                            int ydim,
                                            Layer.GridLayout gridLayout,
                                            Layer.GridTopology gridTopology,
                                            java.lang.String fDir,
                                            java.lang.String fName,
                                            boolean gzipped)
                                     throws java.io.IOException

Method to write a unit description file of an empty map.

Throws:

java.io.IOException

writeUnitDescriptionFile

public static void writeUnitDescriptionFile(java.lang.String[][][] labels,
                                            Layer.GridLayout gridLayout,
                                            Layer.GridTopology gridTopology,
                                            java.lang.String fDir,
                                            java.lang.String fName,
                                            boolean gzipped)
                                     throws java.io.IOException

Throws:

java.io.IOException

writeMapDescriptionFile

public static void writeMapDescriptionFile(GrowingSOM topLevelMap,
                                           java.lang.String fDir,
                                           java.lang.String fName,
                                           SOMProperties somProps,
                                           FileProperties fileProps)
                                    throws java.io.IOException

Throws:

java.io.IOException

writeMapDescriptionFile

public static void writeMapDescriptionFile(int xSize,
                                           int ySize,
                                           int zSize,
                                           int dim,
                                           int numVectors,
                                           java.lang.String fDir,
                                           java.lang.String fName)
                                    throws java.io.IOException

Simple SOMLib Map description file writer, if you don't have a GrowingSOM object at hand, e.g. when converting maps.

Throws:

java.io.IOException

writeDataWinnerMappingFile

public static void writeDataWinnerMappingFile(GHSOM ghsom,
                                              InputData data,
                                              int numWinners,
                                              java.lang.String fDir,
                                              java.lang.String fName,
                                              boolean gzipped)
                                       throws java.io.IOException

Throws:

java.io.IOException

writeDataWinnerMappingFile

public static void writeDataWinnerMappingFile(GrowingSOM gsom,
                                              InputData data,
                                              int numWinners,
                                              java.lang.String fDir,
                                              java.lang.String fName,
                                              boolean gzipped)
                                       throws java.io.IOException

Throws:

java.io.IOException

writeDataWinnerMappingFile

public static void writeDataWinnerMappingFile(SOMLibDataWinnerMapping dwm,
                                              java.lang.String fDir,
                                              java.lang.String fName,
                                              boolean gzip)
                                       throws java.io.IOException

Throws:

java.io.IOException

getUnitDescriptionFileName

protected static java.lang.String getUnitDescriptionFileName(java.lang.String fDir,
                                                             java.lang.String fName,
                                                             java.lang.String idString,
                                                             boolean gzipped)

getWeightVectorFileName

protected static java.lang.String getWeightVectorFileName(java.lang.String fDir,
                                                          java.lang.String fName,
                                                          java.lang.String idString,
                                                          boolean gzipped)

getDataWinnerMappingFileName

protected static java.lang.String getDataWinnerMappingFileName(java.lang.String fDir,
                                                               java.lang.String fName,
                                                               java.lang.String idString,
                                                               boolean gzipped)

getMapDescriptionFileName

protected static java.lang.String getMapDescriptionFileName(java.lang.String fDir,
                                                            java.lang.String fName,
                                                            java.lang.String idString,
                                                            boolean gzipped)