comirva.config
Class GHSOMConfig

java.lang.Object
  comirva.config.GHSOMConfig

Direct Known Subclasses:

GHSOMDefaultConfig

public class GHSOMConfig
extends Object

This class represents a configuration for a GHSOM-Calculation. It is used to pass a configuration to the GHSOM-instance.

Constructor Summary

GHSOMConfig(int mapUnitsInRow, int mapUnitsInColumn, int initMethod, int trainingLength, double growThreshold, double expandThreshold, int maxSize, int maxDepth, boolean circular, boolean onlyFirstCircular, boolean orientated)
Creates a new instance of a GHSOM-Configuration.

Method Summary

double	getExpandThreshold() Returns the threshold which decides when to expand a map unit.
double	getGrowThreshold() Returns the threshold which decides when a map has to grow.
int	getInitMethod() Returns the method used for initializing the codebook of the SOM.
int	getMapUnitsInColumn() Returns the number of map units in each column.
int	getMapUnitsInRow() Returns the number of map units in each row.
int	getMaxDepth()
int	getMaxSize()
int	getTrainingLength() Returns the training length in epochs.
boolean	isCircular()
boolean	isOnlyFirstCircular()
boolean	isOrientated()
void	setCircular(boolean circular)
void	setMaxDepth(int maxDepth)
void	setMaxSize(int maxSize)
void	setOnlyFirstCircular(boolean onlyFirstCircular)
void	setOrientated(boolean orientated)

Methods inherited from class java.lang.Object

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

Constructor Detail

GHSOMConfig

public GHSOMConfig(int mapUnitsInRow,
                   int mapUnitsInColumn,
                   int initMethod,
                   int trainingLength,
                   double growThreshold,
                   double expandThreshold,
                   int maxSize,
                   int maxDepth,
                   boolean circular,
                   boolean onlyFirstCircular,
                   boolean orientated)

Creates a new instance of a GHSOM-Configuration.

Parameters:

mapUnitsInRow - the number of map units in each row

mapUnitsInColumn - the number of map units in each column

initMethod - the initialization method SOM

trainingLength - the training length in epochs (1 epoch = number of iterations equals number of data items)

See Also:

GHSOM

Method Detail

getMapUnitsInRow

public int getMapUnitsInRow()

Returns the number of map units in each row.

Returns:

the number of map units in each row

getMapUnitsInColumn

public int getMapUnitsInColumn()

Returns the number of map units in each column.

Returns:

the number of map units in each column

getInitMethod

public int getInitMethod()

Returns the method used for initializing the codebook of the SOM.

Returns:

an int indicating the initialization method (for a list, see @link comirva.mlearn.SOM)

See Also:

SOM

getTrainingLength

public int getTrainingLength()

Returns the training length in epochs.

Returns:

the number of epochs the training is performed

getExpandThreshold

public double getExpandThreshold()

Returns the threshold which decides when to expand a map unit.

Returns:

the threshold which decides when to expand a map unit

getGrowThreshold

public double getGrowThreshold()

Returns the threshold which decides when a map has to grow.

Returns:

the threshold which decides when a map has to grow

isCircular

public boolean isCircular()

setCircular

public void setCircular(boolean circular)

getMaxDepth

public int getMaxDepth()

setMaxDepth

public void setMaxDepth(int maxDepth)

getMaxSize

public int getMaxSize()

setMaxSize

public void setMaxSize(int maxSize)

isOnlyFirstCircular

public boolean isOnlyFirstCircular()

setOnlyFirstCircular

public void setOnlyFirstCircular(boolean onlyFirstCircular)

isOrientated

public boolean isOrientated()

setOrientated

public void setOrientated(boolean orientated)