Next: 7.2 FFIT_PREP Up: 7 Reference Guide Previous: 7 Reference Guide

7.1 DAY_SUMMER

Process OSSE SDB difference files, summing into daily average spectra. Gain information is obtained from difference SPM files and energy scales are applied to the resultant sums. Optional user screening can be applied. An SDB sum record in the output file is created for each DetConfig, detector and DSA (scan angle) combination for each input file. Optional reprocessing of differences can be performed to produce statistically correct error estimates, correcting for multiple use of individual backgrounds.

Keyword support permits optional division of day into ``orbital'' periods.

NOTE: live-time weighted sums are performed here.

Calling Sequence
DAY_SUMMER, InFiles, Outfile, Status [,keywords]

INPUTS

InFiles:
string array of SDB difference files to be summed. There is one SDB record per detector per DSA per infile in the output SDB file.

Outfile:
String identifying output file specification for resultant sums. A new file is created or sums appended to existing file depending on parameter Status If outfile is a zero length string or all blanks, no standard sum file will be created. (SEE keyword, Good_sumfile, below. If this keyword is not set and outfile is blank, then you get nothing. What a waste of time.)

Status:
Character string identifying output file status. This should specify "NEW" for creation of new output file or "OLD" to append sums to existing file. If status parameter not specified, "NEW" is assumed.

KEYWORDS

E_Range:
Two element array specifying the energy range to use in doing standard tex2html_wrap_inline2090 screening of individual 2-minute differences. Default range is [0.045,0.25]. This spec should be within the low range. If specified, will override keyword Chan_Range. Routines convert this to channel range based on the gain of the detectors.

Chan_Range:
Two element array specifying the range of channels to use in doing standard tex2html_wrap_inline2090 screening of individual 2-min differences. Default range is [14,40]. Obsolete, use keyword E_Range instead.

Good_sumfile:
ascii string containing an SDB file specification for the output of difference sums with correct statistics propagation. There is a one to one correspondence between tags in this file and tags in Outfile. NOTE: If this keyword is not specified, correct statistics are not computed. NOTE:NOTE: Computation of the correct statistics requires reopening of original SPM files and is a time consumming process.

Thresh:
input spec of tex2html_wrap_inline2090 probability threshold (0< thresh <1) for rejecting bad 2-min differences as determined by deviations from average or template. Default threshold is 0.9

NoDSA:
logical switch, if set, the default separating of of sums by DSA is disabled. All SDRs from a given detector summed together for a day.

NoStandard:
logical switch, if set, no standard screening is performed. If Userscreen is specified, user screening will be performed, else no screening is performed. Default is perform standard screening.

Orbit:
logical switch, if set, Data are summed into orbital time sums. Approximately 16 sums per day per detector are created. Sums are synchronized to continuous periods of target visibility (boundaries of sums are the centers of occultations). This overrides default daily sums. NOTE: orbital sums can bridge day boundaries. For correct operation, the file names require the nominal "date root" format so that a filename sort will put them in chronological order.

Prod_Dir:
string specifying the directory for the input files. This input overrides the default specification of "$PROD" for access to the lower level SPM files which are used in computing the correct statistical ouput file.

Start_Time:
string specifying the starting time for the sum(s). Format is yy/ddd hh:mm:ss. This overrides the default action of starting with the first SDR found in the input file list.

Stop_Time:
string specifying the stopping time for the sum(s). Format is yy/ddd hh:mm:ss. This overrides the default action of stopping with the last SDR found in the input file list.

Userscreen:
string specifying the name of a user-supplied screening routine to perform additional data selection criteria prior to summing. Default is no userscreening performed. If specified, the routine is called as a procedure with two parameters: input SDR array and returned array of indices for SDR array which passed user screening. This is approx. equivalent to :
			Igore>  Userscreen, SDR\_Array, NDX
			Igore>  if NDX(0) ge 0 then SDR$SUM, SDR\_Array(NDX), Sum\_SDR
summing is performed by detector and DSA, the userscreen routine is called once per detector (per file), passing SDRs for each detector in separate calls.

Userscreening is performed after standard screening or instead of standard screening, depending on keyword, NoStandard.

DSA_SCREEN:
Logical switch specifying that data from each unique DSA should be screened separately.

BYCMDSTATE:
Logical switch specifying that data from each unique CmdState should be screened AND summed separately. Default breaks on DetCfg_id change.

dqHaz_Mask:
Input long integer specifying dqHaz bits to ignore. Default is reject data if any dqHaz bit is set (dqhaz ne 0). eg. To ignore bit 0, set dqhaz_mask = 1.

dqInfo_Mask:
Input long integer specifying dqInfo bits to use in data quality screening. Default is to ignore contents of dqInfo. A bit set in the mask will cause data rejection if the corresponding bit is set in a spectrum's dqInfo status. eg. To reject data with dqinfo bit 0 set, set dqinfo_mask = 1.

dsfStat_Mask:
Input long integer specifying dsfstat bits to use in data quality screening. Default is to ignore contents of dsfstat. A bit set in the mask will cause data rejection if the corresponding bit is set in a spectrum's dqInfo status. eg. To reject data from ODS (bit 20), set dsfStat_Mask = tex2html_wrap_inline2100.

EarthSep:
Input float specifying the minimum earth separation (in degrees) for consideration as good data. Default is 72 degs - approximately the earth limb + 50 km.

Covar:
Input logical switch specifying that covariance of the resulting sums should be computed and stored in the output Good_SumFile. Default is no covariance computations. This switch is functional only with Good_SumFile keyword specified.

Verbose:
Input logical switch to turn on diagnostic/informational messages.

catsave:
catsave

prelimsave:
prelimsave

OUTPUTS

Output consists of Statistics and Errors written to the screen and summed SDB difference spectra written to specified output file. There is one SDB record in the output file for every unique cmdstate, detector and DSA (scan angle) combination in each input file. Energy scale is computed and stored with each record in sumfile. The optional Good_sumfile is identical to the Outfile but with correct errors (yes, it's an oxymoron).


Next: 7.2 FFIT_PREP Up: 7 Reference Guide Previous: 7 Reference Guide