CBlankImageDetection_interface.h File Reference

Interface for CBlankImageDetection wrapper. More...

Go to the source code of this file.

Functions
CBlankImageDetection	CBlankImageDetection_Create (const CIDRS argIDRS, idrs_exception *pargException)
	Creates a new CBlankImageDetection object.
void	CBlankImageDetection_SetDetectionMode (CBlankImageDetection argCBlankImageDetection, enum BlankImageDetectionMode const evBlankImageDetectionMode, idrs_exception *pargException)
	Sets the detection mode.
enum BlankImageDetectionMode	CBlankImageDetection_GetDetectionMode (const CBlankImageDetection argCBlankImageDetection, idrs_exception *pargException)
	Returns the detection mode.
void	CBlankImageDetection_SetDetectionSensitivity (CBlankImageDetection argCBlankImageDetection, enum BlankImageDetectionSensitivity const evBlankImageDetectionSensitivity, idrs_exception *pargException)
	Sets the detection sensitivity.
enum BlankImageDetectionSensitivity	CBlankImageDetection_GetDetectionSensitivity (const CBlankImageDetection argCBlankImageDetection, idrs_exception *pargException)
	Returns the detection sensitivity.
IDRS_BOOL	CBlankImageDetection_IsBlank (const CBlankImageDetection argCBlankImageDetection, const CImage argImage, idrs_exception *pargException)
	IsBlank detects blank images.
void	CBlankImageDetection_Destroy (CBlankImageDetection argCBlankImageDetection, idrs_exception *pargException)
	Destroys a CBlankImageDetection handle.

Detailed Description

Interface for CBlankImageDetection wrapper.

Function Documentation

CBlankImageDetection_Create()

CBlankImageDetection CBlankImageDetection_Create	(	const CIDRS	argIDRS,
		idrs_exception *	pargException
	)

Creates a new CBlankImageDetection object.

Parameters

argIDRS	The iDRS
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created CBlankImageDetection object.

Remarks

The default blank detection mode used is BlankImageDetectionMode::Advanced which gives the most accurate results.

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

CBlankImageDetection_Destroy()

void CBlankImageDetection_Destroy	(	CBlankImageDetection	argCBlankImageDetection,
		idrs_exception *	pargException
	)

Destroys a CBlankImageDetection handle.

Parameters

argCBlankImageDetection	CBlankImageDetection handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CBlankImageDetection_GetDetectionMode()

enum BlankImageDetectionMode CBlankImageDetection_GetDetectionMode	(	const CBlankImageDetection	argCBlankImageDetection,
		idrs_exception *	pargException
	)

Returns the detection mode.

Remarks

The default blank detection mode used is BlankImageDetectionMode::Advanced which gives the most accurate results.

Returns

The detection mode

Parameters

argCBlankImageDetection	CBlankImageDetection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBlankImageDetection_GetDetectionSensitivity()

enum BlankImageDetectionSensitivity CBlankImageDetection_GetDetectionSensitivity	(	const CBlankImageDetection	argCBlankImageDetection,
		idrs_exception *	pargException
	)

Returns the detection sensitivity.

Returns

The detection sensitivity

Parameters

argCBlankImageDetection	CBlankImageDetection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBlankImageDetection_IsBlank()

IDRS_BOOL CBlankImageDetection_IsBlank	(	const CBlankImageDetection	argCBlankImageDetection,
		const CImage	argImage,
		idrs_exception *	pargException
	)

IsBlank detects blank images.

Parameters

argCBlankImageDetection	CBlankImageDetection handle
argImage	The image to analyze.
pargException	Pointer to exception structure that will be filled if an exception occurs

Return values

IDRS_TRUE	if the image is considered as blank.
IDRS_FALSE	otherwise.

CBlankImageDetection_SetDetectionMode()

void CBlankImageDetection_SetDetectionMode	(	CBlankImageDetection	argCBlankImageDetection,
		enum BlankImageDetectionMode const	evBlankImageDetectionMode,
		idrs_exception *	pargException
	)

Sets the detection mode.

Parameters

argCBlankImageDetection	CBlankImageDetection handle
evBlankImageDetectionMode	The detection mode to set
pargException	Pointer to exception structure that will be filled if an exception occurs

CBlankImageDetection_SetDetectionSensitivity()

void CBlankImageDetection_SetDetectionSensitivity	(	CBlankImageDetection	argCBlankImageDetection,
		enum BlankImageDetectionSensitivity const	evBlankImageDetectionSensitivity,
		idrs_exception *	pargException
	)

Sets the detection sensitivity.

Parameters

argCBlankImageDetection	CBlankImageDetection handle
evBlankImageDetectionSensitivity	The detection sensitivity to set
pargException	Pointer to exception structure that will be filled if an exception occurs