CalcInformation

Syntax

Document.CalcInformation( X, Y[, Rings ])

Parameters

Short X - X-coordinate of pixel

Short Y - Y-coordinate of pixel

Variant Rings - If specified, must be an array of three or four integers denoting:

Rings(0) - Radius of central aperture

Rings(1) - Width of gap between aperture and annulus

Rings(2) - Width of annulus

Rings(3) - Image plane for which measurement is to be determined. This must be zero for a monochrome image; for a color image it can be 1, 2 or 3 to specify the red, green, or blue planes respectively, or 0 to return an average of the results from all three planes.

The first three quantities must be within the limits of the minimum and maximum values shown for the respective quantities on MaxIm DL's context menu. If Rings is omitted, the current rings cursor dimensions are used. If Rings is present but is only three elements long, the image plane selector is taken to be zero.

Returns

VARIANT array of 17 VARIANTs containing various measures present in the Information Window's Aperture and Astrometric modes:

result(0) - Value of pixel at coordinate (X, Y) within the image

result(1) - Maximum pixel value within the central aperture at (X, Y)

result(2) - Minimum pixel value within the central aperture at (X, Y)

result(3) - Median pixel value within the central aperture at (X, Y)

result(4) - Average pixel value within the central aperture at (X, Y)

result(5) - Standard deviation of pixels within the central aperture at (X, Y)

result(6) - X coordinate of the centroid calculated over the aperture

result(7) - Y coordinate of the centroid calculated over the aperture

result(8) - Flatness of star image in aperture

result(9) - FWHM (Full Width Half Maximum) of star image in aperture

result(10) - Half Flux Diameter of star image in aperture

result(11) - Integrated intensity of star image in aperture

result(12) - Signal to Noise ratio of star image with respect to the background

result(13) - Background level (the average of the pixels in the annulus)

result(14) - Standard deviation of the background (the pixels in the annulus)

result(15) - Right Ascension of centroid, in hours

result(16) - Declination of centroid, in hours

The last two items are Empty if the image has not been solved, otherwise they are expressed using the Double subtype of VARIANT. All others elements of the result array use the Single subtype of VARIANT.

Remarks

This method is equivalent to setting the aperture, gap, and annulus to the specified values, positioning the rings cursor on the image window at the given coordinates and transcribing data from the Information Window.  The Information Window can be in any mode, or not even displayed.  The rings cursor is not disturbed.