Commands¶
This page lists the commands for performing analyses with CWB. The commands are implemented as shell scripts (tcsh/bash) and are based on ROOT macros.
Pre-production
| cwb_mkdir | creates the working directory and subdirectories |
| cwb_clonedir | creates the working directory and subdirectories by copying an existing one |
| cwb_setpipe | selects the analysis pipeling: first- or second-generation pipeline (1G/2G - def: 2G) |
| cwb_setpars | sets the user parameters file (default: config/user_parameters.C) |
| cwb_setppars | sets the user pparamters file (default: config/user_pparameters.C) |
| cwb_condor | creates and submits the dag and sub condor files |
| cwb_lsf | creates and submits job with LSF Job System (implemented in the CNAF cluster) |
| cwb_xtalk | creats the xtalk catalog (used for the multiresolution analysis) |
Production
| cwb_inet | runs the interactive CWB pipeline (both 1G and 2G pipelines available) |
| cwb_inet2G | runs the interactive 2G CWB pipeline in the multistage mode |
| cwb_eced | generates the CED with the 1G CWB pipeline |
| cwb_eced2G | generates the CED with the 2G CWB pipeline |
| cwb_dump | dumps the output messages generated by the CWB pipeline |
Post-production
| cwb_condor benchmark | (is a cwb_condor option) draws plots on the computational load |
| cwb_merge | merges the output root files |
| cwb_setchunk | add chunk id leaf to the merged root files |
| cwb_setifar | add ifar leaf to the merged simulation root files |
| cwb_setcuts | applies selection cuts on the leaves contained in the merged root file |
| cwb_setveto | applies vetoes to merged root file |
| cwb_report | creates final analysis reports |
| cwb_mkfad | calculates the false-alarm rate density statistic |
| cwb_mkprc | produce FOM for sky localizations |
Utility
| cwb_mplugin | merge plugins into one |
| cwb_mkhtml | creates html pages from texi files |
| cwb_mkrep | creates customised reports |
| cwb_draw_sensitivity | draws sensitivity curves |
| cwb_draw_antpat | draws the network antenna pattern |
| cwb_gwosc | analysis of GWOSC O2 catalog events |
Pre-production¶
cwb_mkdir¶
This page provides a description of the cwb_mkdir command.
Usage
This command creates the working environment to run the analysis.
Syntax
cwb_mkdir(no arguments)- Prints help
cwb_mkdir .- Creates the working environment in the current directory
cwb_mkdir [WORK_DIR]- It creates the directory WORK_DIR and the working environment in it
Further information
The working environment consists of the following sub-directories:
- condor contains the condor files (dag,sub)
- config contains the cwb configuration files
- data contains the output files of eahc job
- input contains the input data files
- log contains the condor log files
- macro contains the macros developed by the user
- merge contains the files obtained by merging the output files of each job
- output contains the output job files
- report contains the following directories, available on the internet:
- postprod contains the main post-production files
- ced contains the eventual CEDs
- dump contains ascii or binary files with reports on the analysis
- tmp contains temporary job files
- www_dir available on the internet, it contains the following directories:
- postprod link to report/postprod
- ced link to report/ced
- dump link to report/dump
Example
- The following command line creates the working directory JD2_BKG_G1V1_run2r:
cwb_mkdir JD2_BKG_G1V1_run2r
- With the above command, the following subdirectories are created in JD2_BKG_G1V1_run2r:
config, input, condor, tmp, log, output, merge, report, macro, data
cwb_clonedir¶
This page provides a description of the cwb_clonedir command.
Usage
This command creates the working directory by copying files and folders from another working environment.
Syntax
cwb_clonedir(without arguments)- Prints help
cwb_clonedir src_dir dest_dir [options]- Creates the dest_dir folder and copies in it the working environment of the src_dir directory.
Furher information
The following options can be passed to cwb_clonedir:
options = '--output links' : it creates symbolic links to the files in the src_dir output directory underneath the dest_dir output directory. The link data_label points to the data_label folder in dest_dir. In case dest_dir is already existing, the option just updates the links. '--output merge' : it searches in src_dir for the merged file with the largest progressive version number and merges the wave and live trees in the dest_dir output folder. In case dest_dir is already existing, the option just creates the merged files. Comment : this option cannot be used for merged files to which cuts and vetoes have been applied. '--config check' : it checks whether the configuration files in src_dir are compatible with the config files in dest_dir '--jstage stage' : it creates symbolic links only to the output files of the desired analysis stage. The links are created in the output directory. [FULL/INIT/STRAIN/CSTRAIN/COHERENCE/SUPERCLUSTER(default)/LIKELIHOOD] '--simulation false/true' : use false(default)/true for background/simulation runs '--label LABEL' : is the label of the merged root files (Ex: M2.C_rho_gt_8) '--chunk id' : id is a chunk number (must be integer > 0). It must be used to select a specific chunk root version generated with cwb_setchunk command NOTE : --chunk option can not be used when --label option is used !!!
Examples
- The following command line creates the folder S6A_BKG_L1H1V1_run1 and copies the environment in /home/PRODUCTION/S6A_BKG_L1H1V1_run1 :
cwb_clonedir /home/PRODUCTION/S6A_BKG_L1H1V1_run1 S6A_BKG_L1H1V1_run1
- The following command line creates symbolic links to the files in the output directory in /home/PRODUCTION/S6A_BKG_L1H1V1_run1 S6A_BKG_L1H1V1_run1 :
cwb_clonedir /home/PRODUCTION/S6A_BKG_L1H1V1_run1 S6A_BKG_L1H1V1_run1 '--output links'
- The following command line creates a new directory and calls it as the cloned directory:
cwb_clonedir /home/PRODUCTION/S6A_BKG_L1H1V1_run1 .
cwb_setpipe¶
This page provides a description of the cwb_setpipe command.
Usage
This command allows to switch between the available CWB analysis types.
Syntax
cwb_setpipe(without arguments)- Prints help
cwb_setpipe [options]- Selects the analysis type
Further information
The following options can be passed to cwb_setpipe:
options = 1G : it selects the 1G analysis method
1g : it selects the 1g analysis method
1 : it selects the 1 analysis method
2G : it selects the 2G analysis method
2g : it selects the 2g analysis method
2 : it selects the 2 analysis method
Regardless of the selected analysis method, the analysis parameter must be set. This is done by adding the following lines in the user_parameters.C file:
strcpy(analysis,"1G");
or
strcpy(analysis,"2G");
Example
- The following command line selects the 2G analysis method:
cwb_setpipe 2G
cwb_setpars¶
This page provides a description of the cwb_setpars command.
cwb_setpars(without arguments)- Prints help
cwb_setpars [path to parameter_file]- Selects parameter_file as parameter file for the analysis
cwb_setpars q- Prints the path to the current parameter file
cwb_setpars .- Restores the previous parameter file
cwb_setppars¶
This page provides a description of the cwb_setppars command.
cwb_setppars(without arguments)- Prints help
cwb_setppars [path to pparameter_file]- Selects pparameter_file as pparameter file for the analysis
cwb_setppars q- Prints the path to the current pparameter file
cwb_setppars .- Restores the previous pparameter file
cwb_condor¶
This page provides a description of the cwb_condor command.
Usage
This command prepares and submits the analysis jobs on the considered computing cluster by using the condor batch system.
Syntax
cwb_condor(without arguments)- Prints help
cwb_condor benchmark- Prints help in the benchmark type
cwb_condor action [dag_file/cwb_stage] [input_dir]- Prepares and submits the jobs
Further informations
The following options can be passed to cwb_condor:
action = create : it creates the dag and sub files under the condor directory submit : it submits the jobs to the considered computing cluster recovery : it compares the list of jobs in the dag file and checks the number of jobs completed (from history). It produces the dag file data_label.dag.recovery.x (x = recovery version). resume : same as recovery but is done only if previous cwb_stage is present in the output dir status : it shows the jobs status. remove : (R/H/I) it remove the jobs with status (Running/Held/Idle). check : it checks which jobs have been completed. (by reading the history reported in the output root files). list : it lists the jobs reported in the dag file. benchmark : it shows the computation load and related statistics (see cwb_condor benchmark). cleanup : remove broken symbolic links in the condor log dir (avoid init condor failure) to be used when jobs are in held status. sdag : read the standard \*.dag file produced with cwb_condor create and produced a new dag file \*.sdag The \*.sdag permits to submit in each node N jobs in sequential mode mtpe : used to generate the multitask mode for the Parameter Estimation analysis (see How to do the Parameter Estimation Analysis).dag_file/cwb_stage (optional) = dag_file : path to the dag file dag_file to be submitted (used as cwb_condor submit dag_file). cwb_stage : used in the 2G analysis [FULL(default)/INIT/STRAIN/CSTRAIN/COHERENCE/SUPERCLUSTER/LIKELIHOOD]input_dir (optional) : it is used with the recovery option. The default input directory is the output_dir directory defined in cwb_parameters.C
Examples
- The following command lines launch a full stage analysis:
cwb_condor createcwb_condor submit
- The following command lines launch a two-stage analysis:
cwb_condor create SUPERCLUSTERcwb_condor submitcwb_condor recovery LIKELIHOOD outpucwb_condor submit condor/XXX.dag.recovery.x
- The following command line creates the condor/data_label.sub and condor/data_label.dag condor files:
cwb_condor create
- The following command lines submit the analysis jobs to the considered computing cluster:
cwb_condor submitcwb_condor submit condor_data/data_label.dag
- The following command line recovers the analysis which did not get completed and creates the file condor/data_label.dag.recovery.1:
cwb_condor recovery
- The following command line submits the dag files listing the recovered files:
cwb_condor submit condor/data_label.dag.recovery.1
- The following command line creates the condor files for the SUPERCLUSTER stage of the 2G analysis:
cwb_condor create SUPERCLUSTERThe intermediate jobs are stored in the node’s temporary directory. Symbolic links to the remote job files are created in the output directory.
- The following command lines complete an analysis conducted with the 2G CWB pipeline starting from an intermediate stage:
cwb_condor recovery LIKELIHOODcwb_condor submit condor/data_label.dag.recovery.1
- The following command line creates the condor/file.sdag file from the condor/file.dag (it defines 10 sequential jobs per node):
cwb_condor sdag 10 condor/file.dag
cwb_lsf¶
This page provides a description of the cwb_lsf command.
Usage
This command prepares and submits the analysis jobs on the considered computing cluster by using the LSF batch system. The functionality is similar to the ones provided by the cwb_condor command.
Syntax
cwb_lsf(without arguments) Prints helpcwb_lsf action [lsf_file/cwb_stage] [input_dir]Prepares and submits the jobs
Furhter informations
The following options can be passed to cwb_lsf:
action = create : it creates the lsf and tgz files under the condor directory submit : it submits the jobs to the considered computing cluster recovery : it compares the list of jobs in the dag file and checks the number of jobs completed (from history). It produces the dag file data_label.dag.recovery.x (x = recovery version). benchmark : it shows the computation load and related statistics (see cwb_condor benchmark). queue : it shows the lsf queue status. status : it shows the jobs status. status jobID : it shows the log job (jobID is the ID reported with the status option). status jobName : it dumps the log job (jobName is the name reported with the status option). kill : kill all jobs. kill jobID : kill one job (jobID is the ID reported with the status option). stop : suspend all jobs. stop jobID : suspend one job (jobID is the ID reported with the status option). resume : resume all jobs. resume jobID : resume one job (jobID is the ID reported with the status option). utar dir_name : uncompress tgz files produced by the jobs in the output directory (the output is compressed and must be uncompress manually).lsf_file/cwb_stage (optional) = lsf_file : path to the dag file dag_file to be submitted (used as cwb_lsf submit lsf_file). cwb_stage : used in the 2G analysis [FULL(default)/INIT/STRAIN/CSTRAIN/COHERENCE/SUPERCLUSTER/LIKELIHOOD]input_dir (optional) : it is used with the recovery option. The default input directory is the output_dir directory defined in cwb_parameters.C
Examples
To see how the cwb_lsf works see the examples reported for the cwb_condor command. The working directory used for this example is in the svn directory :
tools/cwb/examples/O1_12Sep19Jan_C01_BKG_LF_rMRA_CNAF_vs_ATLAS
The instructions are in the README* files
Note
the supercluster root file is optional it is produced only if the config/user_parameters.C file contains the following option :jobfOptions |= CWB_JOBF_SAVE_TRGFILE;
cwb_xtalk¶
This page provides a description of the cwb_xtalk command.
Usage
This command generates the xtalk catalog used in the Multi Resolution Analysis.
Syntax
cwb_xtalk(without arguments)- Prints help
cwb_xtalk low_res_level high_res_level iNu precision- It generates the xtalk catalog
Further information
The following options can be passed to cwb_xtalk:
action = low_res_level : it corresponds to the lower resolution level. The level is selected as 2^low_res_level high_res_level : it corresponds to the higher resolution level. The level is selected as 2^high_res_level iNu : (optional, by default set to 4) it corresponds to the sharpness of the 'edge' of the basis function in Fourier domain precision : (optional, by default set to 10) it defines the filter length by truncation error quantified by P = -log10(1 - norm_of_filter)
Examples
- The following command line generates the Overlap Catalog file OverlapCatalog-lLev3-hLev8-iNu4-P10.bin with low- and high-resolution layers equal to 8 and 256, respectively:
cwb_xtalk 3 8
Production¶
cwb_inet¶
This page provides a description of the cwb_inet command.
Usage
This command is used to run the pipeline in the interactive mode.
Syntax
cwb_inet(no arguments)- Prints help
cwb_inet jobid [gps_evt] [options] [mdc_factor] [lag] [ced_dir/uparms]- Runs the analysis in the interactive mode.
Further information
The following options can be passed to cwb_inet:
jobid : (mandatory) job number gps_evt : the GPS time of the considered trigger. The pipeline analyses the data within a time window centered around gps_evt options = false : CWB does not produce the CED of the events true/ced : with both options, CWB produces the CED of the events --tool psd --ifo H1/L1/V1 --type strain/mdc/white --draw true/false : it draws the psd Stages : STRAIN : strain/mdc, CSTRAIN : white Ex: cwb_inet 1 0 '--tool psd --ifo H1 --type strain --draw true' Ex: cwb_inet 1 0 '--tool psd --ifo H1 --type strain --draw true --save true' --tool inj --draw true/false -> draw injections Stages : STRAIN Ex: cwb_inet 1 0 '--tool inj --draw true' --tool nRMS --ifo H1/L1/V1 --draw true/false : it draws the nRMS Stages : CSTRAIN Ex: cwb_inet 1 0 '--tool nrms --ifo H1 --draw true' --tool frdisplay --ifo H1/L1/V1 --type strain/mdc/white : it draws the data with frdisplay Stages : STRAIN : strain/mdc, CSTRAIN : white Ex: cwb_inet 1 0 '--tool frdisplay --hpf 50 --decimateby 16 --ifo H1 --type strain' --tool wdm --ifo H1/L1/V1 --type strain/mdc/white --draw true/false : it draws the wdm Stages : STRAIN : strain/mdc, CSTRAIN : white Ex: cwb_inet 1 0 '--tool wdm --ifo H1 --type white --draw true' --tool emax --level xx (optional) --draw true/false : it draws the maximum energy Stages : COHERENCE Ex: cwb_inet 1 0 '--tool emax --level 7 --draw true' --tool sparse --ifo H1/L1/V1 --draw true/false : it draws the sparse Stages : LIKELIHOOD Ex: cwb_inet 1 0 '--tool sparse --ifo H1 --draw true' --tool ced --draw true/false : it draws the ced Stages : LIKELIHOOD Ex: cwb_inet 1 0 '--tool ced --draw true' mdc_factor : numerical factor used to rescale the amplitude of the injected MDC simulated signal lag : lag number [-1 = select all lags defined in the user parameters file] ced_dir/uparms : if it is a directory than it is the directory where the CED is generated (default : data) if it is a file than it is used instead of the user_parameters.C (default) file
Examples
The following command line launches the analysis of the job number 1:
cwb_inet 1The following command line generates the CED for all the events identified in job 1:
cwb_inet 1 0 trueThe following command line generates the CED for all the events identified in job 1 by applying a specific amplitude factor:
cwb_inet 1 0 true factorThe following command line generates the CED of the event reconstructed at GPS time event_gps_time:
cwb_inet 1 event_gps_time trueThe following command line generates the CED of the event reconstructed at GPS time event_gps_time by applying a specific amplitude factor:
cwb_inet 1 event_gps_time true factorThe following command line generates the CED of the event reconstructed at GPS time event_gps_time by applying a specific amplitude factor, and the CED is saved in the output directory my_output (instead of data):
cwb_inet 1 event_gps_time true factor 0 my_outputThe following link reports the example of a complete, interactive multistages analysis conducted with the CWB 2G pipeline:
cwb_inet2G¶
This page provides a description of the cwb_inet2G command.
Usage
This command is used to run the CWB 2G pipeline in the interactive mode.
The 2G pipeline consists of different stages. The output of each stage is saved in a ROOT file, which also contains the configuration settings. Thus, it is possible to perform the analysis over a specific stage without running the pipeline from the initial stage.
Syntax
cwb_inet2G(no arguments)- Prints help
cwb_inet2G ifile stage [jobID/user_parameters.C] [options] [mdc_factor] [lag] [ced_dir]- Runs the 2G pipeline in the interactive mode
The options are not mandatory.
Further information
The following options can be passed to cwb_inet2G:
ifile = jobFile : output ROOT file generated by the previous analysis stage userConfig : user's parameter file (config/user_parameters.C in the "input" directory) stage = FULL : it runs the whole analysis INIT: STRAIN: CSTRAIN: COHERENCE: SUPERCLUSTER: LIKELIHOOD: jobID/user_parameters.C = it is equal to "job id" if the analysis is started from the initial stage of the CWB pipeline. Otherwise, the user can simply provide the name of the stage to be completed. In the case of a multiresolution analysis, at a given stage and with respect to those used for the previous stages, the user can pass as option a new version of the user_parameters.C. This way it is possible to perform analyses at different stages with different values of the search parameters. options = false : CWB does not produce the CED of the events true/ced : with both options, CWB produces the CED of the events --tool psd --ifo H1/L1/V1 --type strain/mdc/white --draw true/false : it draws the psd Stages : STRAIN : strain/mdc, CSTRAIN : white Ex: '--tool psd --ifo H1 --type strain --draw true' Ex: '--tool psd --ifo H1 --type strain --draw true --save true' --tool inj --draw true/false : it draws the injected simulated signals Stages : STRAIN Ex: '--tool inj --draw true' --tool nRMS --ifo H1/L1/V1 --draw true/false : it draws the nRMS Stages : CSTRAIN Ex: '--tool nrms --ifo H1 --draw true' --tool frdisplay --ifo H1/L1/V1 --type strain/mdc/white : it draws the data with frdisplay Stages : STRAIN : strain/mdc, CSTRAIN : white Ex: '--tool frdisplay --hpf 50 --decimateby 16 --ifo H1 --type strain' --tool wdm --ifo H1/L1/V1 --type strain/mdc/white --draw true/false : it draws the wdm Stages : STRAIN : strain/mdc, CSTRAIN : white Ex: '--tool wdm --ifo H1 --type white --draw true' --tool emax --level xx (optional) --draw true/false : it draws the maximum energy Stages : COHERENCE Ex: '--tool emax --level 7 --draw true' --tool sparse --ifo H1/L1/V1 --draw true/false : it draws the sparse Stages : LIKELIHOOD Ex: '--tool sparse --ifo H1 --draw true' --tool ced --draw true/false -> draw ced Stages : LIKELIHOOD Ex: 1 0 '--tool ced --draw true' mdc_factor = numerical factor used to rescale the amplitude of the injected MDC simulated signal lag = lag number [-1 = select all lags defined in the user parameters file] ced_dir = it is the directory where the CED is generated (default : data)
Examples
The following command launches a complete analysis with the 2G pipeline:
cwb_inet2G config/user_parameters.C FULL 1The following command lines launch a complete multistage 2G analysis:
cwb_inet2G config/user_parameters.C INIT 1cwb_inet2G data/jobFile.root STRAINcwb_inet2G data/jobFile.root CSTRAINcwb_inet2G data/jobFile.root COHERENCEcwb_inet2G data/jobFile.root SUPERCLUSTERcwb_inet2G data/jobFile.root LIKELIHOODAt the end of each intermediate stage an output data/jobFile.root file is created, containing all the information required for the following stage
The following command lines launch two steps of a multistage analysis conducted with the 2G pipeline:
cwb_inet2G config/user_parameters.C SUPERCLUSTER 1cwb_inet2G data/jobFile.root LIKELIHOODThe following command line enables the change of 2G analysis options:
cwb_inet2G data/jobFile.root LIKELIHOOD config/user_parameters.CThe following command line allows to monitor the 2G analysis data:
cwb_inet2G data/jobFile.root COHERENCE "" '--tool emax --level 8 --draw true'The following command line allows to process the second stage of run=205, lag=410, ced=true, mdc_factor=0, output ced_dir=data, config=config/user_parameters.C :
cwb_inet2G output/supercluster_1124218800_600_BKG_run1_job205.root LIKELIHOOD config/user_parameters.C ced 0 410 dataThe following link reports a complete example of how to perform the 2G multistage analysis:q*
cwb_eced¶
This page provides a description of the cwb_eced command.
Usage
This command generates the CED of an event via command line (easy CED).
Syntax
cwb_eced(no arguments)- Prints help
cwb_eced eced_opts [detector_opts]- Generates the CED via command line
Further information
The following options can be passed to the cwb_eced command:
eced_opts = gps_time : this is the GPS time of the event or '--gps gps --search search --sim sim --tag tag --cfg cfgfile' In the above line, the various options have the following meaning: --gps is the GPS time of the event --search is the search type (r, i, s, g, R, I, S or G for the 1G pipeline, r for the 2G pipeline) --tag is a label used to name the directory in which the CED is generated. If the tag is not specified, the default tag is used (corresponding to the current GPS time). --cfg is the name of the configuration file. The default configuration file used to generate the easy CED is trunk/tools/cwb/macros/cwb_parameters.C. To chage the default values, add the desired parameter values in a new file cfg.C and use the option --cfg cfg.C --ced false : disable CED, only root file is created detector_opts = '--ifo ifo --type type --chraw chraw --chmdc chmdc --factor factor' In the above line, the various options have the following meaning: --ifo is the detector name. If the gw_data_find tool is used, the input must be one of the following: L1, H1, V1, G1 --type is the type which identifies the considered detector's data. It the same as the one used by the gw_data_find tool. The following command lists the available types: gw_data_find -y. Alternatively, the type can be the name of the file containing the list of the considered frame files. Note that the name of this file must be of the format yyy.xxx . If no type is defined, the following default values are used: L1 -> L1_LDAS_C02_L2 H1 -> H1_LDAS_C02_L2 V1 -> Hreconline G1 -> G1_RDS_C01_L3 --chraw is the name of the channel to be read in the frame files. If no channel is defined, the following default values are used: L1 -> L1:LDAS-STRAIN H1 -> H1:LDAS-STRAIN V1 -> V1:h_16384Hz G1 -> G1:DER_DATA_H --chmdc is the name of the mdc frame channel --factor is the numerical factor used to rescale the hrss or the snr of the injected simulated signal --shift is the detector shift time in seconds for non zero lag events (NOTE : must be integer!!!)
The cwb_eced command creates a directory named according to the following format:
ECED_net_TAGtag_GPSgpswhere
- net corresponds to the considered network (e.g., L1H1V1)
- tag is part of the name of the directory in which the CED is saved, see above in this page.
- gps is the GPS time of the considered event
An example of the directory’s name is as follows:
ECED_L1H1V1_TAG1048593634_GPS968654557The following sub-directories are created in the main folder:
- tmp: this directory contains temporary files
- ced: this directory contains the CED of the event.
A symbolic link is created in the user’s public directory to make the CED accessible via a web browser, e.g.:
~waveburst/WWW/LSC/ceds/ECED_L1H1V1_TAG1048593634_GPS968654557Note that the cwb_eced command cannot be used in the simulation mode.
Examples
The examples reported in this section have been performed on the ATLAS computing cluster.
The following command lines generate the easy CED of the hardware injection performed at 968654557 GPS time on the L1H1V1 network (Big Dog event):
cwb_eced 968654557 L1 H1 V1or
cwb_eced 968654557 '--ifo L1' '--ifo H1' '--ifo V1'/home/waveburst/REPORTS/ECED_L1H1V1_TAG1048598836_GPS968654557
and is available on the internet at the following link:
cwb_eced 968654557 H1The CED is saved at ATLAS here:
/home/waveburst/REPORTS/ECED_H1_TAG1048598281_GPS968654557
and is available on the internet at the following link:
The same CED can be generated also starting from the H1.frames file, which contains the list of the frame files:
cwb_eced 968654557 '--ifo H1 --type H1.frames'cwb_eced 934327040 L1
- The CED is saved at ATLAS here:
/home/waveburst/REPORTS/ECED_L1_TAG1048598553_GPS934327040 and is available on the internet at the following link: CED link.
cwb_eced "--gps 825676252 --tag _CR --ced false" "--ifo H1 --type H1_RDS_C03_L2 --chraw H1:LSC-STRAIN"cwb_eced "--gps 934970296 --cfg config/user_parameters_eced.C --ced true --tag BKG""--ifo L1 --shift 0" "--ifo H1 --shift -272" "--ifo V1 --shift -79"The CED is saved at ATLAS here: /home/waveburst/REPORTS/S6A_BKG_LF_L1H1V1_2G_RSRA_eced and is available on the internet at the following link: CED link.Note
if “-ced false” is declared then only the standard wave*.root is created.
cwb_eced2G¶
This page provides a description of the cwb_eced2G command.
Usage
This command generates the CED of an event via command line (easy CED) and by using the 2G pipeline.
Syntax
See the Syntax section in the page on the cwb_eced command: cwb_eced.
Examples
- See the BigDog example. The easy CEDs are available on the internet at the following link : BigDog CED link.
cwb_dump¶
This page provides a description of the cwb_dump command.
Usage
This command generates various files reporting information on the analysis. The files are saved in the report/dump directory.
Syntax
cwb_dump(no arguments)- Prints help
cwb_dump all/dq/inj/lag/slag/job/sjob/history/events/config- Generates the files reporting information on the analysis
Further information
The following options can be passed to cwb_dump:
action = all : it dumps in the output files all the pieces of information provided by the other options in this list dq : it dumps the data-quality duty times inj : it dumps the list of injected simulated signals and their parameters. Note that this option does not work in the case of 'on the fly' simulation studies. The list can be used to provide information on the simulation study in the final report lag : it dumps the list of time lags used in the production stage slag : it dumps the list of superlags used in the production stage job : it lists the standard jobs (variable length) sjob : it lists the jobs used for the super lags (fixed length) history : root_file_name - dump : it dumps the history infos - view : it views the history infos events : root_file_name (gets the event parameters stored in the output root file) - dump : it saves the events' parameters in the file report/dump/config_*.C - view : it views the events' parameters config : root_file_name (get the cwb parameters.C used in the last stage) - dump : save config to file report/dump/config_*.C - view : view config - m5d : view the MD5 cwb parameters.C
Post-Production¶
cwb_condor benchmark¶
Usage
This command is to draw plots showing what is the memory usage and elapsed time for each job.
Syntax
cwb_condor benchmark 'options'where options are, as written in the help code:
options = --fstage FSTAGE (select output file stage : def=FULL) --jstage JSTAGE (select stage in the pipeline : def=FULL) --res RES (select resolution in the pipeline : def=-1) --factor FACTOR (select factor index in the pipeline : def=-1) --bench BENCH (benchmark type : def=JET) --min MIN (min benchmark value : def=auto) --max MAX (max benchmark value : def=auto) --plot TYPE (plot type HIST/GRAPH/HIST2 : def=HIST) --save SAVEOPT (save plot : use dir name(name is builtin) or file path with extention .png) no arguments print help (exit with 'q')In details:
- FSTAGE/JSTAGE: selects one intermediate stage of the pipeline.
The possibility are:
FULL/INIT/STRAIN/CSTRAIN/COHERENCE/SUPERCLUSTER/LIKELIHOOD currently only FULL stage is implemented for FSTAGE optionBENCH: selects plot subject. Possibilities:
- JET : Job Elapsed Time
- MEM : Memory
- JFS : Job File Size
- SET : Stage Elapsed Time
- THR : Threshold �| Coherence Stage
- GT : Gating Time �| Coherence Stage (to be used only when the Gating Plugin is applied)
- PSIZE : Number of selected pixels per lag �| Coherence Stage
- CSIZE : Number of selected clusters per lag �| Coherence Stage
MIN/MAX: minimum and maximum values in the plot. Useful to compare plots of different analyses.
TYPE: plot type. Possibilities:
- HIST : 1D Histogram of BENCH
- GRAPH : Point Graph reporting on x-axis the job number and on y-axis the BENCH
- HIST2 : 2d Histogram where x- and y-axes are the job numbers (on y-axis the job runs over 100, while on x-axis runs progressively) and on z-axis the values of BENCH
Examples
* cwb_condor benchmark '--jstage COHERENCE --bench THR --res 3 --factor 3' - plot the THRESHOLD used to select pixels in the COHERENCE Stage * cwb_condor benchmark '--jstage COHERENCE --bench GT --res 0 --save report/dump --plot GRAPH' - plot the Gating Time vs JobID used to veto the selection of the pixels in the COHERENCE Stage Note : To be used only when the Gating Plugin is applied * cwb_condor benchmark '--jstage FULL --bench JET --xmax 4' - plot the Job Estimated Time at the end of the Stage LIKELIHOOD, max xaxis is set to 4 hours * cwb_condor benchmark '--jstage LIKELIHOOD --bench SET' - plot the Stage Estimated Time in the Stage LIKELIHOOD * cwb_condor benchmark '--jstage FULL --bench JET --save report/dump' - plot the FULL Job Estimated Time, the plot is saved under report/dump dir * cwb_condor benchmark '--bench JET --save file.png' - plot the Job Estimated Time at the end of the last Stage, the plot is saved under report/dump dir * how to produce plots when analysis is done in 2 stages : supercluster + reconstruction - cwb_condor benchmark '--jstage FULL --bench JET --save report/dump --fstage SUPERCLUSTER' - plot the Job Estimated Time using the informations contained in the supercluster root files produced in the supercluster stage, the plot is saved under report/dump dir - cwb_condor benchmark '--jstage FULL --bench JET --save report/dump' - plot the Job Estimated Time using the informations contained in the wave root files produced in the final stage, the plot is saved under report/dump dir
cwb_merge¶
Usage
This command merges all the ROOT output files for each job in a single
ROOT file. It is possible to merge the files even if the all analysis is
not finished. In this case it is useful to save the ROOT files with
different names, like with a progressive number.
Syntax
cwb_merge label/list options[optional]
- action
- label MX (where X must be a positive number and gives the progressive merged files) M0 (checks what is the last progressive number and create the file with the following one)
- list list the labels of the already merged files
- options ‘–nthreads #N –rms true/false –var true/false –psm true/false’
- –nthreads integer[0:8] : optional : default=0 : greater than 1 -> use nthreads threads (faster)
- –rms false/true : optional : default=false : true -> save rms
- –var false/true : optional : default=false : true -> save variability
- –psm false/true : optional : default=false : true -> save skymap probability
- –idir input directory where are the files to be merged (default = output)
- –utag user tag : added after *.Mx -> *.Mx.U_utag (default is *.Mx)
The script produce 3 files under merge directory
- merge_*.lst: a list of the files from output directory
- live_*.root/mdc_*.root: live time/mdc information
- wave_*.root: event information
Note
skymap has in general a big size, do not enable it if not necessary
Examples
* cwb_merge M1 it produces the files : - merge/live_data_label.M1.root - merge/merge_data_label.M1.lst - merge/wave_data_label.M1.root * cwb_merge list it produces the output : -------------------- List of merge labels -------------------- - M1 * cwb_merge M1 '--nthreads 4' produce merge using 4 threads
cwb_setchunk¶
Usage
This command add a chunk id leaf to the merged root files.
It is used to assign a unique tag id to a the root entries. Different
merged root files can be merged and the different chunks can be selected
using the chunk parameter.
Syntax
cwb_setchunk mlabel/list id
- mlabel/lists same label used by cwb_merge, if the user writes lists it list the available labels
- id is the chunk id (must be integer > 0) new root files are generated, a label will be added to the new merged files names (M1 -> M1.K_chunk’id’)
Examples
* cwb_setchunk M1 1 if the input file is with name: merge/wave_S6A_BKG_L1H1_run1.M1.root the output file assumes the name: merge/wave_S6A_BKG_L1H1_run1.M1.K_chunk1.root and the same for live file.
cwb_setifar¶
Usage
This command adds a new ifar (inverse false alarm rate) leaf to the
selected entries in the merged simulation root file.
For each selected entry a new leaf is created “ifar” which value is
obtained from the background FAR vs RHO file.
It is a text file which contains a corrispondence between far and rho (from background estimation)
Syntax
cwb_setifar mlabel/list tsel farfile ilabel mode- mlabel/lists same label used by cwb_merge, if the user writes lists it list the available labels
- tsel treen selections, only wave tree
- must contains only leaf of waveburst tree (not the leaf run) the syntax is the the same as the one used for the selection TTree
- ilabel label that will be added to the new merged files names (M1 -> M1.S_ilabel)
- mode inclusive/exclusive
- inclusive : if a previous ifar is already associated to the entry then it is updated if the new ifar is greatar exclusive : the ifar is updated regardless what is is the old one
Alternative Syntax
cwb_setifar mlabel/list options- mlabel/lists same label used by cwb_merge
- options options (options must be declared inside ‘…’) : see previous definitions
- –label ilabel default=”“
- –tsel tsel default=”” : tsel is the name or a logical expression of names of TCut selections defined in user_pparameters.C
- –file file default=”” : file is the name of the far file defined in user_pparameters.C, name can be an element of an array (Ex: name[2])
- –mode mode default=”“
- –xtsel xtsel default=”” : the tsel are explicitly defined (must be used as alternative to –tsel)
- –xfile xfile default=”” : the far file path is declared explicitly (must be used as alternative to –file)
Note
label, tsel/xtsel, file/xfile, mode are mandatory
Note
farfile is produced by the background report, and it is saved under the report data dir and its name is far_rho.txt
Note
examples of allowed logical expressions are X&&Y, (X||Y), !X, ((X||Y)&&Z)
Examples
* cwb_setifar M1 'netcc[1]>0.8' /home/waveburst/work_dir/report/postprod/far_rho.txt cc1_gt_0d8 exclusive - add ifar leaf for all entries with ((netcc[1]>0.8)) in the wave file - far is read from /home/frank/work_dir/report/postprod/far_rho.txt : is a two columns file "rho far" Alternative Syntax : cwb_setifar M1 '--xtsel netcc[1]>0.8 --label cc1_gt_0d8 \ --xfile /home/waveburst/work_dir/report/postprod/far_rho.txt --mode exclusive' or : cwb_setifar M1 '--tsel cc1_tsel --label cc1_gt_0d8 --file farfile --mode exclusive' - cc1_tsel is the name of TCut selection defined in user_pparameters.C Ex : TCut cc1_tsel("cc1_tsel","netcc[1]>0.8"); - farfile is the name of the far file defined in user_pparameters.C Ex : TString farfile = "/home/waveburst/work_dir/report/postprod/far_rho.txt"; or : cwb_setifar M1 '--tsel cc0_cut&&cc2_cut --label cc0_cc2_cut --file farfile[2] --mode exclusive' - cc0_cut and cc2_cut are the names of TCut selections defined in user_pparameters.C Ex : TCut cc0_cut("cc0_cut","netcc[0]>0.8"); TCut cc2_cut("cc2_cut","netcc[2]>0.8"); - farfile[2] is the iname of the second element of the far file array defined in user_pparameters.C Ex : TString farfile[3]; farfile[0] = "/home/waveburst/work_dir_0/report/postprod/far_rho.txt"; farfile[1] = "/home/waveburst/work_dir_1/report/postprod/far_rho.txt"; farfile[2] = "/home/waveburst/work_dir_2/report/postprod/far_rho.txt";
cwb_setcuts¶
Usage
This command applies thresholds on tree leaves to select events with certain characteristics defined by the user.
We remind that for each merge label we have two files type: the wave and the mdc/live, with different structure but some leafs are in common.
So when choosing selection cuts, you should distinguish between the cuts that should be applied only to wave tree from the ones that will be
applied also to mdc/live. One example of the former cut is a selection on rho or cc, on the contray a selection on the run is an example of the latter.
Syntax
cwb_setcuts mlabel/list wcuts clabel jcuts(opt) mcuts(opt) lcuts(opt)
- mlabel/lists same label used by cwb_merge, if the user writes lists it list the available labels
- clabel label that will be added to the new merged files names (M1 -> M1.C_clabel)
- wcuts selections for only wave tree must contains only leaf of waveburst tree (not the leaf run) the syntax is the the same as the one used for the selection TTree
- jcuts job selection for wave & mdc trees must contains only the leaf run the syntax is the the same as the one used for the selection TTree
- mcuts selections for only mdc tree must contains only leaf of mdc tree (not the leaf run) the syntax is the the same as the one used for the selection TTree
- lcuts selections of lag/slag : is applied only to wave and livetime tree must contains only lag/slag leafs the syntax is the the same as the one used for the selection TTree
Alternative Syntax
cwb_setcuts mlabel/list options
- mlabel/lists same label used by cwb_merge
- options options (options must be declared inside ‘…’) : see previous definitions
cwb_setcuts mlabel/list wcuts clabel jcuts(opt) mcuts(opt) lcuts(opt)–label clabel default=”“
–tcuts tcuts default=”” : tcuts is the name of TCut selection defined in user_pparameters.C, it is added to wcuts
–wcuts wcuts default=”“
–jcuts jcuts default=”“
–mcuts mcuts default=”“
–lcuts lcuts default=”“
–unique true/false select from the root file a unique reconstructed event for each injected signal.
The signal is selected from the reconstructed events which have the same injected gps time, the selected one has the maximum rho. When this option is used the label “.C_U” will be added to the new merged files names. (default=false) A new leaf is added to the waveburst tree : fsize=number of fragments found in the iwindow NOTE : this option can be applied only when simulation>0.
Note
- not use !expression but !(expression)
- EX : ot use !veto_cat3_H1 but !(veto_cat3_H1)
- use !expression instead of “expression”
- EX : use !veto_cat3_H1 instead of “!(veto_cat3_H1)”
Examples
* cwb_setcuts M1 'netcc[1]>0.8' cc1_gt_0d8_run_lt_100 'run<100' - apply the cut ((netcc[1]>0.8)&&(run<100)) to wave file - apply the cut (run<100) to the live file if the input file is with name: merge/wave_S6A_BKG_L1H1_run1.M1.root the output file assumes the name: merge/wave_S6A_BKG_L1H1_run1.M1.C_cc1_gt_0d8_run_lt_100.root and the same for live file. Alternative Syntax : cwb_setcuts M1 '--wcuts netcc[1]>0.8 --label cc1_gt_0d8_run_lt_100 --jcuts run<100' * cwb_setcuts M1.C_rho0_gt6.V_cat2LH_hvetoLH_cat3LH '!(veto_cat3_H1) && !(veto_cat3_L1)' nohwinj * cwb_setcuts M1 'netcc[2]>0.45' cc2_gt_0d45_lag1_eq_0 '' '' 'lag[1]==0' - apply the cut ((netcc[2]>0.45)&&(lag[1]==0)) to wave file - apply the cut (lag[1]==0) to the live file Alternative Syntax : cwb_setcuts M1 '--wcuts netcc[2]>0.45 --label cc2_gt_0d45_lag1_eq_0 --lcuts lag[1]==0' * cwb_setcuts M1 '--unique true' - apply unique selection of detected events if the input file is with name: merge/wave_S6A_BKG_L1H1_run1.M1.root the output file assumes the name: merge/wave_S6A_BKG_L1H1_run1.M1.C_U.root * cwb_setcuts M1 '--unique true --wcuts netcc[2]>0.45 --label cc2_gt_0d45' - apply unique selection of detected events and tree cuts if the input file is with name: merge/wave_S6A_BKG_L1H1_run1.M1.root the output file assumes the name: merge/wave_S6A_BKG_L1H1_run1.M1.C_U.C_cc2_gt_0d45.root * cwb_setcuts M1 '--tcuts MyTCut --wcuts netcc[2]>0.45 --label cc2_gt_0d45_mytcut' - select events with (MyTCut.GetTitle()) && (netcc[2]>0.45) The MyTCut must be defined in user_pparameters.C Ex : TCut MyTCut('MyTCut','rho[0]>6'); // MyTCut.GetTitle() is 'rho[0]>6' or it can be defined in a file.hh and included in user_pparameters.C inside the brackets {} Ex : #include "file.hh"
cwb_setveto¶
Usage
This command applies post-production data qualities (cat3, hveto, pem)
to the ROOT file produce by cwb_merge command.Data
quality file lists are defined in the
user_pparameters.C file.
Syntax
cwb_setveto action [label/list] user_parameters_file(optional) user_pparameters_file(optional)- action
- label same label used by cwb_merge
- list list the label of files already merged
- user_parameters_file alternative user_parameters file (optional)
- user_pparameters_file alternative user_pparameters file (optional)
This is an example of configuration file used for post-processing of S6A background
Example
* the input files are the merged files produced by the cwb_merge command : - merge/wave_*_M1.root // reconstructed events root file - merge/live_*_M1.root // live time root file - merge/merge_*_M1.lst // list of merged root files * the vetoe files must be defined in the user_pparameters.C, for example : const int nvdqf=3; dqfile vdqf[nvdqf] = { {"L1", "input/L1_KW_HVETO_S6A.txt", CWB_HVETO, 0., false, false}, {"H1", "input/H1_KW_HVETO_S6A.txt", CWB_HVETO, 0., false, false}, {"V1", "input/V1_KW_HVETO_S6A.txt", CWB_HVETO, 0., false, false}, {"L1", "input/S6A_OFFLINE_L1_DQCAT3SEGMENTS.txt", CWB_CAT3, 0., false, false}, {"H1", "input/S6A_OFFLINE_H1_DQCAT3SEGMENTS.txt", CWB_CAT3, 0., false, false}, {"V1", "input/S6A_OFFLINE_V1_DQCAT3SEGMENTS.txt", CWB_CAT3, 0., false, false} }; * cwb_setveto M1 apply hveto & cat3 data quality and produce three new ROOT files in the merge directory: - merge/wave_*_M1.V_hvetoLHV_cat3LHV.root - merge/live_*_M1.V_hvetoLHV_cat3LHV.root (same file as the one produced by cwb_merge) - merge/merge_*_M1.V_hvetoLHV_cat3LHV.lst (same file as the one produced by cwb_merge) * the output vetoed merged files contains a new boolean leaf for each veto type - veto_cat3_L1 - veto_cat3_H1 - veto_cat3_V1 - veto_hveto_L1 - veto_hveto_H1 - veto_hveto_V1 the boolean leaf is true if the event is vetoed
cwb_report¶
Usage
This command produces the web pages. For this command
it is necessary to have configured the
user_pparameters.C file.
Syntax
cwb_report label action [option] user_parameters_file(optional) user_pparameters_file(optional)
- label same label as cwb_merge/cwb_setveto command
- action what kind of action:
- create create sim/bkg report
- pe create parameter-estimation report (only for sim)
- skymap create skymap-statistics (use https://github.com/reedessick/skymap_statistics)
- list merge/report list the labels of ROOT files/web pages
- loudest create condor dag,sub files of the loudest events list produced by the report (see options loudest)
- option specify lag and superlags (only for production)
- Xlag default : Xlag=-1 the selected lags are : lag>0
- Xslag default : Xslag=-1 the selected slags are : slag>=0
- Xlag=-1 & Xslag=-1 : lag>0 & slag>=0 (BACKGROUND)
- Xlag =0 & Xslag =0 : lag=0 & slag=0 (ZERO LAG !!!)
- Xlag>=0 & Xslag>=0 : lag=Xlag & slag=Xslag
- Xlag>=0 & Xslag=-1 : lag=Xlag & slag=any
- Xlag=-1 & Xslag>=0 : lag=any & slag=Xslag
- options loudest specify options for loudest action (only for production)
- -evt set the number of loudest events to be processed (-nevt 0 : no limit) [default = pp_max_nloudest_list]
- rho set the rho threshold (events selected are with rho[pp_irho]>RHO) [default = 0]
- -idmin set the min id number of the loudest events to be processed [default = 0 : no limit]
- -idmax set the max id number of the loudest events to be processed [default = 0 : no limit]
- -ufile set the user parameters file [default = $CWB_PARAMETERS_FILE]
- -ced set ced : true -> produce CED [default = false]
- -veto set veto : true -> events vetoed by pp vetoes are discarted [default = false]
- -odir set output root files directory : is created under the report dir [default = loudest]
- -stage auto = processing start from the last processed stage : full = full stage [default = auto]
- Xlag default : Xlag=-1 the selected lags are : lag>0
- no arguments print help (exit with ‘q’)
- user_parameters_file alternative user_parameters file (optional)
- user_pparameters_file alternative user_pparameters file (optional)
This is an example of configuration files used for post-processing of S6A background
Examples
* cwb_report M1 create create the web page. Background or simulation are chosen according to simulation variable value in user_parameters.C file. * production examples cwb_report M1 create -> report for background (lag>0 & slag>=0) cwb_report M1 create N M -> report for (lag=N & slag=M) cwb_report M1 create 0 0 -> report for zero lag * loudest examples (only for background) cwb_report M1.V_hvetoLH_cat3LH loudest \ '--odir loud_rho1_gt_7d5 --rho 7.5 --ufile config/user_parameters_WavePeaks.C --veto true --nevt 0' select from the report loudest events list the events according the following rules: - rho[pp_irho]>7.5 - events are not vetoed by the post-production vetoes - output root files directory = loud_rho1_gt_7d5 : is created under the dir report/postprod/report_dir/ - uses config/user_parameters_WavePeaks.C - nevt=0 : there are no limit on the number of selected events, the only constraint is rho[pp_irho]>7.5 The dag,sub condor files are produced under the condor directory. * cwb_report M1 pe create the web page for Parameter-Estimation. It is available only for simulation * cwb_report skymap ced_dir/skyprobcc.fits create the web page for skymap-statistics (point estimate) : ced_dir/skyprobcc The symbolic index file is copied to ced_dir and the link to skymap-statistics is added (Skymap Statistic ( point estimate )) * // only for CEDs created with PE (median skymap) cwb_report skymap ced_dir/mskyprobcc.fits create the web page for skymap-statistics (median) : ced_dir/mskyprobcc The symbolic index file is copied to ced_dir and the link to skymap-statistics is added (Skymap Statistic ( median )) * // only for CEDs created with PE (comparison skymap) cwb_report skymap ced_dir/skyprobcc.fits '--fits ced_dir/cskyprobcc.fits' create the web page for comparison skymap-statistics (point estimate vs median) : ced_dir/cskyprobcc The symbolic index file is copied to ced_dir and the link to skymap-statistics is added (Skymap Statistic ( comparison )) * Examples of some web pages: - background : https://ldas-jobs.ligo.caltech.edu/~waveburst/reports \ /S6A_R4_BKG_L1H1V1_SGW_run1/postprod/M1.R_cc60_rho35_vED40/ - background (zero lag) : https://ldas-jobs.ligo.caltech.edu/~waveburst/reports \ /S6A_R4_BKG_L1H1V1_SGW_run1/postprod/M1.R_cc60_rho35_vED40/ - background after apply cwb_setveto : https://ldas-jobs.ligo.caltech.edu/~waveburst/reports \ /S6A_R4_BKG_L1H1V1_SGW_run1/postprod/ \ M1.VhvetoV_cat3LHV.R_hveto_cat3_pem_cc60_rho35_vED40/ - simulation : https://ldas-jobs.ligo.caltech.edu/~waveburst/reports \ /ADV_SIM_BRST_LF_L1H1V1_1G_run1/postprod/M1.R_cc50_rho20_RHO20_win1/
cwb_mkfad¶
Note
The current FAD implementation is a preliminary version and it has some limitations, see FAD howto
Usage
This command must be executed in the simulation working directory, it
produces the FAD files and plots.
For this command it is necessary to have configured the
user_pparameters.C file.
The following pp parameters are used by the cwb_mkfad command:
pp_fad,T_win
,T_cor ,pp_irho
,T_vED ,T_pen
Note
it is not necessary to configure the “-nzbins” in the pp_fad <running.html#others>`__ option
Note
the pp_fad option can be defined in a separated un-named macro which name can be provided to the cwb_mkfad command alternatively to the nzbins parameter.
Syntax
cwb_mkfad label nzbins/fad.in [optional] odir [optional] obstime [optional]label : same label as
commands
nzbins/fad.in : (default is -1)
- if nzbins=0 the standard FAD statistic is used
- if nzbin>0 the FAD statistic is computed until there are nzbins consecutive bins with zero events inside
- if nzbin<0 the FAD statistic is computed with classical FAD and min-hold (un-biased FAD)
- if the parameter is a file name the file must be a un-named ROOT macro which can be used to define the pp_fad.
- odir : output fad directory (default=”fad”)
the output directory is created under report/postprod/sim_report_dir where “sim_report_dir” is the standard simulation report directory created with the cwb_report command. Under the “odir” the command creates the fad.html which can be used by a web browser to display the FAD plots. This is the list of created ascii/plots files :
- FARvsRHO False Alarm Rate vs RHO
- REFFvsRHO Effective Radius vs RHO
- REFFvsIRHO Effective Radius vs Inverse RHO
- VISvsRHO Visible Volume vs RHO
- PRODvsFAD Productivity vs False Alarm Density
- EVTvsRHO Number of Expected False Alarm vs RHO
- FADvsRHO False Alarm Density vs RHO
- FAPvsRHO False Alarm Probability vs RHO
- RECvsINJ Reconstructed Events vs Injected Events
obstime : zero lag observation time (sec), if 0 then it is read from live.txt
Examples
cwb_mkfad M1.C_cc2_gt_0d45 -1 unbiased_fad cwb_mkfad M1.C_cc2_gt_0d45 fad.in fad cwb_mkfad M1 0 standard_fad 840000
cwb_mkprc¶
Usage
This command must be executed in the simulation working directory, it
produces the FOM files and plots for sky localization.
Syntax
cwb_mkprc label odir single [optional] header [optional]label : same label as cwb_merge/cwb_setveto commands
- odir : output prc directory (default=”prc”)
the output directory is created under report/postprod/sim_report_dir where “sim_report_dir” is the standard simulation report directory created with the cwb_report command. Under the “odir” the command creates the prc.html which can be used by a web browser to display the PRC plots. This is the list of created plots files :
- RECvsINJ Injected vs Reconstructed SNRnet distribution
- INJvsAP Sky Source Distribution of injected MDC
- RECvsAP Sky Source Distribution of reconstructed MDC
- CPROBvsSAREA Cumulative Probablitily vs Searched Area
- PDENSvsANGLE Probability Density vs largest angle between the source’s true location and any point within the searched area
- COVvsPERC PP-Plot : Coverage vs Percentage
single : if false (def) the prc plots are produced for each MDC type otherwise the plots include all MDC types
header : if true (def=false) then the html index includes the cWB header logo
Examples
cwb_mkprc M1.C_cc2_gt_0d45 single header cwb_mkprc M1.C_cc2_gt_0d45 multi
Utility¶
cwb_mplugin¶
Usage
This command is used to merge plugins into one.
Syntax
cwb_mplugin out_plugin.C in_plugin_1.C(opt) in_plugin_2.C(opt) in_plugin_3.C(opt) in_plugin_4.C(opt)
- out_plugin.C : name of the output plugin
- in_plugin_1.C : name of the input plugin 1
- in_plugin_2.C : name of the input plugin 2 (optional)
- in_plugin_3.C : name of the input plugin 3 (optional)
- in_plugin_4.C : name of the input plugin 4 (optional)
Note
- the input plugins are executed following the order of the declaration in_plugin_1.C, in_plugin_2.C, in_plugin_3.C, in_plugin_4.C
- the instructions #define,#include,#pragma must be defined outside the functions
Example
cwb_mplugin out_plugin.C in_plugin_1.C in_plugin_2.C
cwb_mkhtml¶
cwb_mkhtml path/file.texi header/wheader/nheader/pdf(optional)path/file.texi : this is the full path of texi file
path : the path of a directory (if it contains png file it creates html with the list of plots)
options : the path options - ‘multi true/false(default)’ : true/false = plots are displayed in 2/1 columns - ‘title TITLE’ : is the TITLE displayed on the top of plot list - ‘subtitle SUBTITLE’ : is the SUBTITLE displayed below the TITLE .. note:
The spaces in the title/subtitle must be declared with # : Ex: 'title PLOT#LIST'file.texi : the texi file name must have the .texi extension
wheader/nheader/pdf : this option add cwb header to the html, it is optional
- wheader is equivalent to header : use wider header
- nheader : use narrow header
- pdf : create pdf
cwb_mkhtml path/file.ext [allowed extensions: C/cc/hh/c/h]- path/file.ext : this is the full path of c-code file, the allowed extensions are [C/cc/hh/c/h]. If only path is declared then an html file with the list of png plots contained in the path dir is created
MathJax
It is possible to include mathematical formulae using MathJax
The MathJax project is an open source JavaScript platform for display of mathematics in html pages
The formulae can be defined with LaTeX notation.
This is an example that shows how to include a formula in a html page.
Example
@ifhtml @include mathjax.texi @html This is a mathematical formula : @c <mj> \[ x = \frac{-b \pm \sqrt{b^2 - 4 a c}}{2 a} \] This is an inline mathematical notation : \( \sqrt@{b^2 - 4 a c@} \) @end html @end ifhtml- @include mathjax.texi this include add to html page the MathJax javascript & configuration - @c <mj> \[ x = \frac{-b \pm \sqrt{b^2 - 4 a c}}{2 a} \] to include a formula in the page it must be include in backslash brackets -> \{ \} To avoid to add the escape character "@" in front of each braket it is necessary to declare in front of the formula the tag "@c <mj> " - This is an inline mathematical notation : \( \sqrt@{b^2 - 4 a c@} \) to include a formula in a line it must be include in backslash brackets -> \( \) the brackets "{ }" must be declared with the escape character "@{ @}"
This is the output in the html page :
This is a mathematical formula : This is an inline mathematical notation : \( \sqrt{b^2 - 4 a c} \)
cwb_mkrep¶
Usage
This command creates a custom index html page with the standard cWB banner.
Syntax
cwb_mkrep path/file.htmlpath/file.html : this is the full path of output html file
Example
In this example we want to create an index html page with the standard cWB banner which includes
the html file created (without option 'header') in the example cwb_mkhtml.
Here are the steps :
* cd to the working directory
cd EXAMPLE
* create config/user_parameters.C
{
simulation = -1; // super report mode
}
* create config/user_pparameters.C
#define RUN_LABEL "SREPORT"
{
pp_sreport[0] = " --link https://ldas-jobs.ligo.caltech.edu/~albert.enstein/ \
LSC/reports/EXAMPLE/postprod/example/ ";
pp_sreport[0]+= " --name index.html --label my-example";
}
NOTE : insert a space at the beginning of each pp_sreport string !!!
See this link to know how to use pp_sreport
* create html file
cwb_mkhtml report/postprod/index.html
If this file has been produced in ATLAS it can be browsed at the following link :
https://ldas-jobs.ligo.caltech.edu/~albert.einstein/LSC/reports/EXAMPLE/postprod/index.html
cwb_draw_sensitivity¶
Usage
This command read psd ascii file and produces plot with the psd of the
detector sensitivity
Syntax
cwb_draw_sensitivityfile_name [save(0,1)] [range_fix(1,0)]The cwb_draw_sensitivity accept the following parameters: file_name : ascii file : each line has format -> freq(Hz) psd save : 0/1 -> saved/not-saved to file (default = 0) the output plot is produced under the report/dump directory range_fix : 1/0 : fixed/auto y-axis range (default = 1)
Examples
* cwb_draw_sensitivity psd.txt * the file psd.txt of real data can be produced with the cwb_inet2G commands and How to do an interactive multistages 2G analysis The following example produce the psd ascii file of L1 under the report/dump directory : cwb_inet2G config/user_parameters.C STRAIN 312 '--tool psd --ifo L1 --type strain --save true'
cwb_draw_antpat¶
Usage
draw the network antenna pattern (read config from the user_parameters.C file)
Syntax
cwb_draw_antpatpolarization projection savepolarization 0 - |Fx| DPF 1 - |F+| DPF 2 - |Fx|/|F+| DPF 3 - sqrt((|F+|^2+|Fx|^2)/nIFO) DPF (default) 4 - |Fx|^2 DPF 5 - |F+|^2 DPF 6 - Fx only with 1 detector 7 - F+ only with 1 detector 8 - F1x/F2x only with 2 detectors 9 - F1+/F2+ only with 2 detectors 10 - sqrt(|F1+|^2+|F1x|^2)/sqrt(|F2+|^2+|F2x|^2) only with 2 detectors 11 - The same as (10) but averaged over psi only with 2 detectors projection hammer(default)/rect save 0(false)/1
Examples
- cwb_dump_antpat 0
cwb_gwosc¶
This page provides a description of the cwb_gwosc command.
Usage
This command is used to retrive and analyze GWOSC O2 catalog events
Syntax
cwb_gwosc(without arguments)- Prints help
cwb_gwosc GW=GWyymmdd action [options]- Prepares and submits the jobs
Further informations
The following options can be passed to cwb_gwosc
GW=GWyymmdd (mandatory) -> Ex: GW=GW150914 Thw following is the list of the O1,O2 available events: O1 Events : GW150914 GW151012 GW151226 O2 Events : GW170104 GW170608 GW170729 GW170809 GW170814 GW170817 GW170818 GW170823 NOTE: GW170817 event includes the L1 glitch -> is not detected by cWBaction = all : setup + ced setup : frames + dq + init init : clean + create + files NOTE: before this command the frames & dq must be done create : create working directory files : create working files frames list, job analysis gps range copy user_parameters.C, copy plugin clean : remove sub-working directories frames : copy LH event frames from GWOSC dq : copy LH event data quality from GWOSC analysis : make cWB analysis, output root file to data directory NOTE: before this command the setup, frames & dq must be done ced : make cWB analysis, output CED to report/ced directory NOTE: before this command the setup, frames & dq must be done skymap : make CED skymap, output skymap into CED report NOTE: before this command the ced must be done xced : display CED with firefox browser NOTE: before this command the setup, frames & dq must be done NOTE: enabled only in VIRTUALBOX !!! psd : display strain PSD NOTE: before this command the setup, frames & dq must be done wpsd : display whitened PSD NOTE: before this command the setup, frames & dq must be done tf : display whitened Time Frequency map NOTE: before this command the etup, frames & dq must be done emax : display max energy Time Frequency map NOTE: before this command the etup, frames & dq must be done sparse : display IFO sparse map NOTE: before this command the setup, frames & dq must be done man : display cWB manual with firefox browser NOTE: enabled only in VIRTUALBOX !!!options IFO : IFO=L1(default),H1 : mandatory for actions: psd, wpsd, rms, ts, emax, sparse Ex: cwb_gwosc GW=GW150914 IFO=L1 psd SR : SR=4(default),16 (KHZ) : select frames sample rate Ex: cwb_gwosc GW=GW150914 SR=4 frames LEVEL : LEVEL=4,5(default),6,7,8,9,10 (Time Frequency decomposition level)
Note
- the GWOSC default definitions are:
- GWOSC O2 catalog event frames
- GWOSC O2 catalog event data quality segments
GWOSC_DQ= https://www.gw-osc.org/timeline/segments
- GWOSC local working directory
GWOSC_DIR= $(HOME)/GWOSC/catalog/GWTC-1-confident
- GWOSC default user_parameters.C configuration file
GW_CONFIG_FILE= $(HOME_CWB)/macros/gwosc_parameters.C
- the default definitions can be overwrite by the user in the following file:
$USER/.gwosc
Examples
- The following command launch a full GW150914 analysis -> frames + dq + clean + create + files + ced:
cwb_gwosc GW=GW150914 all- The following command launch a full GW150914 setup -> frames + dq + clean + create + files:
cwb_gwosc GW=GW150914 setup- The following command download GW150914 frames:
cwb_gwosc GW=GW150914 frames- for frames @ 4KHZcwb_gwosc GW=GW150914 SR=16 frames- for frames @ 16KHZ- The following command download GW150914 data quality data:
cwb_gwosc GW=GW150914 dq- The following command produces the GW150914 setup files into the working directory:
cwb_gwosc GW=GW150914 files- for frames @ 4KHZcwb_gwosc GW=GW150914 SR=16 files- for frames @ 16KHZ- The following commands produce the GW150914 CED:
cwb_gwosc GW=GW150914 ced- for frames @ 4KHZcwb_gwosc GW=GW150914 SR=16 ced- for frames @ 16KHZ- The following commands launch the GW150914 analyis:
cwb_gwosc GW=GW150914 analysis- for frames @ 4KHZcwb_gwosc GW=GW150914 SR=16 analysis- for frames @ 16KHZ- The following command produces the GW150914 skymap plots -> linked to CED www page:
cwb_gwosc GW=GW150914 skymap- The following command display the GW150914 PSD of H1 strain:
cwb_gwosc GW=GW150914 GW=GW150914 IFO=H1 psd- The following command display the GW150914 PSD of H1 whitened strain:
cwb_gwosc GW=GW150914 GW=GW150914 IFO=H1 wpsd- The following command display the GW150914 time frequency map of H1 whitened strain:
cwb_gwosc GW=GW150914 GW=GW150914 IFO=H1 tf- The following command display the GW150914 max energy time frequency map of H1:
cwb_gwosc GW=GW150914 GW=GW150914 IFO=H1 LEVEL=5 emax- The following command display the GW150914 the sparse map of H1:
cwb_gwosc GW=GW150914 GW=GW150914 IFO=H1 sparse