lalsuite 7.26.2.dev20251206__cp312-cp312-manylinux_2_28_x86_64.whl

lalsuite-7.26.2.dev20251206.data/scripts/lalinspiral_injfind

@@ -0,0 +1,206 @@
+#!python
+#
+# Copyright (C) 2006--2009,2013,2014,2016,2017  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
+#
+# =============================================================================
+#
+
+
+"""
+Command-line interface to CBC injection identification code.
+"""
+
+
+from optparse import OptionParser
+import sys
+
+
+from igwn_ligolw import lsctables
+from igwn_ligolw import utils as ligolw_utils
+from igwn_ligolw.utils import process as ligolw_process
+from lalinspiral import inspinjfind
+
+
+__author__ = "Kipp Cannon <kipp.cannon@ligo.org>"
+from lalinspiral.git_version import date as __date__
+from lalinspiral.git_version import version as __version__
+
+
+process_program_name = "lalapps_inspinjfind"
+
+
+#
+# Must use injection finder's custom sngl_inspiral table row type.
+#
+
+
+lsctables.SnglInspiralTable.RowType = lsctables.SnglInspiral = inspinjfind.SnglInspiral
+
+
+#
+# =============================================================================
+#
+#                                 Command Line
+#
+# =============================================================================
+#
+
+
+def parse_command_line():
+	parser = OptionParser(
+		version = "Name: %%prog\n%s" % __version__,
+		usage = "%prog [options] [file ...]",
+		description = "Accepts as input one or more LIGO Light Weight XML files, each containing CBC candidates and a list of injections, and adds entries to the coincidence tables indicating which events match which injections."
+	)
+	parser.add_option("-f", "--force", action = "store_true", help = "Process even if file has already been processed.")
+	parser.add_option("--comment", metavar = "text", help = "Set the comment string to be written to the process table (default = None).")
+	parser.add_option("-c", "--match-algorithm", metavar = "[inspiral]", default = "inspiral", help = "Set the algorithm used to match event candidates with injections (default = \"inspiral\").")
+	parser.add_option("-r", "--revert", action = "store_true", help = "Revert a previously-processed XML file to its pre-lalapps_inspinjfind state, allowing it to be re-processed.  This is achieved by removing lalapps_inspinjfind's entries from the process metadata tables, removing injection-related entries from the coinc_definer table, and removing all coincs created by lalapps_inspinjfind.  NOTE:  generally this is only possible if lalapps_inspinjfind was the last transformation applied to the file, otherwise data that has been added subsequently might be broken due to dangling cross-references to deleted data.  It is left as an exercise to the user to ensure that reverting the file is sensible.")
+	parser.add_option("-w", "--time-window", metavar = "seconds", type = 'float', default = 9., help = "Set the time window used by the \"inspiral\" match algorithm (default = 9.0).")
+	parser.add_option("-v", "--verbose", action = "store_true", help = "Be verbose.")
+	options, filenames = parser.parse_args()
+
+	paramdict = options.__dict__.copy()
+
+	if options.match_algorithm is None:
+		raise ValueError("missing required --match-algorithm option")
+	if options.match_algorithm not in ("inspiral",):
+		raise ValueError("unrecognized --match-algorithm \"%s\"" % options.match_algorithm)
+
+	if options.time_window < 0.:
+		raise ValueError("--time-window must be non-negative")
+
+	return options, paramdict, (filenames or [None])
+
+
+#
+# =============================================================================
+#
+#                                     Main
+#
+# =============================================================================
+#
+
+
+#
+# command line
+#
+
+
+options, paramdict, filenames = parse_command_line()
+
+# must match columns in sngl_inspiral table
+search = {
+	"inspiral": "inspiral"
+}[options.match_algorithm]
+
+
+#
+# set compare functions
+#
+
+
+def InspiralSnglCompare(sim, sngl, twindow = lsctables.LIGOTimeGPS(options.time_window)):
+	"""
+	Returns 0 if sim and sngl are less than twindow apart.
+	"""
+	dt = sim.time_geocent - sngl.end
+	return 0 if abs(dt) < twindow else dt
+
+
+NearCoincCompare = InspiralSnglCompare
+
+
+snglcomparefunc, nearcoinccomparefunc = {
+	"inspiral": (InspiralSnglCompare, NearCoincCompare)
+}[options.match_algorithm]
+
+
+#
+# loop over files
+#
+
+
+for n, filename in enumerate(filenames, start = 1):
+	#
+	# load the document
+	#
+
+	if options.verbose:
+		print("%d/%d:" % (n, len(filenames)), end=' ', file=sys.stderr)
+	xmldoc = ligolw_utils.load_filename(filename, verbose = options.verbose)
+
+	#
+	# process
+	#
+
+	if options.revert:
+		inspinjfind.revert(xmldoc, process_program_name, verbose = options.verbose)
+	else:
+		#
+		# have we already processed it?
+		#
+
+		if ligolw_process.doc_includes_process(xmldoc, process_program_name):
+			if options.verbose:
+				print("warning: %s already processed," % (filename or "stdin"), end=' ', file=sys.stderr)
+			if not options.force:
+				if options.verbose:
+					print("skipping (use --force to force)", file=sys.stderr)
+				continue
+			if options.verbose:
+				print("continuing by --force", file=sys.stderr)
+
+		#
+		# add process metadata to document
+		#
+
+		process = ligolw_process.register_to_xmldoc(xmldoc, process_program_name, paramdict, version = __version__, cvs_repository = u"lscsoft", cvs_entry_time = __date__, comment = options.comment)
+
+		#
+		# run inspinjfind algorithm
+		#
+
+		inspinjfind.ligolw_inspinjfind(
+			xmldoc,
+			process,
+			search,
+			snglcomparefunc,
+			nearcoinccomparefunc,
+			end_time_bisect_window = 1.5 * options.time_window,
+			verbose = options.verbose
+		)
+
+		#
+		# close out the process metadata
+		#
+
+		process.set_end_time_now()
+
+	#
+	# done
+	#
+
+	ligolw_utils.write_filename(xmldoc, filename, verbose = options.verbose)
+	xmldoc.unlink()
+	lsctables.reset_next_ids(lsctables.TableByName.values())

