at.tuwien.ifs.somtoolbox.properties

Class SOMProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

at.tuwien.ifs.somtoolbox.properties.SOMProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

Direct Known Subclasses:

GHSOMProperties

public class SOMProperties
extends java.util.Properties

Properties for SOM training.

Version:

$Id: SOMProperties.java 4327 2014-12-29 21:48:43Z mayer $

Author:

Michael Dittenbach, Rudolf Mayer

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SOMProperties.DatumToUnitMapping
static class	SOMProperties.SelectedClassMode

Field Summary

Fields

Modifier and Type	Field and Description
private double[]	adaptiveCoordinatesThreshold
private boolean	batchSom
private java.lang.String	classInfoFileName
private java.util.Vector<SOMProperties.DatumToUnitMapping>	datumToUnitMappings
static double	defaultLearnRate
private int	dumpEvery TODO: move to FileProperties
private Layer.GridLayout	gridLayout
private Layer.GridTopology	gridTopology
private java.lang.String	growthQualityMeasureName
private double	learnrate
private static java.lang.String	METRIC_PACKAGE
private java.lang.String	metricName
private int	minimumFeatureDensity
private int	neighbourWidth
private int	numCycles
private int	numIterations
static com.martiansoftware.jsap.FlaggedOption	OPTION_ADAPTIVE_COORDINATES_THRESHOLD
static com.martiansoftware.jsap.FlaggedOption	OPTION_BATCH_SOM
static com.martiansoftware.jsap.FlaggedOption	OPTION_BATCH_SOM_NEIGHBOUR_WIDTH
static com.martiansoftware.jsap.FlaggedOption	OPTION_CLASS_SELECTION_MODE
static com.martiansoftware.jsap.FlaggedOption	OPTION_CLASSES_SELECTED
static com.martiansoftware.jsap.FlaggedOption	OPTION_CLASSINFOFILE
static com.martiansoftware.jsap.FlaggedOption	OPTION_DATUM_TO_UNIT_MAPPING
static com.martiansoftware.jsap.FlaggedOption	OPTION_DUMP_EVERY
static com.martiansoftware.jsap.FlaggedOption	OPTION_GRID_LAYOUT
static com.martiansoftware.jsap.FlaggedOption	OPTION_GRID_TOPOLOGY
static com.martiansoftware.jsap.FlaggedOption	OPTION_GROWTH_QUALITY
static com.martiansoftware.jsap.FlaggedOption	OPTION_LEARNRATE
static com.martiansoftware.jsap.FlaggedOption	OPTION_METRIC_NAME
static com.martiansoftware.jsap.FlaggedOption	OPTION_MINIMUM_FEATURE_DENSITY
static com.martiansoftware.jsap.FlaggedOption	OPTION_NUM_CYCLES
static com.martiansoftware.jsap.FlaggedOption	OPTION_NUM_ITERATIONS
static com.martiansoftware.jsap.FlaggedOption	OPTION_SIGMA
static com.martiansoftware.jsap.FlaggedOption	OPTION_TAU
static com.martiansoftware.jsap.FlaggedOption	OPTION_USE_PCA
static com.martiansoftware.jsap.FlaggedOption	OPTION_XSIZE
static com.martiansoftware.jsap.FlaggedOption	OPTION_YSIZE
static com.martiansoftware.jsap.FlaggedOption	OPTION_ZSIZE
static java.lang.String	propertiesFileNameSuffix
static java.lang.String	QUALITY_PACKAGE
private long	randomSeed
private java.util.ArrayList<java.lang.String>	selectedClasses
private SOMProperties.SelectedClassMode	selectedClassMode
private static long	serialVersionUID
private double	sigma
static com.martiansoftware.jsap.FlaggedOption[]	SOM_BATCH_OPTIONS
static com.martiansoftware.jsap.FlaggedOption[]	SOM_GRID_OPTIONS
static com.martiansoftware.jsap.FlaggedOption[]	SOM_OTHERS
static com.martiansoftware.jsap.FlaggedOption[]	SOM_TRAINING_OPTIONS
private double	tau
private boolean	usePCA
static java.lang.String	WORKING_DIRECTORY
private int	xSize
private int	ySize
private int	zSize

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
SOMProperties(int xSize, int ySize, int numIterations, double lernrate)
SOMProperties(int xSize, int ySize, int zSize, long seed, int trainingCycles, int trainingIterations, double lernrate, double sigma, double tau, java.lang.String metric, boolean usePCA)
SOMProperties(int xSize, int ySize, int zSize, long seed, int trainingCycles, int trainingIterations, int dumpEvery, double lernrate, double sigma, double tau, java.lang.String metric, boolean usePCA)
SOMProperties(int xSize, int ySize, long seed, int numCycles, int numIterations, double learnrate, double sigma, double tau, java.lang.String metricName, boolean usePCA)
SOMProperties(java.util.Properties properties)
SOMProperties(java.lang.String fname) Loads and encapsulated properties for the SOM training process.

