# Copyright (C) 2020 Max Trevor and Derek Davis
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 3 of the License, or (at your
# option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
# Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# =============================================================================
#
# Preamble
#
# =============================================================================
#
import logging
from pycbc.workflow.core import (FileList, Executable, Node, make_analysis_dir)
logger = logging.getLogger('pycbc.workflow.dq')
[docs]class PyCBCBinTemplatesDQExecutable(Executable):
current_retention_level = Executable.MERGED_TRIGGERS
[docs] def create_node(self, workflow, ifo, template_bank_file):
node = Node(self)
node.add_opt('--ifo', ifo)
node.add_input_opt('--bank-file', template_bank_file)
node.new_output_file_opt(
workflow.analysis_time, '.hdf', '--output-file')
return node
[docs]class PyCBCBinTriggerRatesDQExecutable(Executable):
current_retention_level = Executable.MERGED_TRIGGERS
[docs] def create_node(self, workflow, flag_file, flag_name,
analysis_segment_file, analysis_segment_name,
trig_file, template_bins_file):
node = Node(self)
node.add_input_opt('--template-bins-file', template_bins_file)
node.add_input_opt('--trig-file', trig_file)
node.add_input_opt('--flag-file', flag_file)
node.add_opt('--flag-name', flag_name)
node.add_input_opt('--analysis-segment-file', analysis_segment_file)
node.add_opt('--analysis-segment-name', analysis_segment_name)
node.new_output_file_opt(workflow.analysis_time, '.hdf',
'--output-file')
return node
[docs]def setup_dq_reranking(workflow, insps, bank,
analyzable_seg_file,
analyzable_name,
dq_seg_file,
output_dir=None, tags=None):
logger.info("Setting up dq reranking")
make_analysis_dir(output_dir)
output_files = FileList()
output_labels = []
if tags is None:
tags = []
dq_labels = workflow.cp.get_subsections('workflow-data_quality')
dq_ifos = {}
dq_names = {}
dq_types = {}
for dql in dq_labels:
dq_ifos[dql] = workflow.cp.get_opt_tags(
'workflow-data_quality', 'dq-ifo', [dql])
dq_names[dql] = workflow.cp.get_opt_tags(
'workflow-data_quality', 'dq-name', [dql])
dq_types[dql] = workflow.cp.get_opt_tags(
'workflow-data_quality', 'dq-type', [dql])
ifos = set(dq_ifos.values())
for ifo in ifos:
# get the dq label, type, and name for this ifo
ifo_dq_labels = [dql for dql in dq_labels if (dq_ifos[dql] == ifo)]
assert len(ifo_dq_labels) < 2, f"Received multiple dq files for {ifo}"
dq_label = ifo_dq_labels[0]
dq_name = dq_names[dq_label]
dq_type = dq_types[dq_label]
dq_tags = tags + [dq_label]
# get triggers for this ifo
ifo_insp = [insp for insp in insps if (insp.ifo == ifo)]
assert len(ifo_insp) == 1, \
f"Received more than one inspiral file for {ifo}"
ifo_insp = ifo_insp[0]
# calculate template bins for this ifo
bin_templates_exe = PyCBCBinTemplatesDQExecutable(
workflow.cp,
'bin_templates',
ifos=ifo,
out_dir=output_dir,
tags=tags)
bin_templates_node = bin_templates_exe.create_node(workflow, ifo, bank)
workflow += bin_templates_node
template_bins_file = bin_templates_node.output_file
if dq_type == 'flag':
flag_file = dq_seg_file
flag_name = dq_name
else:
raise ValueError(f"{dq_type} dq support not yet implemented")
# calculate trigger rates during dq flags
bin_triggers_exe = PyCBCBinTriggerRatesDQExecutable(
workflow.cp,
'bin_trigger_rates_dq',
ifos=ifo,
out_dir=output_dir,
tags=dq_tags)
bin_triggers_node = bin_triggers_exe.create_node(
workflow,
flag_file,
flag_name,
analyzable_seg_file,
analyzable_name,
ifo_insp,
template_bins_file)
workflow += bin_triggers_node
output_files += bin_triggers_node.output_files
output_labels += [dq_label]
logger.info("Finished setting up dq reranking")
return output_files, output_labels