SUBJECT(hrc_lev1) CONTEXT(pipes) SYNOPSIS Level 1 pipeline to calibrate HRC science data DESCRIPTION The pipe runs the basic corrections needed for every observation: aspect correction, badpixel detection, degap correction, and coordinate transformations of the events. In addition a Mission Time Line is generated from aspect, ephin, ephemeris and engineering files, as well as dead time factors and background threshold values determined from the data. From this MTL file two GTIs are created based on different limit conditions. Dead time statistics are determined and written to the event file. The following tools and scripts are run within the `hrc_lev1.ped' pipeline. See the individual documentation for more details on each. o) set_hrc_events - based upon the instrument specified, and whether the system is flight or xrcf (always flight for this pipe), set the coordinate systems, degap parameters and calibration files including degap, gainfile, hypfile, tapfile, ampsatfile, evtflatfile and badpixcalfile. o) hrc_lev1_calib - set the calibration files for HRC Lev1 flight|SEC|SI pipes. o) asp_calc_offsets - calculate aspect offsets from nominal pointing o) hrc_build_badpix - determine the bad pixel regions for this observation. o) hrc_correct_times - make time corrections to a stack of evt0a files o) hrc_process_events - perform coordinate transformations, apply corrections of degap, tap ring, hyperbolic and saturation, flag bad pixels, and perform aspect correction. o) hrc_calc_dead_time - calculate dead time factors from primary science event and secondary science files. o) bkg_calc_ltc - calculate the background light curve for the events. Threshold values for the background rate will be determined, and these will be used to filter the MTL file for a standard GTI. o) mtl_convert_table - convert egti0a to egti1 fits files for the next task (mtl_build_table). o) mtl_build_table - build mission timeline(MTL) table. Inputs are ephin, ephemeris, engineering, aspect, background rate, and dead time factors. This file will be filtered on two different sets of conditions, to produce two GTIs. o) mtl_build_all_gti - calls mtl_build_gti. Build all GTI from all limits and MTL. This is the GTI defined by the telemetry dropouts. Currently there is no way to determine the telemetry dropouts, so this GTI is determined from an open set of limits conditions (i.e. all data is passed through). o) mtl_build_std_gti - calls collate_gti_limits. Build standard GTI from standard limits and MTL. This is the GTI defined by the full range of limits for the MTL elements (as compared to mtl_build_all_gti). o) arc_smooth_mtl - append the output of mtl_build_std_gti onto the output of mtl_build_table o) std_dtf_stats - calls hrc_dtfstats. Filter the dead time records on the standard GTI, and determine the overall dead time correction factor, as well various other statistics. o) all_dtf_stats - calls hrc_set_dead_time, a script around hrc_dtfstats. Hrc_dtfstats is performed using the all GTI. The DTCOR that is calculated is written to the event file, and a livetime is determined and written to the event file as well. o) check_obidata - checks the value of obi_data in the obs par file, that will be used to call an appropriate task to compute the ontarget time. o) calc_ontarget_time - adds ADM_TIME keyword to std_flt1.fits, that contains ontarget time as determined from aiprops and obi look files. o) write_zero_ontarget - calls dmhedit to add ADM_TIME keyword to std_flt1.fits with a value of 0.0. o) update_revision - calls dmhedit to change the value of revision. o) add_caldbver - adds CALDBVER with the value in caldb_version.fits o) remove - remove any temporary files that we really don't need PARAMETERS name type ftype def min max units reqd stacks autoname ================================================================================================ dy_tol float 0.05 arcsec dz_tol float 0.05 arcsec dtheta_tol float 0.0005 degrees g_tolerance float 0.001 seconds badpixfile string input acaofffile string input yes alignmentfile string input yes gainfile string input NONE ADCfile string input NONE badpixcalfile string input no degapfile string input NONE cfu1 real 1.0 cfu2 real 0.0 cfv1 real 1.0 cfv2 real 0.0 hypfile string input NONE tapfile string input NONE ampsatfile string input NONE evtflatfile string input NONE std_limits string input do_ratio boolean yes no yes random_seed integer 1 0 32767 rand_pix_size real 0.5 0.0 0.5 start string coarse stop string sky eventdef string grid_ratio real 0.5 0.0 1.0 pha_ratio real 0.5 0.0 1.0 nbins integer 0 yes binlength real 2.05 yes counts_per_bin real 0 yes bkgsigmafactor real 5 mtl_lookup string input smooth string yes all_limits string input chisqlim real 7 clobber boolean no verbose integer 0 0 5 DETAILED PARAMETER DESCRIPTIONS dy_tol type=float def=0.05 units=arcsec see asp_calc_offsets dz_tol type=float def=0.05 units=arcsec see asp_calc_offsets dtheta_tol type=float def=0.0005 units=degrees see asp_calc_offsets g_tolerance type=float def=0.001 units=seconds see asp_calc_offsets badpixfile type=string filetype=input see hrc_process_events (output of hrc_build_badpix) acaofffile type=string filetype=input stacks=yes see hrc_process_events alignmentfile type=string filetype=input stacks=yes see hrc_process_events gainfile type=string filetype=input def=NONE see hrc_process_events This parameter is set by hrc_lev1_calib ADCfile type=string filetype=input def=NONE see hrc_process_events This parameter is set by hrc_lev1_calib badpixcalfile type=string filetype=input required=no see hrc_build_badpix This parameter is set by hrc_lev1_calib degapfile type=string filetype=input def=NONE see hrc_process_events This parameter is set by hrc_lev1_calib cfu1 type=real def=1.0 see hrc_process_events This parameter is set by set_hrc_lev1 cfu2 type=real def=0.0 see hrc_process_events This parameter is set by set_hrc_lev1 cfv1 type=real def=1.0 see hrc_process_events This parameter is set by set_hrc_lev1 cfv2 type=real def=0.0 see hrc_process_events This parameter is set by set_hrc_lev1 hypfile type=string filetype=input def=NONE see hrc_process_events This parameter is set by hrc_lev1_calib tapfile type=string filetype=input def=NONE see hrc_process_events This parameter is set by hrc_lev1_calib ampsatfile type=string filetype=input def=NONE see hrc_process_events This parameter is set by hrc_lev1_calib evtflatfile type=string filetype=input def=NONE see hrc_process_events This parameter is set by hrc_lev1_calib std_limits type=string filetype=input see mtl_build_gti This parameter is set by hrc_lev1_calib do_ratio type=boolean def=yes min=no max=yes see hrc_process_events random_seed type=integer def=1 min=0 max=32767 see hrc_process_events rand_pix_size type=real def=0.5 min=0.0 max=0.5 see hrc_process_events start type=string def=coarse see hrc_process_events stop type=string def=sky see hrc_process_events eventdef type=string see hrc_process_events grid_ratio type=real def=0.5 min=0.0 max=1.0 see hrc_process_events pha_ratio type=real def=0.5 min=0.0 max=1.0 see hrc_process_events nbins type=integer def=0 required=yes see bkg_calc_ltc binlength type=real def=2.05 required=yes see bkg_calc_ltc counts_per_bin type=real def=0 required=yes see bkg_calc_ltc bkgsigmafactor type=real def=5 see bkg_calc_ltc mtl_lookup type=string filetype=input see mtl_build_table smooth type=string def=yes see mtl_build_gti all_limits type=string filetype=input see mtl_build_gti The limits used to compute the 'all' GTI. chisqlim type=real def=7 see hrc_set_dead_time clobber type=boolean def=no Clobber output files? verbose type=integer def=0 min=0 max=5 Controls amount of output about each processing step. INPUT FILES The following are the lists of inputs files and stacks of files needed to run the pipeline. o) hrc L0 events : hrc[root]_evt0.lis ( list of level 0.5 event files 'hrc*_evt0a.fits' ) o) HRC L0 secondary science(SS) data : hrc[root]_ss0.lis ( list of level 0.5 SS files 'hrc*_ss0a.fits' ) o) aspect solution : pcad[root]_asol1.lis ( list of aspect files 'pcad*__asol1.fits' ) o) aspect interval properties: pcad[root]_aipr0a.lis ( list of pcad*_aipr0a.fits ) o) Obidet obspar file : axaf[obiroot]_obs0a.par o) list of MTL files : mtl[root]_mtl1.lis This file should contain the following ancillary data lists: o) ephin data : ephin[root]_eph1.lis ( list of ephin*_lc1.fits from ephin_lev1 pipeline) o) telescope data : tel[root]_hkp1.lis ( list of tel*_hkp1.fits from tel_lev1 pipeline) o) ephemeris data : angles[root]_eph1.lis ( list of angles*_eph1.fits from ephem_lev1 pipeline) o) aspect quality data : pcad[root]_aqual1.lis ( list of pcad*_aqual1.fits ) o) housekeeping lev0 data : hrc[root]_hk0.lis ( list of hrc*_hk0.fits ) The following outputs from obidet lev05 should also be available o) obi_hrchk_look files : hrc[root]_egti0a.lis ( list of hrc[root]_egti0a.fit ) o) obi_sim_look files : sim[root]_egti0a.lis ( list of sim[root]_egti0a.fits ) o) obi_eng_look files : ccdm[root]_egti0a.lis ( list of ccdm[root]_egti0a.fits ) o) obi_check_tol limits files : axaf[root]_olims0a.lis ( list of axaf[root]_olims0a.fits ) OUTPUT PRODUCTS The following are the archived output products produced by the pipeline. Primary Output Products o) hrc L1 events : hrc[root]_evt1.fits o) Mission Time Line : hrc[root]_mtl1.fits o) Good Time Intervals : hrc[root]_std_flt1.fits Secondary Output Products o) Dead time statistics : hrc[root]_dtfstat1.fits o) Dead time factor : hrc[root]_dtf1.fits o) bad pixel file : hrc[root]_bpix1.fits o) aspect offsets : hrc[root]_aoff1.fits o) SIM offsets : hrc[root]_soff1.fits The pipeline log file is also included in the secondary products. It includes not only the actual execution of the pipe, but all the retrevial and archive steps. PIPELINE ARGUMENTS The following arguments are needed to instanciate the pipeline to be run for a particular obsid. o) revision : Revision number o) obiroot : Root name of observation parameter file These should all be specified as "-a [parameter]=[value]" arguments to pbuilder.pl or flt_run_pipe.pl VERSION DS6.0.0 LAST MODIFIED 4 May 2001