Method Summary

Modifier and Type	Method and Description
double[]	adaptiveCoordinatesTreshold()
boolean	batchSom() Returns the batch_som status.
java.util.Vector<SOMProperties.DatumToUnitMapping>	datumToUnitMappings()
java.lang.String	getClassInfoFileName()
int	getDumpEvery() Default = -1 --> do not dump.
Layer.GridLayout	getGridLayout()
Layer.GridTopology	getGridTopology()
int	getMinimumFeatureDensity()
private java.lang.String	getPropertyAndLog(java.lang.String key, java.lang.String defaultValue)
java.util.ArrayList<java.lang.String>	getSelectedClasses() Returns an ArrayList of Strings containing the class names which should be excluded from training.
SOMProperties.SelectedClassMode	getSelectedClassMode()
java.lang.String	growthQualityMeasureName() Returns the name of the used quality measure.
double	learnrate() Returns the learnrate.
java.lang.String	metricName() Returns the name of the used metric.
int	neighbourWidth() Returns the neighbour_width.
int	numCycles() Returns the number of training cycles.
int	numIterations() Returns the number of training iterations.
private void	parse()
boolean	pca()
long	randomSeed() Returns the random seed. FIXME: this is a duplicate to FileProperties.randomSeed()
double	sigma() Returns sigma determining the neighbourhood radius.
double	tau() Returns tau determining the desired data representation granularity.
int	trainedIterations(int numVectors) Return the number of iterations really trained, either using numIterations or numCycles, whichever value is set.
private void	validatePropertyValues()
void	writeToFile(java.lang.String dataName, java.lang.String outputDir, boolean normalised) Writes the properties to a file.
int	xSize() Returns the number of units in horizontal direction.
int	ySize() Returns the number of units in vertical direction.
int	zSize() Returns the number of units in z-direction.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OPTION_XSIZE

public static final com.martiansoftware.jsap.FlaggedOption OPTION_XSIZE

OPTION_YSIZE

public static final com.martiansoftware.jsap.FlaggedOption OPTION_YSIZE

OPTION_ZSIZE

public static final com.martiansoftware.jsap.FlaggedOption OPTION_ZSIZE

OPTION_LEARNRATE

public static final com.martiansoftware.jsap.FlaggedOption OPTION_LEARNRATE

OPTION_SIGMA

public static final com.martiansoftware.jsap.FlaggedOption OPTION_SIGMA

OPTION_NUM_ITERATIONS

public static final com.martiansoftware.jsap.FlaggedOption OPTION_NUM_ITERATIONS

OPTION_NUM_CYCLES

public static final com.martiansoftware.jsap.FlaggedOption OPTION_NUM_CYCLES

OPTION_METRIC_NAME

public static final com.martiansoftware.jsap.FlaggedOption OPTION_METRIC_NAME

OPTION_TAU

public static final com.martiansoftware.jsap.FlaggedOption OPTION_TAU

OPTION_GROWTH_QUALITY

public static final com.martiansoftware.jsap.FlaggedOption OPTION_GROWTH_QUALITY

SOM_TRAINING_OPTIONS

public static final com.martiansoftware.jsap.FlaggedOption[] SOM_TRAINING_OPTIONS

OPTION_BATCH_SOM

public static final com.martiansoftware.jsap.FlaggedOption OPTION_BATCH_SOM

OPTION_BATCH_SOM_NEIGHBOUR_WIDTH

