Subject: Example HDUCLASn values

From: pence at tetra.gsfc.nasa.gov (William Pence)
Date: Thu, 4 Nov 93 15:21:58 EST

Example HDUCLASn keyword values in OGIP FITS files

The following table gives some example values for the HDUCLASn keywords
to be used for various kinds of FITS files within the Office of Guest
Investigator Programs (OGIP) at GSFC/NASA.  These examples are being
distributed only to illustrate how the HDUCLASn hierarchy of keywords
(which was proposed in a previous message to this group) may be used;
These values have not been finalized within the OGIP and may be changed
in the future.  The particular HDUCLASn keyword values that are finally
adopted within the OGIP will not be binding on any other institution.
Other institutions are free to adopt any other HDUCLASn keyword values,
or to reuse these same values with a different interpretation, as long
as the associated HDUCLASS keyword does not have a value of 'OGIP    '.

         Table of HDUCLASn FITS Keyword Values used by the OGIP

----------------------------------------------------------------------		
HDUCLAS1       HDUCLAS2        HDUCLAS3          COMMENTS
----------------------------------------------------------------------		
EVENTS						A Photon event list that
						conforms to format defined in
						"The Proposed Timing FITS 
						File Format", Angelini et al.
						1993, and "Rationalized Data
		 				Files: an Approach to a Multi-
						Mission Data Format for High
						Energy Astrophysics", Corcoran
						et al. 1993
		ALL				List contains all the detected events 
		ACCEPTED			only accepted photons
		REJECTED			only rejected photons
----------------------------------------------------------------------		
LIGHTCURVE					conforms to format defined in
						"The Proposed Timing FITS 
						File Format", Angelini et al.
						1993.
		TOTAL	 			source + background ltcurv
				RATE		counts/time interval
				COUNT		count
		BKG				background only
				RATE		counts/time interval
				COUNT		count
		NET				net source ltcurv
				RATE		counts/time interval
				COUNT		count
		EXPOSURE			exposure times vs. time
TEMPORALDATA					any table of non-science
 						quantities vs. time
						Should conform to guidelines
						given by Angelini et al. where
						possible.
		HKP				housekeeping parameters
				DELTAS  	in compressed format
		TSI				temporal status intervals
				DELTAS  	TSI list in compressed format
		ASPECT				spacecraft aspect
		EPHEM				spacecraft orbit info
		EVRATE				accepted, rejected, 
						particle rates, etc.
    ----------------------------------------------------------------------		
    NOTE: DELTAS form means that entries in the table only list the
    name of the parameter, the time of the parameter change, and the value
    of the parameter at that time.
    ----------------------------------------------------------------------		
GTI		STANDARD			acceptable science times
						screened by standard
						quality flags/limits
						at minimum giving start
						and stop time for interval
		ALL				science time without
						regard to quality 
						flags/limits
						at minimum giving start
						and stop time for interval
----------------------------------------------------------------------		
SPECTRUM					conforms to "The OGIP Spectral
						File Format", Arnaud et al.
						1992
		TOTAL				gross spectrum (source + bkg)
				RATE		counts/time interval
				COUNT		count
		NET				Net source spectrum
				RATE		counts/time interval
				COUNT		count
		BKG				Background spectrum
				RATE		counts/time interval
				COUNT		count
		DETECTOR			Detector extension for 
						gross, source or bkg 
						spectrum
----------------------------------------------------------------------		
IMAGE		TOTAL				gross image
		NET				Net source image	
		EXPOSURE			exposure map
		DETMAP				map of detector focal plane
		BKG				background image
		GENERIC				miscellaneous image
		PRF		PREDICTED	predicted PRF image
				TOTAL		total PRF image
				NET		net PRF image
		VIGNETTING			image of vignetting
----------------------------------------------------------------------		
SRCLIST						list of derived source 
						characteristics
						Conforms to "Rationalized Data
		 				Files: an Approach to a Multi-
						Mission Data Format for High
						Energy Astrophysics", Corcoran
						et al. 1993
----------------------------------------------------------------------
RESPONSE					Conforms to "The OGIP RMF
						& ARF File Formats",
						George et al. 1992
		EBOUNDS				specifies energy boundaries
						for response matrix.
		SPECRESP			extension contains spectral
						response vs. energy
 	 	RSP_MATRIX	REDIST		"Pure" redistribution matrix
  						w/o anything else folded in

				FULL		Redist matrix with "everything"
						folded in

 				DETECTOR 	Redist matrix with all detector
						components folded in (but NOT
						XRT + Filters).