stattest.doc tab March 1998 Documentation for program "stattest". ------------------------------------ Syntax: stattest [parameters] (filename(s)) Does statistical tests on a WIRE FITS image. It will make plots or an IPAC table or both. The table contains various statistical test values such as mean, standard deviation, median, etc. There are three sets of plots. The first set of plots refer to quantities of a given image (such as histogram, median versus column number, etc.). The second set of plots are averages over all images of the quantities in the first set. The third set shows plots of various statistics test values as a function of frame number (if more than one image is given.) The parameters below control which test values and plots are produced. A few specific warning checks are made on the data. If no device is given or the option "showstat" is not given, then nothing is produced except the warning checks. ................................................... Parameters for command stattest: verbose,v: sw showstat,ss: sw histogram,h: int = 3 medianvsrow,mdr: int = 2 medianvscol,mdc: int = 2 rmsvsrow,rmsr: int = 2 rmsvscol,rmsc: int = 2 sfvsrow,sfr: int = 2 sfvscol,sfc: int = 2 fourier,dft: int = 2 flip: sw output,o: char = none histbins,hb: int = 60 histrange,hr: list of real = 0.,0. numplot,np: int = 3 band,b: int = -1 invgain,ig: double = -1. flux,f: double = -1. resprms,rr: double = -1. spin,sp: double = -1. rectlvl,rect: int = -1 box: list of int = -1,-1,-1,-1 skipcol,sc: list of int = 0,1 skiprow,sr: list of int = 0,1 plotperc,pp: list of real = 0.02,0.98 plotxrange,px: list of real = 0.,0. tests1,t1,t: list of int = 01,05,09,18,04,03 tests2,t2: list of int = 02,08,10,20,21,27 tests3,t3: list of int = 06,07,16,17,19 tests4,t4: list of int = 11,12,13,14,15 tests5,t5: list of int = 22,23,24,25,26 tests6,t6: list of int = 28,29,30,31,32,33 tests7,t7: list of int = 34,35,36,37 tests8,t8: list of int = 38,39,40,41 device,pd,dv,d: char = none list,l: sw checktest,ct: sw nocheck,nc: sw ................................................... Description of parameters: verbose : Show lots of messages. This also relaxes limits on warning checks. showstat: Show statistics on standard output. Warning checks on median and standard deviation are always sent to standard output. The following 8 flags tell which plots to show. In all cases a flag of 0 means no plots of that type, 1 means a plot for each image, 2 means only a plot of the average of all images, and 3 means both a plot for each image and an average. ................ histogram : Show histogram plots. medianvsrow : Show plot of the median for each row. medianvscol : Show plot of the median for each column. rmsvsrow : Show plot of the R.M.S. for each row. rmsvsrow : Show plot of the R.M.S. for each row. sfvsrow : Show plot of the structure function across rows. sfvscol : Show plot of the structure function across columns. fourier : Show four discrete fourier transform plots for each channel. Use "flip" option if image has been flipped to get channels right. ................ flip : Image has been flipped from original raw data. output : Output filename if other than default. histbins : Number of bins to use in histogram plots. histrange : Range of histogram plot. Bin size is given by histrange/histbins. numplot : Number of plots on a side per page, 3 implies 3x3 or 9 plots per page. band : Wavelength band (12 or 25). If not given, the program guesses the band from the filename (i.e. does it contain "wl" or "tl".) invgain : Inverse gain in electrons per digital number. If not given, the program uses the header keyword "INVGAIN". If "INVGAIN" is not in the header, "GAIN" is used. flux : Nominal background flux in electrons per second. If not given, the the program guesses from the "band" value (i.e. 12 micron = 12000, 25 micron = 7000.) resprms : Nominal RMS of normalized response function (i.e. Noise/Signal.) If not given, the program guesses from "band" (i.e. 12 micron = 0.043, 25 micron = 0.049). spin : Spin time (needed if not in header). This will apply to every image. rectlvl : Value for header card RECTLVL (needed if not in header), where: 0=prior to rectification, 1=after linearization, 2=after background subtraction, 3=after flattening. box : Do statistics on sub-box given by four integers for starting column, starting row, ending column, ending row. skipcol : Column skip given by two integers for offset and increment. skiprow : Row skip given by two integers for offset and increment. plotperc : Plot percentiles which define minimum and maximum of vertical scale. plotxrange : Plot paramaters which define min. and max. of horizontal scale. tests1,2,3,4,5,6,7,8 : Specify which tests appear in six different groups. If you specify "-test1 #,#,#" you will get the specified tests in the first group, but the other groups remain at the default values. To get only one set of tests, use "-t #,#,#". In this case you will only get the specified tests and none of the default groups. device : Device for PGPLOT plots. Default is /XWINDOW. Use /XDISP for pgdisp display. Use "file.ps" to output to PostScript file. list : List tests without running programs on images. You may execute "stattest -list" to see which test number refer to which tests. checktest: Test the check warnings (for standard deviaion, median, etc.) by printing out warnings regardless of measured values. nocheck : Do not print any check warnings. For the parameters band,invgain,flux,resprms,rect: if a value is given on the command line, that value will be applied to all images. Otherwise, different values may be derived for each image (depending on header cards). The following are the available tests by number: 1 : Mean. 2 : Standard Deviation. 3 : Maximum Pixel Value. 4 : Minimum Pixel Value. 5 : Median. 6 : 1st Percentile. 7 : 99th Percentile. 8 : One sigma value based on the median value - 15.86% percentile. 9 : Truncated Mean using +/- 34.13% of distribution relative to median. 10 : Truncated Standard Deviation. 11 : Flat Correction Test: Largest Devia. in sigmas of modulus 4 column. 12 : Flat Correction Test: Relative Median of first modulus 4 column. 13 : Flat Correction Test: Relative Median of second modulus 4 column. 14 : Flat Correction Test: Relative Median of third modulus 4 column. 15 : Flat Correction Test: Relative Median of fourth modulus 4 column. 16 : Mode derived using a spline fit to the distribution. 17 : Mode derived using a gaussian fit to the distribution. 18 : Mode derived using a gaussian smoothing/"centroiding" technique. 19 : Percentile position of mode. 20 : Standard Deviation of distribution below median. 21 : Standard Deviation of distribution below smoothing mode (test#17). 22 : Corner Statistic: Relative median for upper left corner. 23 : Corner Statistic: Relative median for upper right corner. 24 : Corner Statistic: Relative median for lower left corner. 25 : Corner Statistic: Relative median for lower right corner. 26 : Corner Statistic: Relative median for center box. 27 : Error determined from Response fluctuations, Median, and Gain. 28 : Band (12 or 25). 29 : Inverse gain (photo-electrons per digital number). 30 : Nominal flux level (in electrons per second). 31 : Response function RMS. 32 : Rectified? (1/0). 33 : Exposure Time (seconds). 34 : Median in channel 1. 35 : Median in channel 2. 36 : Median in channel 3. 37 : Median in channel 4. 38 : RMS in channel 1. 39 : RMS in channel 2. 40 : RMS in channel 3. 41 : RMS in channel 4.