Full API Directory

This page is a quick module-by-module directory for the repository API.

Pipeline module directory

Module	Purpose
triggers_single_detector_HM	Single-detector triggering engine and trigger lifecycle.
data_operations	PSD estimation, whitening, line/hole/glitch processing.
coincidence_HM	Multi-detector coincidence, vetoing, and candidate output.
coherent_score_hm_search	HM coherent score marginalization implementation.
coherent_score_mz_fast	Fast/legacy coherent-scoring support utilities.
ranking_HM	Candidate aggregation and ranking logic.
template_bank_generator_HM	HM template bank and subbank generation/usage.
template_bank_params_O3a_HM	O3a/O3b HM bank hyperparameter definitions.
triggering_on_cluster	Cluster submission and run-management helpers.
gw_detect_file	CLI entrypoint for per-file trigger generation.
utils	Shared utility and path/run helpers.
python_utils	Low-level Python/numeric helper functions.
readligo	LIGO frame/HDF5 loading and segment utilities.
download_data	GWOSC download helper utilities.
ML_modules	Optional ML modules for priors/posteriors.
params	Global pipeline constants and thresholds.