STScI Logo

mkhkscr xray.xdataio


NAME · USAGE · DESCRIPTION · PARAMETERS · EXAMPLES · TIME_REQUIREMENTS
BUGS · SEE_ALSO

NAME

mkhkscr -- Generate a housekeeping (TSI) filter

USAGE

mkhkscr instr qlmtab flt_fname

DESCRIPTION

MKHKSCR generates an ASCII file with housekeeping limits in IRAF filter format. Many instrument parameters are recorded in the TSI extension, either as bit-encoded flags or binned data levels. The task utilizes a lookup table that matches quality parameters (either ALLQLM or STDQLM) with TSI and provides the mapping between the two data structures. The output attribute filter is a list of temporal status identifiers with their quality limit range.

PARAMETERS

instr = "" prompt = Instrument (hri|pspc)

Either ROSAT instruments "hri" or "pspc" accepted (quotes not needed).

qlmtab = "" prompt = Input QLM table filename

Input quality limits table. Written by task RFITS2PROS with default names _all.tab (unscreened) or _std.tab (screened) quality limits tables.

flt_fname = "" prompt = Output HK Screen

Output filter file name. (Input to task hkfilter)

(hklookup = "xdataiodata$tsiqlm.tab") [string]

Lookup table that matches Quality limits to temporal status records. Only ROSAT HRI and PSPC are currently defined.

(clobber = yes) [boolean]

Boolean flag specifying whether or not the qpoe file can be overwritten, if it already exists.

(display = 1) [int]

The display level. A display level of 0 generates no display. Higher levels prevides various amounts of debug output.

EXAMPLES

1. Create a filter of Unscreened ROSAT HRI events.

	xd> mkhkscr
	    Instrument: (hri|pspc): hri
	    Input QLM table filename: rh110267n00_allqlm.tab
	    Output HK Screen (aqlm.scr): arlac_all.scr

	xd> page arlac_all.scr

	    hiback=1:100,hvlevel=12:16,viewgeom=1:5,aspstat=1:5,
	    asperr=1:14,hqual=0:0,saadind=1:3,saada=1:4,saadb=1:4,
	    temp1=1:8,temp2=1:8,temp3=1:8,logicals=%4X,


arlac_all.scr can now be used as the input file to HKFILTER. HKFILTER will output the time intervals when the screens are met.

2. Create a filter of Screened ROSAT HRI events.

	xd> mkhkscr hri xdata$rh110267n00_stdqlm.tab arlac_std.scr

	xd> page arlac_std.scr

	    hiback=1:8,hvlevel=12:16,viewgeom=1:3,aspstat=3:5,
	    asperr=2:4,hqual=0:0,saadind=1:3,saada=1:4,saadb=1:4,
	    temp1=1:8,temp2=1:8,temp3=1:8,logicals=%4X,

arlac_std.scr can now be used as the input file to task HKFILTER. HKFILTER will output the time intervals when the screens are met.

TIME REQUIREMENTS

BUGS

SEE ALSO

Documentation on filtering (help filter ) for a description of the filter syntax interface.

Documentation on qpoe filtering (help qpoe ) for a description of the qpoe filter user interface.


Source Code · Search Form · STSDAS