Open topic with navigation

# OCR Engine Configuration Parameters

OCR recognizes text in video. This section describes the parameters that you can set in the configuration section for an OCR analysis task.

Configuration Parameter | Description
--- | ---
Blacklist | Characters to remove from the character set.
CharacterTypes | The types of characters that the character set contains.
FrameRate | The number of frames to analyze per second of video.
HollowText | Whether to look for outlined text.
Input | The image track to process.
Languages | The languages to use, including the character set and dictionaries.
Region | A region of the frame to restrict processing to.
RegionUnit | The units that the Region parameter uses to specify the size and position of a region.
Type | The analysis engine to use. Set this parameter to `OCR`.
UserDictionary | A comma-separated list of dictionaries to use in addition to the standard dictionaries.
Whitelist | Extra characters to add to the character set.

## OutputTracks

Output track | Type | Description | Output1This column indicates whether the information contained in the track is included by default in the output created by an output task (when you don't set the Input parameter for the output task).
--- | --- | --- | ---
`Data` | OCRResult | Contains a record for every frame in which text is detected. | No
`DataWithSource` | OCRAndImage | Contains the same information as the `Data` track, but each record also includes the source frame. | No
`Event` | OCREvent | The engine creates a record in the `Event` track when text appears or disappears in the video, or when the text changes. | Yes
`Result` | OCRResult | Contains a single record for each example of text (the same text might appear in many consecutive frames). This track only contains the best result from processing an example of text. | Yes
`ResultWithSource` | OCRAndImage | Contains the same information as the `Result` track, but each record also includes the best source frame. | No

OCRResult

Field name | Type | Description
--- | --- | ---
id | UUIDData | A universally unique identifier to identify the text
text | TextData | The result of running OCR on the text
region | RectangleData | The location of the text in the frame
confidence | Integer | The confidence score from OCR

OCRAndImage

Field name | Type | Description
--- | --- | ---
id | UUIDData | A universally unique identifier to identify the text
text | TextData | The result of running OCR on the text
region | RectangleData | The location of the text in the frame
confidence | Integer | The confidence score from OCR
image | ImageData | The source frame

OCREvent

Field name | Type | Description
--- | --- | ---
id | UUIDData | A universally unique identifier to identify the text
event | TrackingEventData | The type of event (begin/end/update), and the elapsed time since the text appeared.
text | TextData | The result of running OCR on the text

© 2016 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE Close We welcome your comments! To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to AutonomyTPFeedback@hpe.com. Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm