Omicron  4.2.0
An algorithm to detect and characterize transient events in gravitational-wave detectors
Functions
omicron-coinc.cc File Reference

Program to compare two omicron trigger sets. More...

#include <ReadTriggers.h>
#include <Coinc2.h>
#include "OmicronUtils.h"
Include dependency graph for omicron-coinc.cc:

Functions

int main (int argc, char *argv[])
 Main program. More...
 
void PrintUsage (void)
 Print the program usage message. More...
 

Detailed Description

Program to compare two omicron trigger sets.

Usage

omicron-coinc is a command line program to compare two trigger sets. A time coincidence between the 2 trigger sets is performed. By default the list of coincident events is printed in the standard output. For example: 

omicron-coinc channel1=[channel name] channel2=[channel name] gps-start=[GPS start] gps-end=[GPS end]

This command assumes that omicron trigger root files are saved in a standard place pointed by the environement variable $OMICRON_TRIGGERS. It is also possible to use specific trigger files: 

omicron-coinc file1=[trigger file pattern] file2=[trigger file pattern] gps-start=[GPS start] gps-end=[GPS end]

where [trigger file pattern] can contain wild cards. For example: file1="/path1/to/triggers/*.root /path2/to/triggers/*.root".

Additionnally, one can print the triggers which are not found in coincidence. For example, for the first trigger set: 

omicron-coinc channel1=[channel name] channel2=[channel name] gps-start=[GPS start] gps-end=[GPS end] print-list-nocoinc1=1

It is also possible to print diagnostic plots with the option: print-plot-coinc=1.

Example 1

Let's perform the coincidence between 2 channels (V1:LSC_DARM and V1:Hrec_hoft_16384Hz) over 6 hours of data: 

omicron-coinc channel1=V1:LSC_DARM channel2=V1:Hrec_hoft_16384Hz gps-start=1266969618 gps-end=1266991218

*********************************************************************
coinc_0
  V1:LSC_DARM: t=1266970234.90625 s, f=3.34949 Hz, snr=9.01751
  V1:Hrec_hoft_16384Hz: t=1266970234.95312 s, f=149.80423, snr=8.09652
*********************************************************************
...
*********************************************************************
coinc_15
  V1:LSC_DARM: t=1266988209.89355 s, f=1887.11766 Hz, snr=7.54301
  V1:Hrec_hoft_16384Hz: t=1266988209.89160 s, f=1914.72933, snr=7.78166
*********************************************************************
Valid livetime                         = 21592.00000 s
Coincident livetime                    = 21592.00000 s
Number of valid clusters for channel 1 = 78
Number of valid clusters for channel 2 = 91
Number of coinc clusters               = 16

In this example, 16 clusters are found in coincidence out of 78 for V1:LSC_DARM and out of 91 for V1:Hrec_hoft_16384Hz. The parameters for these events are printed for both channels.

Example 2

Let's perform the coincidence between 2 channels (V1:LSC_DARM and V1:Hrec_hoft_16384Hz) over 6 hours of data: 

omicron-coinc channel1=V1:LSC_DARM channel2=V1:Hrec_hoft_16384Hz gps-start=1266969618 gps-end=1266991218 print-list-coinc=0 print-list-nocoinc1=1

V1:LSC_DARM: t=1266970228.17969 s, f=346.09037 Hz, snr=7.00438
V1:LSC_DARM: t=1266970327.68750 s, f=7.95789 Hz, snr=7.72376
...
V1:LSC_DARM: t=1266989603.15137 s, f=1585.80320 Hz, snr=7.80582
V1:LSC_DARM: t=1266990803.54688 s, f=12.36363 Hz, snr=8.17653
Valid livetime                         = 21592.00000 s
Coincident livetime                    = 21592.00000 s
Number of valid clusters for channel 1 = 78
Number of valid clusters for channel 2 = 91
Number of coinc clusters               = 16

In this example, 78-16=62 V1:LSC_DARM clusters are not found in coincidence with V1:Hrec_hoft_16384Hz clusters. The parameters of these events are printed.

