Table of Contents

Class BarcodeRecognitionOptionBuilder

Namespace
CapCognition.Net.BarcodeScanning.Common
Assembly
CapCognition.Net.BarcodeScanning.dll
public class BarcodeRecognitionOptionBuilder
Inheritance
BarcodeRecognitionOptionBuilder
Inherited Members

Constructors

BarcodeRecognitionOptionBuilder(RecognitionOptionBuilder, Action<BarcodeRecognitionOptions>) 

public BarcodeRecognitionOptionBuilder(RecognitionOptionBuilder parent, Action<BarcodeRecognitionOptions> onDone)

Parameters

parent RecognitionOptionBuilder
onDone Action<BarcodeRecognitionOptions>

Methods

ConfigureOption(Action<BarcodeRecognitionOptions>)

Gives the option to configure the BarcodeRecognitionOption and directly calling methods on the option.

public BarcodeRecognitionOptionBuilder ConfigureOption(Action<BarcodeRecognitionOptions> configAction)

Parameters

configAction Action<BarcodeRecognitionOptions>

Returns

BarcodeRecognitionOptionBuilder

Done()

Call this when done configuring this option Note: This method has to be the last method called in the builder chain.

public RecognitionOptionBuilder Done()

Returns

RecognitionOptionBuilder

EnableMultiCodeReader(bool)

If set, multiple barcodes are recognized in one image If false, only the first barcode is recognized Note: The recognition is slower if multiple barcodes should be recognized. So only set this to true if you really need it.

public BarcodeRecognitionOptionBuilder EnableMultiCodeReader(bool enable = true)

Parameters

enable bool

Returns

BarcodeRecognitionOptionBuilder

SetBarcodeFormats(IEnumerable<BarcodeFormat>)

Barcode formats to recognize. If null, all formats are recognized.

public BarcodeRecognitionOptionBuilder SetBarcodeFormats(IEnumerable<BarcodeRecognitionOptions.BarcodeFormat> formats)

Parameters

formats IEnumerable<BarcodeRecognitionOptions.BarcodeFormat>

Returns

BarcodeRecognitionOptionBuilder

SetBinarizer(BinarizerType)

Sets the binarizer to use

public BarcodeRecognitionOptionBuilder SetBinarizer(BarcodeRecognitionOptions.BinarizerType binarizer)

Parameters

binarizer BarcodeRecognitionOptions.BinarizerType

Returns

BarcodeRecognitionOptionBuilder

SetEncoding(Encoding)

If provided, the recognition will only recognize barcodes with the given CharacterSet If null, all barcodes are recognized but the recognition is slower

public BarcodeRecognitionOptionBuilder SetEncoding(Encoding encoding)

Parameters

encoding Encoding

Returns

BarcodeRecognitionOptionBuilder

SetTryQuadrantFallback(bool)

Enable quadrant search after all full-image attempts fail.

public BarcodeRecognitionOptionBuilder SetTryQuadrantFallback(bool enabled)

Parameters

enabled bool

Returns

BarcodeRecognitionOptionBuilder

TryInverted(bool)

If set to true, the recognition will also try to recognize inverted barcodes

public BarcodeRecognitionOptionBuilder TryInverted(bool enable = true)

Parameters

enable bool

Returns

BarcodeRecognitionOptionBuilder

UseAutomaticQRDecodingSelection()

Configures the builder to automatically select the optimal QR code decoding method based on the input data. The improved qr decoding algorithm provides better handling of perspective distortion in high-resolution images but is slightly slower. Recommended for industrial scenarios and high-quality scans.

public BarcodeRecognitionOptionBuilder UseAutomaticQRDecodingSelection()

Returns

BarcodeRecognitionOptionBuilder

The current BarcodeRecognitionOptionBuilder instance for method chaining.

Remarks

When automatic selection is enabled, the decoding algorithm is chosen internally to maximize recognition accuracy for different types of QR codes and image size. This setting overrides any explicit QR decoding method previously specified.

UseFastQRFinder()

Set the standard finder for QR codes during recognition.

public BarcodeRecognitionOptionBuilder UseFastQRFinder()

Returns

BarcodeRecognitionOptionBuilder

The current BarcodeRecognitionOptionBuilder instance for method chaining.

UseFastRecognition(bool)

If set to true, the recognition assumes the qr codes and barcodes are always already correct aligned (+/- 45 degrees) so no rotation needs to be done. This speeds up the recognition process but will not recognize all the rotated barcodes.

public BarcodeRecognitionOptionBuilder UseFastRecognition(bool enable = true)

Parameters

enable bool

Returns

BarcodeRecognitionOptionBuilder

UseImprovedQRDecoding()

Enables improved decoding for QR codes during barcode recognition.

public BarcodeRecognitionOptionBuilder UseImprovedQRDecoding()

Returns

BarcodeRecognitionOptionBuilder

The current BarcodeRecognitionOptionBuilder instance to allow method chaining.

Remarks

The improved qr decoding algorithm provides better handling of perspective distortion in high-resolution images but is slightly slower. Recommended for industrial scenarios and high-quality scans.

UseImprovedQRFinder()

Enables improved detection for QR codes during recognition.

public BarcodeRecognitionOptionBuilder UseImprovedQRFinder()

Returns

BarcodeRecognitionOptionBuilder

The current BarcodeRecognitionOptionBuilder instance for method chaining.

Remarks

Configures the builder to use the enhanced QR code detection method by applying additional image filters before detecting qr codes which may improve accuracy in challenging scanning conditions like blurred images or images with shadows but also increase processing time. When set to false, the standard detection algorithm is used.

UseStandardQRDecoding()

Configures the builder to use the standard QR code decoding algorithm instead of the improved decoding method.

public BarcodeRecognitionOptionBuilder UseStandardQRDecoding()

Returns

BarcodeRecognitionOptionBuilder

The current BarcodeRecognitionOptionBuilder instance for method chaining.