Class: PhraseMaker

PhraseMaker

XMM compatible phrase builder utility
Class to ease the creation of XMM compatible data recordings, aka phrases.
Phrases are typically arrays (flattened matrices) of size N * M, N being the size of a vector element, and M the length of the phrase itself, wrapped together in an object with a few settings.

Constructor

new PhraseMaker(options)

Parameters:
Name Type Description
options xmmPhraseConfig

Default phrase configuration.

Source:

Methods

addObservation(obs)

Append an observation vector to the phrase's data. Must be of length dimension.

Parameters:
Name Type Description
obs Array.Number

An input vector, aka observation. If bimodal is true

Source:
Throws:

Will throw an error if the input vector doesn't match the config.

getConfig() → {xmmPhraseConfig}

Returns the current configuration.

Source:
Returns:
Type
xmmPhraseConfig

getPhrase() → {xmmPhrase}

Returns a valid XMM phrase created from the config and the recorded data.

Source:
Returns:
Type
xmmPhrase

reset()

Clear the phrase's data so that a new one is ready to be recorded.

Source:

setConfig(options)

Updates the current configuration with the provided information.

Parameters:
Name Type Description
options xmmPhraseConfig
Source: