CPageProcessing_interface.h File Reference

Interface for CPageProcessing wrapper. More...

Go to the source code of this file.

Functions
CPageProcessing	CPageProcessing_Create (CIDRS argIdrs, idrs_exception *pargException)
	Creates a new instance of this class and associates the provided.
CPageAnalysisParams	CPageProcessing_GetPageAnalysisParams (const CPageProcessing argCPageProcessing, idrs_exception *pargException)
	Gets the parameters used for the page analysis (language detection, orientation detection, skew detection)
void	CPageProcessing_SetPageAnalysisParams (CPageProcessing argCPageProcessing, const CPageAnalysisParams argPageAnalysisParams, idrs_exception *pargException)
	Gets the parameters used for the page analysis (language detection, orientation detection, skew detection)
IDRS_BOOL	CPageProcessing_GetRunPageAnalysis (const CPageProcessing argCPageProcessing, idrs_exception *pargException)
	Gets the boolean flag that enables/disables the page analysis.
void	CPageProcessing_SetRunPageAnalysis (CPageProcessing argCPageProcessing, IDRS_BOOL const bAnalysePage, idrs_exception *pargException)
	Sets the boolean flag that enables/disables the page analysis.
IDRS_BOOL	CPageProcessing_GetRunBarcodeDetection (const CPageProcessing argCPageProcessing, idrs_exception *pargException)
	Gets the boolean flag that enables/disables the barcode detection.
void	CPageProcessing_SetRunBarcodeDetection (CPageProcessing argCPageProcessing, IDRS_BOOL const bDetectBarcodes, idrs_exception *pargException)
	Sets the boolean flag that enables/disables the barcode detection.
IDRS_BOOL	CPageProcessing_GetRunTextRecognition (const CPageProcessing argCPageProcessing, idrs_exception *pargException)
	Gets the boolean flag that enables/disables the text recognition.
void	CPageProcessing_SetRunTextRecognition (CPageProcessing argCPageProcessing, IDRS_BOOL const bRecognizeText, idrs_exception *pargException)
	Sets the boolean flag that enables/disables the text recognition.
CBarcodeParams	CPageProcessing_GetBarcodeParams (const CPageProcessing argCPageProcessing, idrs_exception *pargException)
	Gets the parameters used for the detection (barcode type(s), full page/zonal recognition, etc)
void	CPageProcessing_SetBarcodeParams (CPageProcessing argCPageProcessing, const CBarcodeParams argBarcodeParams, idrs_exception *pargException)
	Sets the parameters used for barcode detection.
COcrParams	CPageProcessing_GetOcrParams (const CPageProcessing argCPageProcessing, idrs_exception *pargException)
	Gets the parameters used for the ocr (language(s), full page/zonal recognition, etc)
void	CPageProcessing_SetOcrParams (CPageProcessing argCPageProcessing, const COcrParams argOcrParams, idrs_exception *pargException)
	Sets the parameters used for the ocr (language(s), full page/zonal recognition, etc).
IProgressPageProcessing	CPageProcessing_GetProgressCallback (const CPageProcessing argCPageProcessing, idrs_exception *pargException)
	Gets the callback used to notify about page processing progress.
void	CPageProcessing_SetProgressCallback (CPageProcessing argCPageProcessing, IProgressPageProcessing pProgressCallback, idrs_exception *pargException)
	Sets the callback used to notify about page processing progress.
void	CPageProcessing_ProcessPage (CPageProcessing argCPageProcessing, CPage argPage, idrs_exception *pargException)
	Runs the page processing. This method is executing the following operations (if enabled), in succession.
void	CPageProcessing_Destroy (CPageProcessing argCPageProcessing, idrs_exception *pargException)
	Destroys a CPageProcessing handle.

Detailed Description

Interface for CPageProcessing wrapper.

Function Documentation

CPageProcessing_Create()

CPageProcessing CPageProcessing_Create	(	CIDRS	argIdrs,
		idrs_exception *	pargException
	)

Creates a new instance of this class and associates the provided.

See also

CIDRS handle to it.

Parameters

argIdrs	CIDRS instance
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

Newly created object

CPageProcessing_Destroy()

void CPageProcessing_Destroy	(	CPageProcessing	argCPageProcessing,
		idrs_exception *	pargException
	)

Destroys a CPageProcessing handle.

Parameters

argCPageProcessing	CPageProcessing handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_GetBarcodeParams()

CBarcodeParams CPageProcessing_GetBarcodeParams	(	const CPageProcessing	argCPageProcessing,
		idrs_exception *	pargException
	)

Gets the parameters used for the detection (barcode type(s), full page/zonal recognition, etc)

By default, the barcode detection runs on full page with all barcode types enabled (depends on enabled extensions)

Returns

Parameters used for barcode detection.

Parameters

argCPageProcessing	CPageProcessing handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_GetOcrParams()

COcrParams CPageProcessing_GetOcrParams	(	const CPageProcessing	argCPageProcessing,
		idrs_exception *	pargException
	)

Gets the parameters used for the ocr (language(s), full page/zonal recognition, etc)

By default, the ocr runs on full page with english language enabled

Returns

Parameters used for ocr.

Parameters

argCPageProcessing	CPageProcessing handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_GetPageAnalysisParams()

CPageAnalysisParams CPageProcessing_GetPageAnalysisParams	(	const CPageProcessing	argCPageProcessing,
		idrs_exception *	pargException
	)

Gets the parameters used for the page analysis (language detection, orientation detection, skew detection)

By default, the page analysis will only preform orientation detection

Returns

Parameters used for page analysis.

Parameters

argCPageProcessing	CPageProcessing handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_GetProgressCallback()

