=============================================================================== HELP FILE for acis_lev1 pipeline =============================================================================== NAME acis_lev1.ped: This pipeline is for level 1 ACIS (AXAF CCD Imaging Spectrometer) observations. This pipeline runs the basic correction needed for all observations including aspect corrections, overclock and bias corrections, position sorting of the events and determination of good time intervals(GTIs). The pipeline works on the data represented in one science run. USAGE 1. Build the pipeline with pbuilder.pl and then run with pctr. a)build the pipeline pbuilder.pl -t $ASCDS_SYS_PROF/acis_lev1.ped -r -i -o -a > b)run the pipeline pctr -prof -log -showlog : the data file prefix /: the directories containing the input and output files, respectively : are discussed below : the name of the PED file created from pbuilder.pl : denotes the name of the log file (.ped.log) If "-log " is omitted, then the default filename is "pedout.log". -showlog: displays log file during the running of the pipeline 2. Use run_pipe which builds and runs the pipeline in one step. run_pipe -r -i -o -t acis_lev1.ped -a 3. options: biasroot: the root for the bias list revision: the output revision number THESE MUST BE SET! -a " biasroot=acisf123456789N000 revision=2 " -a " biasroot=NONE revision=1 " DESCRIPTION This is a list of the task name and what each task does. Please refer to documentation for each task if more information is required. asp_calc_offsets - calculate aspect offsets from nominal pointing set_acis_events - run determine the read and data modes of the data and set the proper processing parameters from this. Check the bias file and set the biasfile. Set the instrument paramter file to the correct coordinate systems. acis_build_badpix - get information about badpixels acis_format_events - Read the input event list, overclock and bias corrects reads CCD node information acis_sort_time - Sorts the acis_format_events output so that the events are in time order. This must be completed to allow time dependent correction such as dither to be applied. acis_process_events- do the coordinate tranformations,grading of events and energy calculations acis_build_mask- build spatial,spectral and grade mask acis_build_chip_gti- Build GTI for each chip/Fep combination mtl_build_table - build mission timeline table mtl_build_std_gti - build standard GTI from standard limits acis_merge_gti- will merge the standard gtis with the all from the event file (acis_build_chip_gti) update_revision- adds the output revision number to all posible files. INPUTS/OUTPUTS 1)Input files for the pipeline Root=fN<3 digit processing version> acis L0 events --------------------> acis_evt0.lis list of level 0 fits acis L0 exposure records-----------> acis_exr0.lis list of exr fits files acis biasfile ---------------------> biasroot_bias0.lis list of biasfiles aspect solution -------------------> pcad_asol1.lis list of aspect files actual obspar file ----------------> axaf_obs0a.par acis parameter block --------------> acis_pbk0.lis list of parameter blocks acis window files -----------------> acis_win0.lis list of window info acis bias error -------------------> acis_berr0.lis list of biaserr files MISSION TIME LINE FILES: list of mtl files---->mtl_mtl1.lis This file should contain the ancillary data lists: ephin data ------> ephin_eph1.lis (run through the ephin_lev1 pipeline) telescope data --> tel_hkp1.lis (run through the tel_lev1 pipeline) ephemeris data --> angles_eph1.lis (run through the ephem_lev1 pipeline) 2)Output files from the pipeline pctr profile, log -----------------> _lev1.ped _lev1.ped.log acis L1 events --------------------> acis_evt1.fits acis_badpix -----------------------> acis_bpix1.fits acis_mask -------------------------> acis_msk1.fits aspect offsets --------------------> acis_aoff1.fits SIM offsets -----------------------> acis_soff1.fits acis exposure stats ---------------> acis_stat1.fits bias(faintwith bias only) ---------> _out<#>.fits mission time line -----------------> acis_mtl1.fits good time intervals(STANDARD)------> acis_std_flt1.fits good time intervals(MERGED) -------> acis_flt1.fits 3) Output Data Files for Archive This is still to be determined PARAMETERS Input Parameter file name: acis_lev1.par The parameter file is set to take almost all parameters for all of the tasks called by the pipeline. Although it is unlikely that a user will wish to explore all of the parameters, we include here a list. If the user wishes to know in detail the parameters of each task, it is recommended to see the documentation on that particular task. #-------------------------------------------------------------------------- # # acis_lev1.par Parameter file for ACIS LEVEL 1 PIPELINE # #-------------------------------------------------------------------------- #----------------------------------------------------------------------- #general parameters for the pipeline #----------------------------------------------------------------------- (clobber = no) Clobber any existing output? (verbose = 0) verbose level(same as debug) #---------------------------------------------------------------------- # The next 2 parameters are reset in the pipeline #---------------------------------------------------------------------- (feventdef = )telev1 -> {d:time,i:expno,s:chipx,s:chipy,s:phas,s:ccd_id,s:ccdnode,x:status}) format events event defination (peventdef = )stdlev1 -> {d:time,s:ccd_id,i:expno,s:chip,s:tdet,d:det,d:sky,s:phas,l:pha,f:energy,l:pi,s:fltgrade,s:grade,x:status}) process events evnet defination #----------------------------------------------------------------------- # ACIS LEVEL ONE:asp_calc_offsets parameters #----------------------------------------------------------------------- (dy_tol = 0.05) dy tolerance for SIM(in arcsec) (dz_tol = 0.05) dz_tolerance for SIM(in arcsec) (dtheta_tol = 0.0005) dtheta_tolerance for SIM(in degress) (g_tolerance = 0.001) Gyro Readout Tolerance (seconds) #----------------------------------------------------------------------- # ACIS LEVEL ONE:acis_build_badpix parameters #----------------------------------------------------------------------- (calibfile = NONE) Calibration bad pixel file (procbias = yes) Process bias image data #----------------------------------------------------------------------- # ACIS LEVEL ONE:acis_format_events parameters #----------------------------------------------------------------------- (badpixfile = )acis_build_badpix.outfile -> ) Input bad pixel file or stack (NONE|) (flogfile = acis_format_events.log) Log filename (min_dlta_oc = -200) Minimum delta overclock value[adu] (max_dlta_oc = 200) Maximum delta overclock value[adu] (tempbias = no) If no bias data available, calculate rough bias value #-------------------- # the following 3 parameters are reset in the pipeline #-------------------- (biasfile = ) biasfile for acis_format_events (bias_correct = yes) Perform bias corrections on input data (oc_correct = yes) Perform overclock corrections on input data #-------------------------------------------------------- # FORMAT Event definations: do not change #-------------------------------------------------------- (telev1 = {d:time,i:expno,s:chipx,s:chipy,s:phas,s:ccd_id,s:ccdnode,x:status}) time exposure event format definition string (vflev1 = {d:time,i:expno,s:chipx,s:chipy,s:phas,s:ccd_id,s:ccdnode,x:status}) very faint event format definition string (tegrflev1 = {d:time,i:expno,s:chipx,s:chipy,l:pha,s:fltgrade,i:corn_pha,s:ccd_id,s:ccdnode,x:status}) te graded event format defination string (ccflev1 = {d:time,i:expno,s:chipx,s:chipy,s:phas,s:ccd_id,s:ccdnode,x:status}) continuous clocking event format definition string (ccgrlev1 = {d:time,i:expno,s:chipx,s:chipy,l:pha,s:fltgrade,i:corn_pha,s:ccd_id,s:ccdnode,x:status}) cc grade event format defination string #----------------------------------------------------------------------- # ACIS_LEVEL_ONE:acis_process_events parameters #----------------------------------------------------------------------- #-------------------- # files needed for processing #-------------------- (plogfile = acis_process_events.log) debug log file (acaofffile = )asp_calc_offsets.outfile -> /stage/ascpool14/nadams/FLIGHT_ACIS/acisf139050000N000_aoff1.fits) aspect offset file [NONE|none|] (alignmentfile = )asp_calc_offsets.simfile -> /stage/ascpool14/nadams/FLIGHT_ACIS/acisf139050000N000_soff1.fits) sim/fam alignment file [NONE|none|] (gainfile = ))echo ${ASCDS_CALIB}/new_acis_gain.fits -> /vobs/ASC_BUILD/data/new_acis_gain.fits) acis gain file ( NONE | none | ) (gradefile = ))echo ${ASCDS_CALIB}/asca_grades.fits -> /vobs/ASC_BUILD/data/asca_grades.fits) grade mapping file (NONE | none | ) (threshfile = NONE) Split threshold file [NONE|none|pi conversion? (requires gain file) (pi_bin_width = 14.6) Width of Pi bin in eV (pi_num_bins = 1024) Number of values to bin energy into (spthresh = 13) Split threshold level (overridden by values in threshfile (docentroid = no) Determine pixel centroid for coord. conversion? (tstart = TSTART) header key containing start/default time value (tstop = TSTOP) header key containing time of last event (coord_stop = sky) end transformations at [chip,tdet,det,tan,sky,none] (random = yes) allow randomized digitation of floating pointnumbers (rand_seed = 1) random seed (for pixlib), 0 = use time dependend seed #-------------------------------------------------- # the following 3 parameters are reset in the pipeline #-------------------------------------------------- (doevtgrade = yes) Determine event grade? (instrume = acis) axaf instrument- used for instrument parameter file (telescop = ) telescop parameter file #-------------------------------------------------------- # Process Event definations: DO NOT CHANGE #-------------------------------------------------------- (stdlev1 = {d:time,s:ccd_id,i:expno,s:chip,s:tdet,d:det,d:sky,s:phas,l:pha,f:energy,l:pi,s:fltgrade,s:grade,x:status}) timed event format definition string (tegrplev1 = {d:time,s:ccd_id,i:expno,s:chip,s:tdet,d:det,d:sky,l:pha,i:corn_pha,f:energy,l:pi,s:fltgrade,s:grade,x:status}) te graded event format definition string (ccplev1 = {d:time,s:ccd_id,i:expno,s:chip,s:tdet,d:det,d:sky,s:phas,l:pha,f:energy,l:pi,s:fltgrade,s:grade,x:status}) cc event format definition string (ccgrdlev1 = {d:time,s:ccd_id,i:expno,s:chip,s:tdet,d:det,d:sky,l:pha,f:energy,l:pi,s:fltgrade,s:grade,x:status}) cc graded event format definition string #----------------------------------------------------------------------- # ACIS_LEVEL_ONE:acis_build_mask parameters #----------------------------------------------------------------------- (winext = WIN) Extension in window block file (nominalchip = DEFAULT) Nominal focus chip (recordlen = keyword) Determine interval length from keyword or records (keyword | records) #----------------------------------------------------------------------- # ACIS_LEVEL_ONE:bkgd_calc_ltc parameters #----------------------------------------------------------------------- (bin_length = 10) Bin length in seconds (sigma_factor = 5) Sigma level of threshold (smoothing = 1) Smmothing factor #----------------------------------------------------------------------- # ACIS_LEVEL_ONE:mtl_build_table parameters #----------------------------------------------------------------------- (mtl_lookup = ))echo $ASCDS_CALIB/mtl_hrc_test.rdb -> /vobs/ASC_BUILD/data/mtl_hrc_test.rdb) mtl lookupkeys (obistart = $indir/$root_obs.tstart) Start time of obi (obistop = $indir/$root_obs.tstop) Stop time of obi (obspar = $indir/$root_obs.par) Observation test parameter file #----------------------------------------------------------------------- # ACIS_LEVEL_ONE:mtl_build_gti parameters #----------------------------------------------------------------------- (std_limits = ))echo ${ASCDS_CALIB}/gti_test.par -> /vobs/ASC_BUILD/data/gti_test.par) Standard GTI limits (smooth = yes) Perform smoothing of mtl table when creating GTIs (yes|no) #----------------------------------------------------------------------- # ACIS_LEVEL_ONE:acis_build_chip_gti parameters #----------------------------------------------------------------------- timefile = none Time offset file (mode = ql) EXAMPLES run_pipe -r -i -o -t acis_lev1.ped -a "biasroot= revision=" NOTES See the tool documentation and help files for specifics on each tool in the pipeline. See help on run_pipe (run_pipe -help), pctr and pbuilder.pl for information on the pipelines. See above for information on -a options to this pipeline. SEE ALSO pctr, run_pipe, pbuilder.pl, asp_calc_offsets, set_acis_events, acis_build_badpix, acis_format_events, acis_sort_time, acis_process_events, acis_build_mask, acis_build_chip_gti, fsort, mtl_build_table, mtl_build_gti, acis_merge_gti, dmhedit DATE last modified: 15 June, 1999