bkAssign

bkAssign ( integer Input, floating Intensity )

Use this function to assign the intensity of a bright field background for transmission and optical density measurements. Both the Transmission and OD measurements use the value of the average intensity of the background bright field which is usually established during the background correction (see bkCorrect). If no background correction has been performed, use this function to assign the average background intensity to the image. By default the bright field intensity is set to the maximum possible intensity value for the given image type except for the floating point type that has a default value of the background set to 1.

Parameters

Input

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

Output

An integer between 1 and 116 specifying the output image frame number. Values in the range of 100-116 correspond to hidden frames.

Intensity

A floating variable or constant specifying the average intensity of the bright field that will be used in transmission and optical density measurements. If this value is set to zero, the background value will be set to the maximum intensity found in the image.

Error flags

ERR_OK

The flag set if successful.

ERR_FAILED

The flag set if failed.

Example

The following operator assigns a value of 234. to the background intensity of the image #1:

bkAssign(1,234.)