lalsuite 7.26.2.dev20251207__cp313-cp313-manylinux_2_28_x86_64.whl

lalsuite-7.26.2.dev20251207.data/scripts/lalapps_string_meas_likelihood

@@ -0,0 +1,264 @@
+#!python
+# Copyright (C) 2010--2018  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 __future__ import print_function
+
+
+import math
+from optparse import OptionParser
+import sqlite3
+import string
+import sys
+
+
+from lal.utils import CacheEntry
+
+
+from igwn_ligolw import dbtables
+from igwn_ligolw import ligolw
+from igwn_ligolw import utils as ligolw_utils
+from igwn_ligolw.utils import process as ligolw_process
+from igwn_ligolw.utils import search_summary as ligolw_search_summary
+from lalburst import SnglBurstUtils
+from lalburst import git_version
+from lalburst import stringutils
+import igwn_segments as segments
+
+
+__author__ = "Kipp Cannon <kipp.cannon@ligo.org>"
+__version__ = "git id %s" % git_version.id
+__date__ = git_version.date
+
+
+# characters allowed to appear in the description string
+T010150_letters = set(string.ascii_lowercase + string.ascii_uppercase + string.digits + "_+#")
+
+
+#
+# =============================================================================
+#
+#                                 Command Line
+#
+# =============================================================================
+#
+
+
+def parse_command_line():
+	parser = OptionParser(
+		version = "Name: %%prog\n%s" % git_version.verbose_msg,
+		usage = "%prog [options] [filename ...]",
+		description = "%prog analyzes a collection of sqlite3 database files containing lalburst_coinc outputs of string-cusp coincidence events, and measures probability distributions for a variety of parameters computed from those coincidences.  The distributions are written to a likelihood data file in XML format, which can later be used by to assign likelihoods to the coincidences.  The files to be processed can be named on the command line and/or provided by a LAL cache file."
+	)
+	parser.add_option("-o", "--output", metavar = "filename", default = None, help = "Set the name of the likelihood data file to write (default = stdout).")
+	parser.add_option("-c", "--input-cache", metavar = "filename", help = "Also process the files named in this LAL cache.  See lalapps_path2cache for information on how to produce a LAL cache file.")
+	parser.add_option("-t", "--tmp-space", metavar = "path", help = "Path to a directory suitable for use as a work area while manipulating the database file.  The database file will be worked on in this directory, and then moved to the final location when complete.  This option is intended to improve performance when running in a networked environment, where there might be a local disk with higher bandwidth than is available to the filesystem on which the final output will reside.")
+	parser.add_option("--T010150", metavar = "description", default = None, help = "Write the output to a file whose name is compatible with the file name format described in LIGO-T010150-00-E, \"Naming Convention for Frame Files which are to be Processed by LDAS\".  The description string will be used to form the second field in the file name.")
+	parser.add_option("--injection-reweight", metavar = "off|astrophysical", default = "off", help = "Set the weight function to be applied to the injections (default = \"off\").  When \"off\", the injections are all given equal weight and so the injection population is whatever was injected.  When set to \"astrophysical\", the injections are reweighted to simulate an amplitude^{-4} distribution.")
+	parser.add_option("--injection-reweight-cutoff", metavar = "amplitude", default = 1e-20, type = "float", help = "When using the astrophysical injection reweighting, do not allow the weight assigned to arbitrarily low-amplitude injections to grow without bound, instead clip the weight assigned to injections to the weight given to injections with this amplitude (default = 1e-20, 0 = disabled).  This option is ignored when astrophysical reweighting is not being performed.")
+	parser.add_option("--vetoes-name", metavar = "name", help = "Set the name of the segment lists to use as vetoes (default = do not apply vetoes).")
+	parser.add_option("-v", "--verbose", action = "store_true", help = "Be verbose.")
+	options, filenames = parser.parse_args()
+
+	paramdict = options.__dict__.copy()
+
+	if options.T010150 is not None:
+		if options.output is not None:
+			raise ValueError("cannot set both --T010150 and --output")
+		if options.T010150 == "":
+			options.T010150 = "STRING_LIKELIHOOD"
+		elif set(options.T010150) - T010150_letters:
+			raise ValueError("invalid characters in description \"%s\"" % options.T010150)
+
+	if options.input_cache:
+		filenames += [CacheEntry(line).path for line in file(options.input_cache)]
+
+	if not filenames:
+		raise ValueError("no input files!")
+
+	if options.injection_reweight not in ("off", "astrophysical"):
+		raise ValueError("--injection-reweight \"%s\" not recognized" % options.injections_reweight)
+
+	return options, filenames, paramdict
+
+
+#
+# =============================================================================
+#
+#                         Injection ReWeight Functions
+#
+# =============================================================================
+#
+
+
+def get_injection_weight_func(contents, reweight_type, amplitude_cutoff):
+	if reweight_type == "off":
+		def weight_func(sim, amplitude_cutoff = amplitude_cutoff):
+			# amplitude cut-off is not used
+			return 1.0
+	elif reweight_type == "astrophysical":
+		population, = ligolw_process.get_process_params(contents.xmldoc, "lalapps_binj", "--population")
+		if population != "string_cusp":
+			raise ValueError("lalapps_binj was not run with --population=\"string_cusp\"")
+		def weight_func(sim, amplitude_cutoff = amplitude_cutoff):
+			# the "string_cusp" injection population is uniform
+			# in log A, meaning the number of injections
+			# between log A and log A + d log A is independent
+			# of A.  that corresponds to a distribution density
+			# in A of P(A) dA \propto A^{-1} dA.  we want P(A)
+			# dA \propto A^{-4} dA, so each physical injection
+			# needs to be treated as if it was A^{-3} virtual
+			# injections, then the density of virtual
+			# injections will be P(A) dA \propto A^{-4} dA.
+			# the factor of 10^{21} simply renders the
+			# amplitudes closer to 1;  since double-precision
+			# arithmetic is used this should have no affect on
+			# the results, but it might help make the numbers a
+			# little easier for humans to look at should anyone
+			# have occasion to do so.
+			return (max(sim.amplitude, amplitude_cutoff) * 1e21)**-3
+	else:
+		raise ValueError(reweight_type)
+	return weight_func
+
+
+#
+# =============================================================================
+#
+#                                     Main
+#
+# =============================================================================
+#
+
+
+#
+# Command line.
+#
+
+
+options, filenames, paramdict = parse_command_line()
+
+
+#
+# Clear the statistics book-keeping object.
+#
+
+
+# FIXME:  don't hard-code instruments
+distributions = stringutils.StringCoincParamsDistributions(["H1", "L1", "V1"])
+segs = segments.segmentlistdict()
+
+
+#
+# Start output document
+#
+
+
+xmldoc = ligolw.Document()
+xmldoc.appendChild(ligolw.LIGO_LW())
+process = ligolw_process.register_to_xmldoc(xmldoc, program = u"lalapps_string_meas_likelihood", paramdict = paramdict, version = __version__, cvs_repository = "lscsoft", cvs_entry_time = __date__, comment = u"")
+
+
+#
+# Iterate over files
+#
+
+
+for n, filename in enumerate(filenames):
+	#
+	# Open the database file.
+	#
+
+	if options.verbose:
+		print("%d/%d: %s" % (n + 1, len(filenames), filename), file=sys.stderr)
+
+	working_filename = dbtables.get_connection_filename(filename, tmp_path = options.tmp_space, verbose = options.verbose)
+	connection = sqlite3.connect(str(working_filename))
+	if options.tmp_space is not None:
+		dbtables.set_temp_store_directory(connection, options.tmp_space, verbose = options.verbose)
+
+	#
+	# Summarize the database.
+	#
+
+	contents = SnglBurstUtils.CoincDatabase(connection, live_time_program = "StringSearch", search = "StringCusp", veto_segments_name = options.vetoes_name)
+	if options.verbose:
+		SnglBurstUtils.summarize_coinc_database(contents)
+	if not contents.seglists and options.verbose:
+		print("\twarning:  no segments found", file=sys.stderr)
+	segs |= contents.seglists
+
+	#
+	# Record statistics.  Assume all files with sim_burst tables are
+	# the outputs of injection runs, and others aren't.
+	#
+
+	if contents.sim_burst_table is None:
+		# iterate over burst<-->burst coincs
+		for is_background, events, offsetvector in contents.get_noninjections():
+			params = distributions.coinc_params([event for event in events if event.ifo not in contents.vetoseglists or event.peak not in contents.vetoseglists[event.ifo]], offsetvector)
+			if is_background:
+				distributions.denominator.increment(**params)
+			else:
+				distributions.candidates.increment(**params)
+	else:
+		weight_func = get_injection_weight_func(contents, options.injection_reweight, options.injection_reweight_cutoff)
+		# iterate over burst<-->burst coincs matching injections
+		# "exactly"
+		for sim, events, offsetvector in contents.get_injections():
+			distributions.numerator.increment(
+				weight = weight_func(sim),
+				**distributions.coinc_params([event for event in events if event.ifo not in contents.vetoseglists or event.peak not in contents.vetoseglists[event.ifo]], offsetvector)
+			)
+
+	#
+	# Clean up.
+	#
+
+	contents.xmldoc.unlink()
+	connection.close()
+	dbtables.discard_connection_filename(filename, working_filename, verbose = options.verbose)
+
+
+#
+# Output.
+#
+
+
+ligolw_search_summary.append_search_summary(xmldoc, process, ifos = segs.keys(), inseg = segs.extent_all(), outseg = segs.extent_all())
+xmldoc.childNodes[-1].appendChild(distributions.to_xml(u"string_cusp_likelihood"))
+process.set_end_time_now()
+
+
+def T010150_basename(instruments, description, seg):
+	start = int(math.floor(seg[0]))
+	duration = int(math.ceil(seg[1] - start))
+	return "%s-%s-%d-%d" % ("+".join(sorted(instruments)), description, start, duration)
+if options.T010150:
+	filename = "%s.xml.gz" % T010150_basename(segs.keys(), options.T010150, segs.extent_all())
+else:
+	filename = options.output
+ligolw_utils.write_filename(xmldoc, filename, verbose = options.verbose)