ranking_HM.collect_all_subbanks
===============================

Back to :doc:`Module page <../modules/ranking_HM>`

Summary
-------

No docstring summary available.

Signature
---------

.. code-block:: python

   def collect_all_subbanks(cand_dirs, chirp_mass_id, subbank_subset = None, snr2min = None, snr2min_marg = None, snr2sumcut = None, max_time_slide_shift = None, minimal_time_slide_jump = 0.1, max_zero_lag_delay = 0.015, score_reduction_max = 5, collect_rerun = False, collect_before_veto = True, collect_timeseries = False, coinc_ftype = 'npz', detectors = ('H1', 'L1'), ncores = 1, trigger_objs = None)

.. list-table:: Input variables
   :header-rows: 1

   * - Name
     - Type
     - Default
     - Description
   * - ``cand_dirs``
     - -
     - -
     - -
   * - ``chirp_mass_id``
     - -
     - -
     - -
   * - ``subbank_subset``
     - -
     - None
     - -
   * - ``snr2min``
     - -
     - None
     - -
   * - ``snr2min_marg``
     - -
     - None
     - -
   * - ``snr2sumcut``
     - -
     - None
     - -
   * - ``max_time_slide_shift``
     - -
     - None
     - -
   * - ``minimal_time_slide_jump``
     - -
     - 0.1
     - -
   * - ``max_zero_lag_delay``
     - -
     - 0.015
     - -
   * - ``score_reduction_max``
     - -
     - 5
     - -
   * - ``collect_rerun``
     - -
     - False
     - -
   * - ``collect_before_veto``
     - -
     - True
     - -
   * - ``collect_timeseries``
     - -
     - False
     - -
   * - ``coinc_ftype``
     - -
     - 'npz'
     - -
   * - ``detectors``
     - -
     - ('H1', 'L1')
     - -
   * - ``ncores``
     - -
     - 1
     - -
   * - ``trigger_objs``
     - -
     - None
     - -

Output variables
----------------

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

   * - Return annotation
     - Docstring type
     - Description
   * - ``None``
     - -
     - -

Docstring
---------

No docstring text available.