cwb_gwosc¶

This page provides a description of the cwb_gwosc command.

Usage

This command is used to retrive and analyze GWOSC catalog events from O1, O2 and O3a/O3b

https://www.gw-openscience.org/eventapi/html/GWTC/

Syntax

cwb_gwosc (without arguments)

Prints help

cwb_gwosc GW=GWyymmdd action [options]

Executes ‘action’ on GWyymmdd event

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 with LH Network:  GW150914 GW151012 GW151226

             O2 Events with LH Network:  GW170104 GW170608 GW170729 GW170809
                                         GW170814 GW170817 GW170818 GW170823

             O2 Events with LHV Network: GW170729 GW170809 GW170814 GW170817 GW170818

             NOTE: GW170817 event includes the L1 glitch -> is not detected by cWB

             O3a Events with LH/LHV Network: GW190408_181802 GW190412        GW190421_213856 GW190503_185404
                                             GW190512_180714 GW190513_205428 GW190517_055101 GW190519_153544
                                             GW190521        GW190521_074359 GW190602_175927 GW190701_203306
                                             GW190706_222641 GW190707_093326 GW190727_060333 GW190728_064510
                                             GW190814        GW190828_063405 GW190828_065509 GW190915_235702

             O3b Events with LH Network:     GW191109_010717 GW191204_171526 GW191222_033537 GW200128_022011
                                             GW200225_060421

             O3b Events with HV Network:     GW200129_065458

             O3b Events with LHV Network:    GW191127_050227 GW191215_223052 GW191230_180458 GW200208_130117
                                             GW200209_085452 GW200216_220804 GW200219_094415 GW200224_222234
                                             GW200311_115853

action =     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

             frdisplay : display IFO Time-Frequency spectromram using frdisplay tool
                         NOTE: before this command the setup, frames 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, frdisplay
                         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)

             DIR       : DIR=$HOME/waveburst/GWOSC/catalog/GWTC-1-confident (default) : select a user define output path
                         EX: cwb_gwosc GW=GW150914 DIR=$HOME/waveburst/GWOSC/catalog/GWTC-1-myconfident
                             output working dir is $HOME/waveburst/GWOSC/catalog/GWTC-1-myconfident/GW150914/GWOSC_LH_GW150914_R1_run1

             TAG       : TAG=run1 (default) : select a user tag for the working directory name
                         EX: cwb_gwosc GW=GW150914 TAG=myrun1
                             output working dir is $HOME/waveburst/GWOSC/catalog/GWTC-1/GW150914-confident/GWOSC_LH_GW150914_R1_myrun1

             CFG       : CFG=$HOME_CWB/macros/gwosc_parameters.C (default) : select a user defined user_parameters.C file
                         EX: cwb_gwosc GW=GW150914 CFG=mypath/myuser_parameters.C

             SIM       : SIM=false(default), true : select to execute the cWB reconstruction on GW real data (false) or on simulated data (true)
                         Ex: cwb_gwosc GW=GW150914 SIM=true all
                             see the full description below in the list of examples

Note

the GWOSC default definitions are:
- GWOSC catalog event frames
  - ALL -> GWOSC_URL = https://www.gw-openscience.org/eventapi/html/
  - O1/O2 -> GWOSC_URL = https://www.gw-openscience.org/catalog/GWTC-1-confident
  - O3a -> GWOSC_URL = https://www.gw-openscience.org/eventapi/html/GWTC-2
  - O3b -> GWOSC_URL = https://www.gw-openscience.org/eventapi/html/GWTC-3-confident/
- GWOSC O1/O2/O3a/O3b catalog event data quality segments
  - GWOSC_DQ = https://www.gw-osc.org/timeline/segments
- GWOSC parameter-estimation (PE) posteriors samples
  - O1/O2 -> GWOSC_PE = https://dcc.ligo.org/public/0157/P1800370/005
  - O3a -> GWOSC_PE = https://dcc.ligo.org/LIGO-P2000223/public
  - O3b -> GWOSC_PE = https://zenodo.org/record/5546663/files
- GWOSC the power spectral densities (PSDs)
  - O1/O2 -> GWOSC_PSD = https://dcc.ligo.org/public/0158/P1900011/001
  - O3a -> are included in the PE h5 files
  - O3b -> are included in the PE h5 files
- GWOSC default local working directory
  - GWOSC_DIR = $(HOME)/GWOSC/catalog/GWTC-1-confident
- GWOSC default user_parameters.C configuration files are (selected according to the event name):
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_lh_gwtc-1.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_lhv_gwtc-1.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_gw170817_lh_gwtc-1.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_gw170817_lhv_gwtc-1.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_bbh_lh_gwtc-2.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_bbh_lhv_gwtc-2.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_imbhb_lh_gwtc-2.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_imbhb_lhv_gwtc-2.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_bbh_hv_gwtc-3.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_bbh_lh_gwtc-3.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_bbh_lhv_gwtc-3.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_imbhb_lh_gwtc-3.C
  - GW_CONFIG_FILE = $(HOME_CWB)/gwosc/gwosc_parameters_imbhb_lhv_gwtc-3.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 analysis on simulated data. This instruction downloads from GWOSC the PSDs and the PE posterior samples for GW150914. Next, the PSDs are used to simulate a stationary colored Gaussian noise and a random PE sample waveform is added to the data. Finally, cWB runs as in the previous example and reports the results on a CED. With this simulation we can also compare injected and reconstructed waveforms in both time and frequency domain :

cwb_gwosc GW=GW150914 SIM=true all

The following command launch a full GW170814 analysis with LHV net -> frames + dq + clean + create + files + ced:

cwb_gwosc GW=GW170814 IFO=V1 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 @ 4KHZ

cwb_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 @ 4KHZ

cwb_gwosc GW=GW150914 SR=16 files - for frames @ 16KHZ

The following commands produce the GW150914 CED:

cwb_gwosc GW=GW150914 ced - for frames @ 4KHZ

cwb_gwosc GW=GW150914 SR=16 ced - for frames @ 16KHZ

The following commands launch the GW150914 analyis:

cwb_gwosc GW=GW150914 analysis - for frames @ 4KHZ

cwb_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 sparse map of H1:

cwb_gwosc GW=GW150914 GW=GW150914 IFO=H1 sparse

The following command display the GW150914 time-frequency spectrogram of H1 using frdisplay tool:

cwb_gwosc GW=GW150914 GW=GW150914 IFO=H1 frdisplay

The following command launch a full GW190521 analysis -> frames + dq + clean + create + files + ced. The working directory is created here: $HOME/GWOSC/catalog/GWTC-2-confident/GW190521/GWOSC_LH_GW190521_R1_IMBHB.

cwb_gwosc GW=GW190521 TAG=IMBHB DIR=$HOME/GWOSC/catalog/GWTC-2-confident all

The following command launch a full GW190521 analysis with LHV net -> frames + dq + clean + create + files + ced:

cwb_gwosc GW=GW190521 IFO=V1 TAG=IMBHB DIR=$HOME/GWOSC/catalog/GWTC-2-confident all

The following command launch a full GW150914 analysis on simulated data.

cwb_gwosc GW=GW190521 SIM=true TAG=IMBHB DIR=$HOME/GWOSC/catalog/GWTC-2-confident all