coherent_score_hm_search
========================

Back to :doc:`API tree index <../index>`

Purpose
-------

Coherent score marginalization routines for HM searches.

Module summary
--------------

Define class \\\`\\\`SearchCoherentScoreHMAS\\\`\\\` that computes the coherent score (marginalized likelihood over extrinsic parameters) for aligned-spin, (l,m) = [(2, 2), (3, 3), (4, 4)] waveforms.

.. list-table:: Top-level functions
   :header-rows: 1

   * - Function
     - Summary
   * - :doc:`compute_coherent_scores <../functions/coherent_score_hm_search.compute_coherent_scores>`
     - -
   * - :doc:`compute_coherent_scores_new <../functions/coherent_score_hm_search.compute_coherent_scores_new>`
     - -
   * - :doc:`create_mode_ratios_qm_subbank <../functions/coherent_score_hm_search.create_mode_ratios_qm_subbank>`
     - No docstring summary available.
   * - :doc:`create_mode_ratios_qm_subbank_new <../functions/coherent_score_hm_search.create_mode_ratios_qm_subbank_new>`
     - No docstring summary available.
   * - :doc:`initialize_cs_instance <../functions/coherent_score_hm_search.initialize_cs_instance>`
     - No docstring summary available.

.. list-table:: Classes
   :header-rows: 1

   * - Class
     - Summary
   * - :doc:`SearchCoherentScoreHMAS <../classes/coherent_score_hm_search.SearchCoherentScoreHMAS>`
     - Class to marginalize the likelihood over extrinsic parameters, intended for the search pipeline.

.. toctree::
   :hidden:
   :maxdepth: 1

   ../classes/coherent_score_hm_search.SearchCoherentScoreHMAS
   ../functions/coherent_score_hm_search.compute_coherent_scores
   ../functions/coherent_score_hm_search.compute_coherent_scores_new
   ../functions/coherent_score_hm_search.create_mode_ratios_qm_subbank
   ../functions/coherent_score_hm_search.create_mode_ratios_qm_subbank_new
   ../functions/coherent_score_hm_search.initialize_cs_instance