public class OmrEngine extends Object
The main entry point for the users of the library. It collects all data necessary for data extractions.
| Constructor and Description |
|---|
OmrEngine(OmrTemplate template)
Initializes a new instance of the
OmrEngine class. |
OmrEngine(OmrTemplate template,
ProcessingPipeline pipeline)
Initializes a new instance of the
OmrEngine class. |
| Modifier and Type | Method and Description |
|---|---|
void |
changeProcessingPipeline(ProcessingPipeline newPipeline)
Replaces the image processing pipeline with a new one.
|
OmrProcessingResult |
extractData(OmrImage[] documentImages)
Extracts data from a scanned OMR sheets.
|
OmrConfig |
getConfiguration()
Gets global configuration for OMR extraction algorithm.
|
ProcessingPipeline |
getProcessingPipeline()
Gets an instance of
ProcessingPipeline that contains image processing algorithms
used for pre-processing of a scanned image before data extraction. |
OmrTemplate |
getTemplate()
Gets a data template that describes data structure of an OMR sheet.
|
void |
setConfiguration(OmrConfig value)
Sets global configuration for OMR extraction algorithm.
|
void |
setTemplate(OmrTemplate value)
Sets a data template that describes data structure of an OMR sheet.
|
public OmrEngine(OmrTemplate template)
Initializes a new instance of the OmrEngine class.
template - An instance of OmrTemplate to be used for data extraction.public OmrEngine(OmrTemplate template, ProcessingPipeline pipeline)
Initializes a new instance of the OmrEngine class.
template - An instance of OmrTemplate to be used for data extraction.pipeline - An instance of ProcessingPipeline that contains image processing algorithms
used for preprocessing of a scanned image before data extraction.public void changeProcessingPipeline(ProcessingPipeline newPipeline)
Replaces the image processing pipeline with a new one.
newPipeline - The new pipeline.public OmrProcessingResult extractData(OmrImage[] documentImages)
Extracts data from a scanned OMR sheets.
documentImages - Collection of scanned pages, according to the template.OmrProcessingResult that contains data extracted from the sheet.public OmrConfig getConfiguration()
Gets global configuration for OMR extraction algorithm.
public ProcessingPipeline getProcessingPipeline()
Gets an instance of ProcessingPipeline that contains image processing algorithms
used for pre-processing of a scanned image before data extraction.
public OmrTemplate getTemplate()
Gets a data template that describes data structure of an OMR sheet.
public void setConfiguration(OmrConfig value)
Sets global configuration for OMR extraction algorithm.
value - global configuration for OMR extraction algorithm.public void setTemplate(OmrTemplate value)
Sets a data template that describes data structure of an OMR sheet.
value - the templateCopyright © 2014. All rights reserved.