ScanbotSDKParametricFilters.h

Go to the documentation of this file.

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

typedef enum scanbotsdk_output_mode_t {

    SCANBOTSDK_OUTPUT_MODE_BINARY = 0,

    SCANBOTSDK_OUTPUT_MODE_ANTIALIASED = 1,
 
} scanbotsdk_output_mode_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_output_mode_t_to_string(scanbotsdk_output_mode_t value, const char** result);

typedef enum scanbotsdk_binarization_filter_preset_t {

    SCANBOTSDK_BINARIZATION_FILTER_PRESET_PRESET_1 = 0,

    SCANBOTSDK_BINARIZATION_FILTER_PRESET_PRESET_2 = 1,

    SCANBOTSDK_BINARIZATION_FILTER_PRESET_PRESET_3 = 2,

    SCANBOTSDK_BINARIZATION_FILTER_PRESET_PRESET_4 = 3,

    SCANBOTSDK_BINARIZATION_FILTER_PRESET_PRESET_5 = 4,
 
} scanbotsdk_binarization_filter_preset_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_binarization_filter_preset_t_to_string(scanbotsdk_binarization_filter_preset_t value, const char** result);

typedef struct scanbotsdk_parametric_filter_t scanbotsdk_parametric_filter_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_free(scanbotsdk_parametric_filter_t* object);
 

