CPageAnalysisParams_interface.h File Reference

Interface for CPageAnalysisParams wrapper. More...

Go to the source code of this file.

Functions
CPageAnalysisParams	CPageAnalysisParams_Create (idrs_exception *pargException)
	Creates a new instance of this class.
enum SkewDetection	CPageAnalysisParams_GetSkewDetection (const CPageAnalysisParams argCPageAnalysisParams, idrs_exception *pargException)
	Gets the boolean flag indicating whether skew detection should be executed as part of page analysis.
void	CPageAnalysisParams_SetSkewDetection (CPageAnalysisParams argCPageAnalysisParams, enum SkewDetection const evSkewDetection, idrs_exception *pargException)
	Sets the boolean flag indicating whether skew detection should be executed as part of page analysis.
enum DimensionAdjust	CPageAnalysisParams_GetDimensionAdjust (const CPageAnalysisParams argCPageAnalysisParams, idrs_exception *pargException)
	Gets the boolean flag indicating whether image should be cropped after deskew during page analysis.
void	CPageAnalysisParams_SetDimensionAdjust (CPageAnalysisParams argCPageAnalysisParams, enum DimensionAdjust const evDimensionAdjust, idrs_exception *pargException)
	Sets the boolean flag indicating whether image should be cropped after deskew during page analysis.
IDRS_BOOL	CPageAnalysisParams_GetDetectOrientation (const CPageAnalysisParams argCPageAnalysisParams, idrs_exception *pargException)
	Gets the boolean flag indicating whether page orientation should be executed as part of page analysis.
void	CPageAnalysisParams_SetDetectOrientation (CPageAnalysisParams argCPageAnalysisParams, IDRS_BOOL const bDetectOrientation, idrs_exception *pargException)
	Sets the boolean flag indicating whether page orientation should be executed as part of page analysis.
PageOrientationArray	CPageAnalysisParams_GetOrientations (const CPageAnalysisParams argCPageAnalysisParams, idrs_exception *pargException)
	Gets the array with all possible page orientations that page analysis is allowed to take into consideration.
void	CPageAnalysisParams_SetOrientations (CPageAnalysisParams argCPageAnalysisParams, const PageOrientationArray argxOrientations, idrs_exception *pargException)
	Sets the array with all possible page orientations that page analysis is allowed to take into consideration.
IDRS_BOOL	CPageAnalysisParams_GetDetectLanguage (const CPageAnalysisParams argCPageAnalysisParams, idrs_exception *pargException)
	Gets the boolean flag indicating whether language detection should be executed as part of page analysis.
void	CPageAnalysisParams_SetDetectLanguage (CPageAnalysisParams argCPageAnalysisParams, IDRS_BOOL const bDetectLanguage, idrs_exception *pargException)
	Sets the boolean flag indicating whether language detection should be executed as part of page analysis.
LanguageArray	CPageAnalysisParams_GetAllowedLanguages (const CPageAnalysisParams argCPageAnalysisParams, idrs_exception *pargException)
	Gets the array with all possible languages that page analysis is allowed to take into consideration.
void	CPageAnalysisParams_SetAllowedLanguages (CPageAnalysisParams argCPageAnalysisParams, const LanguageArray xLanguages, idrs_exception *pargException)
	Sets the array with all possible languages that page analysis is allowed to take into consideration.
enum ThreadingMode	CPageAnalysisParams_GetThreadingMode (const CPageAnalysisParams argCPageAnalysisParams, idrs_exception *pargException)
	Returns the threading mode that should be used for page analysis process.
void	CPageAnalysisParams_SetThreadingMode (CPageAnalysisParams argCPageAnalysisParams, const enum ThreadingMode *const evThreadingMode, idrs_exception *pargException)
	Sets the threading mode to use for page analysis.
PageAnalysisThreadingConfig	CPageAnalysisParams_GetAdvancedThreadingConfig (const CPageAnalysisParams argCPageAnalysisParams, idrs_exception *pargException)
	Gets the threading config used for page analysis.