public static final com.martiansoftware.jsap.FlaggedOption OPTION_BATCH_SOM_NEIGHBOUR_WIDTH

SOM_BATCH_OPTIONS

public static final com.martiansoftware.jsap.FlaggedOption[] SOM_BATCH_OPTIONS

OPTION_USE_PCA

public static final com.martiansoftware.jsap.FlaggedOption OPTION_USE_PCA

OPTION_DUMP_EVERY

public static final com.martiansoftware.jsap.FlaggedOption OPTION_DUMP_EVERY

OPTION_ADAPTIVE_COORDINATES_THRESHOLD

public static final com.martiansoftware.jsap.FlaggedOption OPTION_ADAPTIVE_COORDINATES_THRESHOLD

OPTION_MINIMUM_FEATURE_DENSITY

public static final com.martiansoftware.jsap.FlaggedOption OPTION_MINIMUM_FEATURE_DENSITY

OPTION_DATUM_TO_UNIT_MAPPING

public static final com.martiansoftware.jsap.FlaggedOption OPTION_DATUM_TO_UNIT_MAPPING

OPTION_CLASS_SELECTION_MODE

public static final com.martiansoftware.jsap.FlaggedOption OPTION_CLASS_SELECTION_MODE

OPTION_CLASSES_SELECTED

public static final com.martiansoftware.jsap.FlaggedOption OPTION_CLASSES_SELECTED

OPTION_CLASSINFOFILE

public static final com.martiansoftware.jsap.FlaggedOption OPTION_CLASSINFOFILE

SOM_OTHERS

public static final com.martiansoftware.jsap.FlaggedOption[] SOM_OTHERS

OPTION_GRID_LAYOUT

public static final com.martiansoftware.jsap.FlaggedOption OPTION_GRID_LAYOUT

OPTION_GRID_TOPOLOGY

public static final com.martiansoftware.jsap.FlaggedOption OPTION_GRID_TOPOLOGY

SOM_GRID_OPTIONS

public static final com.martiansoftware.jsap.FlaggedOption[] SOM_GRID_OPTIONS

WORKING_DIRECTORY

public static final java.lang.String WORKING_DIRECTORY

METRIC_PACKAGE

private static final java.lang.String METRIC_PACKAGE

QUALITY_PACKAGE

public static final java.lang.String QUALITY_PACKAGE

defaultLearnRate

public static final double defaultLearnRate

propertiesFileNameSuffix

public static final java.lang.String propertiesFileNameSuffix

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

batchSom

private boolean batchSom

neighbourWidth

private int neighbourWidth

learnrate

private double learnrate

metricName

private java.lang.String metricName

growthQualityMeasureName

private java.lang.String growthQualityMeasureName

numCycles

private int numCycles

numIterations

private int numIterations

dumpEvery

private int dumpEvery

TODO: move to FileProperties

randomSeed

private long randomSeed

sigma

private double sigma

tau

private double tau

xSize

private int xSize

ySize

private int ySize

zSize

private int zSize

gridTopology

private Layer.GridTopology gridTopology

gridLayout

private Layer.GridLayout gridLayout

usePCA

private boolean usePCA

datumToUnitMappings

private java.util.Vector<SOMProperties.DatumToUnitMapping> datumToUnitMappings

selectedClasses

private java.util.ArrayList<java.lang.String> selectedClasses

classInfoFileName

private java.lang.String classInfoFileName

selectedClassMode

private SOMProperties.SelectedClassMode selectedClassMode

minimumFeatureDensity

private int minimumFeatureDensity

adaptiveCoordinatesThreshold

private double[] adaptiveCoordinatesThreshold

Constructor Detail

SOMProperties

public SOMProperties(int xSize,
                     int ySize,
                     int zSize,
                     long seed,
                     int trainingCycles,
                     int trainingIterations,
                     int dumpEvery,
                     double lernrate,
                     double sigma,
                     double tau,
                     java.lang.String metric,
                     boolean usePCA)
              throws PropertiesException

Throws:

PropertiesException

SOMProperties

public SOMProperties(int xSize,
                     int ySize,
                     int zSize,
                     long seed,
                     int trainingCycles,
                     int trainingIterations,
                     double lernrate,
                     double sigma,
                     double tau,
                     java.lang.String metric,
                     boolean usePCA)
              throws PropertiesException

