lalsuite 7.26.2.dev20251206__cp312-cp312-manylinux_2_28_x86_64.whl

lalinspiral/thinca.py

@@ -0,0 +1,509 @@
+# Copyright (C) 2008--2017  Kipp Cannon, Drew G. Keppel
+#
+# 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
+#
+# =============================================================================
+#
+
+
+import itertools
+import math
+import operator
+
+
+from igwn_ligolw import ligolw
+from igwn_ligolw import lsctables
+from lalburst import offsetvector
+from lalburst import snglcoinc
+from . import _thinca
+
+
+__author__ = "Kipp Cannon <kipp.cannon@ligo.org>"
+from .git_version import date as __date__
+from .git_version import version as __version__
+
+
+def mchirp(m1, m2):
+	# mchirp = mtotal * eta**0.6
+	#        = mtotal * ((m1 * m2) / mtotal**2)**0.6
+	mtotal = m1 + m2
+	return mtotal * ((m1 * m2) / (mtotal * mtotal))**0.6
+
+
+#
+# =============================================================================
+#
+#                          CoincTables Customizations
+#
+# =============================================================================
+#
+
+
+#
+# The sngl_inspiral <--> sngl_inspiral coinc type.
+#
+
+
+InspiralCoincDef = lsctables.CoincDef(search = "inspiral", search_coinc_type = 0, description = "sngl_inspiral<-->sngl_inspiral coincidences")
+
+
+#
+# Definition of coinc_inspiral.end_time
+#
+
+
+def coinc_inspiral_end_time(events, offset_vector):
+	"""
+	Compute the end time of an inspiral coincidence.  events is an
+	iterable of sngl_inspiral triggers, offset_vector is a dictionary
+	mapping instrument to offset.
+
+	This function returns the time shifted end time of the trigger with
+	the highest SNR.  The end time reported by this function gets used
+	for things like plot titles, alert messages, and so on.  It is not
+	meant to be an accurate estimate of the time at which the
+	gravitational wave passed through the geocentre, or any other such
+	thing.
+
+	This end time is also used to parallelize thinca by allowing a
+	single lock stretch to be split across several jobs without missing
+	or double counting any coincs.  This is achieved by using a
+	definition that is guaranteed to return a bit-identical "end time"
+	for a given set of triggers.  Guaranteeing that allows thinca to
+	clip coincs to a sequence of contiguous segments and know that no
+	coinc will missed or double counted.
+	"""
+	event = max(events, key = lambda event: event.snr)
+	return event.end + offset_vector[event.ifo]
+
+
+#
+# Custom snglcoinc.CoincTables subclass.
+#
+
+
+class InspiralCoincTables(snglcoinc.CoincTables):
+	def __init__(self, xmldoc, coinc_definer_row):
+		super(InspiralCoincTables, self).__init__(xmldoc, coinc_definer_row)
+
+		#
+		# find the coinc_inspiral table or create one if not found
+		#
+
+		try:
+			self.coinc_inspiral_table = lsctables.CoincInspiralTable.get_table(xmldoc)
+		except ValueError:
+			self.coinc_inspiral_table = lsctables.CoincInspiralTable.new()
+			xmldoc.childNodes[0].appendChild(self.coinc_inspiral_table)
+
+
+	def coinc_rows(self, process_id, time_slide_id, events, seglists):
+		coinc, coincmaps = super(InspiralCoincTables, self).coinc_rows(process_id, time_slide_id, events, "sngl_inspiral")
+
+		#
+		# populate the coinc_inspiral table.  assume exact-match
+		# coincidence, so pick one trigger to provide template
+		# parameters.  otherwise:
+		#
+		# - end time is end time of highest SNR trigger
+		#   time-shifted according to the coinc's offset vector
+		# - snr is root-sum-square of SNRs
+		# - false-alarm rates are blank
+		#
+
+		offsetvector = self.time_slide_index[time_slide_id]
+		# the selection of an "end time" for the coincidence agrees
+		# with the coinc_inspiral_end_time() function above, but
+		# that's not necessary.  lalapps_thinca's ability to split
+		# coincs across boundaries only requires
+		# coinc_inspiral_end_time() to be used by all jobs and
+		# yield reproducible results, not that all "end times" that
+		# might be associated with a candidate agree with one
+		# another.
+		refevent = max(events, key = lambda event: event.snr)
+		end = refevent.end + offsetvector[refevent.ifo]
+		participating_instruments = frozenset(event.ifo for event in events)
+		coinc_inspiral = self.coinc_inspiral_table.RowType(
+			coinc_event_id = coinc.coinc_event_id,	# = None
+			mass = refevent.mass1 + refevent.mass2,
+			mchirp = mchirp(refevent.mass1, refevent.mass2),
+			snr = math.sqrt(sum(event.snr**2. for event in events)),
+			false_alarm_rate = None,
+			combined_far = None,
+			minimum_duration = None,
+			end = end,
+			instruments = participating_instruments
+		)
+
+		#
+		# record the instruments that were on at the time of the
+		# coinc.  instruments that provide triggers are, by
+		# definition, on.  note that the end time of the coinc
+		# must be unslid to compare with the instrument segment
+		# lists
+		#
+
+		coinc.insts = set(instrument for instrument, segs in seglists.items() if float(end - offsetvector[instrument]) in segs) | participating_instruments
+
+		#
+		# done
+		#
+
+		return coinc, coincmaps, coinc_inspiral
+
+
+	def append_coinc(self, coinc_event, coinc_event_maps, coinc_inspiral):
+		coinc_event = super(InspiralCoincTables, self).append_coinc(coinc_event, coinc_event_maps)
+		coinc_inspiral.coinc_event_id = coinc_event.coinc_event_id
+		self.coinc_inspiral_table.append(coinc_inspiral)
+		return coinc_event
+
+
+#
+# =============================================================================
+#
+#                     Coincidence Generator Implementation
+#
+# =============================================================================
+#
+
+
+class coincgen_doubles(snglcoinc.coincgen_doubles):
+	class singlesqueue(snglcoinc.coincgen_doubles.singlesqueue):
+		event_time = operator.attrgetter("end")
+
+
+	get_coincs = _thinca.get_coincs
+
+
+#
+# =============================================================================
+#
+#                                 Library API
+#
+# =============================================================================
+#
+
+
+def ligolw_thinca(
+	xmldoc,
+	process_id,
+	delta_t,
+	seglists,
+	ntuple_comparefunc = None,
+	veto_segments = None,
+	min_instruments = 2,
+	coinc_definer_row = InspiralCoincDef,
+	incremental = True,
+	verbose = False
+):
+	#
+	# prepare the coincidence table interface.
+	#
+
+	coinc_tables = InspiralCoincTables(xmldoc, coinc_definer_row)
+
+	#
+	# construct offset vector assembly graph
+	#
+
+	time_slide_graph = snglcoinc.TimeSlideGraph(coincgen_doubles, coinc_tables.time_slide_index, delta_t, min_instruments = min_instruments, verbose = verbose)
+
+	#
+	# collect events.  apply vetoes by excluding events from the lists
+	# that fall in vetoed segments
+	#
+
+	sngl_inspiral_table = lsctables.SnglInspiralTable.get_table(xmldoc)
+	if veto_segments is not None:
+		sngl_inspiral_table = (event for event in sngl_inspiral_table if event.ifo not in veto_segments or event.end not in veto_segments[event.ifo])
+		# don't do in-place
+		seglists = seglists - veto_segments
+
+	#
+	# push into coincidence graph and collect candidates
+	#
+
+	if not incremental:
+		# normal version:  push everything into the graph, then
+		# pull out all coincs in one operation below using the
+		# final flush
+		for instrument, events in itertools.groupby(sorted(sngl_inspiral_table, key = lambda row: row.ifo), lambda event: event.ifo):
+			time_slide_graph.push(instrument, tuple(events), snglcoinc.segments.PosInfinity)
+	else:
+		# slower diagnostic version.  simulate an online
+		# incremental analysis by pushing events into the graph in
+		# time order and collecting candidates as we go.  we still
+		# do the final flush operation below.
+		for instrument, events in itertools.groupby(sorted(sngl_inspiral_table, key = lambda row: (row.end, row.ifo)), lambda event: event.ifo):
+			events = tuple(events)
+			if time_slide_graph.push(instrument, events, max(event.end for event in events)):
+				for node, events in time_slide_graph.pull(coinc_sieve = ntuple_comparefunc):
+					coinc_tables.append_coinc(*coinc_tables.coinc_rows(process_id, node.time_slide_id, events, seglists = seglists))
+
+	#
+	# retrieve all remaining coincidences.
+	#
+
+	for node, events in time_slide_graph.pull(coinc_sieve = ntuple_comparefunc, flush = True):
+		coinc_tables.append_coinc(*coinc_tables.coinc_rows(process_id, node.time_slide_id, events, seglists = seglists))
+
+	#
+	# done
+	#
+
+	return xmldoc
+
+
+#
+# =============================================================================
+#
+#                              GraceDB Utilities
+#
+# =============================================================================
+#
+
+
+#
+# Device to extract sngl_inspiral coincs from a source XML document tree.
+#
+
+
+class sngl_inspiral_coincs(object):
+	"""
+	Dictionary-like device to extract XML document trees containing
+	individual sngl_inspiral coincs from a source XML document tree
+	containing several.
+
+	An instance of the class is initialized with an XML document tree.
+	The coinc event ID of a sngl_inspiral<-->sngl_inspiral coinc in
+	the document can then be used like a dictionary key to retrieve a
+	newly-constructed XML document containing that coinc by itself.
+	The output document trees are complete, self-describing, documents
+	with all metadata about the event from the source document
+	preserved.
+
+	Example:
+
+	>>> coincs = sngl_inspiral_coincs(xmldoc)
+	>>> print(coincs.coinc_def_id)
+	0
+	>>> coincs.keys()
+	[0]
+	>>> coinc_id = coincs.keys()[0]
+	>>> print(coinc_id)
+	83763
+	>>> coincs[coinc_id].write()
+	<?xml version='1.0' encoding='utf-8'?>
+	<!DOCTYPE LIGO_LW SYSTEM "http://ldas-sw.ligo.caltech.edu/doc/ligolwAPI/html/ligolw_dtd.txt">
+	<LIGO_LW>
+		<Table Name="process:table">
+			<Column Type="lstring" Name="process:comment"/>
+			<Column Type="lstring" Name="process:node"/>
+	...
+
+	The XML documents returned from this class share references to the
+	row objects in the original document.  Modifications to the row
+	objects in the tables returned by this class will affect both the
+	original document and all other documents returned by this class.
+	However, each retrieval constructs a new document from scratch,
+	they are not cached nor re-used, therefore this operation can be
+	time consuming if it needs to be performed repeatedly but the table
+	objects and document trees can be edited without affecting each
+	other.
+
+	If the source document is modified after this class has been
+	instantiated, the behaviour is undefined.
+
+	To assist with memory clean-up, it is helpful to invoke the
+	.unlink() method on the XML trees returned by this class when they
+	are no longer needed.
+	"""
+	def __init__(self, xmldoc):
+		"""
+		Initialize an instance of the class.  xmldoc is the source
+		XML document tree from which the
+		sngl_inspiral<-->sngl_inspiral coincs will be extracted.
+		"""
+		#
+		# find all tables
+		#
+
+		self.process_table = lsctables.ProcessTable.get_table(xmldoc)
+		self.process_params_table = lsctables.ProcessParamsTable.get_table(xmldoc)
+		self.sngl_inspiral_table = lsctables.SnglInspiralTable.get_table(xmldoc)
+		self.coinc_def_table = lsctables.CoincDefTable.get_table(xmldoc)
+		self.coinc_event_table = lsctables.CoincTable.get_table(xmldoc)
+		self.coinc_inspiral_table = lsctables.CoincInspiralTable.get_table(xmldoc)
+		self.coinc_event_map_table = lsctables.CoincMapTable.get_table(xmldoc)
+		self.time_slide_table = lsctables.TimeSlideTable.get_table(xmldoc)
+
+		#
+		# index the process, process params, sngl_inspiral and
+		# time_slide tables
+		#
+
+		self.process_index = dict((row.process_id, row) for row in self.process_table)
+		self.process_params_index = {}
+		for row in self.process_params_table:
+			self.process_params_index.setdefault(row.process_id, []).append(row)
+		self.sngl_inspiral_index = dict((row.event_id, row) for row in self.sngl_inspiral_table)
+		self.time_slide_index = {}
+		for row in self.time_slide_table:
+			self.time_slide_index.setdefault(row.time_slide_id, []).append(row)
+		self.zero_lag_time_slide_ids = frozenset(time_slide_id for time_slide_id, offset_vector in self.time_slide_table.as_dict().items() if not any(offset_vector.values()))
+
+		#
+		# find the sngl_inspiral<-->sngl_inspiral coincs
+		#
+
+		self.coinc_def, = (row for row in self.coinc_def_table if row.search == InspiralCoincDef.search and row.search_coinc_type == InspiralCoincDef.search_coinc_type)
+		coinc_event_map_ids = frozenset(row.coinc_event_id for row in self.coinc_event_map_table)
+		self.coinc_event_index = dict((row.coinc_event_id, row) for row in self.coinc_event_table if row.coinc_def_id == self.coinc_def.coinc_def_id and row.coinc_event_id in coinc_event_map_ids)
+		self.coinc_inspiral_index = dict((row.coinc_event_id, row) for row in self.coinc_inspiral_table if row.coinc_event_id in coinc_event_map_ids)
+		assert frozenset(self.coinc_event_index) == frozenset(self.coinc_inspiral_index)
+		self.coinc_event_map_index = dict((coinc_event_id, []) for coinc_event_id in self.coinc_event_index)
+		for row in self.coinc_event_map_table:
+			try:
+				self.coinc_event_map_index[row.coinc_event_id].append(row)
+			except KeyError:
+				continue
+
+	@property
+	def coinc_def_id(self):
+		"""
+		The coinc_def_id of the sngl_inspiral<-->sngl_inspiral
+		coincs in the source XML document.
+		"""
+		return self.coinc_def.coinc_def_id
+
+	def sngl_inspirals(self, coinc_event_id):
+		"""
+		Return a list of the sngl_inspiral rows that participated
+		in the coincidence given by coinc_event_id.
+		"""
+		return [self.sngl_inspiral_index[row.event_id] for row in self.coinc_event_map_index[coinc_event_id]]
+
+	def single_sngl_inspirals(self):
+		"""
+		Generator returns a sequence of the sngl_inspiral table
+		rows that formed zero-lag single-instrument "coincs".
+
+		This is only meaningful if the coincidence engine was run
+		with min_instruments = 1, otherwise this sequence will be
+		empty by construction.  Also, if there was no zero-lag time
+		slide included in the time slide graph then this sequence
+		will be empty.
+
+		This method is used by codes that want lists of
+		non-coincident triggers for background models even if
+		min_instruments has been set below 2.
+
+		The constraint that they be "zero-lag" singles might at
+		first seem nonsensical but is included to exclude triggers
+		that form genuine coincidences at zero-lag but are present
+		only as single-detector candidates in one or more time
+		slides.
+		"""
+		for coinc_event_id, coinc_event in self.coinc_event_index.items():
+			if coinc_event.time_slide_id in self.zero_lag_time_slide_ids and coinc_event.nevents < 2:
+				row, = self.coinc_event_map_index[coinc_event_id]
+				yield self.sngl_inspiral_index[row.event_id]
+
+	def offset_vector(self, time_slide_id):
+		"""
+		Return the offsetvector given by time_slide_id.
+		"""
+		return offsetvector.offsetvector((row.instrument, row.offset) for row in self.time_slide_index[time_slide_id])
+
+	def __getitem__(self, coinc_event_id):
+		"""
+		Construct and return an XML document containing the
+		sngl_inspiral<-->sngl_inspiral coinc carrying the given
+		coinc_event_id.
+		"""
+		newxmldoc = ligolw.Document()
+		ligolw_elem = newxmldoc.appendChild(ligolw.LIGO_LW())
+
+		# when making these, we can't use .copy() method of Table
+		# instances because we need to ensure we have a Table
+		# subclass, not a DBTable subclass
+		new_process_table = ligolw_elem.appendChild(lsctables.ProcessTable.new(self.process_table.columnnames))
+		new_process_params_table = ligolw_elem.appendChild(lsctables.ProcessParamsTable.new(self.process_params_table.columnnames))
+		new_sngl_inspiral_table = ligolw_elem.appendChild(lsctables.SnglInspiralTable.new(self.sngl_inspiral_table.columnnames))
+		new_coinc_def_table = ligolw_elem.appendChild(lsctables.CoincDefTable.new(self.coinc_def_table.columnnames))
+		new_coinc_event_table = ligolw_elem.appendChild(lsctables.CoincTable.new(self.coinc_event_table.columnnames))
+		new_coinc_inspiral_table = ligolw_elem.appendChild(lsctables.CoincInspiralTable.new(self.coinc_inspiral_table.columnnames))
+		new_coinc_event_map_table = ligolw_elem.appendChild(lsctables.CoincMapTable.new(self.coinc_event_map_table.columnnames))
+		new_time_slide_table = ligolw_elem.appendChild(lsctables.TimeSlideTable.new(self.time_slide_table.columnnames))
+
+		new_coinc_def_table.append(self.coinc_def)
+		coinc_event = self.coinc_event_index[coinc_event_id]
+		new_coinc_event_table.append(coinc_event)
+		new_coinc_inspiral_table.append(self.coinc_inspiral_index[coinc_event_id])
+		map(new_coinc_event_map_table.append, self.coinc_event_map_index[coinc_event_id])
+		map(new_time_slide_table.append, self.time_slide_index[coinc_event.time_slide_id])
+		for row in new_coinc_event_map_table:
+			new_sngl_inspiral_table.append(self.sngl_inspiral_index[row.event_id])
+
+		for process_id in set(new_sngl_inspiral_table.getColumnByName("process_id")) | set(new_coinc_event_table.getColumnByName("process_id")) | set(new_time_slide_table.getColumnByName("process_id")):
+			# process row is required
+			new_process_table.append(self.process_index[process_id])
+			try:
+				map(new_process_params_table.append, self.process_params_index[process_id])
+			except KeyError:
+				# process_params rows are optional
+				pass
+
+		return newxmldoc
+
+	def __iter__(self):
+		"""
+		Iterate over the coinc_event_id's in the source document.
+		"""
+		return iter(self.coinc_event_index)
+
+	def __nonzero__(self):
+		return bool(self.coinc_event_index)
+
+	def keys(self):
+		"""
+		A list of the coinc_event_id's of the
+		sngl_inspiral<-->sngl_inspiral coincs available in the
+		source XML document.
+		"""
+		return self.coinc_event_index.keys()
+
+	def items(self):
+		"""
+		Yield a sequence of (coinc_event_id, XML tree) tuples, one
+		for each sngl_inspiral<-->sngl_inspiral coinc in the source
+		document.
+
+		NOTE:  to allow this to work more easily with very large
+		documents, instead of returning the complete sequence as a
+		pre-constructed list this method is implemented as a
+		generator.
+		"""
+		for coinc_event_id in self:
+			yield (coinc_event_id, self[coinc_event_id])
+
+	iteritems = items

