omicron-print.cc File Reference

Program to print omicron triggers. More...

#include <ReadTriggers.h>
#include "OmicronUtils.h"

Include dependency graph for omicron-print.cc:

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

Detailed Description

Program to print omicron triggers.

omicron-print is a command line program to print the list of omicron triggers from trigger files. The program must be given a minimum set of options:

omicron-print channel=[channel name] gps-start=[GPS start] gps-end=[GPS end]

This command prints the list of omicron triggers of a given channel between 2 GPS times. This command assumes that omicron trigger root files are saved in a standard place pointed by the environement variables $OMICRON_TRIGGERS and $OMICRON_TRIGGERS_ONLINE.

One can also print triggers from a list of root files with:

 omicron-print file=[trigger file pattern] gps-start=[GPS start] gps-end=[GPS end]

where [trigger file pattern] can contain wild cards. For example: file="/path1/to/triggers/*.root /path2/to/triggers/*.root". This method is the correct way to access triggers that you generate yourself. It is bad practice to modify the default environement variables $OMICRON_TRIGGERS and $OMICRON_TRIGGERS_ONLINE.

The omicron-print command comes with many additional options. Type omicron-print to get the full list of options. In particular, triggers can be filtered in frequency, snr and so on. You can also select the trigger parameters to print.

  cerr<<endl;
  cerr<<"Usage:"<<endl;
  cerr<<endl;
  cerr<<"omicron-print channel=[channel name] \\"<<endl;
  cerr<<"              file=[trigger file pattern] \\"<<endl;
  cerr<<"              gps-start=[GPS start] \\"<<endl;
  cerr<<"              gps-end=[GPS end] \\"<<endl;
  cerr<<"              snr-min=[minimum SNR] \\"<<endl;
  cerr<<"              snr-max=[maximum SNR] \\"<<endl;
  cerr<<"              freq-min=[minimum frequency] \\"<<endl;
  cerr<<"              freq-max=[maximum frequency] \\"<<endl;
  cerr<<"              q-min=[minimum Q] \\"<<endl;
  cerr<<"              q-max=[maximum Q] \\"<<endl;
  cerr<<"              print=[output type] \\"<<endl;
  cerr<<"              cluster-dt=[cluster time window] \\"<<endl;
  cerr<<"              print-time=[1/0] \\"<<endl;
  cerr<<"              print-freq=[1/0] \\"<<endl;
  cerr<<"              print-snr=[1/0] \\"<<endl;
  cerr<<"              print-q=[1/0] \\"<<endl;
  cerr<<"              print-amplitude=[1/0] \\"<<endl;
  cerr<<"              print-phase=[1/0] \\"<<endl;
  cerr<<"              print-time-start=[1/0] \\"<<endl;
  cerr<<"              print-time-end=[1/0] \\"<<endl;
  cerr<<"              print-freq-start=[1/0] \\"<<endl;
  cerr<<"              print-freq-end=[1/0] \\"<<endl;
  cerr<<"              print-duration=[1/0] \\"<<endl;
  cerr<<"              print-bandwidth=[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"<<endl;
  cerr<<"[maximum SNR]             maximum SNR value"<<endl;
  cerr<<"[minimum frequency]       minimum frequency value [Hz]"<<endl;
  cerr<<"[maximum frequency]       maximum frequency value [Hz]"<<endl;
  cerr<<"[minimum Q]               minimum Q value"<<endl;
  cerr<<"[maximum Q]               maximum Q value"<<endl;
  cerr<<"[output type]             \"triggers\", \"clusters\" or \"segments\". By default, print=\"clusters\""<<endl;
  cerr<<"[cluster time window]     cluster time window [s]. By default, cluster-dt=0.1"<<endl;
  cerr<<endl;
  cerr<<"For \"print-\" options, 1=yes and 0=no."<<endl;
  cerr<<endl;
  cerr<<"See also: https://virgo.docs.ligo.org/virgoapp/Omicron/omicron-print_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-print-usage]

[omicron-print-usage]