lalsuite-7.26.2.dev20251206.data/scripts/lalinspiral_thinca

@@ -0,0 +1,240 @@
+#!python
+#
+# Copyright (C) 2008--2017  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
+#
+# =============================================================================
+#
+
+
+from optparse import OptionParser
+import sys
+
+
+from igwn_ligolw import lsctables
+from igwn_ligolw import utils as ligolw_utils
+from igwn_ligolw.utils import process as ligolw_process
+from igwn_ligolw.utils import segments as ligolw_segments
+import lal
+from lalinspiral import thinca
+from igwn_segments import utils as segmentsUtils
+
+
+__author__ = "Kipp Cannon <kipp.cannon@ligo.org>"
+from lalinspiral.git_version import date as __date__
+from lalinspiral.git_version import version as __version__
+
+
+#
+# =============================================================================
+#
+#                                 Command Line
+#
+# =============================================================================
+#
+
+
+def parse_command_line():
+	parser = OptionParser(
+		version = "Name: %%prog\n%s" % __version__,
+		usage = "%prog [options] [file ...]",
+		description = "%prog implements the inspiral coincidence algorithm for use in performing trigger-based multi-instrument searches for gravitational wave events.  The LIGO Light Weight XML files listed on the command line are processed one by one in order, and over-written with the results.  If no files are named, then input is read from stdin and output written to stdout.  Gzipped files will be autodetected on input, if a file's name ends in \".gz\" it will be gzip-compressed on output."
+	)
+	parser.add_option("-c", "--comment", metavar = "text", help = "Set comment string in process table (default = None).")
+	parser.add_option("-f", "--force", action = "store_true", help = "Process document even if it has already been processed.")
+	parser.add_option("-t", "--threshold", metavar = "float", type = "float", help = "Set the coincidence window in seconds, not including light travel time (required).  The value entered here will be dilated by the light travel time between detectors to define the coincidence window for each detector pair.")
+	parser.add_option("--min-instruments", metavar = "number", default = "2", type = "int", help = "Set the minimum number of instruments that must participate in a coincidence (default = 2).  The value must be greater than 0.")
+	# FIXME:  the test documents I have don't have SNR segments in
+	# them, but really that's what this should be using
+	parser.add_option("--snr-segments-name", metavar = "string", default = "whitehtsegments", help = "From the input document, use the segment list with this name to define when each detector was operating (default = \"whitehtsegments\").")
+	parser.add_option("--vetoes-segments-name", metavar = "string", help = "From the input document, use the segment list with this name to veto single-detector triggers before considering them for coincidence (default = do not apply vetoes.")
+	parser.add_option("--coinc-end-time-segment", metavar = "seg", help = "The segment of time to retain coincident triggers from.  Uses segmentUtils.from_range_strings() format \"START:END\" for an interval of the form [START,END), \"START:\" for an interval of the form [START,INF), and \":END\" for an interval of the form (-INF,END) (default = retain all coincidences)")
+	parser.add_option("-v", "--verbose", action = "store_true", help = "Be verbose.")
+	options, filenames = parser.parse_args()
+
+	process_params = options.__dict__.copy()
+
+	#
+	# check arguments
+	#
+
+	required_options = ["threshold"]
+	missing_options = [option for option in required_options if getattr(options, option) is None]
+	if missing_options:
+		raise ValueError("missing required option(s) %s" % ", ".join("--%s" % option.replace("_", "-") for option in missing_options))
+	if options.min_instruments < 1:
+		raise ValueError("invalid --min-instruments: \"%s\"" % options.min_instruments)
+
+	if options.coinc_end_time_segment is not None:
+		if ',' in options.coinc_end_time_segment:
+			raise ValueError("--coinc-end-time-segment may only contain a single segment")
+		options.coinc_end_time_segs = segmentsUtils.from_range_strings([options.coinc_end_time_segment], boundtype = lal.LIGOTimeGPS).coalesce()
+	else:
+		options.coinc_end_time_segs = None
+
+	#
+	# done
+	#
+
+	return options, process_params, (filenames or [None])
+
+
+#
+# =============================================================================
+#
+#                             Process Information
+#
+# =============================================================================
+#
+
+
+process_program_name = "lalapps_thinca"
+
+
+#
+# =============================================================================
+#
+#                                     Main
+#
+# =============================================================================
+#
+
+
+#
+# Command line
+#
+
+
+options, process_params, filenames = parse_command_line()
+
+
+#
+# Select ntuple_comparefunc form
+#
+
+
+if options.coinc_end_time_segs is not None:
+	# Custom Ntuple Comparison Function
+	def ntuple_comparefunc(events, offset_vector, seg = options.coinc_end_time_segs):
+		"""
+		Return False (ntuple should be retained) if the end time of
+		the coinc is in the segmentlist segs.
+		"""
+		return thinca.coinc_inspiral_end_time(events, offset_vector) not in seg
+else:
+	ntuple_comparefunc = None
+
+
+#
+# Iterate over files.
+#
+
+
+for n, filename in enumerate(filenames, start = 1):
+	#
+	# Load the file.
+	#
+
+	if options.verbose:
+		print("%d/%d:" % (n, len(filenames)), end=' ', file=sys.stderr)
+	xmldoc = ligolw_utils.load_filename(filename, verbose = options.verbose)
+
+	#
+	# Have we already processed it?
+	#
+
+	if ligolw_process.doc_includes_process(xmldoc, process_program_name):
+		if options.verbose:
+			print("warning: %s already processed," % (filename or "stdin"), end=' ', file=sys.stderr)
+		if not options.force:
+			if options.verbose:
+				print("skipping", file=sys.stderr)
+			continue
+		if options.verbose:
+			print("continuing by --force", file=sys.stderr)
+
+	#
+	# Add an entry to the process table.
+	#
+
+	process = ligolw_process.register_to_xmldoc(
+		xmldoc,
+		process_program_name,
+		process_params,
+		comment = options.comment,
+		version = __version__,
+		cvs_repository = "lscsoft",
+		cvs_entry_time = __date__
+	)
+
+	#
+	# LAL writes all triggers with event_id = 0.  Detect this and barf
+	# on it.
+	#
+
+	tbl = lsctables.SnglInspiralTable.get_table(xmldoc)
+	assert len(set(tbl.getColumnByName("event_id"))) == len(tbl), "degenerate sngl_inspiral event_id detected"
+
+	#
+	# Extract veto segments if present.
+	#
+	# FIXME:  using the tools in the igwn_ligolw.utils.segments module
+	# it's not hard to modify the veto segments in the .xml to be just
+	# those that intersect the search summary segments.  That way, if
+	# multiple documents are inserted into the same database, or merged
+	# with ligolw_add, the veto lists will not get duplicated.
+	#
+
+	seglists = ligolw_segments.segmenttable_get_by_name(xmldoc, options.snr_segments_name).coalesce()
+	if options.vetoes_segments_name is not None:
+		vetoes = ligolw_segments.segmenttable_get_by_name(xmldoc, options.vetoes_segments_name).coalesce()
+	else:
+		vetoes = None
+
+	#
+	# Run coincidence algorithm.
+	#
+
+	thinca.ligolw_thinca(
+		xmldoc,
+		process_id = process.process_id,
+		delta_t = options.threshold,
+		ntuple_comparefunc = ntuple_comparefunc,
+		seglists = seglists,
+		veto_segments = vetoes,
+		min_instruments = options.min_instruments,
+		verbose = options.verbose
+	)
+
+	#
+	# Close out the process table.
+	#
+
+	process.set_end_time_now()
+
+	#
+	# Write back to disk, and clean up.
+	#
+
+	ligolw_utils.write_filename(xmldoc, filename, verbose = options.verbose)
+	xmldoc.unlink()
+	lsctables.reset_next_ids(lsctables.TableByName.values())

