IMAQ OCR Property VI

LabView NI Vision

IMAQ OCR Property VI

Owning Palette: OCRInstalled With: NI Vision Development Module

Gets and sets the value of the property specified by Property. You can use this polymorphic VI to set the value of an I32 property, a string property, or a Boolean property. The data type you wire to the Property Value input determines which polymorphic instance to use.

Use the pull-down menu to select an instance of this VI.

IMAQ OCR I32 Property

Gets and sets the value of the property specified by Property. This VI works only with I32 properties.

IMAQ OCR I32 Property

Property specifies the property that this VI gets or sets. The following values are valid:

Acceptance Level (0)	The minimum acceptance level at which an object is considered a trained character. The range of valid values for this property is 0 to 1000. The default value is 700.
Min Char Size (1)	The minimum object size, in pixels, at which an object is a potential identifiable character. The minimum value allowed for this property is 1. The value of this property must not exceed Max Char Size. The default is 20 pixels.
Max Char Size (2)	The maximum object size, in pixels, at which an object is a potential identifiable character. Set this value to 65536, which is also the default value, to specify that all values greater than Min Char Size are acceptable. The value of this property must not be less than Min Char Size.
Min Char Spacing (3)	The minimum amount of space, in pixels, that can be between characters. This value must not be less than the Max Horiz Element Spacing. The default value is 1.
Max Horiz Element Spacing (4)	The maximum horizontal spacing, in pixels, between the elements that are combined to form a single character. For stroke characters, set this value to 1 or 2. For segment characters or pin stamp characters, set this value to 5 or higher. This value cannot exceed the actual character spacing value specified by the Min Char Spacing property. The horizontal spacing value is required to ensure that OCR correctly trains and reads characters that consist of several elements. The minimum value allowed for this property is 0. The default value is 1.
Max Vert Element Spacing (5)	The maximum vertical spacing, in pixels, between the elements that are combined to form a single character. The default value is 0, which specifies that any object in the ROI should be considered part of a valid object.
Min Bounding Rect Width (6)	The minimum width, in pixels, of a character bounding rectangle. The value of this property cannot exceed Max Bounding Rect Width. The minimum value allowed for this property, which is also the default value, is 1.
Max Bounding Rect Width (7)	The maximum width, in pixels, of a character bounding rectangle. Set this value to 65536, which is also the default value, to specify that all values greater than Min Bounding Rect Width are acceptable. The value of this property must not be less than Min Bounding Rect Width.
Min Bounding Rect Height (8)	The minimum height, in pixels, of a character bounding rectangle. The value of this property cannot exceed Max Bounding Rect Height. The minimum value allowed for this property, which is also the default value, is 1.
Max Bounding Rect Height (9)	The maximum height, in pixels, of a character bounding rectangle. Set this value to 65536, which is also the default value, to specify that all values greater than Min Bounding Rect Height are acceptable. The value of this property must not be less than Min Bounding Rect Height.
Read Strategy (10)	The read strategy determines how closely OCR analyzes images in the reading process to match objects with trained characters. The following list includes valid values: Aggressive—Use few criteria to determine character match. Conservative—Use extensive criteria to determine character match. The default value is Aggressive.
Aspect Ratio (11)	The maximum aspect ratio variation percentage that the IMAQ OCR Read Text 3 VI allows when it identifies characters. The minimum value for this property is 100, which specifies that the identified object must match the trained character exactly in size and height/width ratio. The default aspect ratio is 400.
Number Of Erosions (12)	The number of erosions to perform to remove small objects. After performing the specified number of erosions, OCR restores remaining objects to their original uneroded size. The default value is 0.
Read Resolution (13)	The level of character criteria that OCR uses to determine if an object matches a trained character. The default is low resolution.
Size of Char Set (14)	The number of characters in the trained character set. This property is read-only.

IMAQ OCR Session specifies the OCR session on which this VI operates. To create a session, use the IMAQ OCR Create Session VI.

Property Value is the new value of the property if Get/Set is set to TRUE. Otherwise, Property Value is ignored.

error in (no error) describes the error status before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

	status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

Get/Set (True: Set) specifies whether the VI gets or sets the property value. TRUE sets the property value. FALSE gets the property value.

IMAQ OCR Session (dup) is the reference to the OCR session to which this VI operates.

Property Value Out returns the value of the property specified by Property.

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

IMAQ OCR String Property

Gets and sets the value of the property specified by Property. This VI works only with string properties.

IMAQ OCR String Property

Property specifies the property that this VI gets or sets. The following value is valid:

Substitution Character (15)

The character that the IMAQ OCR Read Text 3 VI substitutes for objects it cannot match with any of the trained characters. The default value is a question mark (?).

IMAQ OCR Session specifies the OCR session on which this VI operates. To create a session, use the IMAQ OCR Create Session VI.

Property Value is the new value of the property if Get/Set is set to TRUE. Otherwise, Property Value is ignored.

	status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

Get/Set (True: Set) specifies whether the VI gets or sets the property value. TRUE sets the property value. FALSE gets the property value.

IMAQ OCR Session (dup) is the reference to the OCR session to which this VI operates.

Property Value Out is the value of the property specified by Property.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

IMAQ OCR Boolean Property

Gets and sets the value of the property specified by Property. This VI works only with Boolean properties.

IMAQ OCR Boolean Property

Property specifies the property that this VI gets or sets. The following values are valid:

Remove Particles Touching ROI (16)	Set this property to TRUE for OCR to remove objects that are touching the ROI you specified. The removed objects are not considered for training or reading. When you set this property to FALSE, OCR retains objects that are touching the ROI. The default value is FALSE.
Auto Split (17)	Set this property to TRUE to automatically adjust the location of the character bounding rectangle when characters overlap vertically. This property is useful when you are working with an image that contains slanted characters. If the characters are not slanted and/or do not overlap vertically, set this property to FALSE. The default value is FALSE.

IMAQ OCR Session specifies the OCR session on which this VI operates. To create a session, use the IMAQ OCR Create Session VI.

Property Value is the new value of the property if Get/Set is set to TRUE. Otherwise, Property Value is ignored.

	status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

Get/Set (True: Set) specifies whether the VI gets or sets the property value. TRUE sets the property value. FALSE gets the property value.

IMAQ OCR Session (dup) is the reference to the OCR session to which this VI operates.

Property Value Out is the value of the property specified by Property.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

previous page start next page