CImage:Div

CImage:Div

The Div method divides this image by another image. The result replaces the current image.

Syntax

bResult = CImage:Div( CImage )

The CImage argument refers to another CImage.
On success, this method returns true.
On failure, this method returns false.

Remarks

This method has a possibility of an illegal divide by 0 operation when the pixel of the other image has a value of 0. Mira traps this condition and substitutes a replacement value into the output pixel. The replacement value is set for math operations using the SetMathErrVal method.

Example

The following script fragment loads two images from files sPath1 and sPath2, divides them, and saves the result of the first image back to its file:

SetMathErrVal( 1 )	-- output pixel set to 1 upon divide by 0 error
I = CImage:new()	-- create a new CImage
I:Open(sPath1)	-- load the image from the file sPath1
I2 = CImage:new()	-- create a new CImage
I2:Open(sPath2)	-- load the second image from the file sPath2
I:SetDatatype("float")	-- change data type for a more significant result
I:Div( I2 )	-- perform the operation on image I
I:Save()	-- save the image
I:delete()	-- remove I from memory
I2:delete()	-- remove I2 from memory