Skip to content

Commit

Permalink
Fix errors in the tables
Browse files Browse the repository at this point in the history
  • Loading branch information
GarethCabournDavies committed Mar 12, 2024
1 parent 3210fe7 commit fec0f4b
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions docs/workflow/pycbc_make_offline_search_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,7 @@ How triggers are ranked is defined by the ranking-statistic, sngl-ranking, stati
.. list-table:: Ranking Statistic
:widths: 25 75
:header-rows: 1

* - Statistic name
- Description
* - ``quadsum``
Expand Down Expand Up @@ -357,20 +358,20 @@ How triggers are ranked is defined by the ranking-statistic, sngl-ranking, stati
:widths: 25 75
:header-rows: 1

* - Keyword
- Description
* - ``benchmark_lograte``
- This is a numerical factor to be subtracted from the log rate ratio in order to alter the dynamic range. Default -14.6.
* - ``minimum_statistic_cutoff``
- Cutoff for the statistic in order to avoid underflowing and very small statistic values. Default -30.
* - ``alpha_below_thresh``
- The fit coefficient (alpha) below the fit threshold (defined in the fit_by_template jobs) will be replaced by a standard value. This is as below this threshold, Gaussian noise can dominate over the glitch response that dominates above the threshold, and rates will be underestimated, boosting quiet things in noisy templates. For Gaussian noise, this will be approximately 6 (the default). To use whatever the fit value is, supply alpha_below_thresh:None.
* - ``reference_ifos``
- If using the ``sensitive_volume``feature, these are the detectors used to determine the benchmark value by which the sensitive volume is compared. We use the median sensitive volume in the network of detectors supplied. Default H1,L1.
* - ``max_chirp_mass``
- If using the ``chirp_mass`` feature, this chirp mass defines a maximum weighting which can be applied to the statistic.
* - ``sngl_ranking_*``
- This is used to provide the keyword arguments to functions in :xref:`the events.ranking module<https://pycbc.org/pycbc/latest/html/_modules/pycbc/events/ranking.html>`. For example, to use a different psdvar threshold in the newsnr_sgveto_psdvar_threshold function, we would use ``sngl_ranking_psd_var_val_threshold:10``.
* - Keyword
- Description
* - ``benchmark_lograte``
- This is a numerical factor to be subtracted from the log rate ratio in order to alter the dynamic range. Default -14.6.
* - ``minimum_statistic_cutoff``
- Cutoff for the statistic in order to avoid underflowing and very small statistic values. Default -30.
* - ``alpha_below_thresh``
- The fit coefficient (alpha) below the fit threshold (defined in the fit_by_template jobs) will be replaced by a standard value. This is as below this threshold, Gaussian noise can dominate over the glitch response that dominates above the threshold, and rates will be underestimated, boosting quiet things in noisy templates. For Gaussian noise, this will be approximately 6 (the default). To use whatever the fit value is, supply alpha_below_thresh:None.
* - ``reference_ifos``
- If using the ``sensitive_volume`` feature, these are the detectors used to determine the benchmark value by which the sensitive volume is compared. We use the median sensitive volume in the network of detectors supplied. Default H1,L1.
* - ``max_chirp_mass``
- If using the ``chirp_mass`` feature, this chirp mass defines a maximum weighting which can be applied to the statistic.
* - ``sngl_ranking_*``
- This is used to provide the keyword arguments to functions in `the events.ranking module <https://pycbc.org/pycbc/latest/html/_modules/pycbc/events/ranking.html>`_. For example, to use a different psdvar threshold in the newsnr_sgveto_psdvar_threshold function, we would use ``sngl_ranking_psd_var_val_threshold:10``.

::

Expand Down

0 comments on commit fec0f4b

Please sign in to comment.