LBitmap::UnsharpMask

#include "ltwrappr.h"

virtual L_INT LBitmap::UnsharpMask (nAmount, nRadius, nThreshold, uColorType)

L_INT nAmount;	/* adjustment factor */
L_INT nRadius;	/* radius of the mask */
L_INT nThreshold;	/* threshold value */
L_UINT uColorType;	/* flag */

Sharpens the class object's bitmap by applying the unsharp mask.

Parameter	Description
nAmount	A percentage value that represents an adjustment factor.
nRadius	Value that indicates the size of the neighborhood used for blurring each pixel of the class object's bitmap.
nThreshold	Value that indicates the threshold for modifying the original value of the pixel. If the difference in the original pixel value and the blurred pixel value is greater than the threshold value, the original pixel value will be modified. The valid range is from 0 - 65535 for 64-bit, 48-bit and 16-bit grayscale images and from 0 - 4095 for 12-bit grayscale images. Otherwise, it is from 0 to 255.
uColorType	Flag that indicates the color space in which to apply the mask. Possible values are:
	Value	Meaning
	RGB_SPACE	[0x0001] Apply the mask in the RGB color space.
	YUV_SPACE	[0x0002] Apply the mask in the YUV color space.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function is actually considered a sharpening function. It is used to sharpen the image with a minimum of noise. To reduce the noise, it starts by blurring a copy of the original image. The amount of blur depends on nRadius. The function then determines the difference between each pixel's value of the original image and the corresponding pixel's value in the blurred image. If the difference is greater than the nThreshold value, then the difference between the pixel values is multiplied by the value in the nAmount parameter and added to the original pixel value.

To increase the thickness of the sharpened edges, increase the value of nRadius.

To increase the amount of sharpness, increase the value of nAmount.

To reduce the noise and eliminate the small edges or individual pixels that will produce noise in image, increase the value of nThreshold.

Using the YUV color space decreases the processing time but some color shift may happen.

To update a status bar or detect a user interrupt during the 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
LTFIL
LTIMGEFX

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:	LBitmap::BricksTexture, LBitmap::Deskew, LBitmap::DiffuseGlow, LBitmap::GlowFilter, LBitmap::HalfTonePattern, LBitmap::HighPassFilter, LBitmap::MaskConvolution, LBitmap::Perspective, LBitmap::PlasmaFilter, LBitmap::Pointillist, LBitmap::Sharpen, LBitmap::Posterize, LBitmap::Mosaic, LBitmap::Emboss, LBitmap::MedianFilter, LBitmap::AddNoise, LBitmap::IntensityDetect, LBitmap::SpatialFilterp, LBitmap::BinaryFilter, LBitmap::MaxFilter, LBitmap::MinFilter, LBitmap::Oilify, LBitmap::Solarize, LDialogImageEffect::DoModalUnsharpMask, LBitmap::WindowLevel, LBitmap::WindowLevelExt, LBitmap::GaussianFilter, Class Members
Topics:	Raster Image Functions: Filtering Images
	Detecting and Enhancing Edges and Lines
	Raster Image Functions: Removing Noise
	Raster Image Functions: Detecting and Enhancing Edges and Lines

Example

L_INT LBitmap__UnsharpMaskExample(LBitmap & Bitmap, L_TCHAR * szFileName)
{
   L_INT nRet;
   nRet =Bitmap.Load(szFileName);
   if(nRet !=SUCCESS)
      return nRet;
   return Bitmap.UnsharpMask(200, 15, 50, RGB_SPACE);
}