lalsuite-7.26.2.dev20251206.data/scripts/lalinspiral_version

@@ -0,0 +1,6 @@
+#!python
+import os
+import sys
+from importlib.resources import files, as_file
+with as_file(files('lalapps') / 'bin' / 'lalinspiral_version') as path:
+    os.execv(path, sys.argv)

lalsuite-7.26.2.dev20251206.data/scripts/lalmetaio_version

@@ -0,0 +1,6 @@
+#!python
+import os
+import sys
+from importlib.resources import files, as_file
+with as_file(files('lalapps') / 'bin' / 'lalmetaio_version') as path:
+    os.execv(path, sys.argv)

lalsuite-7.26.2.dev20251206.data/scripts/lalpulsar_ComputeAntennaPattern

@@ -0,0 +1,6 @@
+#!python
+import os
+import sys
+from importlib.resources import files, as_file
+with as_file(files('lalapps') / 'bin' / 'lalpulsar_ComputeAntennaPattern') as path:
+    os.execv(path, sys.argv)

lalsuite-7.26.2.dev20251206.data/scripts/lalpulsar_ComputeFstatBenchmark

@@ -0,0 +1,6 @@
+#!python
+import os
+import sys
+from importlib.resources import files, as_file
+with as_file(files('lalapps') / 'bin' / 'lalpulsar_ComputeFstatBenchmark') as path:
+    os.execv(path, sys.argv)

