diff --git a/docs/workflow/pycbc_make_offline_search_workflow.rst b/docs/workflow/pycbc_make_offline_search_workflow.rst index 1b8e17ede9d..53366262dcd 100644 --- a/docs/workflow/pycbc_make_offline_search_workflow.rst +++ b/docs/workflow/pycbc_make_offline_search_workflow.rst @@ -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`` @@ -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`. 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 `_. 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``. ::