Skip to content

Latest commit

 

History

History
43 lines (39 loc) · 7.18 KB

ReaderParams.md

File metadata and controls

43 lines (39 loc) · 7.18 KB
Raw

ReaderParams

Properties

Name Type Description Notes
type DecodeBarcodeType The type of barcode to read. [optional]
checksum_validation ChecksumValidation Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies [optional]
detect_encoding bool A flag which force engine to detect codetext encoding for Unicode. [optional]
preset PresetType Preset allows to configure recognition quality and speed manually. You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of Preset is NormalQuality. [optional]
rect_x int Set X of top left corner of area for recognition. [optional]
rect_y int Set Y of top left corner of area for recognition. [optional]
rect_width int Set Width of area for recognition. [optional]
rect_height int Set Height of area for recognition. [optional]
strip_fnc bool Value indicating whether FNC symbol strip must be done. [optional]
timeout int Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 60_000 (1 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. [optional]
median_smoothing_window_size int Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. [optional]
allow_median_smoothing bool Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. [optional]
allow_complex_background bool Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. [optional]
allow_datamatrix_industrial_barcodes bool Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes. Slow mode which helps only for dashed barcodes which consist from spots. [optional]
allow_decreased_image bool Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms. Mode helps to recognize barcodes which are noised and blurred but captured with high resolution. [optional]
allow_detect_scan_gap bool Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes. [optional]
allow_incorrect_barcodes bool Allows engine to recognize barcodes which has incorrect checksum or incorrect values. Mode can be used to recognize damaged barcodes with incorrect text. [optional]
allow_invert_image bool Allows engine to recognize inverse color image as additional scan. Mode can be used when barcode is white on black background. [optional]
allow_micro_white_spots_removing bool Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize slightly damaged Postal barcodes. [optional]
allow_one_d_fast_barcodes_detector bool Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image. Mode helps to quickly recognize generated barcodes from Internet. [optional]
allow_one_d_wiped_bars_restoration bool Allows engine for 1D barcodes to recognize barcodes with single wiped/glued bars in pattern. [optional]
allow_qr_micro_qr_restoration bool Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes. [optional]
allow_regular_image bool Allows engine to recognize regular image without any restorations as main scan. Mode to recognize image as is. [optional]
allow_salt_and_pepper_filtering bool Allows engine to recognize barcodes with salt and pepper noise type. Mode can remove small noise with white and black dots. [optional]
allow_white_spots_removing bool Allows engine to recognize image without small white spots as additional scan. Mode helps to recognize noised image as well as median smoothing filtering. [optional]
check_more1_d_variants bool Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False. [optional]
fast_scan_only bool Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms. Default value: False. [optional]
region_likelihood_threshold_percent float Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between [0.05, 0.9] Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time. [optional]
scan_window_sizes list[int] Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality. [optional]
similarity float Similarity coefficient depends on how homogeneous barcodes are. Use high value for for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9] [optional]
skip_diagonal_search bool Allows detector to skip search for diagonal barcodes. Setting it to False will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time. [optional]
read_tiny_barcodes bool Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. [optional]
australian_post_encoding_table CustomerInformationInterpretingType Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. [optional]
ignore_ending_filling_patterns_for_c_table bool The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence "333" of filling patterns is decoded as letter "z". [optional]

[Back to Model list] [Back to API list] [Back to README]