lalsuite-7.26.2.dev20251206.data/scripts/lalpulsar_ComputeFstatLatticeCount

@@ -0,0 +1,6 @@
+#!python
+import os
+import sys
+from importlib.resources import files, as_file
+with as_file(files('lalapps') / 'bin' / 'lalpulsar_ComputeFstatLatticeCount') as path:
+    os.execv(path, sys.argv)

lalsuite-7.26.2.dev20251206.data/scripts/lalpulsar_ComputeFstatMCUpperLimit

@@ -0,0 +1,6 @@
+#!python
+import os
+import sys
+from importlib.resources import files, as_file
+with as_file(files('lalapps') / 'bin' / 'lalpulsar_ComputeFstatMCUpperLimit') as path:
+    os.execv(path, sys.argv)

lalsuite-7.26.2.dev20251206.data/scripts/lalpulsar_ComputeFstatistic_v2

@@ -0,0 +1,6 @@
+#!python
+import os
+import sys
+from importlib.resources import files, as_file
+with as_file(files('lalapps') / 'bin' / 'lalpulsar_ComputeFstatistic_v2') as path:
+    os.execv(path, sys.argv)

lalsuite-7.26.2.dev20251206.data/scripts/lalpulsar_ComputePSD

@@ -0,0 +1,6 @@
+#!python
+import os
+import sys
+from importlib.resources import files, as_file
+with as_file(files('lalapps') / 'bin' / 'lalpulsar_ComputePSD') as path:
+    os.execv(path, sys.argv)