Call: INQUIRE_HISTOGRAM

reference

The Histogram about which you wish to obtain information.

[No default, this is a mandatory argument.]

exists

Contains on return a Logical which has the value True if the histogram exists, and the value False if it doesn't.

This argument is in practice always True since the first argument has to be a valid histogram reference. The argument's main application is in the area of debugging where it is used in conjunction with the REF_HISTOGRAM function via which one can address directly the entire histogram storage area, also those parts for which no pointer in the form of a Global variable exists.

This argument must me modifiable, i.e. it must be a simple variable name and not an expression. The argument is optional. The value of this argument on entry is not used, and is lost after the procedure call.

set

Contains on return a Logical which has the value True if the range of this histogram has been established, and False if this is an AUTOSCALE histogram which has collected too few entries sofar to have its range set.

channels

Contains on return the Number of bins of the histogram.

minimum

Contains on return the coordinate of the lower edge of the first bin.

This argument must me modifiable, i.e. it must be a simple variable name and not an expression. The argument is on return of type Number. This is an optional argument. The value of this argument on entry is not used, and is lost after the procedure call.

This number can also be obtained with the MINIMUM function.

maximum

Contains on return the coordinate of the upper edge of the last bin.

This number can also be obtained with the MAXIMUM function.

entries

Contains on return the Number of entries sofar collected in the histogram. The weight of an entry doesn't have an incidence on the entry count. Entries outside the range of the histogram are counted.

This argument must me modifiable, i.e. it must be a simple variable name and not an expression. The argument is optional.

The value of this argument on entry is not used, and is lost after the procedure call.

mean

Contains on return the average of the entries collected sofar in the histogram. The average is computed from all entries, whether inside or outside the range of the histogram, respecting the weight of each entry. Binning has no incidence on the way the average is computed.

The mean of an histogram can also be obtained with the MEAN function.

rms

Contains on return the RMS of the entries collected sofar in the histogram. The RMS is computed from all entries, whether inside or outside the range of the histogram, respecting the weight of each entry. Binning has no incidence on the way the RMS is computed.

The RMS of an histogram can also be obtained with the RMS function.

Go to the top level, to Call, to INQUIRE_HISTOGRAM, to the topic index, to the table of contents, or to the full text.

Formatted on 21/01/18 at 16:55.