=============================================================================== HELP FILE for sim_lev05 pipeline =============================================================================== NAME: sim_lev05.ped: The Science Instrument Module (SIM) level 0.5 pipeline runs sim_data_select, which selects the good data from the level 0 input and then passes this to sim_compute_stf_pos which determines the sim_x,sim_y and sim_z positions. The movement of the SIM is also recorded in the final output. USAGE 1. Build the pipeline with pbuilder.pl and then run with flt_pctr. a)build the pipeline pbuilder.pl -t $ASCDS_SYS_PROF/sim_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 sim_lev05.ped -a 3. options: secondary- secondary input file list. revision - output revision number -a " secondary=sim_s_tlm0.lis 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 secondary--Uses if.pl to determine the name of the secondary file. If there is no secondary file, the control passes to sim_data_select_none. If the secondary option was set, control passes to determine_which select to find the value in secondary. determine_which_select-- Uses if.pl to determine if secondary is set to NONE. If it is, the control is passed to sim_data_select_none. If the secondary exists and is not set to NONE, control is passed to sim_data_select. sim_data_select_none --select valid entries to use,no secondary files Can come from two places:determine_which_select or check_secondary sim_data_select--select valid entries to use. Only determine_which_select can send control here. sim_compute_stf_pos--compute the sim,x,y,z positions Takes the output of which ever sim_data_select ran. INPUT/OUTPUT 1)Input files for the pipeline input primary files------------->sim_tlm0.lis OPTIONAL!!! input secondary files----------->sim_s_tlm0.lis Where is fN 2) Output files from the pipeline pctr profile, log ------> _lev1.ped _lev1.ped.log merged sim file -------->sim_tlm0a.fits computed stf file------->sim_coors0a.fits 3) Output Data Files for Archive This is to be determined, but probably both fits files are to be archived. PARAMETERS Input Parameter file name: sim_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. ardfile- Specifies the location of the Analysis Refenerce Data file to be using for sim_compute_stf_pos. EXAMPLES a) With no secondary file flt_run_pipe -r -i -o -t sim_lev05.ped -a "secondary=NONE revision=1" flt_run_pipe -r -i -o -t sim_lev05.ped -a "revision=1" b) With a secondary file list sec_s_tlm0.lis flt_run_pipe -r -i -o -t sim_lev05.ped -a "secondary=sec_s_tlm0.lis revision=1" 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, sim_data_select, sim_compute_stf_pos, if.pl, dmhedit DATE last modified: 2 June 1999