lalmetaio/__init__.py

@@ -0,0 +1,7 @@
+# Import SWIG wrappings, if available
+from ._lalmetaio_swig import *
+
+__version__ = "4.0.6.1"
+
+## \addtogroup lalmetaio_python
+"""This package provides Python wrappings and extensions to LALMetaIO"""

lalmetaio/_lalmetaio_swig.py

@@ -0,0 +1,14 @@
+# This file was automatically generated by SWIG (https://www.swig.org).
+# Version 4.3.1
+#
+# Do not make changes to this file unless you know what you are doing - modify
+# the SWIG interface file instead.
+
+from sys import version_info as _swig_python_version_info
+import lal
+
+# Pull in all the attributes from the low-level C/C++ module
+if __package__ or "." in __name__:
+    from ._lalmetaio import *
+else:
+    from _lalmetaio import *

lalmetaio/git_version.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+# git_version.py - vcs information module
+#
+# Copyright (C) 2010 Nickolas Fotopoulos
+# Copyright (C) 2012-2013 Adam Mercer
+# Copyright (C) 2016 Leo Singer
+#
+# 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 with program; see the file COPYING. If not, write to the
+# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301 USA
+
+id = "eeff03c6df54cc1b9aa861018eac9ca5072a0a77"
+date = "2025-12-4 04:45:18 +0000"
+branch = "None"
+tag = "None"
+if tag == "None":
+    tag = None
+author = "Karl Wette <karl.wette@ligo.org>"
+builder = "Unknown User <>"
+committer = "Karl Wette <karl.wette@ligo.org>"
+status = "CLEAN: All modifications committed"
+version = id
+verbose_msg = """Branch: None
+Tag: None
+Id: eeff03c6df54cc1b9aa861018eac9ca5072a0a77
+
+Builder: Unknown User <>
+Repository status: CLEAN: All modifications committed"""
+
+import warnings
+
+class VersionMismatchError(ValueError):
+    pass
+
+def check_match(foreign_id, onmismatch="raise"):
+    """
+    If foreign_id != id, perform an action specified by the onmismatch
+    kwarg. This can be useful for validating input files.
+
+    onmismatch actions:
+      "raise": raise a VersionMismatchError, stating both versions involved
+      "warn": emit a warning, stating both versions involved
+    """
+    if onmismatch not in ("raise", "warn"):
+        raise ValueError(onmismatch + " is an unrecognized value of onmismatch")
+    if foreign_id == "eeff03c6df54cc1b9aa861018eac9ca5072a0a77":
+        return
+    msg = "Program id (eeff03c6df54cc1b9aa861018eac9ca5072a0a77) does not match given id (%s)." % foreign_id
+    if onmismatch == "raise":
+        raise VersionMismatchError(msg)
+
+    # in the backtrace, show calling code
+    warnings.warn(msg, UserWarning)