edu.cmu.sphinx.frontend
Interface DataProcessor

All Superinterfaces:
Configurable
All Known Implementing Classes:
BaseDataProcessor

public interface DataProcessor
extends Configurable

A processor that performs a signal processing function. Since a DataProcessor usually belongs to a particular front end pipeline, you can name the pipeline it belongs to in the initialize method. (Note, however, that it is not always the case that a DataProcessor belongs to a particular pipeline. For example, the Microphoneclass is a DataProcessor, but it usually does not belong to any particular pipeline.

Each DataProcessor usually have a predecessor as well. This is the previous DataProcessor in the pipeline. Again, not all DataProcessors have predecessors.

Calling getDatawill return the processed Data object.


Method Summary
 Data getData()
          Returns the processed Data output.
 java.lang.String getName()
          Returns the name of this DataProcessor.
 DataProcessor getPredecessor()
          Returns the predecessor DataProcessor.
 void initialize()
          Initializes this DataProcessor.
 void setPredecessor(DataProcessor predecessor)
          Sets the predecessor DataProcessor.
 
Methods inherited from interface edu.cmu.sphinx.util.props.Configurable
newProperties, register
 

Method Detail

initialize

public void initialize()
Initializes this DataProcessor. This is typically called after the DataProcessor has been configured.


getData

public Data getData()
             throws DataProcessingException
Returns the processed Data output.

Returns:
an Data object that has been processed by this DataProcessor
Throws:
DataProcessingException - if a data processor error occurs

getName

public java.lang.String getName()
Returns the name of this DataProcessor.

Specified by:
getName in interface Configurable
Returns:
the name of this DataProcessor

getPredecessor

public DataProcessor getPredecessor()
Returns the predecessor DataProcessor.

Returns:
the predecessor

setPredecessor

public void setPredecessor(DataProcessor predecessor)
Sets the predecessor DataProcessor. This method allows dynamic reconfiguration of the front end.

Parameters:
predecessor - the new predecessor of this DataProcessor