Interface for CPageAnalysis wrapper. More...

Functions
CPageAnalysis	CPageAnalysis_Create (const CIDRS argIdrs, idrs_exception *pargException)
	Creates a new instance of this class and associates the provided.

CPageAnalysis	CPageAnalysis_Create2 (const CIDRS argIdrs, const CPageAnalysisParams argPageAnalysisParams, idrs_exception *pargException)
	Creates a new instance of this class and associates to it the provided.

CPageAnalysisParams	CPageAnalysis_GetPageAnalysisParams (const CPageAnalysis argCPageAnalysis, idrs_exception *pargException)
	Gets the parameters used for the page analysis (language detection, orientation detection, skew detection)

void	CPageAnalysis_SetPageAnalysisParams (CPageAnalysis argCPageAnalysis, const CPageAnalysisParams argPageAnalysisParams, idrs_exception *pargException)
	Gets the parameters used for the page analysis (language detection, orientation detection, skew detection)

IProgressPageProcessing	CPageAnalysis_GetProgressCallback (const CPageAnalysis argCPageAnalysis, idrs_exception *pargException)
	Gets the callback used to notify about page analysis progress.

void	CPageAnalysis_SetProgressCallback (CPageAnalysis argCPageAnalysis, IProgressPageProcessing argpProgressCallback, idrs_exception *pargException)
	Sets the callback used to notify about page analysis progress.

CPageAnalysisResult	CPageAnalysis_AnalyzePage (const CPageAnalysis argCPageAnalysis, const CImage argImage, idrs_exception *pargException)
	Runs page analysis and returns the detected results.

CPageAnalysisResult	CPageAnalysis_AnalyzePage2 (const CPageAnalysis argCPageAnalysis, CPage argPage, IDRS_BOOL const bUpdatePage, idrs_exception *pargException)
	Runs page analysis and returns the detected results.

CPageAnalysisResult	CPageAnalysis_AnalyzePage3 (const CPageAnalysis argCPageAnalysis, CPage argPage, idrs_exception *pargException)
	Runs page analysis and returns the detected results.

void	CPageAnalysis_Destroy (CPageAnalysis argCPageAnalysis, idrs_exception *pargException)
	Destroys a CPageAnalysis handle.

Detailed Description

Interface for CPageAnalysis wrapper.

Function Documentation

◆ CPageAnalysis_AnalyzePage()

CPageAnalysisResult CPageAnalysis_AnalyzePage	(	const CPageAnalysis	argCPageAnalysis,
		const CImage	argImage,
		idrs_exception *	pargException
	)

Runs page analysis and returns the detected results.

Parameters

argCPageAnalysis	CPageAnalysis handle
argImage	Image on which analysis will be run.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns: Page analysis results

Remarks: The provided image will not be modified by this call.

◆ CPageAnalysis_AnalyzePage2()

CPageAnalysisResult CPageAnalysis_AnalyzePage2	(	const CPageAnalysis	argCPageAnalysis,
		CPage	argPage,
		IDRS_BOOL const	bUpdatePage,
		idrs_exception *	pargException
	)

Runs page analysis and returns the detected results.

Parameters

argCPageAnalysis	CPageAnalysis handle
argPage	Page on which analysis will be run.
bUpdatePage	If true, this method will correct the orientation/skew of the image whenever orientation or skew detection are enabled.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns: Page analysis results

Remarks: The provided page will be modified only if the flag bUpdatePage is set to IDRS_TRUE.

◆ CPageAnalysis_AnalyzePage3()

CPageAnalysisResult CPageAnalysis_AnalyzePage3	(	const CPageAnalysis	argCPageAnalysis,
		CPage	argPage,
		idrs_exception *	pargException
	)

Runs page analysis and returns the detected results.

Parameters

argCPageAnalysis	CPageAnalysis handle
argPage	Page on which analysis will be run.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns: Page analysis results

Remarks: The provided page will be modified only if the flag bUpdatePage is set to IDRS_TRUE.

◆ CPageAnalysis_Create()

CPageAnalysis CPageAnalysis_Create	(	const 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

◆ CPageAnalysis_Create2()

CPageAnalysis CPageAnalysis_Create2	(	const CIDRS	argIdrs,
		const CPageAnalysisParams	argPageAnalysisParams,
		idrs_exception *	pargException
	)

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

See also: CIDRS handle and page analysis parameters.

Parameters

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

◆ CPageAnalysis_Destroy()

void CPageAnalysis_Destroy	(	CPageAnalysis	argCPageAnalysis,
		idrs_exception *	pargException
	)

Destroys a CPageAnalysis handle.

Parameters

argCPageAnalysis	CPageAnalysis handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageAnalysis_GetPageAnalysisParams()

CPageAnalysisParams CPageAnalysis_GetPageAnalysisParams	(	const CPageAnalysis	argCPageAnalysis,
		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

argCPageAnalysis	CPageAnalysis handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageAnalysis_GetProgressCallback()

IProgressPageProcessing CPageAnalysis_GetProgressCallback	(	const CPageAnalysis	argCPageAnalysis,
		idrs_exception *	pargException
	)

Gets the callback used to notify about page analysis progress.

The callback mecchanism also allows stopping the page analyis. See

See also: CProgressPageAnalysis for more details

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

Returns: Pointer to the progress callback object to set.

Parameters

argCPageAnalysis	CPageAnalysis handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageAnalysis_SetPageAnalysisParams()

void CPageAnalysis_SetPageAnalysisParams	(	CPageAnalysis	argCPageAnalysis,
		const CPageAnalysisParams	argPageAnalysisParams,
		idrs_exception *	pargException
	)

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

Parameters

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

◆ CPageAnalysis_SetProgressCallback()

void CPageAnalysis_SetProgressCallback	(	CPageAnalysis	argCPageAnalysis,
		IProgressPageProcessing	argpProgressCallback,
		idrs_exception *	pargException
	)

Sets the callback used to notify about page analysis progress.

Parameters

argCPageAnalysis	CPageAnalysis handle
argpProgressCallback	Pointer to the progress callback object to set
pargException	Pointer to exception structure that will be filled if an exception occurs

Functions

Detailed Description

Function Documentation

◆ CPageAnalysis_AnalyzePage()

◆ CPageAnalysis_AnalyzePage2()

◆ CPageAnalysis_AnalyzePage3()

◆ CPageAnalysis_Create()

◆ CPageAnalysis_Create2()

◆ CPageAnalysis_Destroy()

◆ CPageAnalysis_GetPageAnalysisParams()

◆ CPageAnalysis_GetProgressCallback()

◆ CPageAnalysis_SetPageAnalysisParams()

◆ CPageAnalysis_SetProgressCallback()