ScanbotSDKDocumentQualityAnalyzerTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/DocumentQualityAnalyzerTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_DOCUMENTQUALITYANALYZERTYPES_H
#define SCANBOTSDK_DOCUMENTQUALITYANALYZERTYPES_H
 
 
#include <ScanbotSDKImage.h>
#include <ScanbotSDKTypes.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <ScanbotSDKErrorCode.h>
#include <ScanbotSDKDefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 

typedef enum scanbotsdk_document_quality_t {

    SCANBOTSDK_DOCUMENT_QUALITY_VERY_POOR = 0,

    SCANBOTSDK_DOCUMENT_QUALITY_POOR = 1,

    SCANBOTSDK_DOCUMENT_QUALITY_REASONABLE = 2,

    SCANBOTSDK_DOCUMENT_QUALITY_GOOD = 3,

    SCANBOTSDK_DOCUMENT_QUALITY_EXCELLENT = 4,
 
} scanbotsdk_document_quality_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_t_to_string(scanbotsdk_document_quality_t value, const char** result);

typedef enum scanbotsdk_document_quality_assessment_t {

    SCANBOTSDK_DOCUMENT_QUALITY_ASSESSMENT_ACCEPTABLE = 0,

    SCANBOTSDK_DOCUMENT_QUALITY_ASSESSMENT_UNACCEPTABLE = 1,

    SCANBOTSDK_DOCUMENT_QUALITY_ASSESSMENT_UNCERTAIN = 2,
 
} scanbotsdk_document_quality_assessment_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_assessment_t_to_string(scanbotsdk_document_quality_assessment_t value, const char** result);