void	CPageAnalysisParams_SetAdvancedThreadingConfig (CPageAnalysisParams argCPageAnalysisParams, const PageAnalysisThreadingConfig *stThreadingConfig, idrs_exception *pargException)
	Sets the threading config used for page analysis.
void	CPageAnalysisParams_Destroy (CPageAnalysisParams argCPageAnalysisParams, idrs_exception *pargException)
	Destroys a CPageAnalysisParams handle.

Detailed Description

Interface for CPageAnalysisParams wrapper.

Function Documentation

CPageAnalysisParams_Create()

CPageAnalysisParams CPageAnalysisParams_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

CPageAnalysisParams_Destroy()

void CPageAnalysisParams_Destroy	(	CPageAnalysisParams	argCPageAnalysisParams,
		idrs_exception *	pargException
	)

Destroys a CPageAnalysisParams handle.

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_GetAdvancedThreadingConfig()

PageAnalysisThreadingConfig CPageAnalysisParams_GetAdvancedThreadingConfig	(	const CPageAnalysisParams	argCPageAnalysisParams,
		idrs_exception *	pargException
	)

Gets the threading config used for page analysis.

By default, the threading config is set to no multithreading

Returns

Threading config used for page analysis

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_GetAllowedLanguages()

LanguageArray CPageAnalysisParams_GetAllowedLanguages	(	const CPageAnalysisParams	argCPageAnalysisParams,
		idrs_exception *	pargException
	)

Gets the array with all possible languages that page analysis is allowed to take into consideration.

Returns

Array containing all languages that are allowed during page analysis

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_GetDetectLanguage()

IDRS_BOOL CPageAnalysisParams_GetDetectLanguage	(	const CPageAnalysisParams	argCPageAnalysisParams,
		idrs_exception *	pargException
	)

Gets the boolean flag indicating whether language detection should be executed as part of page analysis.

Returns

Boolean flag enabling/disabling language detection detection

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_GetDetectOrientation()

IDRS_BOOL CPageAnalysisParams_GetDetectOrientation	(	const CPageAnalysisParams	argCPageAnalysisParams,
		idrs_exception *	pargException
	)

Gets the boolean flag indicating whether page orientation should be executed as part of page analysis.

Returns

Boolean flag enabling/disabling page orientation detection

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_GetDimensionAdjust()

enum DimensionAdjust CPageAnalysisParams_GetDimensionAdjust	(	const CPageAnalysisParams	argCPageAnalysisParams,
		idrs_exception *	pargException
	)

Gets the boolean flag indicating whether image should be cropped after deskew during page analysis.

Returns

Boolean flag enabling/disabling dimension adjust

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_GetOrientations()

PageOrientationArray CPageAnalysisParams_GetOrientations	(	const CPageAnalysisParams	argCPageAnalysisParams,
		idrs_exception *	pargException
	)

Gets the array with all possible page orientations that page analysis is allowed to take into consideration.

Not setting this parameter will allow the page orientation algorithm to take all page orientations into consideration. It is not advisable to restrict the page orientations for the page analysis. This should be done only in specific conditions.

Returns

Array containing all page orientation that are allowed during page analysis

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_GetSkewDetection()

enum SkewDetection CPageAnalysisParams_GetSkewDetection	(	const CPageAnalysisParams	argCPageAnalysisParams,
		idrs_exception *	pargException
	)

Gets the boolean flag indicating whether skew detection should be executed as part of page analysis.

Returns

Boolean flag enabling/disabling skew detection

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_GetThreadingMode()

enum ThreadingMode CPageAnalysisParams_GetThreadingMode	(	const CPageAnalysisParams	argCPageAnalysisParams,
		idrs_exception *	pargException
	)

Returns the threading mode that should be used for page analysis process.

Please see

See also

ThreadingMode for details about the available threading modes.

Returns

The threading mode to be used

Remarks

