Omicron  4.2.0
An algorithm to detect and characterize transient events in gravitational-wave detectors
Loading...
Searching...
No Matches
omicron-x-event.cc File Reference

Program to display an Ox event in a web report. More...

#include "OxSim.h"
Include dependency graph for omicron-x-event.cc:

Functions

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

Detailed Description

Program to display an Ox event in a web report.

This program generates a web page displaying all the characteristics of an Ox event. An Ox event is defined by three parameters:

  • A start time for the first detector (detector 0). This time is used to set the start time of the Omicron analysis chunk.
  • A start time for the second detector (detector 1). This time is used to set the start time of the Omicron analysis chunk.
  • A slice index which indicates the slice in the cross-correlation map which defines the Ox event.

The Ox analysis is configured with an Ox option file (see OxInit and other Ox classes for the list of options). A single Omicron chunk is analyzed for both detectors. The resulting spectrograms are cross-correlated with the OxCorr engine. The selected event slice properties are then saved, as well as tmie-frequency maps as png files. All the results are displayed in a web page saved in the output directory.

cerr<<endl;
cerr<<"Usage:"<<endl;
cerr<<endl;
cerr<<"omicron-x-event [option file] [GPS 0] ([GPS 1]) ([slice index])"<<endl;
cerr<<endl;
cerr<<"[option file]"<<endl;
cerr<<"Path to the Ox option file"<<endl;
cerr<<endl;
cerr<<"[GPS 0/1]"<<endl;
cerr<<"GPS start time of the Omicron analysis chunk for detector 0 and 1"<<endl;
cerr<<"If [GPS 1] is not provided, use [GPS 1] = [GPS 0]"<<endl;
cerr<<endl;
cerr<<"[slice index]"<<endl;
cerr<<"Slice index in the cross-correlation map. If not given, use the first slice in the map."<<endl;
cerr<<endl;
cerr<<"See also: https://virgo.docs.ligo.org/virgoapp/Omicron/omicron-x-event_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  )

Prints the program usage message.

[omicron-x-event-usage]

[omicron-x-event-usage]