DisplayWorld (Simbrain API)

java.lang.Object
- org.simbrain.world.textworld.TextWorld
- - org.simbrain.world.textworld.DisplayWorld

```
public class DisplayWorld
extends TextWorld
```
DisplayWorld intuitively models "speaking", though it can also be useful as a diagnostic component. Any time it's useful to see text output in Simbrain, a display world can be used. Numbers and vectors from (mainly) neural networks are converted into text that is displayed in the display world. Display world is used in conjunction with couplings (links between components in Simbrain), via consumers. When the workspace is updated, consumers are activated, and corresponding text is displayed. The display world can be thought of as containing a set of "buttons" (one for each consumer). When a given button is activated by a coupling, the corresponding text is displayed. As with reader world, there are scalar and vector attributes:
- Scalar: When the scalar coupling is activated, the associated token (character or word) is produced and displayed. Stored in the "token dictionary"
- Vector: When the vector coupling is activated, the associated token is produced and displayed. These vectors are specified in the "vector dictionary". When a vector comes in, the closest vector in the dictionary is found, and the corresponding token is displayed.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`DisplayWorld.StringDataPoint` Associates a datapoint object (basically a double vector that can be processed by the ntree) with a string.

Nested classes/interfaces inherited from class org.simbrain.world.textworld.TextWorld
TextWorld.TextItem

Field Summary
- Fields inherited from class org.simbrain.world.textworld.TextWorld
  tokenDictionary

Constructor Summary

Constructors
Constructor and Description

DisplayWorld()
Constructs an instance of TextWorld.

Constructors
Constructor and Description
`DisplayWorld()` Constructs an instance of TextWorld.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTextIfAboveThreshold(double value, java.lang.String string)` Add the provided text, if the provided value is above threshold.
`void`	`addVectorTokenPair(java.lang.String token, double[] vec)` Add an entry to the vector-token dictionary.
`void`	`displayClosestWord(double[] key)` Display the string associated with the closest matching vector in the dictionary.
`java.lang.String`	`getClosestWord(double[] key)` Finds the closest vector in terms of Euclidean distance, then returns the String associated with it.
`double`	`getDisplayThreshold()`
`NTree`	`getVectorToTokenDict()`
`(package private) static com.thoughtworks.xstream.XStream`	`getXStream()` Returns a properly initialized xstream object.
`void`	`loadVectorToTokenDict(java.lang.String[][] tableData)` Loads a new vector to token dictionary stored as a matrix of Strings.
`void`	`postOpenInit()` Initializes Dataset from persistent data.
`void`	`preSaveInit()` Initializes persistent data.
`protected java.lang.Object`	`readResolve()` Standard method call made to objects after they are deserialized.
`void`	`setDisplayThreshold(double displayThreshold)`
`void`	`update()` Advance the position in the text, and update the current item.

Methods inherited from class org.simbrain.world.textworld.TextWorld
addListener, addText, addWordToTokenDictionary, fireCurrentItemChanged, fireDictionaryChangedEvent, firePositionChangedEvent, firePrefsChangedEvent, fireTextChangedEvent, getCurrentItem, getHighlightColor, getLastPosition, getPosition, getText, getTokenDictionary, loadTokenDictionary, previewNextChar, removeListener, setCurrentItem, setHighlightColor, setPosition, setPosition, setText, setText

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DisplayWorld
```
public DisplayWorld()
```
    Constructs an instance of TextWorld.
- Method Detail
  - update
```
public void update()
```
    Description copied from class: TextWorld
    
    Advance the position in the text, and update the current item.
    
    Specified by:
    
    update in class TextWorld
  - getClosestWord
```
public java.lang.String getClosestWord(double[] key)
```
    Finds the closest vector in terms of Euclidean distance, then returns the String associated with it. Used by vector-based couplings. Separated from displayClosestWord(double[]) so it can be used in scripts.
    
    Parameters:
    
    key - the vector to check.
    
    Returns:
    
    the closest associated String
  - displayClosestWord
```
public void displayClosestWord(double[] key)
```
    Display the string associated with the closest matching vector in the dictionary. See getClosestWord(double[]).
    
    Parameters:
    
    key - the vector to use to search the dictionary.
  - addTextIfAboveThreshold
```
public void addTextIfAboveThreshold(double value,
                                    java.lang.String string)
```
    Add the provided text, if the provided value is above threshold. Called by consumers reading data from (e.g) neural networks. If node activation > threshold then display a particular word.
    
    Parameters:
    
    value - value to check against threshold
    
    string - text to add
  - getXStream
```
static com.thoughtworks.xstream.XStream getXStream()
```
    Returns a properly initialized xstream object.
    
    Returns:
    
    the XStream object
  - readResolve
```
protected java.lang.Object readResolve()
```
    Standard method call made to objects after they are deserialized. See: http://java.sun.com/developer/JDCTechTips/2002/tt0205.html#tip2 http://xstream.codehaus.org/faq.html
    
    Overrides:
    
    readResolve in class TextWorld
    
    Returns:
    
    Initialized object.
  - preSaveInit
```
public void preSaveInit()
```
    Initializes persistent data. Initializes Dataset from persistent data.
  - postOpenInit
```
public void postOpenInit()
```
    Initializes Dataset from persistent data.
  - getDisplayThreshold
```
public double getDisplayThreshold()
```
    Returns:
    
    the displayThreshold
  - setDisplayThreshold
```
public void setDisplayThreshold(double displayThreshold)
```
    Parameters:
    
    displayThreshold - the displayThreshold to set
  - getVectorToTokenDict
```
public NTree getVectorToTokenDict()
```
    Returns:
    
    the vectorToTokenDict
  - loadVectorToTokenDict
```
public void loadVectorToTokenDict(java.lang.String[][] tableData)
```
    Loads a new vector to token dictionary stored as a matrix of Strings. Assumes the length of the first entry is the same as that of all following entries.
    
    Parameters:
    
    tableData - the string matrix encoding the dictionary.
  - addVectorTokenPair
```
public void addVectorTokenPair(java.lang.String token,
                               double[] vec)
```
    Add an entry to the vector-token dictionary.
    
    Parameters:
    
    token - the String to add
    
    vec - the vector

Class DisplayWorld

Nested Class Summary

Nested classes/interfaces inherited from class org.simbrain.world.textworld.TextWorld

Field Summary

Fields inherited from class org.simbrain.world.textworld.TextWorld

Constructor Summary

Method Summary

Methods inherited from class org.simbrain.world.textworld.TextWorld

Methods inherited from class java.lang.Object

Constructor Detail

DisplayWorld

Method Detail

update

getClosestWord

displayClosestWord

addTextIfAboveThreshold

getXStream

readResolve

preSaveInit

postOpenInit

getDisplayThreshold

setDisplayThreshold

getVectorToTokenDict

loadVectorToTokenDict

addVectorTokenPair