CDeskew_interface.h File Reference

Interface for CDeskew wrapper. More...

Go to the source code of this file.

Functions
CDeskew	CDeskew_Create (const CIDRS argIDRS, idrs_exception *pargException)
	Creates a new CDeskew object.
SkewInfo	CDeskew_DetectSkewAngle (const CDeskew argCDeskew, const CImage argImage, idrs_exception *pargException)
	DetectSkewAngle analyzes the supplied image and detects its skew angle.
SkewInfo	CDeskew_DetectSkewAngle2 (const CDeskew argCDeskew, const CPage argPage, idrs_exception *pargException)
	DetectSkewAngle analyzes the supplied page and detects its skew angle.
SkewInfo	CDeskew_Deskew (CDeskew argCDeskew, CImage argImage, idrs_exception *pargException)
	Deskew analyzes and rotates the image to correct its skew angle.
SkewInfo	CDeskew_Deskew2 (CDeskew argCDeskew, CPage argPage, idrs_exception *pargException)
	Deskew analyzes and rotates the page to correct its skew angle.
void	CDeskew_CorrectSkewAngle (CDeskew argCDeskew, CImage argImage, const SkewInfo *stSkewInfo, idrs_exception *pargException)
	Correct the skew angle of the image according to the skew info provided.
void	CDeskew_CorrectSkewAngle2 (CDeskew argCDeskew, CPage argPage, const SkewInfo *stSkewInfo, idrs_exception *pargException)
	Correct the skew angle of the provided page according to the skew info provided.
void	CDeskew_SetDimensionAdjust (CDeskew argCDeskew, enum DimensionAdjust const evDimensionAdjust, idrs_exception *pargException)
	Sets the behavior regarding dimension adjustment for deskew.
enum DimensionAdjust	CDeskew_GetDimensionAdjust (const CDeskew argCDeskew, idrs_exception *pargException)
	Retrieves the behavior regarding dimension adjustment for deskew operation.
void	CDeskew_Destroy (CDeskew argCDeskew, idrs_exception *pargException)
	Destroys a CDeskew handle.

Detailed Description

Interface for CDeskew wrapper.

Function Documentation

CDeskew_CorrectSkewAngle()

void CDeskew_CorrectSkewAngle	(	CDeskew	argCDeskew,
		CImage	argImage,
		const SkewInfo *	stSkewInfo,
		idrs_exception *	pargException
	)

Correct the skew angle of the image according to the skew info provided.

Parameters

argCDeskew	CDeskew handle
argImage	The image to process.
stSkewInfo	The skew angle.
pargException	Pointer to exception structure that will be filled if an exception occurs

CDeskew_CorrectSkewAngle2()

void CDeskew_CorrectSkewAngle2	(	CDeskew	argCDeskew,
		CPage	argPage,
		const SkewInfo *	stSkewInfo,
		idrs_exception *	pargException
	)

Correct the skew angle of the provided page according to the skew info provided.

The correction is applied on all existing images (source, work and background).

Parameters

argCDeskew	CDeskew handle
argPage	The page to deskew.
stSkewInfo	The skew angle.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The page's zone are removed.

CDeskew_Create()

CDeskew CDeskew_Create	(	const CIDRS	argIDRS,
		idrs_exception *	pargException
	)

Creates a new CDeskew object.

Parameters

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

Returns

The newly created CDeskew object.

Remarks

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

CDeskew_Deskew()

SkewInfo CDeskew_Deskew	(	CDeskew	argCDeskew,
		CImage	argImage,
		idrs_exception *	pargException
	)

Deskew analyzes and rotates the image to correct its skew angle.

Parameters

argCDeskew	CDeskew handle
argImage	The image to process.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The skew angle.

Note

Deskew handles images skewed upto 10 degrees. It doesn't handle higher skew angles.

CDeskew_Deskew2()

SkewInfo CDeskew_Deskew2	(	CDeskew	argCDeskew,
		CPage	argPage,
		idrs_exception *	pargException
	)

Deskew analyzes and rotates the page to correct its skew angle.

The skew angle is always detected on the source image, and applied also to work and background images if existing.

Parameters

argCDeskew	CDeskew handle
argPage	The page to deskew.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The skew angle.

Note

The page's zones are removed.

Deskew handles images skewed upto 10 degrees. It doesn't handle higher skew angles.

CDeskew_Destroy()

void CDeskew_Destroy	(	CDeskew	argCDeskew,
		idrs_exception *	pargException
	)

Destroys a CDeskew handle.

Parameters

argCDeskew	CDeskew handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CDeskew_DetectSkewAngle()

SkewInfo CDeskew_DetectSkewAngle	(	const CDeskew	argCDeskew,
		const CImage	argImage,
		idrs_exception *	pargException
	)

DetectSkewAngle analyzes the supplied image and detects its skew angle.

The provided image will not be modified.

Parameters

argCDeskew	CDeskew handle
argImage	The image to process.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The skew angle.

Note

Deskew handles images skewed upto 10 degrees. It doesn't handle higher skew angles.

CDeskew_DetectSkewAngle2()

SkewInfo CDeskew_DetectSkewAngle2	(	const CDeskew	argCDeskew,
		const CPage	argPage,
		idrs_exception *	pargException
	)

DetectSkewAngle analyzes the supplied page and detects its skew angle.

Detection will be performed based on the source image. The provided page will not be modified.

Parameters

argCDeskew	CDeskew handle
argPage	The page to process.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The skew angle.

Note

Deskew handles images skewed upto 10 degrees. It doesn't handle higher skew angles.

CDeskew_GetDimensionAdjust()

enum DimensionAdjust CDeskew_GetDimensionAdjust	(	const CDeskew	argCDeskew,
		idrs_exception *	pargException
	)

Retrieves the behavior regarding dimension adjustment for deskew operation.

Returns

The dimension adjust value

Parameters

argCDeskew	CDeskew handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDeskew_SetDimensionAdjust()

void CDeskew_SetDimensionAdjust	(	CDeskew	argCDeskew,
		enum DimensionAdjust const	evDimensionAdjust,
		idrs_exception *	pargException
	)

Sets the behavior regarding dimension adjustment for deskew.

Parameters

argCDeskew	CDeskew handle
evDimensionAdjust	The dimension adjust value selected
pargException	Pointer to exception structure that will be filled if an exception occurs