HVeto task

Work in progress

Requirements

Description

Example command-line

This is the help message:

$ dqr-hveto --help
usage: dqr-hveto [-h] [-V] -i IFO [-j NPROC] [-t GPS_TIME] [-d EVENT_DURATION]
                 [-e EVENT_PADDING] [-a ANALYSIS_DURATION]
                 [-p ANALYSIS_PADDING] [-f CONFIG_FILE]
                 [--pvalue-threshold PVALUE_THRESHOLD] [-o OUTPUT_DIRECTORY]

Run the HierarchichalVeto (hveto) algorithm for an event

optional arguments:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  -i IFO, --ifo IFO     IFO prefix for this analysis, default: None
  -j NPROC, --nproc NPROC
                        the number of processes to use when reading data,
                        default: 1
  -t GPS_TIME, --gps-time GPS_TIME
                        path to hveto configuration file, can be given
                        multiple times (files read in order)
  -d EVENT_DURATION, --event-duration EVENT_DURATION
                        path to hveto configuration file, can be given
                        multiple times (files read in order)
  -e EVENT_PADDING, --event-padding EVENT_PADDING
                        path to hveto configuration file, can be given
                        multiple times (files read in order)
  -a ANALYSIS_DURATION, --analysis-duration ANALYSIS_DURATION
                        path to hveto configuration file, can be given
                        multiple times (files read in order)
  -p ANALYSIS_PADDING, --analysis-padding ANALYSIS_PADDING
                        path to hveto configuration file, can be given
                        multiple times (files read in order)
  -f CONFIG_FILE, --config-file CONFIG_FILE
                        path to hveto configuration file, can be given
                        multiple times (files read in order)
  --pvalue-threshold PVALUE_THRESHOLD
                        p-value threshold to decide if additional suggested
                        actions should be added to the results message

Output options:
  -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
                        path of output directory, default: .

Example config

[hveto]
description =  hierarchical veto task
librarian = detchar@ligo.org
include_in_dag = True
tier = 1
question = Are known sources of noise without auxiliary witnesses active?
executable = dqr-hveto
request_memory = 400MB
arguments = "  -i L1 --nproc 4 --gps-time ${t_0} --event-duration 2 --event-padding 1 --analysis-padding 10 --analysis-duration 1000 --config-file hveto_config.ini"

Note that this task requires an additional config file for the included HVeto analysis.

Example results page

An example page for GW170817 can be found here.