# ViDiRead

The ViDiRead function allows you to create a deep learning-based OCR solution around the Blue Read Tool. The ViDiRead function utilizes a pre-trained Blue Read tool, which allows the tool to read a large majority of fonts without needing to be trained. The characters of the pre-trained tool are numerals (0-9), uppercase letters (A-Z, except "O"), hyphen (-), plus sign (+), ampersand (&), colon (:), and forward slash (/).

To use the tool, position the function's Region over the text to read. In most instances, the tool will be able to read the characters in the image.

If one or more of the characters are not being read, you can press the ViDi Editor button to launch the ViDi Editor, where you can make additional adjustments to the tool, and train the tool, if necessary.

Note:

- In the event you need to train the tool, refer to the How to Train the ViDiRead Function topic for more information how to train the tool.
- In addition to the ViDiRead tool utilizing a pre-trained Blue Read tool, the tool also utilizes a default String model. The String model uses a default Minimum Length setting of 4 (meaning the minimum length of the string to be read is four characters). For more information about models, refer to the Blue Read Tool – Models topics.
- For more information about the ViDi Read tool within the ViDi Editor, see the Blue Read Tool and Using the Blue Read Tool topics.

## ViDiRead Inputs

### General Tab

Parameter | Description
--- | ---
Image | This argument must reference a spreadsheet cell that contains a valid Image data structure. By default, the cell referenced is $A$0, which contains the image data structure returned by AcquireImage.
External Fixture | Specifies a reference to a Fixture or Fixtures data structure. This fixture data will be passed into the ViDi tools, and will be used to define the views for each image. When using an external fixture, within the ViDi tool's Region of Interest (ROI), you will need to select External. Then, from the Image Database menu, select Update All Training Fixtures, and then modify the ViDi tool's ROI. You can also update the ViDi tool's reference to the external fixture data by selecting the ViDi data structure, right-click and select Update Training Fixtures.
Region | Also known as the Region of Interest (ROI), specifies the region of the image that undergoes analysis; creates an Interactive Graphics Mode that can be transformed and rotated. With this parameter selected, by pressing the Maximize Region button on the property sheet's Job Edit toolbar, the region will automatically be stretched to cover the entire image.
X | The x-offset of the origin, in fixture coordinates.
Y | The y-offset of the origin, in fixture coordinates.
Width | The dimension along the region's x-axis.
Height | The dimension along the region's y-axis.
Angle | The orientation, in fixture coordinates.
Show | Specifies the display mode for ViDiRead tool's graphical overlays on top of the image.
0 = hide all (default) | All graphics will be hidden, except when the cell containing the ViDi function is highlighted in the spreadsheet.
1 = result graphics only | The result graphics will be shown at all times.
4 = input graphics only | The input graphics will be shown at all times.
2 = input and result graphics | The input and result graphics will be displayed at all times.

### Runtime Tab

Allows access to ViDi Processing Tool Parameters that can be modified while the job is online. These parameters do not require that the tool be retrained. You can drag and drop these parameter to the spreadsheet, and publish them to the HMI for operator interaction.

## ViDiRead Outputs

Returns | A ViDiRead data structure, or #ERR if any of the input parameters are invalid.
Results | After a ViDiRead function is inserted into the spreadsheet, a results table can be created, based on the ViDi Results Vision Data Access Functions by right-clicking on the function's data structure and selecting Insert Getters.
❒ViDiRead | View | Index | Match Index | String | Score
| ❒VidiReadView | 0 | 0 | FHA789 | 0.996
Function | Description
--- | ---
GetViDiReadView(ViDiRead, ViewIndex) | Returns a ViDiReadView data structure, which extracts the results from a single view.
GetViDiMatch(ViDiReadView, MatchIndex) | Returns a ViDiMatch data structure, which extracts the matched model from the referenced view.
GetString(ViDiReadView) | Returns a string generated by the referenced ViDiReadView data structure.
GetScore(ViDiMatch) | Returns the score associated with the ViDiMatch data structure output by a Blue Read tool.