Settings for configuring MBBlinkIdRecognizer. More...

#include <IdRecognizer.h>

Public Member Functions
MB_API void MB_CALL	blinkIdRecognizerSettingsDefaultInit (MBBlinkIdRecognizerSettings *)
	Populate MBBlinkIdRecognizerSettings structure with default values. More...

Data Fields
MBBool	allowBlurFilter

MBBool	allowUnparsedMrzResults

MBBool	allowUnverifiedMrzResults

float	paddingEdge

MBBool	validateResultCharacters

MBAnonymizationMode	anonymizationMode

MBRecognitionModeFilter	recognitionModeFilter

MBFullDocumentImageOptions	fullDocumentImageOptions

MBImageOptions	faceImageOptions

MBImageOptions	signatureImageOptions

MBBool	scanCroppedDocumentImage

MBBool	saveCameraFrames

void(*	dewarpedImageCallback )(MBRawImage image)

void(*	classifierCallback )(MBBool supported)

void(*	barcodeScanningStartedCallback )()

MBBool(*	classFilter )(MBClassInfo classInfo)

Detailed Description

Settings for configuring MBBlinkIdRecognizer.

Member Function Documentation

◆ blinkIdRecognizerSettingsDefaultInit()

MB_API void MB_CALL blinkIdRecognizerSettingsDefaultInit ( MBBlinkIdRecognizerSettings * )

Populate MBBlinkIdRecognizerSettings structure with default values.

Returns: Nothing

Field Documentation

◆ allowBlurFilter

MBBool MBBlinkIdRecognizerSettings::allowBlurFilter

Whether blured frames filtering is allowed

◆ allowUnparsedMrzResults

MBBool MBBlinkIdRecognizerSettings::allowUnparsedMrzResults

Whether returning of unparsed MRZ (Machine Readable Zone) results is allowed

◆ allowUnverifiedMrzResults

MBBool MBBlinkIdRecognizerSettings::allowUnverifiedMrzResults

Whether returning unverified MRZ (Machine Readable Zone) results is allowed Unverified MRZ is parsed, but check digits are incorrect.

◆ anonymizationMode

MBAnonymizationMode MBBlinkIdRecognizerSettings::anonymizationMode

Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents.

◆ barcodeScanningStartedCallback

void(* MBBlinkIdRecognizerSettings::barcodeScanningStartedCallback) ()

Called when barcode scanning step starts.

◆ classFilter

MBBool(* MBBlinkIdRecognizerSettings::classFilter) (MBClassInfo classInfo)

Called when recognizer classifies document as a supported class. Enables filtering based on class.

Parameters

classInfo - classInfo of the document

Returns: should class be processed: true process, false skip

◆ classifierCallback

void(* MBBlinkIdRecognizerSettings::classifierCallback) (MBBool supported)

Called when recognizer classifies document.

Parameters

supported - true if supported, false otherwise

◆ dewarpedImageCallback

void(* MBBlinkIdRecognizerSettings::dewarpedImageCallback) (MBRawImage image)

Called when dewarped full document image is available.

◆ faceImageOptions

MBImageOptions MBBlinkIdRecognizerSettings::faceImageOptions

Options for the faceImage.

◆ fullDocumentImageOptions

MBFullDocumentImageOptions MBBlinkIdRecognizerSettings::fullDocumentImageOptions

Image options for the fullDocumentImage.

◆ paddingEdge

float MBBlinkIdRecognizerSettings::paddingEdge

Pading is a minimum distance from the edge of the frame and is defined as a percentage of the frame width. Default value is 0.0f and in that case padding edge and image edge are the same.

◆ recognitionModeFilter

MBRecognitionModeFilter MBBlinkIdRecognizerSettings::recognitionModeFilter

Enable or disable recognition of specific document groups supported by the current license. By default all modes are enabled.

◆ saveCameraFrames

MBBool MBBlinkIdRecognizerSettings::saveCameraFrames

Configure the recognizer to save the raw camera frames. This significantly increases memory consumption.

◆ scanCroppedDocumentImage

MBBool MBBlinkIdRecognizerSettings::scanCroppedDocumentImage

Configure the recognizer to only work on already cropped and dewarped images. This only works for still images - video feeds will ignore this setting. Default: false.

◆ signatureImageOptions

MBImageOptions MBBlinkIdRecognizerSettings::signatureImageOptions

Options for the signatureImage.

◆ validateResultCharacters

MBBool MBBlinkIdRecognizerSettings::validateResultCharacters

Whether result characters validatation is performed. If a result member contains invalid character, the result state cannot be valid.

The documentation for this struct was generated from the following file:

inc/Recognizer/BlinkID/Generic/IdRecognizer.h

Public Member Functions

Data Fields