COcrPageParams_interface.h File Reference

Interface for COcrPageParams wrapper. More...

Go to the source code of this file.

Functions
COcrPageParams	COcrPageParams_Create (idrs_exception *pargException)
	Creates a new instance of this class.
COcrPageParams	COcrPageParams_Create2 (const COcrContext argContext, idrs_exception *pargException)
	Creates a new instance of this class and sets the associated.
IDRS_BOOL	COcrPageParams_GetComputeBackgroundImage (const COcrPageParams argCOcrPageParams, idrs_exception *pargException)
	Gets the boolean flag that specifies if the background image should be extracted during text recognition process.
void	COcrPageParams_SetComputeBackgroundImage (COcrPageParams argCOcrPageParams, IDRS_BOOL const bComputeBackgroundImage, idrs_exception *pargException)
	Sets the boolean flag that specifies if the background image should be extracted during text recognition process.
IDRS_BOOL	COcrPageParams_GetDetectEmptyFormFields (const COcrPageParams argCOcrPageParams, idrs_exception *pargException)
	Gets the boolean flag that specifies if empty form fields should be detected or not during text recognition.
void	COcrPageParams_SetDetectEmptyFormFields (COcrPageParams argCOcrPageParams, IDRS_BOOL const bDetectEmptyFormFields, idrs_exception *pargException)
	Set the boolean flag that enables or not the empty forms detection.
COcrContext	COcrPageParams_GetContext (const COcrPageParams argCOcrPageParams, idrs_exception *pargException)
	Gets the associated ocr context.
void	COcrPageParams_SetContext (COcrPageParams argCOcrPageParams, const COcrContext argContext, idrs_exception *pargException)
	Sets the associated ocr context.
enum TableDetectionMode	COcrPageParams_GetTableDetectionMode (const COcrPageParams argCOcrPageParams, idrs_exception *pargException)
	Gets the table detection mode.
void	COcrPageParams_SetTableDetectionMode (COcrPageParams argCOcrPageParams, enum TableDetectionMode const evTableDetection, idrs_exception *pargException)
	Sets the table detection mode.
void	COcrPageParams_Destroy (COcrPageParams argCOcrPageParams, idrs_exception *pargException)
	Destroys a COcrPageParams handle.

Detailed Description

Interface for COcrPageParams wrapper.

Function Documentation

COcrPageParams_Create()

COcrPageParams COcrPageParams_Create

(

idrs_exception *

pargException

)

Creates a new instance of this class.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

Remarks

Instances created by this method can also be provided to COcrParams methods

COcrPageParams_Create2()

COcrPageParams COcrPageParams_Create2	(	const COcrContext	argContext,
		idrs_exception *	pargException
	)

Creates a new instance of this class and sets the associated.

See also

COcrContext

Parameters

argContext	Ocr context to set
pargException	Pointer to exception structure that will be filled if an exception occurs

By default the associated ocr context enables only English language

Remarks

Instances created by this method can also be provided to COcrParams methods

COcrPageParams_Destroy()

void COcrPageParams_Destroy	(	COcrPageParams	argCOcrPageParams,
		idrs_exception *	pargException
	)

Destroys a COcrPageParams handle.

Parameters

argCOcrPageParams	COcrPageParams handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrPageParams_GetComputeBackgroundImage()

IDRS_BOOL COcrPageParams_GetComputeBackgroundImage	(	const COcrPageParams	argCOcrPageParams,
		idrs_exception *	pargException
	)

Gets the boolean flag that specifies if the background image should be extracted during text recognition process.

The background image represents a variant of the original image where the detected text characters are removed. iDRS SDK takes care of replacing the zones where the text has been removed with the appropriate colors.

If set to IDRS_TRUE, the background image will be extracted and set into the

See also

CPage object provided as argument during text recognition.

Returns

Boolean flag enabling/disabling background image extraction

Parameters

argCOcrPageParams	COcrPageParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrPageParams_GetContext()

COcrContext COcrPageParams_GetContext	(	const COcrPageParams	argCOcrPageParams,
		idrs_exception *	pargException
	)

Gets the associated ocr context.

The ocr context allows specifying options like languages to detect. See

See also

COcrContext for more details

Returns

Associated ocr context

Parameters

argCOcrPageParams	COcrPageParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrPageParams_GetDetectEmptyFormFields()

IDRS_BOOL COcrPageParams_GetDetectEmptyFormFields	(	const COcrPageParams	argCOcrPageParams,
		idrs_exception *	pargException
	)

Gets the boolean flag that specifies if empty form fields should be detected or not during text recognition.

Default value is IDRS_FALSE

Returns

IDRS_TRUE to enable the empty forms detection, IDRS_FALSE otherwise.

Parameters

argCOcrPageParams	COcrPageParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrPageParams_GetTableDetectionMode()

enum TableDetectionMode COcrPageParams_GetTableDetectionMode	(	const COcrPageParams	argCOcrPageParams,
		idrs_exception *	pargException
	)

Gets the table detection mode.

Returns

Table detection mode

Parameters

argCOcrPageParams	COcrPageParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrPageParams_SetComputeBackgroundImage()

void COcrPageParams_SetComputeBackgroundImage	(	COcrPageParams	argCOcrPageParams,
		IDRS_BOOL const	bComputeBackgroundImage,
		idrs_exception *	pargException
	)

Sets the boolean flag that specifies if the background image should be extracted during text recognition process.

The background image represents a variant of the original image where the detected text characters are removed. iDRS SDK takes care of replacing the zones where the text has been removed with the appropriate colors.

If set to IDRS_TRUE, the background image will be extracted and set into the

See also

CPage object provided as argument during text recognition.

Parameters

argCOcrPageParams	COcrPageParams handle
bComputeBackgroundImage	Boolean flag enabling/disabling background image extraction
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrPageParams_SetContext()

void COcrPageParams_SetContext	(	COcrPageParams	argCOcrPageParams,
		const COcrContext	argContext,
		idrs_exception *	pargException
	)

Sets the associated ocr context.

The ocr context allows specifying options like languages to detect. See

See also

COcrContext for more details

Parameters

argCOcrPageParams	COcrPageParams handle
argContext	Associated ocr context
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrPageParams_SetDetectEmptyFormFields()

void COcrPageParams_SetDetectEmptyFormFields	(	COcrPageParams	argCOcrPageParams,
		IDRS_BOOL const	bDetectEmptyFormFields,
		idrs_exception *	pargException
	)

Set the boolean flag that enables or not the empty forms detection.

Parameters

argCOcrPageParams	COcrPageParams handle
bDetectEmptyFormFields	IDRS_TRUE to enable the empty forms detection, IDRS_FALSE otherwise.
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrPageParams_SetTableDetectionMode()

void COcrPageParams_SetTableDetectionMode	(	COcrPageParams	argCOcrPageParams,
		enum TableDetectionMode const	evTableDetection,
		idrs_exception *	pargException
	)

Sets the table detection mode.

Setting this flag will change the way the ocr engine will interpret the layout of the page. Please see

See also

TableDetectionMode for the different modes supported.

Parameters

argCOcrPageParams	COcrPageParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs