Table of contents

CImageProcessor

The CImageProcessor class is a utility class for applying advanced processing on images.

Definition

Namespace: dynamsoft::utility

Assembly: DynamsoftUtility

class CImageProcessor

Methods

Method Description
AdjustBrightness Adjusts the brightness of the image.
AdjustContrast Adjusts the contrast of the image.
ConvertToBinaryGlobal Converts the grayscale image to binary image using a global threshold.
ConvertToBinaryLocal Converts the grayscale image to binary image using local (adaptive) binarization.
ConvertToGray Converts colour image to grayscale.
CropImage Crops an image.
CropAndDeskewImage Crops and deskews a region from the input image based on the specified quadrilateral.
FilterImage Applies a specified image filter to an input image and returns the filtered result.

AdjustBrightness

Adjusts the brightness of the image.

CImageData* AdjustBrightness(const CImageData* pImageData, int brightness)

Parameters

[in] pImageData A pointer to the image data to be processed.

[in] brightness Brightness adjustment value (positive values increase brightness, negative values decrease brightness). The value range is [-100, 100]

Return value

Returns a pointer to a CImageData object representing the processed image.

See Also

CImageData

AdjustContrast

Adjusts the contrast of the image.

CImageData* AdjustContrast(const CImageData* pImageData, int contrast)

Parameters

[in] pImageData A pointer to the image data to be processed.

[in] contrast Contrast adjustment value (positive values enhance, negative values reduce contrast). The value range is [-100, 100]

Return value

Returns a pointer to a CImageData object representing the processed image.

See Also

CImageData

ConvertToBinaryGlobal

Converts the grayscale image to binary image using a global threshold.

CImageData* ConvertToBinaryGlobal(const CImageData* pImageData, int threshold = -1, bool invert = false)

Parameters

[in] pImageData A pointer to the image data to be processed.

[in] threshold Global threshold for binarization(default is -1, automatic calculate the threshold).

[in] invert If true, invert the binary image (black becomes white and white becomes black).

Return value

Returns a pointer to a CImageData object representing the processed image.

See Also

CImageData

ConvertToBinaryLocal

Converts the grayscale image to binary image using local (adaptive) binarization.

CImageData* ConvertToBinaryLocal(const CImageData* pImageData, int blockSize = 0, int compensation = 0, bool invert = false)

Parameters

[in] pImageData A pointer to the image data to be processed.

[in] blockSize Size of the block for local binarization(default is 0).

[in] compensation Adjustment value to modify the threshold (default is 0).

[in] invert If true, invert the binary image (black becomes white and white becomes black).

Return value

Returns a pointer to a CImageData object representing the processed image.

See Also

CImageData

ConvertToGray

Converts colour image to grayscale.

CImageData* ConvertToGray(const CImageData* pImageData, float R = 0.3f, float G = 0.59f, float B = 0.11f)

Parameters

[in] pImageData A pointer to the image data to be processed.

[in] R Weight for red channel.

[in] G Weight for green channel.

[in] B Weight for blue channel.

Return value

Returns a pointer to a CImageData object representing the processed image.

See Also

CImageData

CropImage

Crops an image.

CImageData* CropImage(const CImageData* pImageData, const CRect& rect, int* pErrorCode = NULL)

//Announced as deprecated. Use CropAndDeskewImage instead.
CImageData* CropImage(const CImageData* pImageData, const CQuadrilateral& quad, int* pErrorCode = NULL)

Parameters

[in] pImageData A pointer to the image data to be cropped.

[in] rect The rectangle to be cropped.

[in] quad The quadrilateral to be cropped.

[out] pErrorCode The error code.

Return value

Returns a pointer to a CImageData object representing the cropped image.

See Also

CImageData

CRect

CQuadrilateral

CropAndDeskewImage

Crops and deskews a region from the input image based on the specified quadrilateral.

CImageData* CropAndDeskewImage(const CImageData* imageData, const CQuadrilateral& quad, int dstWidth = 0, int dstHeight = 0, int padding = 0, int* errorCode = NULL);

Parameters

[in] imageData A pointer to the source image to be cropped and deskewed.

[in] quad A quadrilateral defining the region of interest to extract.

[in] dstWidth (Optional) The width of the output image. If set to 0, the width and height will be automatically calculated.

[in] dstHeight (Optional) The height of the output image. If set to 0, the width and height will be automatically calculated.

[in] padding (Optional) Extra padding (in pixels) applied to expand the boundaries of the extracted region. Default is 0.

[out] errorCode The error code.

Return value

Returns a pointer to a CImageData object representing the cropped image.

Remarks

The caller is responsible for freeing the memory allocated for the cropped image.
The function will automatically calculate the perspective transform matrix and use it to crop the image.
If the specified quadrilateral exceeds the image boundaries, white will be used to fill the exceeding area.

See Also

CImageData

CQuadrilateral

FilterImage

Applies a specified image filter to an input image and returns the filtered result.

CImageData* FilterImage(const CImageData* pImageData, FilterType filterType)

Parameters

[in] pImageData A pointer to the image data to be processed.

[in] filterType Specifies the type of filter to apply to the input image.

Return value

Returns a pointer to a CImageData object representing the processed image.

See Also

CImageData

FilterType

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article: