Maintenance will be performed on git.ligo.org, chat.ligo.org, containers.ligo.org, and docs.ligo.org on Tuesday 26 May 2020 starting at approximately 10am CDT. It is expected to take around 30 minutes and will involve a short period of downtime, around 5 minutes, towards the end of the maintenance period. Please address any questions, comments, or concerns to uwm-help@cgca.uwm.edu.

Commit 9c343a38 authored by Leo Pound Singer's avatar Leo Pound Singer

Update documentation about preferred event criterion

See gwcelery!579.
parent b8be9e40
......@@ -21,14 +21,20 @@ Selection of the Preferred Event
When multiple online searches report events at the same time, the preferred
event is decided by applying the following rules, in order:
1. An event detected in multiple interferometers is preferred over an
event from a single interferometer.
2. An event from modeled :term:`CBC` searches are preferred over an event from
1. An event from modeled :term:`CBC` searches are preferred over an event from
unmodeled Burst searches (see :doc:`Searches </analysis/searches>` for
details on search pipelines).
3. In the case of multiple CBC events, the event with the highest :term:`SNR`
is preferred. In the case of multiple Burst events, the event with the
lowest false alarm rate (FAR) is preferred.
2. In the case of multiple CBC events, three-interferometer events are
preferred over two-interferometer events, and two-interferometer events are
preferred over single-interferometer events.
3. In the case of multiple CBC events with the same number of participating
interferometers, the event with the highest :term:`SNR` is preferred. In the
case of multiple Burst events, the event with the lowest false alarm rate
(FAR) is preferred.
See also the :ref:`preferred event selection flow chart
<gwcelery.tasks.superevents:Selection of the preferred event>` in our software
documentation.
.. note::
* A Preliminary GCN is automatically issued for superevents when the false
......
......@@ -12,6 +12,11 @@ Version 11 (unreleased)
.. rubric:: Data Analysis
* Update the documentation about superevents describing the criteria by which
the preferred event is selected. For CBC events, events with three detectors
are preferred over two detectors, and events with two detectors are
preferred over events with one detector.
.. rubric:: Alert Contents
.. rubric:: Sample Code
......
......@@ -42,6 +42,7 @@ version = parse_version(release).base_version
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autosectionlabel',
'sphinx.ext.doctest',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
......@@ -179,6 +180,11 @@ texinfo_documents = [
# -- Extension configuration -------------------------------------------------
# -- Options for autosectionlabel extension -------------------------------
autosectionlabel_prefix_document = True
# -- Options for extlinks extension ------------------------------------------
extlinks = {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment