Documentation for /Users/balarsen/Documents/idl/larsen/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

stats/

confidence_band.pro

topconfidence_band

result = confidence_band(x, y [, confidence=confidence] [, PLOT=PLOT] [, RESIDUAL=RESIDUAL] [, REG_EQ=REG_EQ] [, OPLOT=OPLOT] [, EQUATION=EQUATION] [, CORRELATION=CORRELATION] [, LINESTYLE=LINESTYLE] [, PSYM=PSYM] [, NAN=NAN] [, _EXTRA=_EXTRA])

compute and optionally plot the confidence bands on a regression plot

currently only works for single regression

Return value

structure of points for the confidence bands at the points passed in in x Structure format is: YTOP DOUBLE Array[N_ELEMENTS(x)] YBOT DOUBLE Array[N_ELEMETNS(x)]

Parameters

x in required

'x' values to regress against

y in required

'y' values to regress

Keywords

confidence in optional

set this to specify the conidence band (default 0.95)

PLOT in optional

set this to plot the data

RESIDUAL in optional

input the residualts instead of calculation them

REG_EQ in optional

input a regression equation found externally

OPLOT in optional

oplot the confidence band on an exsisting plot

EQUATION in optional

show the equation on the plot

CORRELATION in optional

returns the correlation coefficient of regression

LINESTYLE in optional

linestyle of the confidence bands

PSYM in optional

specifiy the symbol to use when plotting the points

NAN in optional

pull out any nan data

_EXTRA in optional

extra keywords to plot

Examples

a=confidence_band(findgen(10)+randomn(seed, 10), findgen(10), /plot)

Author information

History:

Mon Mar 5 08:52:08 2007, Brian Larsen added _extra call and remove various keywords Tue Jun 20 14:35:58 2006, Brian Larsen added xtitle, ytitle, and nan keywords Wed Jun 7 14:16:07 2006, Brian Larsen documented, written previously

Statistics

Lines: 87
McCabe complexity:

File attributes

Modifcation date: Mon Sep 22 12:40:28 2008
Lines: 152