Produced by IDL 7.1.1
User Documentation

./guide
stats.pro

Last modification date:
Wed Sep 28 13:27:09 2016

stats

procedure stats[, brange][, erange], [/full], [/chan], [ret=variable], [/quiet]

Procedure to display some simple statistics.

Statistics are done on the contents of buffer 0. One can specify the range over which statistics will be computed in any of several ways. To specify a begin and end x-value in the currently displayed x-axis units, use the parameters brange and erange. If no x-axis range is given, the user is prompted to specify the region of interest using the mouse.

If there is no plot displayed, then brange and erange are assumed to be in units of channel number. If either is not supplied and there is no plot displayed then the full range is used.

Use /chan if brange and range are in channels instead of the currently displayed x-axis units.

Examples
    getrec,1
    show               ; Use the plotter to set the X-axis to channels
    stats,0,99         ; Gets stats for first 100 channels
    show               ; Use the plotter to set the X-axis to GHz
    stats,1.420,1.421  ; Gets stats
    stats              ; User clicks plot to determine stats region
    stats,ret=mystats  ; Return stats in a structure
    print,mystats.rms
 
Version
$Id$

Parameters
brange
in, optional
float
Starting value in x-axis units
erange
in, optional
float
Ending value in x-axis units

Keywords
full
in, optional
boolean
Compute stats for full spectrum?
chan
in, optional
boolean
Range specified in channels?
ret
out, optional
variable
Structure containing results
quiet
in, optional
boolean
Suppress the printing of the moments.


Produced by IDLdoc 1.6 on Wed Sep 28 13:27:36 2016