Read ID Tool

Use the Read ID tool to find and decode 1D and 2D symbols. The function supports a variety of symbologies and can handle a high degree of rotation and perspective distortion. The Read ID tool fails if it does not decode any symbols.

  1. Select Read ID under ID Tools.

  2. Set the Search Region. Once ready, select OK.

  3. Enable the symbologies you want to search for.

    You can select both 1D and 2D symbologies in a single search. If you want to search for multiple symbologies of the same type on one image, increase the number of Maximum Results.

    Note: The Maximum Results value applies to all 1D codes, regardless of type. For 2D codes, you can set the Maximum Results for each type individually. In both cases, the default number is 1 and the maximum is 20.

    The read results show up both on the image and under Results.

    Note: The Results table can show a maximum of 20 reads.
Code 128
Code 39
Interleaved 2 of 5
Pharmacode
UPC/EAN
Code 93
Codabar
MSI
Code 25
PDF417
Databar
Databar Limited
Databar Expanded

EAN/UCC Composite
Note: EAN/UCC Composite requires one of the following linear options:

  • Code 128

  • Databar

  • Databar Limited

  • Databar Expanded

Data Matrix
QR Code
MaxiCode
Aztec Code
DotCode

To open the advanced settings, click on the Cog icon.

General Settings

See General Advanced Settings.

Training Status

Trained Symbology Shows the trained symbology type.
Enable Training

When enabled, trains a model of the first symbol read. Training the function can improve performance, especially if all symbols to be decoded have similar characteristics.

Disabled (default) Do not train a model.
Enabled Train a model of the first symbol read (at index 0).
Note: It is recommended to have only one symbol in the Region of Interest before training is enabled to ensure the correct symbology is in result index 0.

Considerations when using the training option:

  • You can train both 1D and 2D codes.

  • You can enable training for only one symbology.

  • If you have multiple symbologies enabled, the result at index 0 is trained (first result found).

  • Training any 1D code disables the search for other enabled 1D code types. But the search can still find 2D codes if you enabled any.

  • Adding other symbologies to the read does not affect the trained data.

  • The trained information is retained until you disable the training option.

To train a new symbology:

  1. Disable training.

  2. Ensure the desired symbology is in result index 0.

  3. Enable training again.
Allow Flexible Grid Size

Specifies whether to read 1D, Data Matrix, and QR Code symbols of a different grid size, with respect to the trained symbol.

Note: This parameter is only valid if the Enable Training toggle is enabled.
Disabled (default) Only allow symbols to be read that are the same grid size as the trained symbol.
Enabled Allow symbols to be read that are not the same grid size as the trained symbol.
Ignore Polarity

Specifies whether or not to read 1D, Data Matrix, and QR Code symbols where the polarity is inverted, with respect to the trained symbol.

Note: This parameter is only valid if the Enable Training toggle is enabled.
Disabled (default) Do not allow inverted polarity from the trained model.
Enabled Allow inverted polarity from the trained model.

Decode Settings

Advanced Decode Mode

Specifies the setting to be used to decode symbologies.

IDMax® (default)

Used for symbols that appear warped, distorted, or appear on a non-uniform background. This mode is designed for codes with "continuous" finder patterns, not separated dots.

IDQuick™

Only reads conformant symbols; does not attempt to read non-conformant symbols.
Perspective Distortion

Specifies the decoding of symbologies with perspective distortion and optionally trains symbols for a known perspective distortion.

Minimal

Decodes symbologies with minimal perspective distortion.

Moderate

(default)

Decodes symbologies with moderate perspective distortion; the perspective distortion is estimated independently during model training and run time.

Severe

Decodes symbologies with severe perspective distortion. The perspective is trained, then at run time, the symbol is searched in a space where the perspective distortion in the input image is compensated, using the trained attributes. This option requires that the run time symbol is placed on the same plane as that of the trained symbol. This option provides the ability to decode severely damaged symbols, with known perspective distortion.

Note: It is recommended that the vision system be mounted such that the angle of incidence (the angle between the optical axis of the sensor and the normal vector of the plane on which the symbol is presented) is no more than 40 degrees, and the resolution of the symbol be at least 5 pixels per cell.
QR Mode

