Back to Aurora Vision Library website
You are here: Start » Function Reference » Computer Vision » Barcodes » ReadSingleBarcode_Deprecated
ReadSingleBarcode_Deprecated
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | Barcodes |
Detects and recognizes a single barcode on the input image.
Applications: To be used as an easy all-in-one solution for typical barcode reading applications.
Syntax
void avl::ReadSingleBarcode_Deprecated ( const avl::Image& inImage, atl::Optional<const avl::Rectangle2D&> inRoi, atl::Optional<const avl::CoordinateSystem2D&> inRoiAlignment, atl::Optional<avl::BarcodeFormat::Type> inBarcodeFormat, float inMinGradientLength, int inBaseBarWidth, int inDetectionScanCount, const int inReadingScanCount, const int inScanWidth, const float inMinStrength, const float inSmoothingStdDev, avl::Polarity::Type inPolarity, atl::Conditional<avl::Rectangle2D>& outBarcodePosition, atl::Conditional<atl::String>& outDecodedText, atl::Conditional<avl::BarcodeFormat::Type>& outBarcodeFormat, atl::Optional<atl::Conditional<avl::Polarity::Type>&> outBarcodePolarity = atl::NIL, atl::Optional<avl::Rectangle2D&> outAlignedRoi = atl::NIL, atl::Optional<atl::Array<avl::Rectangle2D>&> outBarcodeCandidates = atl::NIL, avl::Image& diagGradientImage, atl::Array<avl::Segment2D>& diagScheduledScanSegments )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inImage | const Image& | Input image | |||
inRoi | Optional<const Rectangle2D&> | NIL | Region of interest | ||
inRoiAlignment | Optional<const CoordinateSystem2D&> | NIL | Adjusts the region of interest to the position of the inspected object | ||
inBarcodeFormat | Optional<BarcodeFormat::Type> | EAN13 | Format of the barcode | ||
inMinGradientLength | float | 0.0 - | 8.0f | Minimal gradient length of edge pixels used for detecting barcodes | |
inBaseBarWidth | int | 1 - | 3 | Estimated width of the thinnest bar | |
inDetectionScanCount | int | 1 - | 5 | Number of scan lines used in detecting barcode | |
inReadingScanCount | const int | 1 - | 5 | Number of parallel scans run until first successful read | |
inScanWidth | const int | 1 - | 5 | Width of the single scan | |
inMinStrength | const float | 0.0 - | 5.0f | Minimal strength of an extracted edge | |
inSmoothingStdDev | const float | 0.0 - | 0.25f | Standard deviation of the gaussian smoothing applied to the profile extracted in each scan | |
inPolarity | Polarity::Type | Dark | Specifies whether code is darker or brighter than the background | ||
outBarcodePosition | Conditional<Rectangle2D>& | Position of the found barcode | |||
outDecodedText | Conditional<String>& | Decoded barcode content or nothing if all of the scans failed | |||
outBarcodeFormat | Conditional<BarcodeFormat::Type>& | Decoded barcode format or nothing if all of the scans failed | |||
outBarcodePolarity | Optional<Conditional<Polarity::Type>&> | NIL | Decoded barcode polarity or nothing if all of the scans failed | ||
outAlignedRoi | Optional<Rectangle2D&> | NIL | Input ROI after transformation (in the image coordinates) | ||
outBarcodeCandidates | Optional<Array<Rectangle2D>&> | NIL | Places with high gradient values that are further investigated | ||
diagGradientImage | Image& | Image of gradient directions | |||
diagScheduledScanSegments | Array<Segment2D>& | Scheduled scan segments |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outBarcodePolarity, outAlignedRoi, outBarcodeCandidates.
Read more about Optional Outputs.
Hardware Acceleration
This operation supports automatic parallelization for multicore and multiprocessor systems.