ScanbotSDKOcrTypes.h File Reference

Go to the source code of this file.

Typedefs
typedef struct scanbotsdk_ocr_element_t	scanbotsdk_ocr_element_t
	scanbotsdk_ocr_element_t class
typedef struct scanbotsdk_glyph_t	scanbotsdk_glyph_t
	scanbotsdk_glyph_t class
typedef struct scanbotsdk_word_t	scanbotsdk_word_t
	scanbotsdk_word_t class
typedef struct scanbotsdk_line_t	scanbotsdk_line_t
	scanbotsdk_line_t class
typedef struct scanbotsdk_block_t	scanbotsdk_block_t
	scanbotsdk_block_t class
typedef struct scanbotsdk_page_t	scanbotsdk_page_t
	scanbotsdk_page_t class

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_free (scanbotsdk_ocr_element_t *object)
	Frees the memory allocated for the instance of scanbotsdk_ocr_element_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_get_text (scanbotsdk_ocr_element_t *self, const char **text)
	Returns value of text 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_ocr_element_get_confidence (scanbotsdk_ocr_element_t *self, double *confidence)
	Returns value of confidence field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_get_roi (scanbotsdk_ocr_element_t *self, scanbotsdk_pointf_t **roi)
	Returns value of roi field of the given object. The returned value is direct view into memory, no pre-allocations needed.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_get_roi_size (scanbotsdk_ocr_element_t *self, size_t *size)
	Returns size of roi array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_glyph_create (const char *text, double confidence, scanbotsdk_pointf_t *roi, size_t roi_size, scanbotsdk_glyph_t **result)
	Creates a new instance of scanbotsdk_glyph with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_glyph_free (scanbotsdk_glyph_t *object)
	Frees the memory allocated for the instance of scanbotsdk_glyph_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_is_scanbotsdk_glyph (scanbotsdk_ocr_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_ocr_element_t is an instance of its subtype scanbotsdk_glyph_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_as_scanbotsdk_glyph (scanbotsdk_ocr_element_t *object, scanbotsdk_glyph_t **result)
	Casts the given instance of scanbotsdk_ocr_element_t to its subtype scanbotsdk_glyph_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_glyph_as_scanbotsdk_ocr_element (scanbotsdk_glyph_t *object, scanbotsdk_ocr_element_t **result)
	Casts the given instance of scanbotsdk_glyph_t to its parent type scanbotsdk_ocr_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_word_create (const char *text, double confidence, scanbotsdk_pointf_t *roi, size_t roi_size, scanbotsdk_glyph_t **glyphs, size_t glyphs_size, scanbotsdk_word_t **result)
	Creates a new instance of scanbotsdk_word with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_word_free (scanbotsdk_word_t *object)
	Frees the memory allocated for the instance of scanbotsdk_word_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_is_scanbotsdk_word (scanbotsdk_ocr_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_ocr_element_t is an instance of its subtype scanbotsdk_word_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_as_scanbotsdk_word (scanbotsdk_ocr_element_t *object, scanbotsdk_word_t **result)
	Casts the given instance of scanbotsdk_ocr_element_t to its subtype scanbotsdk_word_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_word_as_scanbotsdk_ocr_element (scanbotsdk_word_t *object, scanbotsdk_ocr_element_t **result)
	Casts the given instance of scanbotsdk_word_t to its parent type scanbotsdk_ocr_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_word_get_glyphs (scanbotsdk_word_t *self, scanbotsdk_glyph_t **glyphs, size_t size)
	Returns value of glyphs 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_word_get_glyphs_size (scanbotsdk_word_t *self, size_t *size)
	Returns size of glyphs array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_line_create (const char *text, double confidence, scanbotsdk_pointf_t *roi, size_t roi_size, scanbotsdk_word_t **words, size_t words_size, scanbotsdk_line_t **result)
	Creates a new instance of scanbotsdk_line with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_line_free (scanbotsdk_line_t *object)
	Frees the memory allocated for the instance of scanbotsdk_line_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_is_scanbotsdk_line (scanbotsdk_ocr_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_ocr_element_t is an instance of its subtype scanbotsdk_line_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_as_scanbotsdk_line (scanbotsdk_ocr_element_t *object, scanbotsdk_line_t **result)
	Casts the given instance of scanbotsdk_ocr_element_t to its subtype scanbotsdk_line_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_line_as_scanbotsdk_ocr_element (scanbotsdk_line_t *object, scanbotsdk_ocr_element_t **result)
	Casts the given instance of scanbotsdk_line_t to its parent type scanbotsdk_ocr_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_line_get_words (scanbotsdk_line_t *self, scanbotsdk_word_t **words, size_t size)
	Returns value of words 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_line_get_words_size (scanbotsdk_line_t *self, size_t *size)
	Returns size of words array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_block_create (const char *text, double confidence, scanbotsdk_pointf_t *roi, size_t roi_size, scanbotsdk_line_t **lines, size_t lines_size, scanbotsdk_block_t **result)
	Creates a new instance of scanbotsdk_block with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_block_free (scanbotsdk_block_t *object)
	Frees the memory allocated for the instance of scanbotsdk_block_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_is_scanbotsdk_block (scanbotsdk_ocr_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_ocr_element_t is an instance of its subtype scanbotsdk_block_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_as_scanbotsdk_block (scanbotsdk_ocr_element_t *object, scanbotsdk_block_t **result)
	Casts the given instance of scanbotsdk_ocr_element_t to its subtype scanbotsdk_block_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_block_as_scanbotsdk_ocr_element (scanbotsdk_block_t *object, scanbotsdk_ocr_element_t **result)
	Casts the given instance of scanbotsdk_block_t to its parent type scanbotsdk_ocr_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_block_get_lines (scanbotsdk_block_t *self, scanbotsdk_line_t **lines, size_t size)
	Returns value of lines 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_block_get_lines_size (scanbotsdk_block_t *self, size_t *size)
	Returns size of lines array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_page_create (const char *text, double confidence, scanbotsdk_pointf_t *roi, size_t roi_size, scanbotsdk_block_t **blocks, size_t blocks_size, scanbotsdk_page_t **result)
	Creates a new instance of scanbotsdk_page with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_page_free (scanbotsdk_page_t *object)
	Frees the memory allocated for the instance of scanbotsdk_page_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_is_scanbotsdk_page (scanbotsdk_ocr_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_ocr_element_t is an instance of its subtype scanbotsdk_page_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_ocr_element_as_scanbotsdk_page (scanbotsdk_ocr_element_t *object, scanbotsdk_page_t **result)
	Casts the given instance of scanbotsdk_ocr_element_t to its subtype scanbotsdk_page_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_page_as_scanbotsdk_ocr_element (scanbotsdk_page_t *object, scanbotsdk_ocr_element_t **result)
	Casts the given instance of scanbotsdk_page_t to its parent type scanbotsdk_ocr_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_page_get_blocks (scanbotsdk_page_t *self, scanbotsdk_block_t **blocks, size_t size)
	Returns value of blocks 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_page_get_blocks_size (scanbotsdk_page_t *self, size_t *size)
	Returns size of blocks array.