typedef struct scanbotsdk_legacy_filter_t scanbotsdk_legacy_filter_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_legacy_filter_create(
    int filter_type,
    scanbotsdk_legacy_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_legacy_filter_create_with_defaults(
    scanbotsdk_legacy_filter_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_legacy_filter_free(scanbotsdk_legacy_filter_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_is_scanbotsdk_legacy_filter(scanbotsdk_parametric_filter_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_as_scanbotsdk_legacy_filter(scanbotsdk_parametric_filter_t* object, scanbotsdk_legacy_filter_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_legacy_filter_as_scanbotsdk_parametric_filter(scanbotsdk_legacy_filter_t* object, scanbotsdk_parametric_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_legacy_filter_get_filter_type(scanbotsdk_legacy_filter_t* self, int* filter_type);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_legacy_filter_set_filter_type(scanbotsdk_legacy_filter_t* self, int filter_type);
 

typedef struct scanbotsdk_scanbot_binarization_filter_t scanbotsdk_scanbot_binarization_filter_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_scanbot_binarization_filter_create(
    scanbotsdk_output_mode_t output_mode,
    scanbotsdk_scanbot_binarization_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_scanbot_binarization_filter_create_with_defaults(
    scanbotsdk_scanbot_binarization_filter_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_scanbot_binarization_filter_free(scanbotsdk_scanbot_binarization_filter_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_is_scanbotsdk_scanbot_binarization_filter(scanbotsdk_parametric_filter_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_as_scanbotsdk_scanbot_binarization_filter(scanbotsdk_parametric_filter_t* object, scanbotsdk_scanbot_binarization_filter_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_scanbot_binarization_filter_as_scanbotsdk_parametric_filter(scanbotsdk_scanbot_binarization_filter_t* object, scanbotsdk_parametric_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_scanbot_binarization_filter_get_output_mode(scanbotsdk_scanbot_binarization_filter_t* self, scanbotsdk_output_mode_t* output_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_scanbot_binarization_filter_set_output_mode(scanbotsdk_scanbot_binarization_filter_t* self, scanbotsdk_output_mode_t output_mode);
 

typedef struct scanbotsdk_custom_binarization_filter_t scanbotsdk_custom_binarization_filter_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_create(
    scanbotsdk_output_mode_t output_mode,
    double denoise,
    int radius,
    scanbotsdk_binarization_filter_preset_t preset,
    scanbotsdk_custom_binarization_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_create_with_defaults(
    scanbotsdk_custom_binarization_filter_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_free(scanbotsdk_custom_binarization_filter_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_is_scanbotsdk_custom_binarization_filter(scanbotsdk_parametric_filter_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_as_scanbotsdk_custom_binarization_filter(scanbotsdk_parametric_filter_t* object, scanbotsdk_custom_binarization_filter_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_as_scanbotsdk_parametric_filter(scanbotsdk_custom_binarization_filter_t* object, scanbotsdk_parametric_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_get_output_mode(scanbotsdk_custom_binarization_filter_t* self, scanbotsdk_output_mode_t* output_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_set_output_mode(scanbotsdk_custom_binarization_filter_t* self, scanbotsdk_output_mode_t output_mode);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_get_denoise(scanbotsdk_custom_binarization_filter_t* self, double* denoise);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_set_denoise(scanbotsdk_custom_binarization_filter_t* self, double denoise);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_get_radius(scanbotsdk_custom_binarization_filter_t* self, int* radius);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_set_radius(scanbotsdk_custom_binarization_filter_t* self, int radius);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_get_preset(scanbotsdk_custom_binarization_filter_t* self, scanbotsdk_binarization_filter_preset_t* preset);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_custom_binarization_filter_set_preset(scanbotsdk_custom_binarization_filter_t* self, scanbotsdk_binarization_filter_preset_t preset);
 

typedef struct scanbotsdk_color_document_filter_t scanbotsdk_color_document_filter_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_create(
    double contrast_enhancement,
    double color_enhancement,
    double paper_whitening,
    int paper_whitening_bias,
    scanbotsdk_color_document_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_create_with_defaults(
    scanbotsdk_color_document_filter_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_free(scanbotsdk_color_document_filter_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_is_scanbotsdk_color_document_filter(scanbotsdk_parametric_filter_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_as_scanbotsdk_color_document_filter(scanbotsdk_parametric_filter_t* object, scanbotsdk_color_document_filter_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_as_scanbotsdk_parametric_filter(scanbotsdk_color_document_filter_t* object, scanbotsdk_parametric_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_get_contrast_enhancement(scanbotsdk_color_document_filter_t* self, double* contrast_enhancement);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_set_contrast_enhancement(scanbotsdk_color_document_filter_t* self, double contrast_enhancement);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_get_color_enhancement(scanbotsdk_color_document_filter_t* self, double* color_enhancement);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_set_color_enhancement(scanbotsdk_color_document_filter_t* self, double color_enhancement);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_get_paper_whitening(scanbotsdk_color_document_filter_t* self, double* paper_whitening);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_set_paper_whitening(scanbotsdk_color_document_filter_t* self, double paper_whitening);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_get_paper_whitening_bias(scanbotsdk_color_document_filter_t* self, int* paper_whitening_bias);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_filter_set_paper_whitening_bias(scanbotsdk_color_document_filter_t* self, int paper_whitening_bias);
 

typedef struct scanbotsdk_color_document_shadow_removal_filter_t scanbotsdk_color_document_shadow_removal_filter_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_create(
    double contrast_enhancement,
    double color_enhancement,
    double paper_saturation,
    double paper_lightness,
    scanbotsdk_color_document_shadow_removal_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_create_with_defaults(
    scanbotsdk_color_document_shadow_removal_filter_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_free(scanbotsdk_color_document_shadow_removal_filter_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_is_scanbotsdk_color_document_shadow_removal_filter(scanbotsdk_parametric_filter_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_as_scanbotsdk_color_document_shadow_removal_filter(scanbotsdk_parametric_filter_t* object, scanbotsdk_color_document_shadow_removal_filter_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_as_scanbotsdk_parametric_filter(scanbotsdk_color_document_shadow_removal_filter_t* object, scanbotsdk_parametric_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_get_contrast_enhancement(scanbotsdk_color_document_shadow_removal_filter_t* self, double* contrast_enhancement);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_set_contrast_enhancement(scanbotsdk_color_document_shadow_removal_filter_t* self, double contrast_enhancement);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_get_color_enhancement(scanbotsdk_color_document_shadow_removal_filter_t* self, double* color_enhancement);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_set_color_enhancement(scanbotsdk_color_document_shadow_removal_filter_t* self, double color_enhancement);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_get_paper_saturation(scanbotsdk_color_document_shadow_removal_filter_t* self, double* paper_saturation);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_set_paper_saturation(scanbotsdk_color_document_shadow_removal_filter_t* self, double paper_saturation);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_get_paper_lightness(scanbotsdk_color_document_shadow_removal_filter_t* self, double* paper_lightness);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_color_document_shadow_removal_filter_set_paper_lightness(scanbotsdk_color_document_shadow_removal_filter_t* self, double paper_lightness);
 

typedef struct scanbotsdk_brightness_filter_t scanbotsdk_brightness_filter_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_brightness_filter_create(
    double brightness,
    scanbotsdk_brightness_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_brightness_filter_create_with_defaults(
    scanbotsdk_brightness_filter_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_brightness_filter_free(scanbotsdk_brightness_filter_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_is_scanbotsdk_brightness_filter(scanbotsdk_parametric_filter_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_as_scanbotsdk_brightness_filter(scanbotsdk_parametric_filter_t* object, scanbotsdk_brightness_filter_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_brightness_filter_as_scanbotsdk_parametric_filter(scanbotsdk_brightness_filter_t* object, scanbotsdk_parametric_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_brightness_filter_get_brightness(scanbotsdk_brightness_filter_t* self, double* brightness);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_brightness_filter_set_brightness(scanbotsdk_brightness_filter_t* self, double brightness);
 

typedef struct scanbotsdk_contrast_filter_t scanbotsdk_contrast_filter_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_contrast_filter_create(
    double contrast,
    scanbotsdk_contrast_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_contrast_filter_create_with_defaults(
    scanbotsdk_contrast_filter_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_contrast_filter_free(scanbotsdk_contrast_filter_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_is_scanbotsdk_contrast_filter(scanbotsdk_parametric_filter_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_as_scanbotsdk_contrast_filter(scanbotsdk_parametric_filter_t* object, scanbotsdk_contrast_filter_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_contrast_filter_as_scanbotsdk_parametric_filter(scanbotsdk_contrast_filter_t* object, scanbotsdk_parametric_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_contrast_filter_get_contrast(scanbotsdk_contrast_filter_t* self, double* contrast);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_contrast_filter_set_contrast(scanbotsdk_contrast_filter_t* self, double contrast);
 

typedef struct scanbotsdk_grayscale_filter_t scanbotsdk_grayscale_filter_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_grayscale_filter_create(
    double border_width_fraction,
    double black_outliers_fraction,
    double white_outliers_fraction,
    scanbotsdk_grayscale_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_grayscale_filter_create_with_defaults(
    scanbotsdk_grayscale_filter_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_grayscale_filter_free(scanbotsdk_grayscale_filter_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_is_scanbotsdk_grayscale_filter(scanbotsdk_parametric_filter_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_as_scanbotsdk_grayscale_filter(scanbotsdk_parametric_filter_t* object, scanbotsdk_grayscale_filter_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_grayscale_filter_as_scanbotsdk_parametric_filter(scanbotsdk_grayscale_filter_t* object, scanbotsdk_parametric_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_grayscale_filter_get_border_width_fraction(scanbotsdk_grayscale_filter_t* self, double* border_width_fraction);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_grayscale_filter_set_border_width_fraction(scanbotsdk_grayscale_filter_t* self, double border_width_fraction);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_grayscale_filter_get_black_outliers_fraction(scanbotsdk_grayscale_filter_t* self, double* black_outliers_fraction);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_grayscale_filter_set_black_outliers_fraction(scanbotsdk_grayscale_filter_t* self, double black_outliers_fraction);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_grayscale_filter_get_white_outliers_fraction(scanbotsdk_grayscale_filter_t* self, double* white_outliers_fraction);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_grayscale_filter_set_white_outliers_fraction(scanbotsdk_grayscale_filter_t* self, double white_outliers_fraction);
 

typedef struct scanbotsdk_white_black_point_filter_t scanbotsdk_white_black_point_filter_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_white_black_point_filter_create(
    double black_point,
    double white_point,
    scanbotsdk_white_black_point_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_white_black_point_filter_create_with_defaults(
    scanbotsdk_white_black_point_filter_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_white_black_point_filter_free(scanbotsdk_white_black_point_filter_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_is_scanbotsdk_white_black_point_filter(scanbotsdk_parametric_filter_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_parametric_filter_as_scanbotsdk_white_black_point_filter(scanbotsdk_parametric_filter_t* object, scanbotsdk_white_black_point_filter_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_white_black_point_filter_as_scanbotsdk_parametric_filter(scanbotsdk_white_black_point_filter_t* object, scanbotsdk_parametric_filter_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_white_black_point_filter_get_black_point(scanbotsdk_white_black_point_filter_t* self, double* black_point);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_white_black_point_filter_set_black_point(scanbotsdk_white_black_point_filter_t* self, double black_point);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_white_black_point_filter_get_white_point(scanbotsdk_white_black_point_filter_t* self, double* white_point);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_white_black_point_filter_set_white_point(scanbotsdk_white_black_point_filter_t* self, double white_point);
 

typedef enum scanbotsdk_page_binarization_t {

    SCANBOTSDK_PAGE_BINARIZATION_DISABLED = 0,

    SCANBOTSDK_PAGE_BINARIZATION_ENABLED = 1,

    SCANBOTSDK_PAGE_BINARIZATION_ENABLED_IF_BINARIZATION_FILTER_SET = 2,
 
} scanbotsdk_page_binarization_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_page_binarization_t_to_string(scanbotsdk_page_binarization_t value, const char** result);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_PARAMETRICFILTERS_H */