Throws:

PropertiesException

SOMProperties

public SOMProperties(int xSize,
                     int ySize,
                     int numIterations,
                     double lernrate)
              throws PropertiesException

Throws:

PropertiesException

SOMProperties

public SOMProperties(int xSize,
                     int ySize,
                     long seed,
                     int numCycles,
                     int numIterations,
                     double learnrate,
                     double sigma,
                     double tau,
                     java.lang.String metricName,
                     boolean usePCA)
              throws PropertiesException

Throws:

PropertiesException

SOMProperties

public SOMProperties(java.lang.String fname)
              throws PropertiesException

Loads and encapsulated properties for the SOM training process.

Parameters:

fname - name of the properties file.

Throws:

PropertiesException - thrown if properties file could not be opened or the values of the properties are illegal.

SOMProperties

public SOMProperties(java.util.Properties properties)
              throws PropertiesException

Throws:

PropertiesException

Method Detail

getDumpEvery

public int getDumpEvery()

Default = -1 --> do not dump.

Returns:

iteration % dumpEvery == 0 --> dump

parse

private void parse()
            throws PropertiesException

Throws:

PropertiesException

getPropertyAndLog

private java.lang.String getPropertyAndLog(java.lang.String key,
                                           java.lang.String defaultValue)

validatePropertyValues

private void validatePropertyValues()
                             throws PropertiesException

Throws:

PropertiesException

getSelectedClasses

public java.util.ArrayList<java.lang.String> getSelectedClasses()

Returns an ArrayList of Strings containing the class names which should be excluded from training.

Returns:

classes to be excluded from the training

getSelectedClassMode

public SOMProperties.SelectedClassMode getSelectedClassMode()

getClassInfoFileName

public java.lang.String getClassInfoFileName()

batchSom

public boolean batchSom()

Returns the batch_som status.

Returns:

the batch_som status.

neighbourWidth

public int neighbourWidth()

Returns the neighbour_width.

Returns:

the neighbour_width.

learnrate

public double learnrate()

Returns the learnrate.

Returns:

the learnrate.

metricName

public java.lang.String metricName()

Returns the name of the used metric.

Returns:

the name of the used metric.

growthQualityMeasureName

public java.lang.String growthQualityMeasureName()

Returns the name of the used quality measure.

Returns:

the name of the used quality measure.

numCycles

public int numCycles()

Returns the number of training cycles.

Returns:

the number of training cycles.

numIterations

public int numIterations()

Returns the number of training iterations.

Returns:

the number of training iterations.

trainedIterations

public int trainedIterations(int numVectors)

Return the number of iterations really trained, either using numIterations or numCycles, whichever value is set.

randomSeed

public long randomSeed()

Returns the random seed.
FIXME: this is a duplicate to FileProperties.randomSeed()

Returns:

the random seed.

sigma

public double sigma()

Returns sigma determining the neighbourhood radius.

Returns:

sigma determining the neighbourhood radius.

tau

public double tau()

Returns tau determining the desired data representation granularity.

Returns:

tau determining the desired data representation granularity.

xSize

public int xSize()

Returns the number of units in horizontal direction.

Returns:

the number of units in horizontal direction.

ySize

public int ySize()

Returns the number of units in vertical direction.

Returns:

the number of units in vertical direction.

zSize

public int zSize()

Returns the number of units in z-direction. Default is 1

Returns:

the number of units in z-direction. Default is 1

getMinimumFeatureDensity

public int getMinimumFeatureDensity()

pca

public boolean pca()

getGridTopology

public Layer.GridTopology getGridTopology()

getGridLayout

public Layer.GridLayout getGridLayout()

datumToUnitMappings

public java.util.Vector<SOMProperties.DatumToUnitMapping> datumToUnitMappings()

writeToFile

public void writeToFile(java.lang.String dataName,
                        java.lang.String outputDir,
                        boolean normalised)
                 throws java.io.IOException

Writes the properties to a file.

Throws:

java.io.IOException

adaptiveCoordinatesTreshold

public double[] adaptiveCoordinatesTreshold()