Back to FabImage Library website

You are here: Start » Function Reference » Computer Vision » Barcodes » ReadSingleBarcode_Deprecated

ReadSingleBarcode_Deprecated


Header: FIL.h
Namespace: fil
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 fil::ReadSingleBarcode_Deprecated
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Rectangle2D&> inRoi,
	ftl::Optional<const fil::CoordinateSystem2D&> inRoiAlignment,
	ftl::Optional<fil::BarcodeFormat::Type> inBarcodeFormat,
	float inMinGradientLength,
	int inBaseBarWidth,
	int inDetectionScanCount,
	const int inReadingScanCount,
	const int inScanWidth,
	const float inMinStrength,
	const float inSmoothingStdDev,
	fil::Polarity::Type inPolarity,
	ftl::Conditional<fil::Rectangle2D>& outBarcodePosition,
	ftl::Conditional<ftl::String>& outDecodedText,
	ftl::Conditional<fil::BarcodeFormat::Type>& outBarcodeFormat,
	ftl::Optional<ftl::Conditional<fil::Polarity::Type>&> outBarcodePolarity = ftl::NIL,
	ftl::Optional<fil::Rectangle2D&> outAlignedRoi = ftl::NIL,
	ftl::Optional<ftl::Array<fil::Rectangle2D>&> outBarcodeCandidates = ftl::NIL,
	fil::Image& diagGradientImage,
	ftl::Array<fil::Segment2D>& diagScheduledScanSegments
)

Parameters

Name Type Range Default Description
Input value inImage const Image& Input image
Input value inRoi Optional<const Rectangle2D&> NIL Region of interest
Input value inRoiAlignment Optional<const CoordinateSystem2D&> NIL Adjusts the region of interest to the position of the inspected object
Input value inBarcodeFormat Optional<BarcodeFormat::Type> EAN13 Format of the barcode
Input value inMinGradientLength float 0.0 - 8.0f Minimal gradient length of edge pixels used for detecting barcodes
Input value inBaseBarWidth int 1 - 3 Estimated width of the thinnest bar
Input value inDetectionScanCount int 1 - 5 Number of scan lines used in detecting barcode
Input value inReadingScanCount const int 1 - 5 Number of parallel scans run until first successful read
Input value inScanWidth const int 1 - 5 Width of the single scan
Input value inMinStrength const float 0.0 - 5.0f Minimal strength of an extracted edge
Input value inSmoothingStdDev const float 0.0 - 0.25f Standard deviation of the gaussian smoothing applied to the profile extracted in each scan
Input value inPolarity Polarity::Type Dark Specifies whether code is darker or brighter than the background
Output value outBarcodePosition Conditional<Rectangle2D>& Position of the found barcode
Output value outDecodedText Conditional<String>& Decoded barcode content or nothing if all of the scans failed
Output value outBarcodeFormat Conditional<BarcodeFormat::Type>& Decoded barcode format or nothing if all of the scans failed
Output value outBarcodePolarity Optional<Conditional<Polarity::Type>&> NIL Decoded barcode polarity or nothing if all of the scans failed
Output value outAlignedRoi Optional<Rectangle2D&> NIL Input ROI after transformation (in the image coordinates)
Output value outBarcodeCandidates Optional<Array<Rectangle2D>&> NIL Places with high gradient values that are further investigated
Diagnostic input diagGradientImage Image& Image of gradient directions
Diagnostic input diagScheduledScanSegments Array<Segment2D>& Scheduled scan segments

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outBarcodePolarity, outAlignedRoi, outBarcodeCandidates.

Read more about Optional Outputs.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.