Default value is set to ThreadingMode::None

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_SetAdvancedThreadingConfig()

void CPageAnalysisParams_SetAdvancedThreadingConfig	(	CPageAnalysisParams	argCPageAnalysisParams,
		const PageAnalysisThreadingConfig *	stThreadingConfig,
		idrs_exception *	pargException
	)

Sets the threading config used for page analysis.

Threading config can be altered directly by integrators, or set to recommended values via property ThreadingMode.

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
stThreadingConfig	Threading config to set
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_SetAllowedLanguages()

void CPageAnalysisParams_SetAllowedLanguages	(	CPageAnalysisParams	argCPageAnalysisParams,
		const LanguageArray	xLanguages,
		idrs_exception *	pargException
	)

Sets the array with all possible languages that page analysis is allowed to take into consideration.

Remarks

Not setting this parameter will allow the language detection algorithm to take all supported languages into consideration.

Specifying the allowed languages is also helpful for orientation detection, even if language detection is disabled; as it will allow to discard potential false positive matches.

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
xLanguages	Array containing all languages that are allowed during page analysis
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_SetDetectLanguage()

void CPageAnalysisParams_SetDetectLanguage	(	CPageAnalysisParams	argCPageAnalysisParams,
		IDRS_BOOL const	bDetectLanguage,
		idrs_exception *	pargException
	)

Sets the boolean flag indicating whether language detection should be executed as part of page analysis.

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
bDetectLanguage	Boolean flag enabling/disabling language detection detection
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_SetDetectOrientation()

void CPageAnalysisParams_SetDetectOrientation	(	CPageAnalysisParams	argCPageAnalysisParams,
		IDRS_BOOL const	bDetectOrientation,
		idrs_exception *	pargException
	)

Sets the boolean flag indicating whether page orientation should be executed as part of page analysis.

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
bDetectOrientation	Boolean flag enabling/disabling page orientation detection
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_SetDimensionAdjust()

void CPageAnalysisParams_SetDimensionAdjust	(	CPageAnalysisParams	argCPageAnalysisParams,
		enum DimensionAdjust const	evDimensionAdjust,
		idrs_exception *	pargException
	)

Sets the boolean flag indicating whether image should be cropped after deskew during page analysis.

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
evDimensionAdjust	Boolean flag enabling/disabling dimension adjust
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_SetOrientations()

void CPageAnalysisParams_SetOrientations	(	CPageAnalysisParams	argCPageAnalysisParams,
		const PageOrientationArray	argxOrientations,
		idrs_exception *	pargException
	)

Sets the array with all possible page orientations that page analysis is allowed to take into consideration.

Not setting this parameter will allow the page orientation algorithm to take all page orientations into consideration. It is not advisable to restrict the page orientations for the page analysis. This should be done only in specific conditions.

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
argxOrientations	Array containing all page orientation that are allowed during page analysis
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_SetSkewDetection()

void CPageAnalysisParams_SetSkewDetection	(	CPageAnalysisParams	argCPageAnalysisParams,
		enum SkewDetection const	evSkewDetection,
		idrs_exception *	pargException
	)

Sets the boolean flag indicating whether skew detection should be executed as part of page analysis.

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
evSkewDetection	Boolean flag enabling/disabling skew detection
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageAnalysisParams_SetThreadingMode()

void CPageAnalysisParams_SetThreadingMode	(	CPageAnalysisParams	argCPageAnalysisParams,
		const enum ThreadingMode *const	evThreadingMode,
		idrs_exception *	pargException
	)

Sets the threading mode to use for page analysis.

Please see

See also

ThreadingMode for details about the available threading modes. Calling SetThreadingMode() will set the threading configuration with the default values associated with the mode chosen. This will invalidate any custom change made via property AdvancedThreadingConfig.

Parameters

argCPageAnalysisParams	CPageAnalysisParams handle
evThreadingMode	The threading mode to be used
pargException	Pointer to exception structure that will be filled if an exception occurs