loadSpaceCal

loadSpaceCal ( integer Image, string Name )

Use this function to apply an existing spatial calibration scale to an image. Spatial calibration supplies a scale for establishing a size relationship for objects in an image and affects the results of measurements.
.
Parameters

Image

An integer between 1 and 116 specifying the frame number of the image to which the calibration scale will be applied. Values in the range of 100-116 correspond to hidden frames.

Name

A string specifying the name of a previously saved calibration scale that must be applied to the image.

Error flags

ERR_OK

The flag set if successful.

ERR_NOTFOUND

The flag set if the scale was not found.

ERR_FAILED

The flag set if failed.

Example

This set of statements loads the existing calibration scale "scalex20" to a sample image:

setCurDir ("samples")

loadIm (1,"sample8.iwd")

loadSpaceCal(1, "scale_x20")

Remark

To create and store calibration scales, use the with spaceCal function or the Spatial Calibration command from the Measure menu. For more information refer to ImageWarp User's Guide.