Example 3

Let's perform the coincidence between 2 channels (V1:LSC_DARM and V1:Hrec_hoft_16384Hz) over 6 hours of data: 

omicron-coinc channel1=V1:LSC_DARM channel2=V1:Hrec_hoft_16384Hz gps-start=1266969618 gps-end=1266991218 print-list-coinc=0 print-plot-coinc=1

Number of valid clusters for channel 1 = 78
Number of valid clusters for channel 2 = 91
Number of coinc clusters               = 16

In this example, no events are printed. Instead, with the option print-plot-coinc=1, diagnostic plots are produced in the current directory.

Frequency-frequency plot for coincident events.

SNR-SNR plot for coincident events.

SNR-time distribution of V1:LSC_DARM clusters in blue. Coincident events are plotted with red crosses.

Frequency-time distribution of V1:LSC_DARM clusters in blue. Coincident events are plotted with red crosses.

Fraction of coincident events for V1:LSC_DARM as a function of SNR.

Fraction of coincident events for V1:LSC_DARM as a function of frequency.

SNR-time distribution of V1:Hrec_hoft_16384Hz clusters in blue. Coincident events are plotted with red crosses.

Frequency-time distribution of V1:Hrec_hoft_16384Hz clusters in blue. Coincident events are plotted with red crosses.

Fraction of coincident events for V1:Hrec_hoft_16384Hz as a function of SNR.

Fraction of coincident events for V1:Hrec_hoft_16384Hz as a function of frequency.

Options

The omicron-coinc command comes with many additional options. Type omicron-coinc to get the full list of options.

cerr<<endl;
cerr<<"Usage:"<<endl;
cerr<<endl;
cerr<<"omicron-coinc channel1=[channel name] \\"<<endl;
cerr<<" channel2=[channel name] \\"<<endl;
cerr<<" file1=[trigger file pattern] \\"<<endl;
cerr<<" file2=[trigger file pattern] \\"<<endl;
cerr<<" gps-start=[GPS start] \\"<<endl;
cerr<<" gps-end=[GPS end] \\"<<endl;
cerr<<" snr-min1=[minimum SNR] \\"<<endl;
cerr<<" snr-min2=[minimum SNR] \\"<<endl;
cerr<<" cluster-dt=[cluster time window] \\"<<endl;
cerr<<" coinc-dt=[coincidence time window] \\"<<endl;
cerr<<" print-list-coinc=[1/0] \\"<<endl;
cerr<<" print-list-nocoinc1=[1/0] \\"<<endl;
cerr<<" print-list-nocoinc2=[1/0] \\"<<endl;
cerr<<" print-plot-coinc=[1/0]"<<endl;
cerr<<endl;
cerr<<"[channel name] channel name used to retrieve centralized Omicron triggers"<<endl;
cerr<<"[trigger file pattern] file pattern to ROOT trigger files (GWOLLUM convention)"<<endl;
cerr<<"[GPS start] starting GPS time (integer only)"<<endl;
cerr<<"[GPS end] stopping GPS time (integer only)"<<endl;
cerr<<"[minimum SNR] minimum SNR value. Default = 7.0"<<endl;
cerr<<"[cluster time window] cluster time window [s]. By default, cluster-dt=0.1"<<endl;
cerr<<"[coincidence time window] coincidence time window [s]. By default, cluster-dt is used"<<endl;
cerr<<"[1/0] 1=YES, 0=NO"<<endl;
cerr<<endl;
cerr<<"See also: https://virgo.docs.ligo.org/virgoapp/Omicron/omicron-coinc_8cc.html#details"<<endl;
cerr<<endl;
Author
Florent Robinet - florent.robinet@ijclab.in2p3.fr

Function Documentation

◆ main()

int main ( int  argc,
char *  argv[] 
)

Main program.

◆ PrintUsage()

void PrintUsage ( void  )

Print the program usage message.

[omicron-coinc-usage]

[omicron-coinc-usage]