LEADTOOLS Raster Imaging C++ Class Library Help > Classes and Member Functions > LBitmap > LBitmap Member Functions > LBitmap::GaussianFilter |
#include "ltwrappr.h"
virtual L_INT LBitmap::GaussianFilter (nRadius, uFlags = 0)
L_INT nRadius; |
/* radius of the neighborhood */ |
L_UINT32 uFlags; |
/* flags */ |
Smooths or blurs the class object's bitmap by applying a Gaussian filter to it.
Parameter |
Description |
nRadius |
Value that indicates the radius of the neighborhood on which the filter is applied. |
uFlags |
Reserved for future use. Must be 0. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Each pixel in the class object's bitmap is blurred based on neighborhood pixels. The parameter nRadius determines the size of the neighborhood to consider when blurring a pixel. The result is a blurred version of the original image.
The amount of blur is controlled by specifying the size of the neighborhood used for blurring or smoothing. The value of the nRadius parameter determines the size and values of the mask.
To update a status bar or detect a user interrupt during execution of this function, refer to LBase::EnableStatusCallback.
This function supports 12 and 16-bit grayscale and 48 and 64-bit color images. Support for 12 and 16-bit grayscale and 48 and 64-bit color images is available only in the Document/Medical toolkits.
This function does not support 32-bit grayscale images. It returns the error code ERROR_GRAY32_UNSUPPORTED if a 32-bit grayscale image is passed to this function.
Required DLLs and Libraries
LTDIS For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Win32, x64.
See Also
Example
L_INT LBitmap__GaussianFilterExample(LBitmap & Bitmap, L_TCHAR * szFileName, L_INT nRadius) { L_INT nRet; nRet =Bitmap.Load(szFileName); if(nRet !=SUCCESS) return nRet; nRet =Bitmap.GaussianFilter(nRadius); if(nRet !=SUCCESS) return nRet; return SUCCESS; }