edu.cmu.sphinx.instrumentation

Class AccuracyTracker

java.lang.Object

edu.cmu.sphinx.util.props.ConfigurableAdapter

edu.cmu.sphinx.instrumentation.AccuracyTracker

All Implemented Interfaces:

ResultListener, Monitor, Resetable, StateListener, Configurable, java.util.EventListener

Direct Known Subclasses:

BestPathAccuracyTracker

public abstract class AccuracyTracker
extends ConfigurableAdapter
implements ResultListener, Resetable, StateListener, Monitor

Tracks and reports recognition accuracy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_RECOGNIZER The property that defines which recognizer to monitor
static java.lang.String	PROP_SHOW_ALIGNED_RESULTS The property that defines whether recognition results should be displayed.
static java.lang.String	PROP_SHOW_DETAILS The property that defines whether detailed accuracy information is displayed
static java.lang.String	PROP_SHOW_RAW_RESULTS The property that defines whether recognition results should be displayed.
static java.lang.String	PROP_SHOW_RESULTS The property that defines whether recognition results should be displayed.
static java.lang.String	PROP_SHOW_SUMMARY The property that defines whether summary accuracy information is displayed

Fields inherited from class edu.cmu.sphinx.util.props.ConfigurableAdapter

logger

Constructor Summary

Constructors

Constructor and Description
AccuracyTracker()
AccuracyTracker(Recognizer recognizer, boolean showSummary, boolean showDetails, boolean showResults, boolean showAlignedResults, boolean showRawResults)

Method Summary

Modifier and Type	Method and Description
NISTAlign	getAligner() Retrieves the aligner used to track the accuracy stats
java.lang.String	getName()
void	newProperties(PropertySheet ps) This method is called when this configurable component needs to be reconfigured.
abstract void	newResult(Result result) Method called when a new result is generated
void	reset() Resets this component.
protected void	showDetails(java.lang.String rawText) Shows the complete details.
void	statusChanged(Recognizer.State status) Called when the status has changed.

Methods inherited from class edu.cmu.sphinx.util.props.ConfigurableAdapter

initLogger, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROP_RECOGNIZER

@S4Component(type=Recognizer.class)
public static final java.lang.String PROP_RECOGNIZER

The property that defines which recognizer to monitor

See Also:

Constant Field Values

PROP_SHOW_SUMMARY

@S4Boolean(defaultValue=true)
public static final java.lang.String PROP_SHOW_SUMMARY

The property that defines whether summary accuracy information is displayed

See Also:

Constant Field Values

PROP_SHOW_DETAILS

@S4Boolean(defaultValue=true)
public static final java.lang.String PROP_SHOW_DETAILS

The property that defines whether detailed accuracy information is displayed

See Also:

Constant Field Values

PROP_SHOW_RESULTS

@S4Boolean(defaultValue=true)
public static final java.lang.String PROP_SHOW_RESULTS

The property that defines whether recognition results should be displayed.

See Also:

Constant Field Values

PROP_SHOW_ALIGNED_RESULTS

@S4Boolean(defaultValue=true)
public static final java.lang.String PROP_SHOW_ALIGNED_RESULTS

The property that defines whether recognition results should be displayed.

See Also:

Constant Field Values

PROP_SHOW_RAW_RESULTS

@S4Boolean(defaultValue=true)
public static final java.lang.String PROP_SHOW_RAW_RESULTS

The property that defines whether recognition results should be displayed.

See Also:

Constant Field Values

Constructor Detail

AccuracyTracker

public AccuracyTracker(Recognizer recognizer,
                       boolean showSummary,
                       boolean showDetails,
                       boolean showResults,
                       boolean showAlignedResults,
                       boolean showRawResults)

AccuracyTracker

public AccuracyTracker()

Method Detail

newProperties

public void newProperties(PropertySheet ps)
                   throws PropertyException

Description copied from interface: Configurable

This method is called when this configurable component needs to be reconfigured.

Specified by:

newProperties in interface Configurable

Overrides:

newProperties in class ConfigurableAdapter

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()

Overrides:

getName in class ConfigurableAdapter

Returns:

the configuration name this Configurable.

getAligner

public NISTAlign getAligner()

Retrieves the aligner used to track the accuracy stats

Returns:

the aligner

showDetails

protected void showDetails(java.lang.String rawText)

Shows the complete details.

Parameters:

rawText - the RAW result

newResult

public abstract 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(Recognizer.State status)

Description copied from interface: StateListener

Called when the status has changed.

Specified by:

statusChanged in interface StateListener

Parameters:

status - the new status