IProgressPageProcessing CPageProcessing_GetProgressCallback	(	const CPageProcessing	argCPageProcessing,
		idrs_exception *	pargException
	)

Gets the callback used to notify about page processing progress.

The callback mechanism also allows stopping the page processing. See

See also

IProgressPageProcessing for more details

By default, there's no callback defined for page processing, so the returned value will be NULL

Returns

Pointer to the current progress callback object.

Parameters

argCPageProcessing	CPageProcessing handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_GetRunBarcodeDetection()

IDRS_BOOL CPageProcessing_GetRunBarcodeDetection	(	const CPageProcessing	argCPageProcessing,
		idrs_exception *	pargException
	)

Gets the boolean flag that enables/disables the barcode detection.

Returns

Boolean flag that enables/disables text barcode detection

Parameters

argCPageProcessing	CPageProcessing handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_GetRunPageAnalysis()

IDRS_BOOL CPageProcessing_GetRunPageAnalysis	(	const CPageProcessing	argCPageProcessing,
		idrs_exception *	pargException
	)

Gets the boolean flag that enables/disables the page analysis.

Returns

Boolean flag that enables/disables page analysis

Parameters

argCPageProcessing	CPageProcessing handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_GetRunTextRecognition()

IDRS_BOOL CPageProcessing_GetRunTextRecognition	(	const CPageProcessing	argCPageProcessing,
		idrs_exception *	pargException
	)

Gets the boolean flag that enables/disables the text recognition.

Returns

Boolean flag that enables/disables text recognition

Parameters

argCPageProcessing	CPageProcessing handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_ProcessPage()

void CPageProcessing_ProcessPage	(	CPageProcessing	argCPageProcessing,
		CPage	argPage,
		idrs_exception *	pargException
	)

Runs the page processing. This method is executing the following operations (if enabled), in succession.

• Page analysis
• Barcode detection
• Text recognition If any of the above operations is not specifically enabled, then it will not be executed

Parameters

argCPageProcessing	CPageProcessing handle
argPage	The page to process. Page's content will be updated with the results.
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_SetBarcodeParams()

void CPageProcessing_SetBarcodeParams	(	CPageProcessing	argCPageProcessing,
		const CBarcodeParams	argBarcodeParams,
		idrs_exception *	pargException
	)

Sets the parameters used for barcode detection.

By default, the barcode detection runs on full page with all barcode types enabled (depends on enabled extensions)

Parameters

argCPageProcessing	CPageProcessing handle
argBarcodeParams	Parameters used for barcode detection.
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_SetOcrParams()

void CPageProcessing_SetOcrParams	(	CPageProcessing	argCPageProcessing,
		const COcrParams	argOcrParams,
		idrs_exception *	pargException
	)

Sets the parameters used for the ocr (language(s), full page/zonal recognition, etc).

By default, the ocr runs on full page with english language enabled

Parameters

argCPageProcessing	CPageProcessing handle
argOcrParams	Parameters used for ocr.
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

If OCR is set to full page recognition, and language detection has been enabled in the page analysis params, then the language(s) provided therein will be used only as fallback value if language detection failed; otherwise the detected language will be used instead for OCR.

If OCR is set to zonal recognition, then the language detection result will be ignored

CPageProcessing_SetPageAnalysisParams()

void CPageProcessing_SetPageAnalysisParams	(	CPageProcessing	argCPageProcessing,
		const CPageAnalysisParams	argPageAnalysisParams,
		idrs_exception *	pargException
	)

Gets the parameters used for the page analysis (language detection, orientation detection, skew detection)

By default, the page analysis will only preform orientation detection.

Parameters

argCPageProcessing	CPageProcessing handle
argPageAnalysisParams	Parameters to be used for page analysis.
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

Language detection result is only used when full page text recognition is used, when zonal recognition is used then language detection is ignored.

CPageProcessing_SetProgressCallback()

void CPageProcessing_SetProgressCallback	(	CPageProcessing	argCPageProcessing,
		IProgressPageProcessing	pProgressCallback,
		idrs_exception *	pargException
	)

Sets the callback used to notify about page processing progress.

The callback mechanism also allows stopping the page processing. See

See also

IProgressPageProcessing for more details

By default, there's no callback defined for page processing, so the returned value will be NULL

Parameters

argCPageProcessing	CPageProcessing handle
pProgressCallback	Pointer to the progress callback object to set.
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_SetRunBarcodeDetection()

void CPageProcessing_SetRunBarcodeDetection	(	CPageProcessing	argCPageProcessing,
		IDRS_BOOL const	bDetectBarcodes,
		idrs_exception *	pargException
	)

Sets the boolean flag that enables/disables the barcode detection.

Parameters

argCPageProcessing	CPageProcessing handle
bDetectBarcodes	Boolean flag that enables/disables barcode detection
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_SetRunPageAnalysis()

void CPageProcessing_SetRunPageAnalysis	(	CPageProcessing	argCPageProcessing,
		IDRS_BOOL const	bAnalysePage,
		idrs_exception *	pargException
	)

Sets the boolean flag that enables/disables the page analysis.

Parameters

argCPageProcessing	CPageProcessing handle
bAnalysePage	Boolean flag that enables/disables page analysis
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageProcessing_SetRunTextRecognition()

void CPageProcessing_SetRunTextRecognition	(	CPageProcessing	argCPageProcessing,
		IDRS_BOOL const	bRecognizeText,
		idrs_exception *	pargException
	)

Sets the boolean flag that enables/disables the text recognition.

Parameters

argCPageProcessing	CPageProcessing handle
bRecognizeText	Boolean flag that enables/disables text recognition
pargException	Pointer to exception structure that will be filled if an exception occurs