Detailed Description
Typedef Documentation
◆ scanbotsdk_medical_certificate_check_box_t
| typedef struct scanbotsdk_medical_certificate_check_box_t scanbotsdk_medical_certificate_check_box_t |
scanbotsdk_medical_certificate_check_box_t class
Structure to contain full information about found box.
◆ scanbotsdk_medical_certificate_check_box_type_t
| typedef enum scanbotsdk_medical_certificate_check_box_type_t scanbotsdk_medical_certificate_check_box_type_t |
scanbotsdk_medical_certificate_check_box_type_t enum
Type of the checkbox.
◆ scanbotsdk_medical_certificate_date_record_t
| typedef struct scanbotsdk_medical_certificate_date_record_t scanbotsdk_medical_certificate_date_record_t |
scanbotsdk_medical_certificate_date_record_t class
Structure to contain date record information.
◆ scanbotsdk_medical_certificate_date_record_type_t
| typedef enum scanbotsdk_medical_certificate_date_record_type_t scanbotsdk_medical_certificate_date_record_type_t |
scanbotsdk_medical_certificate_date_record_type_t enum
Type of a date record.
◆ scanbotsdk_medical_certificate_form_type_t
scanbotsdk_medical_certificate_form_type_t enum
Type of the medical certificate form.
◆ scanbotsdk_medical_certificate_patient_info_box_t
| typedef struct scanbotsdk_medical_certificate_patient_info_box_t scanbotsdk_medical_certificate_patient_info_box_t |
scanbotsdk_medical_certificate_patient_info_box_t class
Patient information box.
◆ scanbotsdk_medical_certificate_patient_info_field_t
| typedef struct scanbotsdk_medical_certificate_patient_info_field_t scanbotsdk_medical_certificate_patient_info_field_t |
scanbotsdk_medical_certificate_patient_info_field_t class
Patient information field.
◆ scanbotsdk_medical_certificate_patient_info_field_type_t
| typedef enum scanbotsdk_medical_certificate_patient_info_field_type_t scanbotsdk_medical_certificate_patient_info_field_type_t |
scanbotsdk_medical_certificate_patient_info_field_type_t enum
Type of a field in the patient info box.
◆ scanbotsdk_medical_certificate_scanner_t
scanbotsdk_medical_certificate_scanner_t class
API for medical certificate scanning.
Required licence feature(s): MedicalCertificateScanner.
◆ scanbotsdk_medical_certificate_scanning_parameters_t
| typedef struct scanbotsdk_medical_certificate_scanning_parameters_t scanbotsdk_medical_certificate_scanning_parameters_t |
scanbotsdk_medical_certificate_scanning_parameters_t class
Parameters for the medical certificate scanning. The scanner supports Form 1 (Arbeitsunfähigkeitsbescheinigung) and Form 21a (Ärztliche Bescheinigung für den Bezug von Krankengeld bei Erkrankung eines Kindes) from the KBV (Kassenärztliche Bundesvereinigung) list of forms.
◆ scanbotsdk_medical_certificate_scanning_result_t
| typedef struct scanbotsdk_medical_certificate_scanning_result_t scanbotsdk_medical_certificate_scanning_result_t |
scanbotsdk_medical_certificate_scanning_result_t class
The result of the medical certificate scanning.
Enumeration Type Documentation
◆ scanbotsdk_medical_certificate_check_box_type_t
scanbotsdk_medical_certificate_check_box_type_t enum
Type of the checkbox.
◆ scanbotsdk_medical_certificate_date_record_type_t
scanbotsdk_medical_certificate_date_record_type_t enum
Type of a date record.
◆ scanbotsdk_medical_certificate_form_type_t
scanbotsdk_medical_certificate_form_type_t enum
Type of the medical certificate form.
◆ scanbotsdk_medical_certificate_patient_info_field_type_t
scanbotsdk_medical_certificate_patient_info_field_type_t enum
Type of a field in the patient info box.
Function Documentation
◆ scanbotsdk_medical_certificate_check_box_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_check_box_free | ( | scanbotsdk_medical_certificate_check_box_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_medical_certificate_check_box_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_medical_certificate_check_box_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_check_box_get_checked()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_check_box_get_checked | ( | scanbotsdk_medical_certificate_check_box_t * | self, |
| bool * | checked ) |
Returns value of checked field of the given object.
True if the box is checked.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_check_box_t checked Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_check_box_get_checked_confidence()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_check_box_get_checked_confidence | ( | scanbotsdk_medical_certificate_check_box_t * | self, |
| double * | checked_confidence ) |
Returns value of checked_confidence field of the given object.
Confidence of the checked/unchecked prediction.
Default is 0.0
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_check_box_t checked_confidence Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_check_box_get_quad()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_check_box_get_quad | ( | scanbotsdk_medical_certificate_check_box_t * | self, |
| scanbotsdk_pointf_t ** | quad ) |
Returns value of quad field of the given object. The returned value is direct view into memory, no pre-allocations needed.
Points of the box.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_check_box_t quad Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_check_box_get_quad_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_check_box_get_quad_size | ( | scanbotsdk_medical_certificate_check_box_t * | self, |
| size_t * | size ) |
Returns size of quad array.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_check_box_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_check_box_get_type()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_check_box_get_type | ( | scanbotsdk_medical_certificate_check_box_t * | self, |
| scanbotsdk_medical_certificate_check_box_type_t * | type ) |
Returns value of type field of the given object.
Box type.
Default is UNKNOWN
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_check_box_t type Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_check_box_type_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_check_box_type_t_to_string | ( | scanbotsdk_medical_certificate_check_box_type_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_medical_certificate_check_box_type_t value.
The returned string doesn't need to be freed.
- Parameters
-
value The value to be converted to string. result Pointer to a variable that will store the string representation of the value.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_date_record_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_date_record_free | ( | scanbotsdk_medical_certificate_date_record_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_medical_certificate_date_record_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_medical_certificate_date_record_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_date_record_get_quad()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_date_record_get_quad | ( | scanbotsdk_medical_certificate_date_record_t * | self, |
| scanbotsdk_pointf_t ** | quad ) |
Returns value of quad field of the given object. The returned value is direct view into memory, no pre-allocations needed.
Date box.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_date_record_t quad Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_date_record_get_quad_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_date_record_get_quad_size | ( | scanbotsdk_medical_certificate_date_record_t * | self, |
| size_t * | size ) |
Returns size of quad array.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_date_record_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_date_record_get_raw_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_date_record_get_raw_string | ( | scanbotsdk_medical_certificate_date_record_t * | self, |
| const char ** | raw_string ) |
Returns value of raw_string field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Raw date string.
Default is ""
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_date_record_t raw_string Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_date_record_get_recognition_confidence()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_date_record_get_recognition_confidence | ( | scanbotsdk_medical_certificate_date_record_t * | self, |
| double * | recognition_confidence ) |
Returns value of recognition_confidence field of the given object.
Confidence in the recognized value.
Default is 0.0
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_date_record_t recognition_confidence Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_date_record_get_type()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_date_record_get_type | ( | scanbotsdk_medical_certificate_date_record_t * | self, |
| scanbotsdk_medical_certificate_date_record_type_t * | type ) |
Returns value of type field of the given object.
Date type.
Default is UNDEFINED
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_date_record_t type Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_date_record_get_value()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_date_record_get_value | ( | scanbotsdk_medical_certificate_date_record_t * | self, |
| const char ** | value ) |
Returns value of value field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Validated date string.
Default is ""
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_date_record_t value Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_date_record_type_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_date_record_type_t_to_string | ( | scanbotsdk_medical_certificate_date_record_type_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_medical_certificate_date_record_type_t value.
The returned string doesn't need to be freed.
- Parameters
-
value The value to be converted to string. result Pointer to a variable that will store the string representation of the value.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_form_type_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_form_type_t_to_string | ( | scanbotsdk_medical_certificate_form_type_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_medical_certificate_form_type_t value.
The returned string doesn't need to be freed.
- Parameters
-
value The value to be converted to string. result Pointer to a variable that will store the string representation of the value.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_patient_info_box_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_box_free | ( | scanbotsdk_medical_certificate_patient_info_box_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_medical_certificate_patient_info_box_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_medical_certificate_patient_info_box_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_patient_info_box_get_fields()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_box_get_fields | ( | scanbotsdk_medical_certificate_patient_info_box_t * | self, |
| scanbotsdk_medical_certificate_patient_info_field_t ** | fields, | ||
| size_t | size ) |
Returns value of fields field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Vector of found fields.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_patient_info_box_t size Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function. fields Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_patient_info_box_get_fields_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_box_get_fields_size | ( | scanbotsdk_medical_certificate_patient_info_box_t * | self, |
| size_t * | size ) |
Returns size of fields array.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_patient_info_box_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_patient_info_box_get_has_contents()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_box_get_has_contents | ( | scanbotsdk_medical_certificate_patient_info_box_t * | self, |
| bool * | has_contents ) |
Returns value of has_contents field of the given object.
Whether the patient info box has contents.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_patient_info_box_t has_contents Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_patient_info_box_get_quad()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_box_get_quad | ( | scanbotsdk_medical_certificate_patient_info_box_t * | self, |
| scanbotsdk_pointf_t ** | quad ) |
Returns value of quad field of the given object. The returned value is direct view into memory, no pre-allocations needed.
Four corners of the patient info box.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_patient_info_box_t quad Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_patient_info_box_get_quad_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_box_get_quad_size | ( | scanbotsdk_medical_certificate_patient_info_box_t * | self, |
| size_t * | size ) |
Returns size of quad array.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_patient_info_box_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_patient_info_field_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_field_free | ( | scanbotsdk_medical_certificate_patient_info_field_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_medical_certificate_patient_info_field_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_medical_certificate_patient_info_field_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_patient_info_field_get_recognition_confidence()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_field_get_recognition_confidence | ( | scanbotsdk_medical_certificate_patient_info_field_t * | self, |
| double * | recognition_confidence ) |
Returns value of recognition_confidence field of the given object.
Confidence in the recognized value.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_patient_info_field_t recognition_confidence Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_patient_info_field_get_type()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_field_get_type | ( | scanbotsdk_medical_certificate_patient_info_field_t * | self, |
| scanbotsdk_medical_certificate_patient_info_field_type_t * | type ) |
Returns value of type field of the given object.
Field type.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_patient_info_field_t type Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_patient_info_field_get_value()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_field_get_value | ( | scanbotsdk_medical_certificate_patient_info_field_t * | self, |
| const char ** | value ) |
Returns value of value field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Field value.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_patient_info_field_t value Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_patient_info_field_type_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_patient_info_field_type_t_to_string | ( | scanbotsdk_medical_certificate_patient_info_field_type_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_medical_certificate_patient_info_field_type_t value.
The returned string doesn't need to be freed.
- Parameters
-
value The value to be converted to string. result Pointer to a variable that will store the string representation of the value.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanner_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanner_create | ( | scanbotsdk_medical_certificate_scanner_t ** | result | ) |
Creates a new instance of scanbotsdk_medical_certificate_scanner with given params and stores it in the location specified by the last argument.
As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_medical_certificate_scanner_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanner_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanner_free | ( | scanbotsdk_medical_certificate_scanner_t * | self | ) |
Frees the memory allocated for the instance of scanbotsdk_medical_certificate_scanner_t. If null is passed, the function does nothing.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanner_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanner_run()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanner_run | ( | scanbotsdk_medical_certificate_scanner_t * | self, |
| scanbotsdk_image_t * | image, | ||
| scanbotsdk_medical_certificate_scanning_parameters_t * | parameters, | ||
| scanbotsdk_medical_certificate_scanning_result_t ** | result ) |
Recognize the document in the given image.
As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanner_t method to be called on image The image to recognize. The value must not be null. parameters The recognition parameters. The value must not be null. result Pointer to a variable that will store the created instance of scanbotsdk_medical_certificate_scanner_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanning_parameters_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_create | ( | bool | should_crop_document, |
| bool | recognize_patient_info_box, | ||
| bool | recognize_barcode, | ||
| bool | extract_cropped_image, | ||
| bool | preprocess_input, | ||
| scanbotsdk_medical_certificate_scanning_parameters_t ** | result ) |
Creates a new instance of scanbotsdk_medical_certificate_scanning_parameters with given params and stores it in the location specified by the last argument.
As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.
- Parameters
-
should_crop_document Document will be detected and cropped before recognition. If false, a cropped image of a document is assumed.
Default is true
- Parameters
-
recognize_patient_info_box All data in the patient info box will be extracted. If false, the patient info box is ignored.
Default is true
- Parameters
-
recognize_barcode Some forms are printed with an extra barcode that encodes the same information as the document. Reading the barcode is more reliable than OCR and is recommended when possible. If false, the barcode will not be scanned.
Default is true
- Parameters
-
extract_cropped_image If true, cropped document image will be extracted and returned.
Default is false
- Parameters
-
preprocess_input If true, the image is sharpened before processing.
Default is false
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_medical_certificate_scanning_parameters_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanning_parameters_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_create_with_defaults | ( | scanbotsdk_medical_certificate_scanning_parameters_t ** | result | ) |
Creates a new instance of scanbotsdk_medical_certificate_scanning_parameters_t with given required params and stores it in the location specified by the last argument.
As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_medical_certificate_scanning_parameters_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanning_parameters_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_free | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_medical_certificate_scanning_parameters_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanning_parameters_get_extract_cropped_image()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_get_extract_cropped_image | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | self, |
| bool * | extract_cropped_image ) |
Returns value of extract_cropped_image field of the given object.
If true, cropped document image will be extracted and returned.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t extract_cropped_image Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_parameters_get_preprocess_input()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_get_preprocess_input | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | self, |
| bool * | preprocess_input ) |
Returns value of preprocess_input field of the given object.
If true, the image is sharpened before processing.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t preprocess_input Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_parameters_get_recognize_barcode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_get_recognize_barcode | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | self, |
| bool * | recognize_barcode ) |
Returns value of recognize_barcode field of the given object.
Some forms are printed with an extra barcode that encodes the same information as the document. Reading the barcode is more reliable than OCR and is recommended when possible. If false, the barcode will not be scanned.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t recognize_barcode Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_parameters_get_recognize_patient_info_box()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_get_recognize_patient_info_box | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | self, |
| bool * | recognize_patient_info_box ) |
Returns value of recognize_patient_info_box field of the given object.
All data in the patient info box will be extracted. If false, the patient info box is ignored.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t recognize_patient_info_box Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_parameters_get_should_crop_document()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_get_should_crop_document | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | self, |
| bool * | should_crop_document ) |
Returns value of should_crop_document field of the given object.
Document will be detected and cropped before recognition. If false, a cropped image of a document is assumed.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t should_crop_document Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_parameters_set_extract_cropped_image()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_set_extract_cropped_image | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | self, |
| bool | extract_cropped_image ) |
Sets value of extract_cropped_image field of the given object.
If true, cropped document image will be extracted and returned.
Default is false
As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t, the field of which will be set extract_cropped_image The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanning_parameters_set_preprocess_input()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_set_preprocess_input | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | self, |
| bool | preprocess_input ) |
Sets value of preprocess_input field of the given object.
If true, the image is sharpened before processing.
Default is false
As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t, the field of which will be set preprocess_input The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanning_parameters_set_recognize_barcode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_set_recognize_barcode | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | self, |
| bool | recognize_barcode ) |
Sets value of recognize_barcode field of the given object.
Some forms are printed with an extra barcode that encodes the same information as the document. Reading the barcode is more reliable than OCR and is recommended when possible. If false, the barcode will not be scanned.
Default is true
As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t, the field of which will be set recognize_barcode The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanning_parameters_set_recognize_patient_info_box()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_set_recognize_patient_info_box | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | self, |
| bool | recognize_patient_info_box ) |
Sets value of recognize_patient_info_box field of the given object.
All data in the patient info box will be extracted. If false, the patient info box is ignored.
Default is true
As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t, the field of which will be set recognize_patient_info_box The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanning_parameters_set_should_crop_document()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_parameters_set_should_crop_document | ( | scanbotsdk_medical_certificate_scanning_parameters_t * | self, |
| bool | should_crop_document ) |
Sets value of should_crop_document field of the given object.
Document will be detected and cropped before recognition. If false, a cropped image of a document is assumed.
Default is true
As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_parameters_t, the field of which will be set should_crop_document The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanning_result_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_free | ( | scanbotsdk_medical_certificate_scanning_result_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_medical_certificate_scanning_result_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_medical_certificate_scanning_result_get_check_boxes()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_check_boxes | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| scanbotsdk_medical_certificate_check_box_t ** | check_boxes, | ||
| size_t | size ) |
Returns value of check_boxes field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Found checkboxes.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t size Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function. check_boxes Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_check_boxes_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_check_boxes_size | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| size_t * | size ) |
Returns size of check_boxes array.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_clockwise_rotations()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_clockwise_rotations | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| int * | clockwise_rotations ) |
Returns value of clockwise_rotations field of the given object.
The number of 90-degree clockwise rotations that were applied to the original image. The same number of counter-clockwise rotations are necessary to make the image upright again.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t clockwise_rotations Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_cropped_image()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_cropped_image | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| scanbotsdk_image_t ** | cropped_image ) |
Returns value of cropped_image field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
The cropped image used for recognition.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t cropped_image Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_dates()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_dates | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| scanbotsdk_medical_certificate_date_record_t ** | dates, | ||
| size_t | size ) |
Returns value of dates field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Found dates.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t size Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function. dates Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_dates_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_dates_size | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| size_t * | size ) |
Returns size of dates array.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_document_detection_result()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_document_detection_result | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| scanbotsdk_document_detection_result_t ** | document_detection_result ) |
Returns value of document_detection_result field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Result of the document detection in the input image. Is available only if the shouldCropDocument parameter is set to true.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t document_detection_result Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_form_type()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_form_type | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| scanbotsdk_medical_certificate_form_type_t * | form_type ) |
Returns value of form_type field of the given object.
Form type.
Default is UNKNOWN
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t form_type Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_patient_info_box()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_patient_info_box | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| scanbotsdk_medical_certificate_patient_info_box_t ** | patient_info_box ) |
Returns value of patient_info_box field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Patient info box.
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t patient_info_box Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_scale_x()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_scale_x | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| double * | scale_x ) |
Returns value of scale_x field of the given object.
The scale factor used to scale the image to the recognition size.
Default is 1.0
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t scale_x Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_scale_y()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_scale_y | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| double * | scale_y ) |
Returns value of scale_y field of the given object.
The scale factor used to scale the image to the recognition size.
Default is 1.0
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t scale_y Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_medical_certificate_scanning_result_get_scanning_successful()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_medical_certificate_scanning_result_get_scanning_successful | ( | scanbotsdk_medical_certificate_scanning_result_t * | self, |
| bool * | scanning_successful ) |
Returns value of scanning_successful field of the given object.
True if scanning was successful.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_medical_certificate_scanning_result_t scanning_successful Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
Generated by
1.13.2