|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.Dictionary<K,V>
java.util.Hashtable<Object,Object>
java.util.Properties
at.tuwien.ifs.somtoolbox.properties.SOMProperties
public class SOMProperties
Properties for SOM training.
Nested Class Summary | |
---|---|
class |
SOMProperties.DatumToUnitMapping
|
Field Summary | |
---|---|
private double[] |
adaptiveCoordinatesThreshold
|
private boolean |
batchSom
|
private String |
classInfoFileName
|
private Vector<SOMProperties.DatumToUnitMapping> |
datumToUnitMappings
|
private static String |
DEFAULT_METRIC_NAME
|
static double |
defaultLearnRate
|
private int |
dumpEvery
|
private Layer.GridLayout |
gridLayout
|
private Layer.GridTopology |
gridTopology
|
private String |
growthQualityMeasureName
|
private double |
learnrate
|
private static String |
METRIC_PACKAGE
|
private String |
metricName
|
private int |
minimumFeatureDensity
|
static int |
MODE_EXCEPT
|
static int |
MODE_FAVOUR
|
static int |
MODE_NORMAL
|
private int |
neighbourWidth
|
private int |
numCycles
|
private int |
numIterations
|
static String |
propertiesFileNameSuffix
|
private long |
randomSeed
|
private ArrayList<String> |
selectedClasses
|
private int |
selectedClassMode
|
private static long |
serialVersionUID
|
private double |
sigma
|
private double |
tau
|
private boolean |
usePCA
|
static String |
WORKING_DIRECTORY
|
private int |
xSize
|
private int |
ySize
|
private int |
zSize
|
Fields inherited from class java.util.Properties |
---|
defaults |
Constructor Summary | |
---|---|
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,
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,
String metric,
boolean usePCA)
|
|
SOMProperties(int xSize,
int ySize,
long seed,
int numCycles,
int numIterations,
double learnrate,
double sigma,
double tau,
String metricName,
boolean usePCA)
|
|
SOMProperties(Properties properties)
|
|
SOMProperties(String fname)
Loads and encapsulated properties for the SOM training process. |
Method Summary | |
---|---|
double[] |
adaptiveCoordinatesTreshold()
|
boolean |
batchSom()
Returns the batch_som status. |
Vector<SOMProperties.DatumToUnitMapping> |
datumToUnitMappings()
|
String |
getClassInfoFileName()
|
int |
getDumpEvery()
Default = -1 --> do not dump. |
Layer.GridLayout |
getGridLayout()
|
Layer.GridTopology |
getGridTopology()
|
int |
getMinimumFeatureDensity()
|
ArrayList<String> |
getSelectedClasses()
Returns an ArrayList of Strings containing the class names which should be excluded from training. |
int |
getSelectedClassMode()
|
String |
growthQualityMeasureName()
Returns the name of the used quality measure. |
double |
learnrate()
Returns the learnrate. |
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. |
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(String dataName,
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, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String WORKING_DIRECTORY
private static final String DEFAULT_METRIC_NAME
private static final String METRIC_PACKAGE
public static final double defaultLearnRate
public static final String propertiesFileNameSuffix
private static final long serialVersionUID
private boolean batchSom
private int neighbourWidth
private double learnrate
private String metricName
private String growthQualityMeasureName
private int numCycles
private int numIterations
private int dumpEvery
private long randomSeed
private double sigma
private double tau
private int xSize
private int ySize
private int zSize
private Layer.GridTopology gridTopology
private Layer.GridLayout gridLayout
private boolean usePCA
private Vector<SOMProperties.DatumToUnitMapping> datumToUnitMappings
private ArrayList<String> selectedClasses
private String classInfoFileName
private int selectedClassMode
private int minimumFeatureDensity
private double[] adaptiveCoordinatesThreshold
public static final int MODE_NORMAL
public static final int MODE_EXCEPT
public static final int MODE_FAVOUR
Constructor Detail |
---|
public SOMProperties(int xSize, int ySize, int zSize, long seed, int trainingCycles, int trainingIterations, int dumpEvery, double lernrate, double sigma, double tau, String metric, boolean usePCA) throws PropertiesException
PropertiesException
public SOMProperties(int xSize, int ySize, int zSize, long seed, int trainingCycles, int trainingIterations, double lernrate, double sigma, double tau, String metric, boolean usePCA) throws PropertiesException
PropertiesException
public SOMProperties(int xSize, int ySize, int numIterations, double lernrate) throws PropertiesException
PropertiesException
public SOMProperties(int xSize, int ySize, long seed, int numCycles, int numIterations, double learnrate, double sigma, double tau, String metricName, boolean usePCA) throws PropertiesException
PropertiesException
public SOMProperties(String fname) throws PropertiesException
fname
- name of the properties file.
PropertiesException
- thrown if properties file could not be opened or the values of the properties are
illegal.public SOMProperties(Properties properties) throws PropertiesException
PropertiesException
Method Detail |
---|
public int getDumpEvery()
private void parse() throws PropertiesException
PropertiesException
private void validatePropertyValues() throws PropertiesException
PropertiesException
public ArrayList<String> getSelectedClasses()
public int getSelectedClassMode()
public String getClassInfoFileName()
public boolean batchSom()
public int neighbourWidth()
public double learnrate()
public String metricName()
public String growthQualityMeasureName()
public int numCycles()
public int numIterations()
public int trainedIterations(int numVectors)
numIterations
or numCycles
,
whichever value is set.
public long randomSeed()
public double sigma()
public double tau()
public int xSize()
public int ySize()
public int zSize()
public int getMinimumFeatureDensity()
public boolean pca()
public Layer.GridTopology getGridTopology()
public Layer.GridLayout getGridLayout()
public Vector<SOMProperties.DatumToUnitMapping> datumToUnitMappings()
public void writeToFile(String dataName, String outputDir, boolean normalised) throws IOException
IOException
public double[] adaptiveCoordinatesTreshold()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |