CLineRemoval_interface.h File Reference

Interface for CLineRemoval wrapper. More...

Go to the source code of this file.

Functions
CLineRemoval	CLineRemoval_Create (const CIDRS argIDRS, idrs_exception *pargException)
	Creates a new CLineRemoval object.
void	CLineRemoval_SetHorizontalMinLength (CLineRemoval argCLineRemoval, IDRS_UINT const uiHorizontalMinLength, idrs_exception *pargException)
	SetHorizontalMinLength sets the minimum length of the horizontal lines to remove.
void	CLineRemoval_SetHorizontalMaxThickness (CLineRemoval argCLineRemoval, IDRS_UINT const uiHorizontalMaxThickness, idrs_exception *pargException)
	SetHorizontalMaxThickness sets the maximum thickness of the horizontal lines to remove.
void	CLineRemoval_SetHorizontalMaxGap (CLineRemoval argCLineRemoval, IDRS_UINT const uiHorizontalMaxGap, idrs_exception *pargException)
	SetHorizontalMaxGap sets the maximum horizontal line gap to close.
void	CLineRemoval_SetHorizontalDilate (CLineRemoval argCLineRemoval, IDRS_UINT const uiHorizontalDilate, idrs_exception *pargException)
	SetHorizontalDilate sets the dilate parameter that helps the detection of horizontal lines, especially for thin and/or skewed horizontal lines.
void	CLineRemoval_SetHorizontalCleanY (CLineRemoval argCLineRemoval, IDRS_UINT const uiHorizontalCleanY, idrs_exception *pargException)
	SetHorizontalCleanY sets the parameter for cleaning noisy pixels attached to the horizontal lines.
void	CLineRemoval_SetHorizontalCleanX (CLineRemoval argCLineRemoval, IDRS_UINT const uiHorizontalCleanX, idrs_exception *pargException)
	SetHorizontalCleanX sets the parameter for cleaning noisy pixels attached to the horizontal lines.
void	CLineRemoval_SetVerticalMinLength (CLineRemoval argCLineRemoval, IDRS_UINT const uiVerticalMinLength, idrs_exception *pargException)
	SetVerticalMinLength sets the minimum length of the vertical lines to remove.
void	CLineRemoval_SetVerticalMaxThickness (CLineRemoval argCLineRemoval, IDRS_UINT const uiVerticalMaxThickness, idrs_exception *pargException)
	SetVerticalMaxThickness sets the maximum thickness of the vertical lines to remove.
void	CLineRemoval_SetVerticalMaxGap (CLineRemoval argCLineRemoval, IDRS_UINT const uiVerticalMaxGap, idrs_exception *pargException)
	SetVerticalMaxGap sets the maximum vertical line gap to close.
void	CLineRemoval_SetVerticalDilate (CLineRemoval argCLineRemoval, IDRS_UINT const uiVerticalDilate, idrs_exception *pargException)
	SetVerticalDilate sets the dilate parameter that helps the detection of vertical lines, especially for thin and/or skewed vertical lines.
void	CLineRemoval_SetVerticalCleanY (CLineRemoval argCLineRemoval, IDRS_UINT const uiVerticalCleanY, idrs_exception *pargException)
	SetVerticalCleanY sets the parameter for cleaning noisy pixels attached to the vertical lines.
void	CLineRemoval_SetVerticalCleanX (CLineRemoval argCLineRemoval, IDRS_UINT const uiVerticalCleanX, idrs_exception *pargException)
	SetVerticalCleanX sets the parameter for cleaning noisy pixels attached to the vertical lines.
void	CLineRemoval_RemoveLines (CLineRemoval argCLineRemoval, CImage argImage, IDRS_BOOL const bRemoveHorizontalLines, IDRS_BOOL const bRemoveVerticalLines, idrs_exception *pargException)
	RemoveLines removes lines in the given image.
void	CLineRemoval_RemoveLines2 (CLineRemoval argCLineRemoval, CImage argImage, IDRS_BOOL const bRemoveHorizontalLines, idrs_exception *pargException)
	RemoveLines removes lines in the given image.
void	CLineRemoval_RemoveLines3 (CLineRemoval argCLineRemoval, CImage argImage, idrs_exception *pargException)
	RemoveLines removes lines in the given image.
void	CLineRemoval_RemoveLines4 (CLineRemoval argCLineRemoval, CImage argImage, const IDRS_RECT *rRectangle, IDRS_BOOL const bRemoveHorizontalLines, IDRS_BOOL const bRemoveVerticalLines, idrs_exception *pargException)
	RemoveLines removes lines in a zone of the given image.
void	CLineRemoval_RemoveLines5 (CLineRemoval argCLineRemoval, CImage argImage, const IDRS_RECT *rRectangle, IDRS_BOOL const bRemoveHorizontalLines, idrs_exception *pargException)
	RemoveLines removes lines in a zone of the given image.
void	CLineRemoval_RemoveLines6 (CLineRemoval argCLineRemoval, CImage argImage, const IDRS_RECT *rRectangle, idrs_exception *pargException)
	RemoveLines removes lines in a zone of the given image.
void	CLineRemoval_Destroy (CLineRemoval argCLineRemoval, idrs_exception *pargException)
	Destroys a CLineRemoval handle.

Detailed Description

Interface for CLineRemoval wrapper.

Function Documentation

CLineRemoval_Create()

CLineRemoval CLineRemoval_Create	(	const CIDRS	argIDRS,
		idrs_exception *	pargException
	)

Creates a new CLineRemoval object.

Parameters

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

Returns

The newly created CLineRemoval object.

Remarks

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

CLineRemoval_Destroy()

void CLineRemoval_Destroy	(	CLineRemoval	argCLineRemoval,
		idrs_exception *	pargException
	)

Destroys a CLineRemoval handle.

Parameters

argCLineRemoval	CLineRemoval handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CLineRemoval_RemoveLines()

void CLineRemoval_RemoveLines	(	CLineRemoval	argCLineRemoval,
		CImage	argImage,
		IDRS_BOOL const	bRemoveHorizontalLines,
		IDRS_BOOL const	bRemoveVerticalLines,
		idrs_exception *	pargException
	)

RemoveLines removes lines in the given image.

The image must be black and white (otherwise an exception with the IDRS_ERROR_INVALID_ARGS code is thrown).

Attention

Line removal is only available for black and white images.

Parameters

argCLineRemoval	CLineRemoval handle
argImage	The image to clean.
bRemoveHorizontalLines	If IDRS_TRUE, the horizontal lines are removed.
bRemoveVerticalLines	If IDRS_TRUE, the vertical lines are removed.
pargException	Pointer to exception structure that will be filled if an exception occurs

CLineRemoval_RemoveLines2()

void CLineRemoval_RemoveLines2	(	CLineRemoval	argCLineRemoval,
		CImage	argImage,
		IDRS_BOOL const	bRemoveHorizontalLines,
		idrs_exception *	pargException
	)

RemoveLines removes lines in the given image.

The image must be black and white (otherwise an exception with the IDRS_ERROR_INVALID_ARGS code is thrown).

Attention

Line removal is only available for black and white images.

Parameters

argCLineRemoval	CLineRemoval handle
argImage	The image to clean.
bRemoveHorizontalLines	If IDRS_TRUE, the horizontal lines are removed.
pargException	Pointer to exception structure that will be filled if an exception occurs

CLineRemoval_RemoveLines3()

void CLineRemoval_RemoveLines3	(	CLineRemoval	argCLineRemoval,
		CImage	argImage,
		idrs_exception *	pargException
	)

RemoveLines removes lines in the given image.

The image must be black and white (otherwise an exception with the IDRS_ERROR_INVALID_ARGS code is thrown).

Attention

Line removal is only available for black and white images.

Parameters

argCLineRemoval	CLineRemoval handle
argImage	The image to clean.
pargException	Pointer to exception structure that will be filled if an exception occurs

CLineRemoval_RemoveLines4()

