Class MrzConfig
-
- All Implemented Interfaces:
-
java.io.Serializable
public class MrzConfig implements Serializable
Configuration for scanning machine-readable zones (MRZ) of passports and other IDs
-
-
Field Summary
Fields Modifier and Type Field Description public MrzFieldScanOptionsmrzFieldScanOptionspublic MrzMinFieldConfidencesmrzMinFieldConfidencespublic BooleanstrictModepublic BooleancropAndTransformIDpublic IntegerminConfidencepublic BooleanfaceDetectionEnabled
-
Constructor Summary
Constructors Constructor Description MrzConfig()
-
Method Summary
Modifier and Type Method Description MrzFieldScanOptionsgetMrzFieldScanOptions()The fieldmrzScanOptions configure which text fields shall be captured mandatory, optional or not at all. voidsetMrzFieldScanOptions(MrzFieldScanOptions mrzFieldScanOptions)The fieldmrzScanOptions configure which text fields shall be captured mandatory, optional or not at all. MrzMinFieldConfidencesgetMrzMinFieldConfidences()The minFieldConfidences configure which fields must reach which confidence thresholds in order to be part of the scan result. voidsetMrzMinFieldConfidences(MrzMinFieldConfidences mrzMinFieldConfidences)The minFieldConfidences configure which fields must reach which confidence thresholds in order to be part of the scan result. BooleangetStrictMode()When enabling the strictMode, a result is only returned if all the check digits on the scanned document are valid. voidsetStrictMode(Boolean strictMode)When enabling the strictMode, a result is only returned if all the check digits on the scanned document are valid. BooleangetCropAndTransformID()The cropAndTransformID determines whether or not the image shall be cropped and transformed. voidsetCropAndTransformID(Boolean cropAndTransformID)The cropAndTransformID determines whether or not the image shall be cropped and transformed. IntegergetMinConfidence()Sets a minimum confidence which has to be reached in order to trigger a scan result. voidsetMinConfidence(Integer minConfidence)Sets a minimum confidence which has to be reached in order to trigger a scan result. BooleangetFaceDetectionEnabled()Sets whether the face detection approach is enabled. voidsetFaceDetectionEnabled(Boolean faceDetectionEnabled)Sets whether the face detection approach is enabled. StringtoString()inthashCode()booleanequals(Object other)-
-
Method Detail
-
getMrzFieldScanOptions
MrzFieldScanOptions getMrzFieldScanOptions()
The fieldmrzScanOptions configure which text fields shall be captured mandatory, optional or not at all.
-
setMrzFieldScanOptions
void setMrzFieldScanOptions(MrzFieldScanOptions mrzFieldScanOptions)
The fieldmrzScanOptions configure which text fields shall be captured mandatory, optional or not at all.
-
getMrzMinFieldConfidences
MrzMinFieldConfidences getMrzMinFieldConfidences()
The minFieldConfidences configure which fields must reach which confidence thresholds in order to be part of the scan result.
-
setMrzMinFieldConfidences
void setMrzMinFieldConfidences(MrzMinFieldConfidences mrzMinFieldConfidences)
The minFieldConfidences configure which fields must reach which confidence thresholds in order to be part of the scan result.
-
getStrictMode
Boolean getStrictMode()
When enabling the strictMode, a result is only returned if all the check digits on the scanned document are valid. (Required)
-
setStrictMode
void setStrictMode(Boolean strictMode)
When enabling the strictMode, a result is only returned if all the check digits on the scanned document are valid. (Required)
-
getCropAndTransformID
Boolean getCropAndTransformID()
The cropAndTransformID determines whether or not the image shall be cropped and transformed. (Required)
-
setCropAndTransformID
void setCropAndTransformID(Boolean cropAndTransformID)
The cropAndTransformID determines whether or not the image shall be cropped and transformed. (Required)
-
getMinConfidence
Integer getMinConfidence()
Sets a minimum confidence which has to be reached in order to trigger a scan result.
-
setMinConfidence
void setMinConfidence(Integer minConfidence)
Sets a minimum confidence which has to be reached in order to trigger a scan result.
-
getFaceDetectionEnabled
Boolean getFaceDetectionEnabled()
Sets whether the face detection approach is enabled.
-
setFaceDetectionEnabled
void setFaceDetectionEnabled(Boolean faceDetectionEnabled)
Sets whether the face detection approach is enabled.
-
hashCode
int hashCode()
-
-
-
-