typedef struct scanbotsdk_document_quality_threshold_t scanbotsdk_document_quality_threshold_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_threshold_create(
    double symbol_quality,
    double symbol_ratio,
    scanbotsdk_document_quality_threshold_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_threshold_free(scanbotsdk_document_quality_threshold_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_threshold_get_symbol_quality(scanbotsdk_document_quality_threshold_t* self, double* symbol_quality);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_threshold_get_symbol_ratio(scanbotsdk_document_quality_threshold_t* self, double* symbol_ratio);
 

typedef struct scanbotsdk_process_by_tile_configuration_t scanbotsdk_process_by_tile_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_create(
    bool enabled,
    double min_processed_fraction,
    double max_processed_fraction,
    int min_number_of_required_symbols,
    int tile_size,
    scanbotsdk_process_by_tile_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_create_with_defaults(
    scanbotsdk_process_by_tile_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_free(scanbotsdk_process_by_tile_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_get_enabled(scanbotsdk_process_by_tile_configuration_t* self, bool* enabled);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_set_enabled(scanbotsdk_process_by_tile_configuration_t* self, bool enabled);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_get_min_processed_fraction(scanbotsdk_process_by_tile_configuration_t* self, double* min_processed_fraction);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_set_min_processed_fraction(scanbotsdk_process_by_tile_configuration_t* self, double min_processed_fraction);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_get_max_processed_fraction(scanbotsdk_process_by_tile_configuration_t* self, double* max_processed_fraction);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_set_max_processed_fraction(scanbotsdk_process_by_tile_configuration_t* self, double max_processed_fraction);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_get_min_number_of_required_symbols(scanbotsdk_process_by_tile_configuration_t* self, int* min_number_of_required_symbols);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_set_min_number_of_required_symbols(scanbotsdk_process_by_tile_configuration_t* self, int min_number_of_required_symbols);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_get_tile_size(scanbotsdk_process_by_tile_configuration_t* self, int* tile_size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_process_by_tile_configuration_set_tile_size(scanbotsdk_process_by_tile_configuration_t* self, int tile_size);
 

typedef enum scanbotsdk_document_quality_analyzer_compatibility_mode_t {

    SCANBOTSDK_DOCUMENT_QUALITY_ANALYZER_COMPATIBILITY_MODE_V8 = 0,
 
} scanbotsdk_document_quality_analyzer_compatibility_mode_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_t_to_string(scanbotsdk_document_quality_analyzer_compatibility_mode_t value, const char** result);

typedef struct scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_create(
    scanbotsdk_document_quality_analyzer_compatibility_mode_t mode,
    scanbotsdk_document_quality_t minimum_acceptable_quality,
    scanbotsdk_document_quality_t minimum_uncertain_quality,
    bool inspect_small_text,
    scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_create_with_defaults(
    scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_free(scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_get_mode(scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t* self, scanbotsdk_document_quality_analyzer_compatibility_mode_t* mode);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_get_minimum_acceptable_quality(scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t* self, scanbotsdk_document_quality_t* minimum_acceptable_quality);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_set_minimum_acceptable_quality(scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t* self, scanbotsdk_document_quality_t minimum_acceptable_quality);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_get_minimum_uncertain_quality(scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t* self, scanbotsdk_document_quality_t* minimum_uncertain_quality);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_set_minimum_uncertain_quality(scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t* self, scanbotsdk_document_quality_t minimum_uncertain_quality);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_get_inspect_small_text(scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t* self, bool* inspect_small_text);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_set_inspect_small_text(scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t* self, bool inspect_small_text);
 

typedef struct scanbotsdk_document_quality_analyzer_configuration_t scanbotsdk_document_quality_analyzer_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_create(
    scanbotsdk_u8string_ref_t quality_analysis_model,
    double quality_acceptable_uncertain_threshold,
    double quality_unacceptable_uncertain_threshold,
    scanbotsdk_document_quality_threshold_t** quality_level_thresholds,
    size_t quality_level_thresholds_size,
    scanbotsdk_document_quality_t* quality_level_indices,
    size_t quality_level_indices_size,
    double* input_scales,
    size_t input_scales_size,
    double input_scale_threshold_to_process_entire_image,
    int max_image_size,
    int min_estimated_number_of_symbols_for_document,
    scanbotsdk_process_by_tile_configuration_t* process_by_tile_configuration,
    double min_required_orientation_confidence,
    bool return_quality_heatmap,
    scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t* compatibility_mode,
    scanbotsdk_document_quality_analyzer_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_create_with_defaults(
    scanbotsdk_document_quality_analyzer_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_free(scanbotsdk_document_quality_analyzer_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_quality_analysis_model(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_u8string_ref_t* quality_analysis_model);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_quality_analysis_model(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_u8string_ref_t quality_analysis_model);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_quality_acceptable_uncertain_threshold(scanbotsdk_document_quality_analyzer_configuration_t* self, double* quality_acceptable_uncertain_threshold);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_quality_acceptable_uncertain_threshold(scanbotsdk_document_quality_analyzer_configuration_t* self, double quality_acceptable_uncertain_threshold);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_quality_unacceptable_uncertain_threshold(scanbotsdk_document_quality_analyzer_configuration_t* self, double* quality_unacceptable_uncertain_threshold);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_quality_unacceptable_uncertain_threshold(scanbotsdk_document_quality_analyzer_configuration_t* self, double quality_unacceptable_uncertain_threshold);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_quality_level_thresholds(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_document_quality_threshold_t** quality_level_thresholds, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_quality_level_thresholds_size(scanbotsdk_document_quality_analyzer_configuration_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_quality_level_thresholds(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_document_quality_threshold_t** quality_level_thresholds, size_t quality_level_thresholds_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_quality_level_indices(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_document_quality_t** quality_level_indices);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_quality_level_indices_size(scanbotsdk_document_quality_analyzer_configuration_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_quality_level_indices(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_document_quality_t* quality_level_indices, size_t quality_level_indices_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_input_scales(scanbotsdk_document_quality_analyzer_configuration_t* self, double** input_scales);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_input_scales_size(scanbotsdk_document_quality_analyzer_configuration_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_input_scales(scanbotsdk_document_quality_analyzer_configuration_t* self, double* input_scales, size_t input_scales_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_input_scale_threshold_to_process_entire_image(scanbotsdk_document_quality_analyzer_configuration_t* self, double* input_scale_threshold_to_process_entire_image);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_input_scale_threshold_to_process_entire_image(scanbotsdk_document_quality_analyzer_configuration_t* self, double input_scale_threshold_to_process_entire_image);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_max_image_size(scanbotsdk_document_quality_analyzer_configuration_t* self, int* max_image_size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_max_image_size(scanbotsdk_document_quality_analyzer_configuration_t* self, int max_image_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_min_estimated_number_of_symbols_for_document(scanbotsdk_document_quality_analyzer_configuration_t* self, int* min_estimated_number_of_symbols_for_document);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_min_estimated_number_of_symbols_for_document(scanbotsdk_document_quality_analyzer_configuration_t* self, int min_estimated_number_of_symbols_for_document);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_process_by_tile_configuration(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_process_by_tile_configuration_t** process_by_tile_configuration);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_process_by_tile_configuration(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_process_by_tile_configuration_t* process_by_tile_configuration);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_min_required_orientation_confidence(scanbotsdk_document_quality_analyzer_configuration_t* self, double* min_required_orientation_confidence);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_min_required_orientation_confidence(scanbotsdk_document_quality_analyzer_configuration_t* self, double min_required_orientation_confidence);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_return_quality_heatmap(scanbotsdk_document_quality_analyzer_configuration_t* self, bool* return_quality_heatmap);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_return_quality_heatmap(scanbotsdk_document_quality_analyzer_configuration_t* self, bool return_quality_heatmap);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_compatibility_mode(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t** compatibility_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_compatibility_mode(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_document_quality_analyzer_compatibility_mode_configuration_t* compatibility_mode);
 

typedef struct scanbotsdk_character_level_annotation_t scanbotsdk_character_level_annotation_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotation_free(scanbotsdk_character_level_annotation_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotation_get_plot_center(scanbotsdk_character_level_annotation_t* self, scanbotsdk_pointf_t* plot_center);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotation_get_plot_width(scanbotsdk_character_level_annotation_t* self, double* plot_width);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotation_get_plot_height(scanbotsdk_character_level_annotation_t* self, double* plot_height);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotation_get_ocrability(scanbotsdk_character_level_annotation_t* self, double* ocrability);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotation_get_contrast(scanbotsdk_character_level_annotation_t* self, double* contrast);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotation_get_font_size(scanbotsdk_character_level_annotation_t* self, double* font_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotation_get_orientation(scanbotsdk_character_level_annotation_t* self, double* orientation);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotation_get_orientation_normalized(scanbotsdk_character_level_annotation_t* self, double* orientation_normalized);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotation_get_orientation_deviation(scanbotsdk_character_level_annotation_t* self, double* orientation_deviation);
 

typedef struct scanbotsdk_character_level_annotations_t scanbotsdk_character_level_annotations_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotations_free(scanbotsdk_character_level_annotations_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotations_get_annotations(scanbotsdk_character_level_annotations_t* self, scanbotsdk_character_level_annotation_t** annotations, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotations_get_annotations_size(scanbotsdk_character_level_annotations_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_level_annotations_get_api_version(scanbotsdk_character_level_annotations_t* self, scanbotsdk_u8string_ref_t* api_version);
 

typedef struct scanbotsdk_document_quality_analyzer_training_data_t scanbotsdk_document_quality_analyzer_training_data_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_training_data_free(scanbotsdk_document_quality_analyzer_training_data_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_training_data_get_character_level_annotations(scanbotsdk_document_quality_analyzer_training_data_t* self, scanbotsdk_character_level_annotations_t** character_level_annotations);
 

typedef struct scanbotsdk_document_quality_analyzer_result_t scanbotsdk_document_quality_analyzer_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_free(scanbotsdk_document_quality_analyzer_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_quality(scanbotsdk_document_quality_analyzer_result_t* self, scanbotsdk_document_quality_assessment_t* quality);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_document_found(scanbotsdk_document_quality_analyzer_result_t* self, bool* document_found);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_quality_level(scanbotsdk_document_quality_analyzer_result_t* self, scanbotsdk_document_quality_t** quality_level);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_orientation(scanbotsdk_document_quality_analyzer_result_t* self, double* orientation);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_orientation_confidence(scanbotsdk_document_quality_analyzer_result_t* self, double* orientation_confidence);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_cumulative_quality_histogram(scanbotsdk_document_quality_analyzer_result_t* self, int** cumulative_quality_histogram);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_cumulative_quality_histogram_size(scanbotsdk_document_quality_analyzer_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_quality_heatmap(scanbotsdk_document_quality_analyzer_result_t* self, scanbotsdk_image_t** quality_heatmap);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_best_input_scale(scanbotsdk_document_quality_analyzer_result_t* self, double* best_input_scale);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_DOCUMENTQUALITYANALYZERTYPES_H */