Specifies the type of QR Code to read.

  • QR Model 1

  • QR Model 2

  • QR Models 1 and 2

  • Micro QR

  • Micro QR and QR Model 1

  • Micro QR and QR Model 2

  • All QR Modes (default)
Symbol Damage

Allows reading of damaged and low-quality codes.

Moderate 2DMax is enabled to allow reading of low quality codes
Extreme 2DMax and Powergrid are enabled to allow reading of low quality codes with damage to their quiet zones, finding and clocking patterns.
Checksum

Determines if the symbol is valid to ensure reliability using an error-detection algorithm. Checksum only applies to symbols with optional checksum algorithms included in the symbol; each symbol has its own unique checksum algorithm. The type of checksum, if any, that is used depends on the code type selected.

OFF (default)

Do not verify checksum.

ON

Requires checksum to pass.
Note: Code 128, Code 93, and UPC/EAN barcodes are validated with a checksum regardless of the parameter selection. If Checksum is enabled for any other barcode, and no checksum is encoded, the read fails.
Polarity

Specifies the color of the symbols.

Black

The symbol is darker than the background.

White

The symbol is lighter than the background.

Auto (default)

The function automatically selects the polarity of the symbol.
Sort Mode

Specifies the order in which the results appear.

Note: For accurate sorting of symbols, the Maximum Results parameter must be set to a value that is equal to or greater than the number of symbols contained in the image.

None (default)

Sorts by first decoded results. Any undecoded results will follow decoded results.

Top Down

Sorts in ascending Row order.

Left To Right

Sorts in ascending Column order

Alphabetical

Sorts the results alphabetically.

String Length

Sorts the results by string length (shortest to longest).

Rows

Sorts the results by grouping the symbols into rows, and then sorting them from left-to-right within each row. When sorting by Rows, two symbols are considered part of the same Row if the center of one symbol overlaps vertically with any part of the other symbol.

Columns

Sorts the results by grouping the symbols into columns, and then sorting them from top-to-bottom within each column. When sorting by Columns, two symbols are considered part of the same Column if the center of one overlaps horizontally with any part of the other symbol.
Allow Identical 1D Symbols

Specifies whether the function has to decode all symbols within the region, even if they are identical. Two symbols are considered identical if they have the same length, symbology type and decoded string.

OFF (default)

Only return one result if multiple symbols are decoded.

ON

Return all results, even if they are identical.
Expand UPC-E

Specifies whether the decoded symbol returns the 6-digit UPC-E string or the expanded 11-digit UPC-A equivalent string.

OFF

 The decoded symbol returns the 6-digit UPC-E string.

ON (default)

The decoded symbol returns the expanded 11-digit UPC-A equivalent string.
Expand Rectangular Extension

Enables decoding of Data Matrix Rectangular Extension (DMRE) symbols.

OFF (default) The tool reads standard Data Matrix symbols only.
ON The tool reads standard Data Matrix and DMRE symbols.
Minimum Decodes Before Output

Specifies the number of matching decodes for a successful reading of a 1D symbol (1 to 5; default value = 2). In most cases, you do not need to change the default value.

Increasing this value reduces read errors but raises execution time and decreases tolerance for damaged or noisy codes.

Decreasing this value improves the ability to read damaged or noisy codes, but increases the likelihood of a read error.
Show Decoded Result Show decoded string results on top of decoded code.

Timeout

Specifies the time, in milliseconds (0 to 30000) the function searches for a valid ID symbol before execution is halted and an #ERR is returned. Setting the value to 0 disables this setting.

Note: At times, the Read ID may exceed the specified Timeout parameter value. If this happens, set the Timeout parameter value lower to compensate for the overage.

Refer to the below table to see which advanced setting works with which code type

Setting Any 1D Data Matrix QR Code MaxiCode Aztec Code DotCode
Advanced Decode Mode X X X      
Perspective Distortion   X X      
QR Mode     X      
Symbol Damage   X X      
Checksum X          
Polarity X       X X
Sort Mode X X X X X X
Allow Identical 1D Symbols X          
Expand UPC-E X          
Expand Rectangular Extension   X        
Minimum Decodes Before Output X          
Show Decoded Result X X X X X X