org.wandora.application.tools.som

Class SOMClassifier

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.som.SOMClassifier

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, WandoraTool, WandoraToolLogger, TopicMapLogger

public class SOMClassifier
extends AbstractWandoraTool
implements WandoraTool

Creates a Self Organized Map (SOM) using given associations. SOM is a 2D matrix visualization of given association player topics where similar topics i.e. topics with similar associations locate near each other. Tool is able to group similar topics.

This class is strictly speaking the a train vector builder while the actual SOM implementation locates in class SOMMap.

About train vector building: Lets say user has selected eight binary associations a-q, a-e, a-t, b-e, b-l, c-q, c-o, and d-e. User selects first player as the grouping role. Training vectors for this setting are:

a: [ q=1, e=1, t=1, l=0, o=0 ]
b: [ q=0, e=1, t=0, l=1, o=0 ]
c: [ q=1, e=0, t=1, l=0, o=1 ]
d: [ q=0, e=1, t=0, l=0, o=0 ]

in other words:
a: [ 1, 1, 1, 0, 0 ]
b: [ 0, 1, 0, 1, 0 ]
c: [ 1, 0, 1, 0, 1 ]
d: [ 0, 1, 0, 0, 0 ]

One should note SOM gives best results if vectors are NOT orthogonal.

Read more about Self Organizing Maps here: http://en.wikipedia.org/wiki/Self-organizing_map

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
SOMClassifier(Context preferredContext)

Method Summary

Modifier and Type	Method and Description
private java.util.HashMap<Topic,java.util.Set>	buildInputSets(Wandora admin, Topic groupingRole, java.util.Iterator<Association> associations)
private java.util.HashMap<Topic,SOMVector>	buildInputVectors(java.util.HashMap<Topic,java.util.Set> inputSets)
void	execute(Wandora wandora, Context context) Runs the tool.
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
private java.util.Set<Topic>	getRolesFrom(java.util.Iterator<Association> associations)
SOMVector	topicVector2SOMVector(Topic[] topicVector)

Methods inherited from class org.wandora.application.tools.AbstractWandoraTool

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, configure, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getIcon, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, getType, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isConfigurable, isRunning, isRunning, lockLog, log, log, log, log, requiresRefresh, run, runInOwnThread, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap, writeOptions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wandora.application.WandoraTool

configure, execute, execute, getContext, getIcon, getToolMenuItem, getType, hlog, initialize, isConfigurable, isRunning, log, log, log, log, requiresRefresh, setContext, setToolLogger, writeOptions

Methods inherited from interface org.wandora.application.WandoraToolLogger

forceStop, getHistory, getState, lockLog, setLogTitle, setProgress, setProgressMax, setState

Constructor Detail

SOMClassifier

public SOMClassifier(Context preferredContext)

Method Detail

getName

public java.lang.String getName()

Description copied from class: AbstractWandoraTool

Tools name represent the tool in UI unless the tool has been given explicitly another GUI name. All tools should override this method and return a valid string representing name of the tool.

Specified by:

getName in interface WandoraTool

Overrides:

getName in class AbstractWandoraTool

Returns:

String representing tool's name.

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractWandoraTool

AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu. By default description equals the tool name. All tools should override this method.

Specified by:

getDescription in interface WandoraTool

Overrides:

getDescription in class AbstractWandoraTool

Returns:

String representing tool's description.

execute

public void execute(Wandora wandora,
                    Context context)

Description copied from interface: WandoraTool

Runs the tool. This is the main entry to the tool. Here the context

Specified by:

execute in interface WandoraTool

getRolesFrom

private java.util.Set<Topic> getRolesFrom(java.util.Iterator<Association> associations)
                                   throws TopicMapException

Throws:

TopicMapException

buildInputSets

private java.util.HashMap<Topic,java.util.Set> buildInputSets(Wandora admin,
                                                              Topic groupingRole,
                                                              java.util.Iterator<Association> associations)

buildInputVectors

private java.util.HashMap<Topic,SOMVector> buildInputVectors(java.util.HashMap<Topic,java.util.Set> inputSets)

topicVector2SOMVector

public SOMVector topicVector2SOMVector(Topic[] topicVector)