API Tree

This API is organized as a navigation tree:

1. Module pages

2. Per-module tables for top-level functions and classes

3. Per-class tables for methods

4. Per-callable pages with signature, input variables, and output variables

Modules

Module	Purpose
ML_modules	Optional ML prior/posterior helpers used by ranking/scoring stages.
coherent_score_hm_search	Coherent score marginalization routines for HM searches.
coherent_score_mz_fast	Fast and legacy coherent-scoring support utilities.
coincidence_HM	Multi-detector coincidence, vetoing, and candidate output logic.
data_operations	PSD estimation, whitening, and glitch/line mitigation utilities.
download_data	GWOSC data download helpers.
gw_detect_file	CLI entry points for per-file single-detector trigger generation.
params	Global constants and threshold parameters used across the pipeline.
python_utils	Numeric and Python utility helpers shared across modules.
ranking_HM	Candidate aggregation, reweighting, and ranking logic.
readligo	LIGO frame/HDF5 loading and segment-manipulation helpers.
template_bank_generator_HM	HM template-bank generation and basis-coefficient utilities.
template_bank_params_O3a_HM	Template-bank hyperparameter settings for observing runs.
triggering_on_cluster	Cluster submission and trigger-run orchestration helpers.
triggers_single_detector_HM	Single-detector triggering engine and trigger lifecycle.
utils	Cross-cutting utility functions and run/path helpers.