void CLineRemoval_RemoveLines4	(	CLineRemoval	argCLineRemoval,
		CImage	argImage,
		const IDRS_RECT *	rRectangle,
		IDRS_BOOL const	bRemoveHorizontalLines,
		IDRS_BOOL const	bRemoveVerticalLines,
		idrs_exception *	pargException
	)

RemoveLines removes lines in a zone of the given image.

The image must be black and white (otherwise an exception with the IDRS_ERROR_INVALID_ARGS code is thrown).

Attention

Line removal is only available for black and white images.

Parameters

argCLineRemoval	CLineRemoval handle
argImage	The image to clean.
rRectangle	The rectangle zone to process.
bRemoveHorizontalLines	If IDRS_TRUE, the horizontal lines are removed.
bRemoveVerticalLines	If IDRS_TRUE, the vertical lines are removed.
pargException	Pointer to exception structure that will be filled if an exception occurs

CLineRemoval_RemoveLines5()

void CLineRemoval_RemoveLines5	(	CLineRemoval	argCLineRemoval,
		CImage	argImage,
		const IDRS_RECT *	rRectangle,
		IDRS_BOOL const	bRemoveHorizontalLines,
		idrs_exception *	pargException
	)

RemoveLines removes lines in a zone of the given image.

The image must be black and white (otherwise an exception with the IDRS_ERROR_INVALID_ARGS code is thrown).

Attention

Line removal is only available for black and white images.

Parameters

argCLineRemoval	CLineRemoval handle
argImage	The image to clean.
rRectangle	The rectangle zone to process.
bRemoveHorizontalLines	If IDRS_TRUE, the horizontal lines are removed.
pargException	Pointer to exception structure that will be filled if an exception occurs

CLineRemoval_RemoveLines6()

void CLineRemoval_RemoveLines6	(	CLineRemoval	argCLineRemoval,
		CImage	argImage,
		const IDRS_RECT *	rRectangle,
		idrs_exception *	pargException
	)

RemoveLines removes lines in a zone of the given image.

The image must be black and white (otherwise an exception with the IDRS_ERROR_INVALID_ARGS code is thrown).

Attention

Line removal is only available for black and white images.

Parameters

argCLineRemoval	CLineRemoval handle
argImage	The image to clean.
rRectangle	The rectangle zone to process.
pargException	Pointer to exception structure that will be filled if an exception occurs

CLineRemoval_SetHorizontalCleanX()

void CLineRemoval_SetHorizontalCleanX	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiHorizontalCleanX,
		idrs_exception *	pargException
	)

SetHorizontalCleanX sets the parameter for cleaning noisy pixels attached to the horizontal lines.

Parameters

argCLineRemoval	CLineRemoval handle
uiHorizontalCleanX	The parameter for cleaning noisy pixels attached to the horizontal lines.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_HORZ_CLEAN_X.

CLineRemoval_SetHorizontalCleanY()

void CLineRemoval_SetHorizontalCleanY	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiHorizontalCleanY,
		idrs_exception *	pargException
	)

SetHorizontalCleanY sets the parameter for cleaning noisy pixels attached to the horizontal lines.

Parameters

argCLineRemoval	CLineRemoval handle
uiHorizontalCleanY	The parameter for cleaning noisy pixels attached to the horizontal lines.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_HORZ_CLEAN_Y.

CLineRemoval_SetHorizontalDilate()

void CLineRemoval_SetHorizontalDilate	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiHorizontalDilate,
		idrs_exception *	pargException
	)

SetHorizontalDilate sets the dilate parameter that helps the detection of horizontal lines, especially for thin and/or skewed horizontal lines.

Parameters

argCLineRemoval	CLineRemoval handle
uiHorizontalDilate	The dilate parameter that helps the detection of horizontal lines.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_HORZ_DILATE.

CLineRemoval_SetHorizontalMaxGap()

void CLineRemoval_SetHorizontalMaxGap	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiHorizontalMaxGap,
		idrs_exception *	pargException
	)

SetHorizontalMaxGap sets the maximum horizontal line gap to close.

It is useful to remove broken lines.

Parameters

