lalsuite 7.26.2.dev20260106__cp314-cp314-macosx_13_0_x86_64.whl

lalburst/binjfind.py

@@ -0,0 +1,824 @@
+# Copyright (C) 2006-2021  Kipp Cannon
+#
+# 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 2 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
+#
+# =============================================================================
+#
+
+
+"""
+Burst injection identification library.  Contains code providing the
+capacity to search a list of sngl_burst burst candidates for events
+matching entries in a sim_burst list of software injections, recording the
+matches as burst <--> injection coincidences using the standard coincidence
+infrastructure.  Also, any pre-recorded burst <--> burst coincidences are
+checked for cases where all the burst events in a coincidence match an
+injection, and these are recorded as coinc <--> injection coincidences,
+again using the standard coincidence infrastructure.
+"""
+
+
+import bisect
+import sys
+
+
+from igwn_ligolw import lsctables
+from igwn_ligolw.utils import coincs as ligolw_coincs
+from igwn_ligolw.utils import process as ligolw_process
+from igwn_ligolw.utils import search_summary as ligolw_search_summary
+from igwn_ligolw.utils import time_slide as ligolw_time_slide
+import lal
+import igwn_segments as segments
+from . import burca
+from . import SimBurstUtils
+
+
+__author__ = "Kipp Cannon <kipp.cannon@ligo.org>"
+from .git_version import date as __date__
+from .git_version import version as __version__
+
+
+#
+# =============================================================================
+#
+#                                 Speed Hacks
+#
+# =============================================================================
+#
+
+
+#
+# Construct a subclass of the sngl_burst row class with the methods that
+# are needed
+#
+
+
+class SnglBurst(lsctables.SnglBurst):
+	__slots__ = ()
+
+	#
+	# compare self's end time to the LIGOTimeGPS instance other.
+	# allows bisection searches by GPS time to find ranges of triggers
+	# quickly
+	#
+
+	def __lt__(self, other):
+		return self.end < other
+
+	def __le__(self, other):
+		return self.end <= other
+
+	def __eq__(self, other):
+		return self.end == other
+
+	def __ne__(self, other):
+		return self.end != other
+
+	def __ge__(self, other):
+		return self.end >= other
+
+	def __gt__(self, other):
+		return self.end > other
+
+
+lsctables.SnglBurstTable.RowType = lsctables.SnglBurst = SnglBurst
+
+
+#
+# place-holder class for sim_inspiral table's row class so that
+# time_slide_id attributes can be assigned to it (this would normally be
+# prevented by the __slots__ mechanism).  FIXME:  delete when the
+# sim_inspiral table has a time_slide_id column
+#
+
+
+class SimInspiral(lsctables.SimInspiral):
+	pass
+
+
+lsctables.SimInspiralTable.RowType = lsctables.SimInspiral = SimInspiral
+
+
+#
+# =============================================================================
+#
+#                              Document Interface
+#
+# =============================================================================
+#
+
+
+ExcessPowerSBBCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")
+ExcessPowerSIBCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")
+ExcessPowerSBCCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")
+ExcessPowerSBCNearCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")
+ExcessPowerSICCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")
+ExcessPowerSICNearCoincDef = lsctables.CoincDef(search = "excesspower", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")
+
+
+StringCuspSBBCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")
+StringCuspSIBCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")
+StringCuspSBCCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")
+StringCuspSBCNearCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")
+StringCuspSICCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")
+StringCuspSICNearCoincDef = lsctables.CoincDef(search = "StringCusp", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")
+
+
+OmegaBBCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 0, description = "sngl_burst<-->sngl_burst coincidences")
+OmegaSBBCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")
+OmegaSIBCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")
+OmegaSBCCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")
+OmegaSBCNearCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")
+OmegaSICCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")
+OmegaSICNearCoincDef = lsctables.CoincDef(search = "omega", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")
+
+CWBBBCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 0, description = "sngl_burst<-->sngl_burst coincidences")
+CWBSBBCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 1, description = "sim_burst<-->sngl_burst coincidences")
+CWBSIBCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 4, description = "sim_inspiral<-->sngl_burst coincidences")
+CWBSBCCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 2, description = "sim_burst<-->coinc_event coincidences (exact)")
+CWBSBCNearCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 3, description = "sim_burst<-->coinc_event coincidences (nearby)")
+CWBSICCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 5, description = "sim_inspiral<-->coinc_event coincidences (exact)")
+CWBSICNearCoincDef = lsctables.CoincDef(search = "waveburst", search_coinc_type = 6, description = "sim_inspiral<-->coinc_event coincidences (nearby)")
+
+
+class DocContents(object):
+	"""
+	A wrapper interface to the XML document.
+	"""
+	def __init__(self, xmldoc, b_b_def, sb_b_def, si_b_def, sb_c_e_def, sb_c_n_def, si_c_e_def, si_c_n_def, process, livetime_program):
+		#
+		# store the process row
+		#
+
+		self.process = process
+
+		#
+		# locate the sngl_burst, time_slide and injection tables
+		#
+
+		self.snglbursttable = lsctables.SnglBurstTable.get_table(xmldoc)
+		try:
+			self.simbursttable = lsctables.SimBurstTable.get_table(xmldoc)
+		except ValueError:
+			self.simbursttable = None
+		try:
+			self.siminspiraltable = lsctables.SimInspiralTable.get_table(xmldoc)
+		except ValueError:
+			self.siminspiraltable = None
+		try:
+			timeslidetable = lsctables.TimeSlideTable.get_table(xmldoc)
+		except ValueError:
+			timeslidetable = None
+		if timeslidetable is not None:
+			self.offsetvectors = timeslidetable.as_dict()
+		else:
+			self.offsetvectors = {}
+
+		#
+		# store the longest duration of a burst event
+		#
+
+		if self.snglbursttable:
+			self.longestduration = max(self.snglbursttable.getColumnByName("duration"))
+		else:
+			self.longestduration = 0.0
+
+		#
+		# get a segmentlistdict indicating the times when the jobs
+		# that produced burst events could have produced output
+		#
+
+		self.seglists = ligolw_search_summary.segmentlistdict_fromsearchsummary(xmldoc, livetime_program).coalesce()
+
+		#
+		# FIXME:  in the future, the sim_inspiral table should
+		# indicate time slide at which the injection was done, like
+		# the sim_burst table does.  for now, fake it by giving
+		# each one a time_slide_id attribute.  this is the only
+		# reason why a place-holder class is required for the
+		# SimInspiral row type;  that class can be deleted when
+		# this is no longer needed
+		#
+
+		if self.siminspiraltable is not None:
+			time_slide_id = ligolw_time_slide.get_time_slide_id(xmldoc, {}.fromkeys(self.seglists, 0.0), create_new = process, superset_ok = True, nonunique_ok = False)
+			for sim in self.siminspiraltable:
+				sim.time_slide_id = time_slide_id
+
+		#
+		# get coinc_definer rows for sim_* <--> sngl_burst coincs
+		# for whichever sim_* tables are present; this creates a
+		# coinc_definer table if the document doesn't have one
+		#
+
+		if self.simbursttable is not None:
+			self.sb_b_coinc_def_id = ligolw_coincs.get_coinc_def_id(xmldoc, sb_b_def.search, sb_b_def.search_coinc_type, create_new = True, description = sb_b_def.description)
+		else:
+			self.sb_b_coinc_def_id = None
+		if self.siminspiraltable is not None:
+			self.si_b_coinc_def_id = ligolw_coincs.get_coinc_def_id(xmldoc, si_b_def.search, si_b_def.search_coinc_type, create_new = True, description = si_b_def.description)
+		else:
+			self.si_b_coinc_def_id = None
+
+		#
+		# get coinc_def_id's for sngl_burst <--> sngl_burst, and
+		# both kinds of sim_* <--> coinc_event coincs.  set all to
+		# None if this document does not contain any sngl_burst
+		# <--> sngl_burst coincs.
+		#
+
+		try:
+			b_b_coinc_def_id = ligolw_coincs.get_coinc_def_id(xmldoc, b_b_def.search, b_b_def.search_coinc_type, create_new = False)
+		except KeyError:
+			b_b_coinc_def_id = None
+			self.sb_c_e_coinc_def_id = None
+			self.sb_c_n_coinc_def_id = None
+			self.si_c_e_coinc_def_id = None
+			self.si_c_n_coinc_def_id = None
+		else:
+			if self.simbursttable is not None:
+				self.sb_c_e_coinc_def_id = ligolw_coincs.get_coinc_def_id(xmldoc, sb_c_e_def.search, sb_c_e_def.search_coinc_type, create_new = True, description = sb_c_e_def.description)
+				self.sb_c_n_coinc_def_id = ligolw_coincs.get_coinc_def_id(xmldoc, sb_c_n_def.search, sb_c_n_def.search_coinc_type, create_new = True, description = sb_c_n_def.description)
+			else:
+				self.sb_c_e_coinc_def_id = None
+				self.sb_c_n_coinc_def_id = None
+			if self.siminspiraltable is not None:
+				self.si_c_e_coinc_def_id = ligolw_coincs.get_coinc_def_id(xmldoc, si_c_e_def.search, si_c_e_def.search_coinc_type, create_new = True, description = si_c_e_def.description)
+				self.si_c_n_coinc_def_id = ligolw_coincs.get_coinc_def_id(xmldoc, si_c_n_def.search, si_c_n_def.search_coinc_type, create_new = True, description = si_c_n_def.description)
+			else:
+				self.si_c_e_coinc_def_id = None
+				self.si_c_n_coinc_def_id = None
+
+		#
+		# get coinc table, create one if needed
+		#
+
+		try:
+			self.coinctable = lsctables.CoincTable.get_table(xmldoc)
+		except ValueError:
+			self.coinctable = lsctables.CoincTable.new()
+			xmldoc.childNodes[0].appendChild(self.coinctable)
+		self.coinctable.sync_next_id()
+
+		#
+		# get coinc_map table, create one if needed
+		#
+
+		try:
+			self.coincmaptable = lsctables.CoincMapTable.get_table(xmldoc)
+		except ValueError:
+			self.coincmaptable = lsctables.CoincMapTable.new()
+			xmldoc.childNodes[0].appendChild(self.coincmaptable)
+
+		#
+		# index the document
+		#
+
+		# index sngl_burst table
+		index = dict((row.event_id, row) for row in self.snglbursttable)
+		# find IDs of burst<-->burst coincs
+		self.coincs = dict((row.coinc_event_id, []) for row in self.coinctable if row.coinc_def_id == b_b_coinc_def_id)
+		# construct event list for each burst<-->burst coinc
+		for row in self.coincmaptable:
+			try:
+				self.coincs[row.coinc_event_id].append(index[row.event_id])
+			except KeyError:
+				pass
+		del index
+		# sort the event list for each coin by peak time and
+		# convert to tuples for speed
+		for coinc_event_id, events in self.coincs.items():
+			events.sort(key = lambda event: event.peak)
+			self.coincs[coinc_event_id] = tuple(events)
+		# convert dictionary to a list of (coinc_event_id, events)
+		# tuples and create a coinc_event_id to offset vector
+		# look-up table
+		self.coincs = self.coincs.items()
+		self.coincoffsets = dict((row.coinc_event_id, self.offsetvectors[row.time_slide_id]) for row in self.coinctable if row.coinc_def_id == b_b_coinc_def_id)
+
+		#
+		# represent the sngl_burst table as a dictionary indexed by
+		# instrument whose values are the event lists for those
+		# instruments sorted by peak time.  sort the coincs list by
+		# the peak time of the first (earliest) event in each coinc
+		# (recall that the event tuple for each coinc has been
+		# time-ordered)
+		#
+
+		self.snglbursttable = dict((instrument, sorted((event for event in self.snglbursttable if event.ifo == instrument), key = lambda event: event.peak)) for instrument in set(self.snglbursttable.getColumnByName("ifo")))
+		self.coincs.sort(key = lambda coinc_id_events: coinc_id_events[1][0].peak)
+
+	def bursts_near_peaktime(self, t, window, offsetvector):
+		"""
+		Return a list of the burst events whose peak times (with
+		offsetvector added) are within window seconds of t.  This
+		is not used to define any coincidences, only to provide a
+		short list of burst events for use in more costly
+		comparison tests.
+		"""
+		# instead of adding the offsets to each burst trigger, the
+		# offsets are subtracted from the times against which the
+		# bursts are compared
+		return sum((events[bisect.bisect_left(events, t - offsetvector[instrument] - window):bisect.bisect_right(events, t - offsetvector[instrument] + window)] for instrument, events in self.snglbursttable.items()), [])
+
+	def coincs_near_peaktime(self, t, window, offsetvector):
+		"""
+		Return a list of the (coinc_event_id, event list) tuples in
+		which at least one burst event's peak time is within window
+		seconds of t.  This is not used to define any coincidences,
+		only to provide a short list of coinc events for use in
+		more costly comparison tests.
+		"""
+		#
+		# burst events within window of t
+		#
+
+		near_events = set(self.bursts_near_peaktime(t, window, offsetvector))
+
+		#
+		# coincs that involve at least one of those burst events
+		# and were found following the application of an offset
+		# vector consistent with the injection offset vector
+		#
+
+		return [(coinc_event_id, events) for coinc_event_id, events in self.coincs if set(events) & near_events and offsetvector.contains(self.coincoffsets[coinc_event_id])]
+
+	def new_coinc(self, coinc_def_id, time_slide_id):
+		"""
+		Construct a new coinc_event row attached to the given
+		process, and belonging to the set of coincidences defined
+		by the given coinc_def_id.
+		"""
+		coinc = self.coinctable.RowType()
+		coinc.process_id = self.process.process_id
+		coinc.coinc_def_id = coinc_def_id
+		coinc.coinc_event_id = self.coinctable.get_next_id()
+		coinc.time_slide_id = time_slide_id
+		coinc.set_instruments(None)
+		coinc.nevents = 0
+		coinc.likelihood = None
+		self.coinctable.append(coinc)
+		return coinc
+
+
+#
+# =============================================================================
+#
+#                           Add Process Information
+#
+# =============================================================================
+#
+
+
+process_program_name = "lalburst_injfind"
+
+
+def append_process(xmldoc, match_algorithm, comment):
+	"""
+	Convenience wrapper for adding process metadata to the document.
+	"""
+	return ligolw_process.register_to_xmldoc(
+		xmldoc,
+		program = process_program_name,
+		paramdict = {
+			"match_algorithm": match_algorithm
+		},
+		version = __version__,
+		cvs_repository = "lscsoft",
+		cvs_entry_time = __date__,
+		comment = comment
+	)
+
+
+#
+# =============================================================================
+#
+#                 Injection <--> Burst Event Comparison Tests
+#
+# =============================================================================
+#
+
+
+def StringCuspSnglCompare(sim, burst, offsetvector):
+	"""
+	Return False (injection matches event) if an autocorrelation-width
+	window centred on the injection is continuous with the time
+	interval of the burst.
+	"""
+	tinj = sim.time_at_instrument(burst.ifo, offsetvector)
+	window = SimBurstUtils.stringcusp_autocorrelation_width / 2
+	# uncomment last part of expression to impose an amplitude cut
+	return segments.segment(tinj - window, tinj + window).disjoint(burst.period) #or abs(sim.amplitude / SimBurstUtils.string_amplitude_in_instrument(sim, burst.ifo, offsetvector)) > 3
+
+
+def ExcessPowerSnglCompare(sim, burst, offsetvector):
+	"""
+	Return False (injection matches event) if the peak time and centre
+	frequency of sim lie within the time-frequency tile of burst.
+	"""
+	return (sim.time_at_instrument(burst.ifo, offsetvector) not in burst.period) or (sim.frequency not in burst.band)
+
+
+def OmegaSnglCompare(sim, burst, offsetvector, delta_t = 10.0):
+	"""
+	Return False (injection matches event) if the time of the sim and
+	the peak time of the burst event differ by less than or equal to
+	delta_t seconds.
+	"""
+	return abs(float(sim.time_at_instrument(burst.ifo, offsetvector) - burst.peak)) > delta_t
+
+def CWBSnglCompare(sim, burst, offsetvector, delta_t = 10.0):
+	"""
+	Return False (injection matches event) if the time of the sim and
+	the peak time of the burst event differ by less than or equal to
+	delta_t seconds.
+	"""
+	return abs(float(sim.time_at_instrument(burst.ifo, offsetvector) - burst.peak)) > delta_t
+
+
+def StringCuspNearCoincCompare(sim, burst, offsetvector):
+	"""
+	Return False (injection matches coinc) if the peak time of the sim
+	is "near" the burst event.
+	"""
+	tinj = sim.time_at_instrument(burst.ifo, offsetvector)
+	window = SimBurstUtils.stringcusp_autocorrelation_width / 2 + SimBurstUtils.burst_is_near_injection_window
+	return segments.segment(tinj - window, tinj + window).disjoint(burst.period)
+
+
+def ExcessPowerNearCoincCompare(sim, burst, offsetvector):
+	"""
+	Return False (injection matches coinc) if the peak time of the sim
+	is "near" the burst event.
+	"""
+	tinj = sim.time_at_instrument(burst.ifo, offsetvector)
+	window = SimBurstUtils.burst_is_near_injection_window
+	return segments.segment(tinj - window, tinj + window).disjoint(burst.period)
+
+
+def OmegaNearCoincCompare(sim, burst, offsetvector):
+	"""
+	Return False (injection matches coinc) if the peak time of the sim
+	is "near" the burst event.
+	"""
+	return OmegaSnglCompare(sim, burst, offsetvector, delta_t = 20.0 + burst.duration / 2)
+
+def CWBNearCoincCompare(sim, burst, offsetvector):
+	"""
+	Return False (injection matches coinc) if the peak time of the sim
+	is "near" the burst event.
+	"""
+	return OmegaSnglCompare(sim, burst, offsetvector, delta_t = 20.0 + burst.duration / 2)
+
+
+#
+# =============================================================================
+#
+#                 Build sim_* <--> sngl_burst Coincidences
+#
+# =============================================================================
+#
+
+
+def find_sngl_burst_matches(contents, sim, comparefunc, sieve_window):
+	"""
+	Scan the burst table for triggers matching sim.  sieve_window is
+	used in a bisection search to quickly identify burst events within
+	that many seconds of the injection's peak time at the geocentre;
+	it should be larger than the greatest time difference that can
+	separate a burst event's peak time from an injection's peak time at
+	the geocentre and the two still be considered a match.
+	"""
+	offsetvector = contents.offsetvectors[sim.time_slide_id]
+	return [burst for burst in contents.bursts_near_peaktime(sim.time_geocent, sieve_window, offsetvector) if not comparefunc(sim, burst, offsetvector)]
+
+
+def add_sim_burst_coinc(contents, sim, events, coinc_def_id):
+	"""
+	Create a coinc_event in the coinc table, and add arcs in the
+	coinc_event_map table linking the sim_burst row and the list of
+	sngl_burst rows to the new coinc_event row.
+	"""
+	# the coinc always carries the same time_slide_id as the injection
+	coinc = contents.new_coinc(coinc_def_id, sim.time_slide_id)
+	coinc.set_instruments(set(event.ifo for event in events))
+	coinc.nevents = len(events)
+
+	coincmap = contents.coincmaptable.RowType()
+	coincmap.coinc_event_id = coinc.coinc_event_id
+	coincmap.table_name = sim.simulation_id.table_name
+	coincmap.event_id = sim.simulation_id
+	contents.coincmaptable.append(coincmap)
+
+	for event in events:
+		coincmap = contents.coincmaptable.RowType()
+		coincmap.coinc_event_id = coinc.coinc_event_id
+		coincmap.table_name = event.event_id.table_name
+		coincmap.event_id = event.event_id
+		contents.coincmaptable.append(coincmap)
+
+	return coinc
+
+
+#
+# =============================================================================
+#
+#                   Build sim_burst <--> coinc Coincidences
+#
+# =============================================================================
+#
+
+
+def find_exact_coinc_matches(coincs, sim, comparefunc, seglists, offsetvector):
+	"""
+	Return a set of the coinc_event_ids of the burst<-->burst coincs in
+	which all burst events match sim and to which all instruments on at
+	the time of the sim contributed events.
+	"""
+	# note:  this doesn't check that the coinc and the sim share
+	# compatible offset vectors, it is assumed this condition was
+	# applied in the .coincs_near_peaktime() method that was used to
+	# assemble the list of candidate coincs
+
+	# comparefunc() returns False --> event matches sim
+	# any() --> at least one compare returns True == not all events match
+	# not any() --> all events match sim
+	on_instruments = SimBurstUtils.on_instruments(sim, seglists, offsetvector)
+	return set(coinc_event_id for coinc_event_id, events in coincs if on_instruments.issubset(set(event.ifo for event in events)) and not any(comparefunc(sim, event, offsetvector) for event in events))
+
+
+def find_near_coinc_matches(coincs, sim, comparefunc, offsetvector):
+	"""
+	Return a set of the coinc_event_ids of the burst<-->burst coincs in
+	which at least one burst event matches sim.
+	"""
+	# note:  this doesn't check that the coinc and the sim share
+	# compatible offset vectors, it is assumed this condition was
+	# applied in the .coincs_near_peaktime() method that was used to
+	# assemble the list of candidate coincs
+
+	# comparefunc() returns False --> event matches sim
+	# all() --> all compares return True == no events match
+	# not all() --> at least one event matches sim
+	return set(coinc_event_id for coinc_event_id, events in coincs if not all(comparefunc(sim, event, offsetvector) for event in events))
+
+
+def add_sim_coinc_coinc(contents, sim, coinc_event_ids, coinc_def_id):
+	"""
+	Create a coinc_event in the coinc table, and add arcs in the
+	coinc_event_map table linking the sim_burst row and the list of
+	coinc_event rows to the new coinc_event row.
+	"""
+	# the coinc always carries the same time_slide_id as the injection
+	coinc = contents.new_coinc(coinc_def_id, sim.time_slide_id)
+	coinc.nevents = len(coinc_event_ids)
+
+	coincmap = contents.coincmaptable.RowType()
+	coincmap.coinc_event_id = coinc.coinc_event_id
+	coincmap.table_name = sim.simulation_id.table_name
+	coincmap.event_id = sim.simulation_id
+	contents.coincmaptable.append(coincmap)
+
+	for coinc_event_id in coinc_event_ids:
+		coincmap = contents.coincmaptable.RowType()
+		coincmap.coinc_event_id = coinc.coinc_event_id
+		coincmap.table_name = coinc_event_id.table_name
+		coincmap.event_id = coinc_event_id
+		contents.coincmaptable.append(coincmap)
+
+	return coinc
+
+
+#
+# =============================================================================
+#
+#                                 Library API
+#
+# =============================================================================
+#
+
+
+def binjfind(xmldoc, process, search, snglcomparefunc, nearcoinccomparefunc, verbose = False):
+	#
+	# Analyze the document's contents.
+	#
+
+	if verbose:
+		print("indexing ...", file=sys.stderr)
+
+	b_b_def = {
+		"StringCusp": burca.StringCuspBBCoincDef,
+		"excesspower": burca.ExcessPowerBBCoincDef,
+		"waveburst": CWBBBCoincDef,
+		"omega": OmegaBBCoincDef
+	}[search]
+	sb_b_def = {
+		"StringCusp": StringCuspSBBCoincDef,
+		"excesspower": ExcessPowerSBBCoincDef,
+		"waveburst": CWBSBBCoincDef,
+		"omega": OmegaSBBCoincDef
+	}[search]
+	si_b_def = {
+		"StringCusp": StringCuspSIBCoincDef,
+		"excesspower": ExcessPowerSIBCoincDef,
+		"waveburst": CWBSIBCoincDef,
+		"omega": OmegaSIBCoincDef
+	}[search]
+	sb_c_e_def = {
+		"StringCusp": StringCuspSBCCoincDef,
+		"excesspower": ExcessPowerSBCCoincDef,
+		"waveburst": CWBSBCCoincDef,
+		"omega": OmegaSBCCoincDef
+	}[search]
+	sb_c_n_def = {
+		"StringCusp": StringCuspSBCNearCoincDef,
+		"excesspower": ExcessPowerSBCNearCoincDef,
+		"waveburst": CWBSBCNearCoincDef,
+		"omega": OmegaSBCNearCoincDef
+	}[search]
+	si_c_e_def = {
+		"StringCusp": StringCuspSICCoincDef,
+		"excesspower": ExcessPowerSICCoincDef,
+		"waveburst": CWBSICCoincDef,
+		"omega": OmegaSICCoincDef
+	}[search]
+	si_c_n_def = {
+		"StringCusp": StringCuspSICNearCoincDef,
+		"excesspower": ExcessPowerSICNearCoincDef,
+		"waveburst": CWBSICNearCoincDef,
+		"omega": OmegaSICNearCoincDef
+	}[search]
+
+	contents = DocContents(
+		xmldoc = xmldoc,
+		b_b_def = b_b_def,
+		sb_b_def = sb_b_def,
+		si_b_def = si_b_def,
+		sb_c_e_def = sb_c_e_def,
+		sb_c_n_def = sb_c_n_def,
+		si_c_e_def = si_c_e_def,
+		si_c_n_def = si_c_n_def,
+		process = process,
+		livetime_program = {
+			"StringCusp": "StringSearch",
+			"excesspower": "lalapps_power",
+			"omega": None,	# FIXME:  this causes all segments in the search_summary table to be retrieved
+			"waveburst": None	# FIXME:  this causes all segments in the search_summary table to be retrieved
+		}[search]
+	)
+
+	#
+	# set the window for the sieve in bursts_near_peaktime().  this
+	# window is the amount of time such that if an injection's peak
+	# time and a burst event's peak time differ by more than this it is
+	# *impossible* for them to match one another.
+	#
+
+	# the radius of Earth in light seconds == the most an injection's
+	# peak time column can differ from the time it peaks in an
+	# instrument.  1.25 = add 25% for good luck (we're not being
+	# careful with asphericity here, so a bit of padding is needed
+	# anyway, just make sure it's enough).
+	burst_peak_time_window = lal.REARTH_SI / lal.C_SI * 1.25
+
+	# add the duration of the longest burst event (the most a burst
+	# event's peak time could differ from either the start or stop time
+	# of the event)
+	burst_peak_time_window += contents.longestduration
+
+	# add a search-specific padding
+	#
+	# for the string search this is 1/2 the typical width of a whitened
+	# template's autocorrelation function (because this is added to a
+	# time window somewhere)
+	#
+	# for omega, the number should be larger than the largest delta_t
+	# passed to OmegaSnglCompare() not including the duration of the
+	# burst event (already taken into account above)
+	burst_peak_time_window += {
+		"StringCusp": SimBurstUtils.stringcusp_autocorrelation_width / 2,
+		"excesspower": 0.0,
+		"omega": 30.0,
+		"waveburst": 30.0
+	}[search]
+
+	#
+	# set the window for identifying coincs near a peak time
+	# FIXME:  this is kinda specific to the excess power search.
+	#
+
+	coinc_peak_time_window = burst_peak_time_window + SimBurstUtils.burst_is_near_injection_window
+
+	#
+	# Search for sim_burst <--> * coincidences
+	#
+
+	if contents.simbursttable is not None:
+		N = len(contents.simbursttable)
+
+		#
+		# Find sim_burst <--> sngl_burst coincidences.
+		#
+
+		if verbose:
+			print("constructing %s:" % sb_b_def.description, file=sys.stderr)
+		for n, sim in enumerate(contents.simbursttable):
+			if verbose:
+				print("\t%.1f%%\r" % (100.0 * n / N), end=' ', file=sys.stderr)
+			events = find_sngl_burst_matches(contents, sim, snglcomparefunc, burst_peak_time_window)
+			if events:
+				add_sim_burst_coinc(contents, sim, events, contents.sb_b_coinc_def_id)
+		if verbose:
+			print("\t100.0%", file=sys.stderr)
+
+		#
+		# Find sim_burst <--> coinc_event coincidences.
+		#
+
+		if verbose:
+			print("constructing %s and %s:" % (sb_c_e_def.description, sb_c_n_def.description), file=sys.stderr)
+		for n, sim in enumerate(contents.simbursttable):
+			if verbose:
+				print("\t%.1f%%\r" % (100.0 * n / N), end=' ', file=sys.stderr)
+			offsetvector = contents.offsetvectors[sim.time_slide_id]
+			coincs = contents.coincs_near_peaktime(sim.time_geocent, coinc_peak_time_window, offsetvector)
+			exact_coinc_event_ids = find_exact_coinc_matches(coincs, sim, snglcomparefunc, contents.seglists, offsetvector)
+			near_coinc_event_ids = find_near_coinc_matches(coincs, sim, nearcoinccomparefunc, offsetvector)
+			assert exact_coinc_event_ids.issubset(near_coinc_event_ids)
+			if exact_coinc_event_ids:
+				add_sim_coinc_coinc(contents, sim, exact_coinc_event_ids, contents.sb_c_e_coinc_def_id)
+			if near_coinc_event_ids:
+				add_sim_coinc_coinc(contents, sim, near_coinc_event_ids, contents.sb_c_n_coinc_def_id)
+		if verbose:
+			print("\t100.0%", file=sys.stderr)
+	elif verbose:
+		print("no %s table in document, skipping" % lsctables.SimBurstTable.tableName, file=sys.stderr)
+
+	#
+	# Search for sim_inspiral <--> * coincidences
+	#
+
+	if contents.siminspiraltable is not None:
+		N = len(contents.siminspiraltable)
+
+		#
+		# Find sim_inspiral <--> sngl_burst coincidences.
+		#
+
+		if verbose:
+			print("constructing %s:" % si_b_def.description, file=sys.stderr)
+		for n, sim in enumerate(contents.siminspiraltable):
+			if verbose:
+				print("\t%.1f%%\r" % (100.0 * n / N), end=' ', file=sys.stderr)
+			events = find_sngl_burst_matches(contents, sim, snglcomparefunc, burst_peak_time_window)
+			if events:
+				add_sim_burst_coinc(contents, sim, events, contents.si_b_coinc_def_id)
+		if verbose:
+			print("\t100.0%", file=sys.stderr)
+
+		#
+		# Find sim_inspiral <--> coinc_event coincidences.
+		#
+
+		if verbose:
+			print("constructing %s and %s:" % (si_c_e_def.description, si_c_n_def.description), file=sys.stderr)
+		for n, sim in enumerate(contents.siminspiraltable):
+			if verbose:
+				print("\t%.1f%%\r" % (100.0 * n / N), end=' ', file=sys.stderr)
+			offsetvector = contents.offsetvectors[sim.time_slide_id]
+			coincs = contents.coincs_near_peaktime(sim.time_geocent, coinc_peak_time_window, offsetvector)
+			exact_coinc_event_ids = find_exact_coinc_matches(coincs, sim, snglcomparefunc, contents.seglists, offsetvector)
+			near_coinc_event_ids = find_near_coinc_matches(coincs, sim, nearcoinccomparefunc, offsetvector)
+			assert exact_coinc_event_ids.issubset(near_coinc_event_ids)
+			if exact_coinc_event_ids:
+				add_sim_coinc_coinc(contents, sim, exact_coinc_event_ids, contents.si_c_e_coinc_def_id)
+			if near_coinc_event_ids:
+				add_sim_coinc_coinc(contents, sim, near_coinc_event_ids, contents.si_c_n_coinc_def_id)
+		if verbose:
+			print("\t100.0%", file=sys.stderr)
+	elif verbose:
+		print("no %s table in document, skipping" % lsctables.SimInspiralTable.tableName, file=sys.stderr)
+
+	#
+	# Done.
+	#
+
+	return xmldoc