IDCode
- The ReadIDCode function is only available on In-Sight vision systems using In-Sight firmware 4.x.x, and is not available on In-Sight vision systems running In-Sight firmware 5.1.0 and later. For a complete list of models and supported firmware versions, see Firmware Versions.
- Cognex recommends that the ReadIDMax function be used instead of the ReadIDCode function, which is a legacy function. The ReadIDMax function has enhanced performance capabilities.
- All returned values are from a referenced IDCode structure, which is inserted in the spreadsheet when the ReadIDCode function is created.
Function |
Description |
---|---|
Returns the angle of a symbol (except PharmaCode, RSS-14\Stacked and RSS Limited codes). Note:
|
|
Returns the mean of the skew of the bars in a Postal barcode. Note: If the Algorithm parameter is disabled in
the ReadIDCode function, the Verify checkbox must be enabled. If the Algorithm parameter is enabled in the
ReadIDCode function, the function must reference the VerifyIDCode
function. For more information, see VerifyIDCode.
|
|
Returns the mean space width between bars in a Postal barcode. Note: If the Algorithm parameter is disabled in
the ReadIDCode function, the Verify checkbox must be enabled. If the Algorithm parameter is enabled in the
ReadIDCode function, the function must reference the VerifyIDCode
function. For more information, see VerifyIDCode.
|
|
Returns the average width of the bars in a Postal barcode. |
|
Returns the name of the code type. This is the same code name shown in the property sheet. For more information, see Property Sheet. |
|
Returns the code type. |
|
Returns the column coordinate (in pixels) of the upper left-hand corner of a Postal symbol and the column (y) coordinate for 2D symbols at the indexed (0 to 3) finder pattern points. For more information, see Finder Pattern Points. Note: The Verify parameter in the ReadIDCode function must be
enabled. For more information, see ReadIDCode.
|
|
Returns the value (0 = black, 1 = white) of the foreground color for a Data Matrix, QR Code or PDF417 symbol. |
|
Returns the mean contrast between foreground and background in grey levels in a Postal barcode. Note:
|
|
Returns the minimum decodability of the barcode (except RSS Stacked barcodes). Note: The Verify parameter in the ReadIDCode function must be
enabled. For more information, see ReadIDCode.
|
|
Returns the ratio of the maximum element reflectance nonuniformity to the average barcode contrast (except RSS Stacked barcodes). An element refers to either a bar or space in a barcode. Note: The Verify parameter in the ReadIDCode function must be
enabled. For more information, see ReadIDCode.
|
|
Returns the error correction level of a Data Matrix or a PDF 417 code. |
|
Returns the minimum edge response between successive elements in a barcode (except RSS Stacked barcodes). Note: The Verify parameter in the ReadIDCode function must be
enabled. For more information, see ReadIDCode.
|
|
Returns an error code for each information string. |
|
Returns the number of erroneous codewords found in a 2D symbol. This value is used to calculate UnusedEC. |
|
Returns diagnostic information if symbol decoding fails. For more information, see ID Error Strings. |
|
Returns the value representing the format of a 2D symbol in the ReadIDCode function. For more information, see GetFormat Values. |
|
Returns the overall quality grade for the barcode based on the lowest grade received from the Contrast, Modulation, Defect and Decodability tests. The Verify checkbox in ReadIDCode must be enabled. A second IDCode structure can be referenced as an optional parameter.
Note: If the Algorithm parameter is enabled in
the ReadIDCode function, GetGrade returns a #ERR for PDF417 codes.
See return values when the optional second IDCode parameter is used |
|
Returns the number of columns contained in a 2D symbol. |
|
Returns the number of rows contained in a 2D symbol. |
|
Returns the 2D symbol print growth test result. The horizontal and vertical print growths are calculated independently and the lower score is returned. Note: The Verify parameter in the ReadIDCode function must be
enabled. For more information, see ReadIDCode.
|
|
Returns the height of the symbol. Note: The Verify parameter in the ReadIDCode function must be
enabled. For more information, see ReadIDCode.
|
|
Returns '1' if the model of the symbol has been successfully learned and '0' if the model is not learned. |
|
Returns the number of columns in a learned QR Code or Data Matrix symbol. |
|
Returns the number of rows in a learned QR Code or Data Matrix symbol. |
|
Returns the maximum skew of the bars in a Postal barcode. Note:
|
|
Returns the maximum width of the bars in a Postal barcode. Note:
|
|
Returns the maximum space width between bars in a Postal barcode. Note: If the Algorithm parameter is disabled in
the ReadIDCode function, the Verify checkbox must be enabled. If the Algorithm parameter is enabled in the
ReadIDCode function, the function must reference the VerifyIDCode
function. For more information, see VerifyIDCode.
|
|
Returns the minimum skew of the bars in a Postal barcode. Note:
|
|
Returns the minimum width of the bars in a Postal barcode. Note:
|
|
Returns the minimum space width between bars in a Postal barcode. Note: If the Algorithm parameter is disabled in
the ReadIDCode function, the Verify checkbox must be enabled. If the Algorithm parameter is enabled in the
ReadIDCode function, the function must reference the VerifyIDCode
function. For more information, see VerifyIDCode.
|
|
Returns the mirrored status (0 = not mirrored, 1 = mirrored) of a Data Matrix or QR Code symbol. |
|
Returns the ratio of the Minimum Edge Response (ECMin) to the average contrast of the barcode (except RSS Stacked barcodes). Note: The Verify parameter in the ReadIDCode function must be
enabled. For more information, see ReadIDCode.
|
|
Returns the number of bars found in a Postal barcode. Note:
|
|
Returns the 2D symbol axial non-uniformity test result (except PDF417 symbols). Note: The Verify parameter in the ReadIDCode function must be
enabled. For more information, see ReadIDCode.
|
|
Returns the total number of edges found for one valid scan line for the verified RSS CC-A\CC-B symbol component(s). Note:
|
|
Returns the ratio of the maximum non-uniformity found in a 2D RSS CC-A\CC-B symbol's quiet zones to the average symbol contrast. The Verify checkbox in ReadIDCode must be enabled. Note:
|
|
Returns the undecoded data stream from a read symbol of a Code 128 symbol. |
|
Returns the minimum (dark) reflectance for a 2D RSS CC-A\CC-B or Postal symbol. Note:
|
|
Returns the maximum (light) reflectance for a 2D RSS CC-A\CC-B or Postal symbol. Note:
|
|
Returns the minimum (narrowest) element width for a Postal barcode. For 2D symbols, the average size, in pixels, of the cells is returned. |
|
Returns the row coordinate (in pixels) of the upper left-hand corner of a Postal symbol and the row (y) coordinate for 2D symbols at the indexed (0 to 3) finder pattern point. For more information, see Finder Pattern Points. Note: The Verify parameter in the ReadIDCode function must be
enabled. For more information, see ReadIDCode.
|
|
Returns the standard deviation of the skew of the bars in a Postal barcode. Note:
|
|
Returns the standard deviation of the space width between bars in a Postal barcode. Note:
|
|
Returns the standard deviation of the width of the bars in a Postal barcode. Note:
|
|
Returns the standard deviation of the contrast between foreground and background in grey levels in a Postal barcode. Note:
|
|
Returns the string encoded in the symbol. |
|
Returns the type of symbol, as a three-character code, based on the ISO 15424 specification. Note: The Algorithm parameter in the ReadIDCode function must be enabled.
|
|
Returns the unused error correction test result for a 2D symbol, as a percentage. |
|
Returns the width of the symbol. Note: The Verify parameter in the ReadIDCode function must be
enabled. For more information, see ReadIDCode.
|