argCLineRemoval	CLineRemoval handle
uiHorizontalMaxGap	The maximum horizontal line gap to close.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_HORZ_MAX_GAP.

CLineRemoval_SetHorizontalMaxThickness()

void CLineRemoval_SetHorizontalMaxThickness	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiHorizontalMaxThickness,
		idrs_exception *	pargException
	)

SetHorizontalMaxThickness sets the maximum thickness of the horizontal lines to remove.

It is useful to keep vertical lines larger than this parameter. Can be also useful to keep vertical letter strokes

Parameters

argCLineRemoval	CLineRemoval handle
uiHorizontalMaxThickness	The maximum thickness of the horizontal lines to remove.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_HORZ_MAX_THICKNESS.

CLineRemoval_SetHorizontalMinLength()

void CLineRemoval_SetHorizontalMinLength	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiHorizontalMinLength,
		idrs_exception *	pargException
	)

SetHorizontalMinLength sets the minimum length of the horizontal lines to remove.

Parameters

argCLineRemoval	CLineRemoval handle
uiHorizontalMinLength	The minimum length of the horizontal lines to remove.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_HORZ_MIN_LENGTH.

CLineRemoval_SetVerticalCleanX()

void CLineRemoval_SetVerticalCleanX	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiVerticalCleanX,
		idrs_exception *	pargException
	)

SetVerticalCleanX sets the parameter for cleaning noisy pixels attached to the vertical lines.

Parameters

argCLineRemoval	CLineRemoval handle
uiVerticalCleanX	The parameter for cleaning noisy pixels attached to the vertical lines.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_VERT_CLEAN_X.

CLineRemoval_SetVerticalCleanY()

void CLineRemoval_SetVerticalCleanY	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiVerticalCleanY,
		idrs_exception *	pargException
	)

SetVerticalCleanY sets the parameter for cleaning noisy pixels attached to the vertical lines.

Parameters

argCLineRemoval	CLineRemoval handle
uiVerticalCleanY	The parameter for cleaning noisy pixels attached to the vertical lines.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_VERT_CLEAN_Y.

CLineRemoval_SetVerticalDilate()

void CLineRemoval_SetVerticalDilate	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiVerticalDilate,
		idrs_exception *	pargException
	)

SetVerticalDilate sets the dilate parameter that helps the detection of vertical lines, especially for thin and/or skewed vertical lines.

Parameters

argCLineRemoval	CLineRemoval handle
uiVerticalDilate	The dilate parameter that helps the detection of vertical lines.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_VERT_DILATE.

CLineRemoval_SetVerticalMaxGap()

void CLineRemoval_SetVerticalMaxGap	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiVerticalMaxGap,
		idrs_exception *	pargException
	)

SetVerticalMaxGap sets the maximum vertical line gap to close.

It is useful to remove broken lines.

Parameters

argCLineRemoval	CLineRemoval handle
uiVerticalMaxGap	The maximum vertical line gap to close.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_VERT_MAX_GAP.

CLineRemoval_SetVerticalMaxThickness()

void CLineRemoval_SetVerticalMaxThickness	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiVerticalMaxThickness,
		idrs_exception *	pargException
	)

SetVerticalMaxThickness sets the maximum thickness of the vertical lines to remove.

It is useful to keep horizontal lines larger than this parameter. Can be also useful to keep horizontal letter strokes.

Parameters

argCLineRemoval	CLineRemoval handle
uiVerticalMaxThickness	The maximum thickness of the vertical lines to remove.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_VERT_MAX_THICKNESS.

CLineRemoval_SetVerticalMinLength()

void CLineRemoval_SetVerticalMinLength	(	CLineRemoval	argCLineRemoval,
		IDRS_UINT const	uiVerticalMinLength,
		idrs_exception *	pargException
	)

SetVerticalMinLength sets the minimum length of the vertical lines to remove.

Parameters

argCLineRemoval	CLineRemoval handle
uiVerticalMinLength	The minimum length of the vertical lines to remove.
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The default value is IDRS_DFLT_LRM_VERT_MIN_LENGTH.