NAME:
stats
PURPOSE: (one line)
Compute and print statistics plus plot histogram of data.
DESCRIPTION:
This computes basic statistical information regarding the input data and
prints it to the screen. It is intended for purely interactive work,
use MOMENT if you want to save the results to a variable.
CATEGORY:
Numerical
CALLING SEQUENCE:
stats,data
INPUTS:
data - Input data (any rank, or type).
OPTIONAL INPUT PARAMETERS:
KEYWORD INPUT PARAMETERS:
NBINS - number of bins for histogram (default = 750)
ROBO - If set, compute robust statistics.
SILENT - If set, supresses printed output to the screen
TITLE - Title for plot (default is blank)
XTITLE - X-axis title for plot (default is 'Data Numbers')
GAUSSIAN - Flag, if set will overplot a gaussian on the histogram
WINDOW - Window number for plot (default=current)
BACKGROUND - background color of plot (default=white)
COLOR - color of plot (default=black)
OUTPUTS:
KEYWORD OUTPUT PARAMETERS:
MEAN - Optional return on mean of sample.
IDX - position of bins
HIST - histogram values
MODE - Estimate of the mode (bin position of maximum in histogram)
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
Written by Marc W. Buie, Lowell Observatory, 1993/5/14
1993/09/23, MWB, Added ROBO keyword
1995/01/12, MWB, Added SILENT keyword
1995/03/29, MWB, Augment plot to include mean and sigma annotation.
1996/07/15, MWB, Added MEAN keyword
2004/07/08, MWB, Added NaN exclusion for non-robust statistics
2008/04/09, MWB, added CHARSIZE keyword pass through to plot
2010/11/29, MWB, added WINDOW keyword
2015/11/23, MWB, changed plot colors to make background white and
foreground black.
2016/08/18, MWB, added IDX and HIST output keywords
2017/11/20, MWB, added keywords to control color of plot
2018/11/29, MWB, added optional return of the mode (will depend on binning)
2022/02/10, MWB, changed y-axis scaling to always include 0.