Scanbot C SDK Document quality analyzer configurator

Typedefs
typedef struct scanbotsdk_document_quality_analyzer_training_data_annotator_t	scanbotsdk_document_quality_analyzer_training_data_annotator_t
	scanbotsdk_document_quality_analyzer_training_data_annotator_t class

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_quality_analyzer_training_data_annotator_create (scanbotsdk_document_quality_analyzer_training_data_annotator_t **result)
	Creates a new instance of scanbotsdk_document_quality_analyzer_training_data_annotator with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_quality_analyzer_training_data_annotator_free (scanbotsdk_document_quality_analyzer_training_data_annotator_t *self)
	Frees the memory allocated for the instance of scanbotsdk_document_quality_analyzer_training_data_annotator_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_quality_analyzer_training_data_annotator_run (scanbotsdk_document_quality_analyzer_training_data_annotator_t *self, scanbotsdk_image_t *image, scanbotsdk_document_quality_analyzer_training_data_t **result)
	Obtains annotations about the document that can be used to create custom document quality analyzer configurations.

Detailed Description

Typedef Documentation

scanbotsdk_document_quality_analyzer_training_data_annotator_t

typedef struct scanbotsdk_document_quality_analyzer_training_data_annotator_t scanbotsdk_document_quality_analyzer_training_data_annotator_t

scanbotsdk_document_quality_analyzer_training_data_annotator_t class

API for generating annotations that can be used to create custom document quality analyzer configurations.

Required licence feature(s): DocumentQualityAnalyzerConfigurator.

Function Documentation

scanbotsdk_document_quality_analyzer_training_data_annotator_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_training_data_annotator_create

(

scanbotsdk_document_quality_analyzer_training_data_annotator_t **

result

)

Creates a new instance of scanbotsdk_document_quality_analyzer_training_data_annotator 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_document_quality_analyzer_training_data_annotator_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_quality_analyzer_training_data_annotator_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_training_data_annotator_free

(

scanbotsdk_document_quality_analyzer_training_data_annotator_t *

self

)

Frees the memory allocated for the instance of scanbotsdk_document_quality_analyzer_training_data_annotator_t. If null is passed, the function does nothing.

Parameters

self	Pointer to the instance of scanbotsdk_document_quality_analyzer_training_data_annotator_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_quality_analyzer_training_data_annotator_run()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_quality_analyzer_training_data_annotator_run	(	scanbotsdk_document_quality_analyzer_training_data_annotator_t *	self,
		scanbotsdk_image_t *	image,
		scanbotsdk_document_quality_analyzer_training_data_t **	result )

Obtains annotations about the document that can be used to create custom document quality analyzer configurations.

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_document_quality_analyzer_training_data_annotator_t method to be called on
image	The image to analyze. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_document_quality_analyzer_training_data_annotator_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered