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 <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 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_document_quality_analyzer_configuration_t scanbotsdk_document_quality_analyzer_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_create(
    scanbotsdk_document_quality_threshold_t** quality_thresholds,
    size_t quality_thresholds_size,
    scanbotsdk_document_quality_t* quality_indices,
    size_t quality_indices_size,
    bool detect_orientation,
    bool inspect_small_text,
    int max_image_size,
    int min_estimated_number_of_symbols_for_document,
    double min_processed_fraction,
    double max_processed_fraction,
    int min_number_of_required_symbols,
    double min_required_orientation_confidence,
    int tile_size,
    bool return_quality_heatmap,
    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_thresholds(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_document_quality_threshold_t** quality_thresholds, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_quality_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_thresholds(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_document_quality_threshold_t** quality_thresholds, size_t quality_thresholds_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_quality_indices(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_document_quality_t** quality_indices);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_quality_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_indices(scanbotsdk_document_quality_analyzer_configuration_t* self, scanbotsdk_document_quality_t* quality_indices, size_t quality_indices_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_detect_orientation(scanbotsdk_document_quality_analyzer_configuration_t* self, bool* detect_orientation);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_detect_orientation(scanbotsdk_document_quality_analyzer_configuration_t* self, bool detect_orientation);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_inspect_small_text(scanbotsdk_document_quality_analyzer_configuration_t* self, bool* inspect_small_text);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_inspect_small_text(scanbotsdk_document_quality_analyzer_configuration_t* self, bool inspect_small_text);

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_min_processed_fraction(scanbotsdk_document_quality_analyzer_configuration_t* self, double* min_processed_fraction);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_min_processed_fraction(scanbotsdk_document_quality_analyzer_configuration_t* self, double min_processed_fraction);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_max_processed_fraction(scanbotsdk_document_quality_analyzer_configuration_t* self, double* max_processed_fraction);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_max_processed_fraction(scanbotsdk_document_quality_analyzer_configuration_t* self, double max_processed_fraction);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_min_number_of_required_symbols(scanbotsdk_document_quality_analyzer_configuration_t* self, int* min_number_of_required_symbols);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_min_number_of_required_symbols(scanbotsdk_document_quality_analyzer_configuration_t* self, int min_number_of_required_symbols);

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_tile_size(scanbotsdk_document_quality_analyzer_configuration_t* self, int* tile_size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_tile_size(scanbotsdk_document_quality_analyzer_configuration_t* self, int tile_size);

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);
 

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_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(scanbotsdk_document_quality_analyzer_result_t* self, scanbotsdk_document_quality_t** quality);

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_cumulative_contrast_histogram(scanbotsdk_document_quality_analyzer_result_t* self, int** cumulative_contrast_histogram);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_cumulative_contrast_histogram_size(scanbotsdk_document_quality_analyzer_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_cumulative_text_size_histogram(scanbotsdk_document_quality_analyzer_result_t* self, int** cumulative_text_size_histogram);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_cumulative_text_size_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);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_DOCUMENTQUALITYANALYZERTYPES_H */