|

cwb_report
~~~~~~~~~~~~~~~~

|
| **Usage**
|
| This command produces background and simulation `web pages <#web-pages>`__. 
  It needs a properly configured 
  `user\_pparameters.C <#user_pparameters_002eC>`__ file.
|
| **Syntax**
|

 - ``cwb_report label action [option] user_parameters_file(optional) user_pparameters_file(optional)``

  - **label** same label for the data, just like cwb_merge and cwb_setveto commands
  - **action** :

   -  **create** create a (simulation or background) report
   -  **pe** create a parameter-estimation report (simulation reports only)
   -  **skymap** create a skymap-statistics report (by using
      https://github.com/reedessick/skymap\_statistics)
   -  **list** merge/report list the labels of ROOT files/web pages
   -  **loudest** create condor dagman (dag + sub files) for the loudest events
      list produced by the background report (see **options loudest**)

 - **option** specify lag(s) and superlag(s) (background reports only)

   -  **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 (background reports only)

   -  **-evt** set the number of loudest events to be processed
      (-nevt 0 : no limit) [default = pp\_max\_nloudest\_list]
   -  **rho** set the rho threshold above which events will be selected 
      (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 directory name, which 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)

 
|
| **Examples**
|

 .. code-block:: bash

    * cwb_report M1 create
      it creates a report page, background or simulation, depending from the value of the "simulation" 
      variable in user_parameters.C file (1=True; 0=False, hence background).

    * background and zero-lag examples
      cwb_report M1 create     ->  report for background (lag>0 & slag>=0)
      cwb_report M1 create N M ->  report for background (lag=N & slag=M)
      cwb_report M1 create 0 0 ->  report for zero lag

    * loudest examples (background only)
      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 to:

        - rho[pp_irho]>7.5 
        - events are not vetoed by the post-production vetoes 
        - output directory name = loud_rho1_gt_7d5  
          is created under the dir report/postprod/report_dir/
        - it uses config/user_parameters_WavePeaks.C
        - nevt=0 : there are no limit on the number of selected events

      The dag,sub condor files are produced under the condor directory. 

    * cwb_report M1 pe
      it creates the report page for Parameter-Estimation (simulation only).


    * cwb_report skymap ced_dir/skyprobcc.fits          
      it creates the web page for skymap-statistics (point estimate) : ced_dir/skyprobcc

      The symbolic index file is copied to ced_dir and 
      a 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
      it creates the web page for skymap-statistics (median) : ced_dir/mskyprobcc

      The symbolic index file is copied to ced_dir and 
      a 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' 
      it creates the web page for comparison skymap-statistics (point estimate vs median) : ced_dir/cskyprobcc

      The symbolic index file is copied to ced_dir and 
      a 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/