Table Of Contents

Get Set OCR Threshold Data (Get Set OCR Threshold Data Global) (G Dataflow)

Last Modified: June 25, 2019

Gets and sets global threshold data.

connector_pane_image
datatype_icon

OCR session in

OCR session on which the node operates.

To create a session, use the Create OCR Session node.

datatype_icon

threshold mode in

Thresholding method that the node sets when get/set? is True. This value is ignored if get/set? is False.

The following values are valid:

Name Value Description
Fixed Range 0

Use this mode when you want to specify the low and high threshold values. OCR performs no automatic calculations. This is the fastest thresholding method.

Uniform 1

Computes a single threshold value for the entire ROI.

Linear 2

Divides the ROI into the number of blocks specified by number of blocks, calculates a threshold value for each block, and then uses the value to extract pixel data. Use this mode when the light intensity varies uniformly across the ROI.

Non-linear 3

Calculates a value on the left side of the ROI, a value on the right size of the ROI, and then fills the middle values in a linear fashion from left to right. The size of the steps from which to calculate the left and right values is based on the value of number of blocks.

Default: Uniform

datatype_icon

threshold options in

Parameters that the node sets if get/set? is True. The value of this cluster is ignored if get/set? is False.

datatype_icon

Dark Characters

Boolean that specifies how the characters appear in the image.

True The image contains dark characters on a light background.
False The image contains light characters on a dark background.

Default: True

datatype_icon

Number of Blocks

Number of blocks that OCR uses when threshold mode is linear or non-linear. Valid values range from 4 to 50.

datatype_icon

Threshold Limits

Upper and lower bounds of the threshold values used to calculate the threshold.

datatype_icon

Lower Value

Lower bound of the calculated threshold value.

datatype_icon

Upper Value

Upper bound of the calculated threshold value.

datatype_icon

Optimize For Speed

Boolean input that indicates if a faster, less accurate threshold algorithm is used.

True A faster, less accurate threshold calculation algorithm is used.
False A slower, more accurate threshold calculation algorithm is used.
datatype_icon

Perform Bi-modal Calculation

Boolean input that indicates if OCR calculates both the low and high threshold values when optimize for speed is set to True. True enables OCR to calculate both the low and high threshold values when optimize for speed is set to TRUE.

If you set this item to TRUE, dark characters is ignored.

Default: False

datatype_icon

fixed threshold range in

Fixed threshold range when threshold mode is set to fixed range and get/set? is True.

Fixed threshold range is ignored for all other values of threshold mode or if get/set? is False.

datatype_icon

lower value

Lower bound of the threshold range.

datatype_icon

upper value

Upper bound of the threshold range.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

get/set?

Boolean that specifies whether the node gets or sets the property value.

True Sets the property value.
False Gets the property value.
datatype_icon

OCR session out

OCR session on which this node operates.

datatype_icon

threshold mode out

Current value of the thresholding mode.

datatype_icon

threshold options out

Current value of the advanced threshold data.

datatype_icon

Dark Characters

Boolean that specifies how the characters appear in the image.

True The image contains dark characters on a light background.
False The image contains light characters on a dark background.

Default: True

datatype_icon

Number of Blocks

Number of blocks that OCR uses when threshold mode is linear or non-linear.

datatype_icon

Threshold Limits

Upper and lower bounds of the threshold values used to calculate the threshold.

datatype_icon

Lower Value

Lower bound of the calculated threshold value.

datatype_icon

Upper Value

Upper bound of the calculated threshold value.

datatype_icon

Optimize For Speed

Boolean input that indicates if a faster, less accurate threshold calculation algorithm is used.

True OCR uses a faster, less accurate threshold calculation algorithm.
False OCR uses a slower, more accurate threshold calculation algorithm.
datatype_icon

Perform Bi-modal Calculation

Boolean that indicates if OCR calculates both the low and high threshold values. TRUE enables OCR to calculate both the low and high threshold values when optimize for speed is set to True.

datatype_icon

fixed threshold range out

Current value of the fixed threshold range.

datatype_icon

Lower value

Lower bound of the threshold range.

datatype_icon

Upper value

Upper bound of the threshold range.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics