You are here: Start » FIL.NET » FIS.ReadSingleBarcode Method

FIS.ReadSingleBarcode Method

Detects and recognizes a single barcode on the input image.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

public static void ReadSingleBarcode
(
	FilNet.Image inImage,
	FilNet.Rectangle2D? inRoi,
	FilNet.CoordinateSystem2D? inRoiAlignment,
	FilNet.BarcodeFormat? inBarcodeFormat,
	float inMinGradientLength,
	int inBaseBarWidth,
	int inDetectionScanCount,
	int inReadingScanCount,
	int inScanWidth,
	float inMinStrength,
	float inSmoothingStdDev,
	FilNet.Polarity inPolarity,
	out FilNet.Rectangle2D? outBarcodePosition,
	INullable<string> outDecodedText,
	out FilNet.BarcodeFormat? outBarcodeFormat,
	NullableRef<NullableValue<FilNet.Polarity>> outBarcodePolarity,
	NullableValue<FilNet.Rectangle2D> outAlignedRoi,
	NullableRef<List<FilNet.Rectangle2D>> outBarcodeCandidates
)

Parameters

Name Type Range Default Description
inImageFilNet.ImageInput image.
inRoiFilNet.Rectangle2D?Region of interest. Default value: ftl::NIL.
inRoiAlignmentFilNet.CoordinateSystem2D?Adjusts the region of interest to the position of the inspected object. Default value: ftl::NIL.
inBarcodeFormatFilNet.BarcodeFormat?EAN13Format of the barcode. Default value: EAN13.
inMinGradientLengthfloat<0.0f, INF>8.0fMinimal gradient length of edge pixels used for detecting barcodes. Default value: 8.0f.
inBaseBarWidthint<1, INF>3Estimated width of the thinnest bar. Default value: 3.
inDetectionScanCountint<1, INF>5Number of scan lines used in detecting barcode. Default value: 5.
inReadingScanCountint<1, INF>5Number of parallel scans run until first successful read. Default value: 5.
inScanWidthint<1, INF>5Width of the single scan. Default value: 5.
inMinStrengthfloat<0.0f, INF>5.0fMinimal strength of an extracted edge. Default value: 5.0f.
inSmoothingStdDevfloat<0.0f, INF>0.25fStandard deviation of the gaussian smoothing applied to the profile extracted in each scan. Default value: 0.25f.
inPolarityFilNet.PolarityDarkSpecifies whether code is darker or brighter than the background. Default value: Dark.
outBarcodePositionFilNet.Rectangle2D?Position of the found barcode.
outDecodedTextFilNet.INullable<string>Decoded barcode content or nothing if all of the scans failed. This parameter cannot be null.
outBarcodeFormatFilNet.BarcodeFormat?Decoded barcode format or nothing if all of the scans failed.
outBarcodePolarityFilNet.NullableRef<FilNet.NullableValue<FilNet.Polarity>>Decoded barcode polarity or nothing if all of the scans failed. Can be null to skip this parameter calculation.
outAlignedRoiFilNet.NullableValue<FilNet.Rectangle2D>Input ROI after transformation (in the image coordinates). Can be null to skip this parameter calculation.
outBarcodeCandidatesFilNet.NullableRef<System.Collections.Generic.List<FilNet.Rectangle2D>>Places with high gradient values that are further investigated. Can be null to skip this parameter calculation.

Function Overrides

See also