coincidence_HM.combine_files_npz#

Back to Module page

Summary#

Combines files that were read in using collect_files_npz

Signature#

def combine_files_npz(candidate_info, apply_vetoes = False)
Input variables#

Name

Type

Default

Description

candidate_info

(possibly empty) List of (possibly empty) n_files read in

apply_vetoes

False

Flag to enforece vetoes when saving candidates

Output variables#

Return annotation

Docstring type

Description

None

Combined candidate info, in the form of a list with the elements being candidates, veto_metadata, coherent score (+timeseries) if asked for, with vetoes applied if needed

Docstring#

Combines files that were read in using collect_files_npz
:param candidate_info:
    (possibly empty) List of (possibly empty) n_files read in
:param apply_vetoes: Flag to enforece vetoes when saving candidates
:return:
    Combined candidate info, in the form of a list with the elements being
    candidates, veto_metadata, coherent score (+timeseries) if asked for,
    with vetoes applied if needed