Program to access information about online data quality channels. More...

#include <ffl.h>
#include "VPconfig.h"

Include dependency graph for dq-print.cc:

Functions
int	main (int argc, char *argv[])
	Main program.

int	PrintUsage (void)
	Usage funcion.

Detailed Description

Program to access information about online data quality channels.

Many data quality channels are produced in the DAQ and most of them are saved in the raw data (/virgoData/ffl/raw.ffl). The name of these channels starts by V1:DQ_. Data quality channels usually take discrete values depending on the data quality. For example, FLAG channels take value=1 when the data quality is bad and value=0 when it is good. The dq-print command lists data quality channels taking a given value at a given time: the channel is then said to be "active". It can also prints the list of segments when the channels are active.

Input/Output

The dq-print command must be given a timing and a list of channels. It prints the list of data quality time segments or the list of active channels.

Timing

The timing is specified as a GPS time interval: gps-start → gps-end. This interval can be provided in different ways:

gps-start= and gps-end= are specified explicitly.
A GPS time of interest gps= is specified as well as a (half-)time window dt= (by default dt=5 seconds).
Any combination of the parameters above.

Channels

One or several data quality channels can be provided. If several channels are provided, they will be combined using a OR operation when "segments" are printed.

The list of channels can be specified with the channel= option. With this option, you can list the channel names separated with a space: channel="V1:CHANNEL1 V1:CHANNEL2 V1:CHANNEL3". You can also use patterns: channel="V1:DQ_*_TOTO_* V1:DQ_*_TITI_*". By default, channel="V1:DQ_*_FLAG_* V1:DQ*_VETO_*" is used.

Finally, the list of channels can be provided in a text file with channel-file=. The channel names or patterns are listed in a single column in this file.

A channel is said to be active if it takes a pre-defined value. By default, this value is set to 1. You can change the active value with the active-value= option.

Output

The dq-print command prints the output in the standard output or in a file which must be specified with the output= option.

There are 2 types of output:

A first feature provided by dq-print is to dump the list of time segments when the data quality channel is active. One or several data quality channels can be combined. To print segments, use the print="segments" option in the command line.
Another feature is to print the list of data quality channels which are active. This can be used to study a glitch or to follow-up a gravitational-wave candidate. To activate this feature, use the print="list-active" option in the command line.

If you use the second feature, only active channels are printed. It is possible to print all channels (active or not) with the print="list-all" option.

Running `dq-print`

Use the following command to run dq-print:

dq-print gps=[GPS] channel="V1:CHANNEL1 V1:CHANNEL2 V1:CHANNEL3"

This commands tests whether V1:CHANNEL1, V1:CHANNEL2, or V1:CHANNEL3 is active around a given GPS time.

You can also specify a list of channels matching a pattern:

dq-print gps=[GPS] channel="V1:DQ_*_TOTO_* V1:DQ_*_TITI_*"

Or a file with a list of channels (patterns):

dq-print gps=[GPS] channel-file="myfile.txt"

Options

dq-print comes with many extra options which can be used at the command line. Just type dq-print to get the list of options:

gps=: Specify the GPS time of interest.
gps-start=: Specify the GPS starting time.
gps-end=: Specify the GPS ending time.
dt=: Specify the half time window. By default = 5 seconds.
channel=: Specify the list of channels (names and/or patterns). By default = "V1:DQ_*_FLAG_* V1:DQ*_VETO_*".
channel-file=: Specify the path to a text file listing the channel names and/or patterns.
ffl=: Specify the path to the ffl file where to scan data quality channels. By default = /virgoData/ffl/raw.ffl
active-value=: Specify the active value. By default = 1.
print=: Specify the type of output: "segments" to print segments when at least one channel is active, "list-active" to print the list of active channels, "list-all" to print the list of all channels. By default = "list-active"
output=: Specify the path to the output file. By default, use the standard output.

  cerr<<"dq-print gps=[GPS time] \\"<<endl;
  cerr<<"             gps-start=[GPS start] \\"<<endl;
  cerr<<"             gps-end=[GPS end] \\"<<endl;
  cerr<<"             dt=[half time window] \\"<<endl;
  cerr<<"             channel=[channel name pattern] \\"<<endl;
  cerr<<"             channel-file=[path to channel file] \\"<<endl;
  cerr<<"             ffl=[path to ffl] \\"<<endl;
  cerr<<"             active-value=[active value] \\"<<endl;
  cerr<<"             print=[print type] \\"<<endl;
  cerr<<"             output=[path to output file]"<<endl;
  cerr<<endl;
  cerr<<"[GPS time]             GPS time of interest"<<endl;
  cerr<<"[half time window]     half time window to be applied on both sides of the GPS time of interest [s]. Default dt=5"<<endl;
  cerr<<"[GPS start]            starting GPS time"<<endl;
  cerr<<"[GPS send]             ending GPS time"<<endl;
  cerr<<endl;
  cerr<<"[channel name pattern] filter channel names to consider. The filter string must be a pattern."<<endl;
  cerr<<"                       Default: channel=\"V1:DQ_*_FLAG_* V1:DQ*_VETO_*\""<<endl;
  cerr<<"[path to channel file] path to the file listing channel names."<<endl;
  cerr<<"                       they must be listed in a text file over a single column."<<endl;
  cerr<<"[path to ffl]          path to ffl (or lcf). Default = /virgoData/ffl/raw.ffl"<<endl;
  cerr<<"[active value]         value for the channel to be said \"active\". Default: val=1"<<endl;
  cerr<<endl;
  cerr<<"[print type]           \"segments\": print segments when at least one channel is active"<<endl;
  cerr<<"                       \"list-active\": print list of active channels"<<endl;
  cerr<<"                       \"list-all\": print list of all channels"<<endl;
  cerr<<"                       default: print=\"list-active\""<<endl;
  cerr<<"[path to output file]  path to output file. By default, use standard output."<<endl;

Author: Florent Robinet - florent.robinet@ijclab.in2p3.fr

Function Documentation

◆ main()

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

Main program.

◆ PrintUsage()

int PrintUsage ( void )

Usage funcion.

[dq-print-usage]

Functions