edu.cmu.sphinx.instrumentation
Class AccuracyTracker

java.lang.Object
  extended byedu.cmu.sphinx.instrumentation.AccuracyTracker
All Implemented Interfaces:
Configurable, java.util.EventListener, Resetable, ResultListener, StateListener

public class AccuracyTracker
extends java.lang.Object
implements Configurable, ResultListener, Resetable, StateListener

Tracks and reports recognition accuracy


Field Summary
static java.lang.String PROP_RECOGNIZER
          A Sphinx property that defines which recognizer to monitor
static java.lang.String PROP_SHOW_ALIGNED_RESULTS
          A sphinx property that define whether recognition results should be displayed.
static boolean PROP_SHOW_ALIGNED_RESULTS_DEFAULT
          The default setting of PROP_SHOW_ALIGNED_RESULTS
static java.lang.String PROP_SHOW_DETAILS
          A sphinx property that define whether detailed accuracy information is displayed
static boolean PROP_SHOW_DETAILS_DEFAULT
          The default setting of PROP_SHOW_DETAILS
static java.lang.String PROP_SHOW_FULL_PATH
          A sphinx property that define whether the full token path is displayed
static boolean PROP_SHOW_FULL_PATH_DEFAULT
          The default setting of PROP_SHOW_FULL_PATH
static java.lang.String PROP_SHOW_RAW_RESULTS
          A sphinx property that define whether recognition results should be displayed.
static boolean PROP_SHOW_RAW_RESULTS_DEFAULT
          The default setting of PROP_SHOW_RAW_RESULTS
static java.lang.String PROP_SHOW_RESULTS
          A sphinx property that define whether recognition results should be displayed.
static boolean PROP_SHOW_RESULTS_DEFAULT
          The default setting of PROP_SHOW_DETAILS
static java.lang.String PROP_SHOW_SUMMARY
          A sphinx property that define whether summary accuracy information is displayed
static boolean PROP_SHOW_SUMMARY_DEFAULT
          The default setting of PROP_SHOW_SUMMARY
 
Constructor Summary
AccuracyTracker()
           
 
Method Summary
 NISTAlign getAligner()
          Retrieves the aligner used to track the accuracy stats
 java.lang.String getName()
          Retrieves the name for this configurable component
 void newProperties(PropertySheet ps)
          This method is called when this configurable component has new data.
 void newResult(Result result)
          Method called when a new result is generated
 void register(java.lang.String name, Registry registry)
          Register my properties.
 void reset()
          Resets this component.
 void statusChanged(RecognizerState status)
          Called when the status has changed.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROP_RECOGNIZER

public static final java.lang.String PROP_RECOGNIZER
A Sphinx property that defines which recognizer to monitor

See Also:
Constant Field Values

PROP_SHOW_SUMMARY

public static final java.lang.String PROP_SHOW_SUMMARY
A sphinx property that define whether summary accuracy information is displayed

See Also:
Constant Field Values

PROP_SHOW_SUMMARY_DEFAULT

public static final boolean PROP_SHOW_SUMMARY_DEFAULT
The default setting of PROP_SHOW_SUMMARY

See Also:
Constant Field Values

PROP_SHOW_DETAILS

public static final java.lang.String PROP_SHOW_DETAILS
A sphinx property that define whether detailed accuracy information is displayed

See Also:
Constant Field Values

PROP_SHOW_DETAILS_DEFAULT

public static final boolean PROP_SHOW_DETAILS_DEFAULT
The default setting of PROP_SHOW_DETAILS

See Also:
Constant Field Values

PROP_SHOW_FULL_PATH

public static final java.lang.String PROP_SHOW_FULL_PATH
A sphinx property that define whether the full token path is displayed

See Also:
Constant Field Values

PROP_SHOW_FULL_PATH_DEFAULT

public static final boolean PROP_SHOW_FULL_PATH_DEFAULT
The default setting of PROP_SHOW_FULL_PATH

See Also:
Constant Field Values

PROP_SHOW_RESULTS

public static final java.lang.String PROP_SHOW_RESULTS
A sphinx property that define whether recognition results should be displayed.

See Also:
Constant Field Values

PROP_SHOW_RESULTS_DEFAULT

public static final boolean PROP_SHOW_RESULTS_DEFAULT
The default setting of PROP_SHOW_DETAILS

See Also:
Constant Field Values

PROP_SHOW_ALIGNED_RESULTS

public static final java.lang.String PROP_SHOW_ALIGNED_RESULTS
A sphinx property that define whether recognition results should be displayed.

See Also:
Constant Field Values

PROP_SHOW_ALIGNED_RESULTS_DEFAULT

public static final boolean PROP_SHOW_ALIGNED_RESULTS_DEFAULT
The default setting of PROP_SHOW_ALIGNED_RESULTS

See Also:
Constant Field Values

PROP_SHOW_RAW_RESULTS

public static final java.lang.String PROP_SHOW_RAW_RESULTS
A sphinx property that define whether recognition results should be displayed.

See Also:
Constant Field Values

PROP_SHOW_RAW_RESULTS_DEFAULT

public static final boolean PROP_SHOW_RAW_RESULTS_DEFAULT
The default setting of PROP_SHOW_RAW_RESULTS

See Also:
Constant Field Values
Constructor Detail

AccuracyTracker

public AccuracyTracker()
Method Detail

register

public void register(java.lang.String name,
                     Registry registry)
              throws PropertyException
Description copied from interface: Configurable
Register my properties. This method is called once early in the time of the component, shortly after the component is constructed. This component should register any configuration properties that it needs to register. If this configurable extends another configurable, super.register should also be called

Specified by:
register in interface Configurable
Parameters:
name - the name of the component
registry - the registry for this component
Throws:
PropertyException

newProperties

public void newProperties(PropertySheet ps)
                   throws PropertyException
Description copied from interface: Configurable
This method is called when this configurable component has new data. The component should first validate the data. If it is bad the component should return false. If the data is good, the component should record the the data internally and return true.

Specified by:
newProperties in interface Configurable
Parameters:
ps - a property sheet holding the new data
Throws:
PropertyException - if there is a problem with the properties.

reset

public void reset()
Description copied from interface: Resetable
Resets this component. Typically this is for components that keep track of statistics

Specified by:
reset in interface Resetable

getName

public java.lang.String getName()
Description copied from interface: Configurable
Retrieves the name for this configurable component

Specified by:
getName in interface Configurable
Returns:
the name

getAligner

public NISTAlign getAligner()
Retrieves the aligner used to track the accuracy stats

Returns:
the aligner

newResult

public void newResult(Result result)
Description copied from interface: ResultListener
Method called when a new result is generated

Specified by:
newResult in interface ResultListener
Parameters:
result - the new result

statusChanged

public void statusChanged(RecognizerState status)
Description copied from interface: StateListener
Called when the status has changed.

Specified by:
statusChanged in interface StateListener
Parameters:
status - the new status