CImage:ScaleXy

The ScaleXy method scales the image independently in each axis. Scaling is relative to 1.0. One application of this method is to remove the distortion present in images taken with a detector having non-square pixels.

Syntax

bSuccess = CImage:ScaleXy( xs, ys )

bSuccess = CImage:ScaleXy( xs, ys, bResize )

where

xs and ys are the multiplication factors and may be a number or string.

bResize controls whether the image dimension is adjusted for the scale factor. It defaults to true.

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

This method resamples the image to calculate the new values at fractional pixel locations. Resampling is controlled by members of the ResampleParams table. The image is not resampled if both x and y shifts are integral values. When resampling is needed, you can either do nothing and use the default parameters or set specific parameters and then call SetResampleParams function.

The optional bResize controls whether the image dimension (pixel count) is changed to accommodate the scaling.

Example

Suppose an image is displayed in a CImageView named V. The following script scales the image by 1.2 times in x and 1.44 times in y, without changing the number of image pixels:

I = V:GetImage()	-- attach the current displayed image
I:ScaleXy( 1.2, 1.44, false )	-- perform the operation, do not change image size
V:Update()	-- update the display after the scale