Scanbot SDK
Loading...
Searching...
No Matches
ScanbotSDKDocumentQualityAnalyzerTypes.h File Reference

Go to the source code of this file.

Typedefs

typedef enum scanbotsdk_document_quality_t scanbotsdk_document_quality_t
 scanbotsdk_document_quality_t enum
 
typedef struct scanbotsdk_document_quality_threshold_t scanbotsdk_document_quality_threshold_t
 scanbotsdk_document_quality_threshold_t class
 
typedef struct scanbotsdk_document_quality_analyzer_configuration_t scanbotsdk_document_quality_analyzer_configuration_t
 scanbotsdk_document_quality_analyzer_configuration_t class
 
typedef struct scanbotsdk_document_quality_analyzer_result_t scanbotsdk_document_quality_analyzer_result_t
 scanbotsdk_document_quality_analyzer_result_t class
 

Enumerations

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 enum More...
 

Functions

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_t_to_string (scanbotsdk_document_quality_t value, const char **result)
 Returns the string representation of the given scanbotsdk_document_quality_t value.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_threshold_create (double symbol_quality, double symbol_ratio, scanbotsdk_document_quality_threshold_t **result)
 Creates a new instance of scanbotsdk_document_quality_threshold with given params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_threshold_free (scanbotsdk_document_quality_threshold_t *object)
 Frees the memory allocated for the instance of scanbotsdk_document_quality_threshold_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_threshold_get_symbol_quality (scanbotsdk_document_quality_threshold_t *self, double *symbol_quality)
 Returns value of symbol_quality field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_threshold_get_symbol_ratio (scanbotsdk_document_quality_threshold_t *self, double *symbol_ratio)
 Returns value of symbol_ratio field of the given object.
 
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)
 Creates a new instance of scanbotsdk_document_quality_analyzer_configuration with given params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_create_with_defaults (scanbotsdk_document_quality_analyzer_configuration_t **result)
 Creates a new instance of scanbotsdk_document_quality_analyzer_configuration_t with given required params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_free (scanbotsdk_document_quality_analyzer_configuration_t *object)
 Frees the memory allocated for the instance of scanbotsdk_document_quality_analyzer_configuration_t. If null is passed, the function does nothing.
 
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)
 Returns value of quality_thresholds field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
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)
 Returns size of quality_thresholds array.
 
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)
 Sets value of quality_thresholds field of the given object.
 
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)
 Returns value of quality_indices field of the given object. The returned value is direct view into memory, no pre-allocations needed.
 
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)
 Returns size of quality_indices array.
 
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)
 Sets value of quality_indices field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_detect_orientation (scanbotsdk_document_quality_analyzer_configuration_t *self, bool *detect_orientation)
 Returns value of detect_orientation field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_detect_orientation (scanbotsdk_document_quality_analyzer_configuration_t *self, bool detect_orientation)
 Sets value of detect_orientation field of the given object.
 
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)
 Returns value of inspect_small_text field of the given object.
 
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)
 Sets value of inspect_small_text field of the given object.
 
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)
 Returns value of max_image_size field of the given object.
 
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)
 Sets value of max_image_size field of the given object.
 
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)
 Returns value of min_estimated_number_of_symbols_for_document field of the given object.
 
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)
 Sets value of min_estimated_number_of_symbols_for_document field of the given object.
 
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)
 Returns value of min_processed_fraction field of the given object.
 
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)
 Sets value of min_processed_fraction field of the given object.
 
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)
 Returns value of max_processed_fraction field of the given object.
 
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)
 Sets value of max_processed_fraction field of the given object.
 
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)
 Returns value of min_number_of_required_symbols field of the given object.
 
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)
 Sets value of min_number_of_required_symbols field of the given object.
 
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)
 Returns value of min_required_orientation_confidence field of the given object.
 
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)
 Sets value of min_required_orientation_confidence field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_get_tile_size (scanbotsdk_document_quality_analyzer_configuration_t *self, int *tile_size)
 Returns value of tile_size field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_configuration_set_tile_size (scanbotsdk_document_quality_analyzer_configuration_t *self, int tile_size)
 Sets value of tile_size field of the given object.
 
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)
 Returns value of return_quality_heatmap field of the given object.
 
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)
 Sets value of return_quality_heatmap field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_free (scanbotsdk_document_quality_analyzer_result_t *object)
 Frees the memory allocated for the instance of scanbotsdk_document_quality_analyzer_result_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_document_found (scanbotsdk_document_quality_analyzer_result_t *self, bool *document_found)
 Returns value of document_found field of the given object.
 
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)
 Returns value of quality field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_orientation (scanbotsdk_document_quality_analyzer_result_t *self, double **orientation)
 Returns value of orientation field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_result_get_orientation_confidence (scanbotsdk_document_quality_analyzer_result_t *self, double **orientation_confidence)
 Returns value of orientation_confidence field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
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)
 Returns value of cumulative_quality_histogram field of the given object. The returned value is direct view into memory, no pre-allocations needed.
 
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)
 Returns size of cumulative_quality_histogram array.
 
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)
 Returns value of cumulative_contrast_histogram field of the given object. The returned value is direct view into memory, no pre-allocations needed.
 
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)
 Returns size of cumulative_contrast_histogram array.
 
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)
 Returns value of cumulative_text_size_histogram field of the given object. The returned value is direct view into memory, no pre-allocations needed.
 
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)
 Returns size of cumulative_text_size_histogram array.
 
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)
 Returns value of quality_heatmap field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.