=============================================================================== HELP FILE for obidet_lev05 pipeline =============================================================================== NAME: obidet_lev05.ped: The Observation Interval Determination (obidet) pipeline looks at the Level 0 data from the telescope to determine the actual status of the telescope during the specified time range. This information is compared against the planned information for the requested observational identification (obsid) and determines the start and stop time for level 1 processing and produces a good time interval (GTI) limits file for later use in level 1. The actual observation parameter (obs.par) file is created. USAGE 1. Build the pipeline with pbuilder.pl and then run with flt_pctr. a)build the pipeline pbuilder.pl -t $ASCDS_SYS_PROF/obidet_lev05.ped -r -i -o -a > b)run the pipeline flt_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 flt_run_pipe which builds and runs the pipeline in one step. flt_run_pipe -r -i -o -t obidet_lev05.ped -a "" 3. options: The pipeline MUST contain all three of these options. tstart: The approximate start time of the obi. Usually padded to be before the actual start time. tstop: The approximate stop time of the obi. Usually padded to be after the actual stop time. obsid: Observation ID assigned to the obi in question. revision: The ouput data products revision number To run with all of these options, the user must enter the options with double quotes. ex) -a " tstart=1234 tstop=1245 obsid=100 revision=2 " 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. This pipeline utilizes the conditional control in the flt_pipeline. check_args--Confirms that ALL three arguments are passed in. Will cause the pipeline to fail if they don't exist. Will pass control to obi_asp_look if they do. echo_error--Prints out an error message if check_args fails. Calls exit obspar_upd--Uses the input planned obs.par from the database and creates the predicted obs.par with default values and the predicted telescope configuration. dmappend--A temporary step to concatenate the aspect interval files in the case that there are more than one. obi_asp_look--will check the aspect interval properties file and creates an interval that matches the requested obsid and adjusts the times to mid slews. obi_sim_look--will take the sim_lev05 output and determine the stable sim intervals within tstart and tstop and assign the instrument, detname, filter and defocus based on the sim x,y, and z positions. obi_eng_look--takes in files that contain the obsid, telemetry format, and grating information and converts the engineering information into stable intervals for a set obsid,format or grating. check_inst--Control statement to determine the instrument set in the predicted obs.par file. Looks for ACIS. check_inst2--Same as check_inst, but looks for HRC. obi_acishk_look--Will find the configuration of ACIS based on the parameter block files. Will only run if instrument is ACIS. set_housekeep_acis--Resets the hkfile parameter to the output of obi_acishk_look. Will only run if obi_acishk_look runs. obi_hrchk_look--Will find the configuration of HRC based on the HRC housekeep and engineering files. Will only run if the instrument is HRC. set_housekeep_hrc--Resets the hkfile parameter to the output of obi_hrchk_look. Will only run if obi_hrchk_look runs. set_housekeep_none--Resets the hkfile parameter to NONE. Will run if both check_inst and check_inst2 fail. no_ops--Brings control back together after the housekeep stage. obi_merge_times--Takes in the outputs of all of the look tools and the predicted obs.par to create a merged time file that can be used to determine the actual obs.par. obi_set_times--collects the start and stop times that were determined by obi_merge_times. calc_mean_pointing--Uses the merge times to calculate the mean spacecraft pointing. obi_check_tol--Checks the planned versus the actual observation Updates the predicted observational parameter file to make the actual observational parameter file. update_revision_header-Updates the headers of the outputs with the revision option. update_revision_param1-Updates the predicted parameter file with the output revision update_revision_param2-Updates the updated parameter file with the output revision exit--A call to force the flt_pctr to fail to prevent the user from thinking that the pipeline worked. INPUT/OUTPUT NOTE: The pipeline is dependent on the IP&CL version the data are created with. This version is for IP&CL version 6.8 1)Input files for the pipeline database observational par file----------->axaf_obs0.par -------LEVEL 0.5 inputs---- aspect interval properties list----------->pcad_aipr0a.lis sim coordinates list --------------------->sim_coor0a.lis -------LEVEL 0 inputs ----- ccdm file 10 list ------------------------>ccdm_10_eng0.lis ccdm file 4 list ------------------------->ccdm_4_eng0.lis tel file 1 list -------------------------->tel_1_eng0.lis ccdm file 1 list ------------------------->ccdm_1_eng0.lis ---if observation is ACIS ----------- acis parameter block list ---------------->acis_pbk0.lis ---if observation is HRC ----------- hrc housekeep list ----------------------->hrc_hk0.lis hrc eng file 2 list ---------------------->hrc_2_eng0.lis Where is fN NOTE: as usual, the file lists contain the FITS files of the same type that fall within tstart and tstop OUTPUT: predicted observational par file --------->axaf_pred_obs0a.par aspect status file ----------------------->pcad_egti0a.fits sim status file -------------------------->sim_egti0a.fits eng status file -------------------------->ccdm_egti0a.fits HRC housekeep file ----------------------->hrc_egti0a.fits ACIS housekeep file ---------------------->acis_egti0a.fits obi elements ----------------------------->axaf_egti0a.fits mean pointing ---------------------------->pcad_point0a.fits actual obspar ---------------------------->axaf_obs0a.par gti limits ------------------------------->axaf_flt0a.fits(not yet) pctr profile, log ------> _lev1.ped _lev1.ped.log 3) Output Data Files for Archive To be determined, but will probably be the aspect status file, the sim status file, the eng status file, any housekeep files that exist, merged times file, the mission time line and the observational parameters. PARAMETERS Input Parameter file name: obidet_lev05.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. verbose- Will be sent to each tool in the pipeline. This allows the user to set the amount of textual information from the tool execution. Allowed range of values is 0-5. Set to 0, verbose is silent. Set to 5 is the maximum amount of information. clobber- This parameter is sent to each tool in the pipeline. Allowed values are "yes" and "no". The default is "no" and will not allow a file to be overwritten. Setting clobber to "yes" will allow files to be overwritten. merged_start- Time from the merged file for start. This is reset in the pipeline. The user's input WILL BE IGNORED. merged_stop- Time from the merged file for stop. This is reset in the pipeline. The user's input WILL BE IGNORED. hkfile- File name to be used in obi_merge_time. This is reset in the pipeline, The user's input WILL BE IGNORED. sim_ardfile- Specifies the location of the Analysis Reference Data file to be using for obi_sim_look. tolerancefile- Specifies the Analysis Reference Data file to be used for obi_check_tol. dmappendlk- Specifies the merge header rules table for dmappend. EXAMPLES flt_run_pipe -r -i -o -t obidet_lev05.ped -a " tstart= tstop= obsid= revision=" NOTES See the tool documentation and help files for specifics on each tool in the pipeline. See help on flt_run_pipe (flt_run_pipe -help), flt_pctr and pbuilder.pl for information on the pipelines. See above for information on -a options to this pipeline. SEE ALSO flt_pctr, flt_run_pipe, pbuilder.pl, if.pl, obspar_upd, dmappend, obi_asp_look, obi_sim_look, obi_eng_look, obi_acishk_look, obi_hrchk_look, obi_merge_times, obi_set_times, calc_mean_pointing, obi_check_tol dmhedit, pset DATE last modified: 2 June 1999