CImage:SetMaskedValue

The SetMaskedValue method assigns a new value to pixels at coordinates stored in a pixel mask file. One application of this method is for repairing small small defects in the form of points and single-pixel wide lines.

Syntax

bSuccess = CImage:SetMaskedValue( value, sMaskFile )

bSuccess = CImage:SetMaskedValue( value, sMaskFile, CRect )

where

value is a number or string specifying the replacement value.

sMaskFile is the name of the text file containing the pixel mask.

CRect is a CRect object specifying the rectangle to repair. If omitted, the entire image is repaired.

bSuccess is the returned success code. On success it is true, otherwise false.

This method replaces pixels with a new value specified by the value argument. The target coordinates are loaded from a Pixel Mask File. The related ApplyPixelMask method replaces pixels with a locally computed neighborhood value rather than a fixed value.

Example

Assume that a pixel mask file named sMaskFile exists. The following script sets pixel values to -1000 at coordinates listed in the pixel mask file. The CRect argument is not used so that the entire image is available. Note: The entire image could also be used with the CRect argument after calling CRect:SetToImage:

I = CImage:new()	-- Create a CImage
I:Open( sPath )	-- Open the image from sPath.
I:SetMaskedValue(-1000,sMaskFile)	-- apply the pixel mask
I:Save()	-- save the image