lalsuite 7.26.2.dev20251206__cp312-cp312-manylinux_2_28_x86_64.whl

lalsuite-7.26.2.dev20251206.data/scripts/lalapps_string_plot_likelihood

@@ -0,0 +1,380 @@
+#!python
+#
+# Copyright (C) 2009  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
+import matplotlib
+matplotlib.rcParams.update({
+	"font.size": 8.0,
+	"axes.titlesize": 10.0,
+	"axes.labelsize": 10.0,
+	"xtick.labelsize": 8.0,
+	"ytick.labelsize": 8.0,
+	"legend.fontsize": 8.0,
+	"figure.dpi": 300,
+	"savefig.dpi": 300,
+	"text.usetex": True,
+	"grid.linestyle": "-",
+	"grid.linewidth": 0.25
+})
+from matplotlib import figure
+from matplotlib import cm
+from matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas
+import numpy
+from optparse import OptionParser
+import sys
+
+
+from lalburst import git_version
+from lalburst import snglcoinc
+from lalburst import stringutils
+
+
+__author__ = "Kipp Cannon <kipp.cannon@ligo.org>"
+__version__ = "git id %s" % git_version.id
+__date__ = git_version.date
+
+
+golden_ratio = (1 + math.sqrt(5)) / 2
+
+
+#
+# =============================================================================
+#
+#                                 Command Line
+#
+# =============================================================================
+#
+
+
+def parse_command_line():
+	parser = OptionParser(
+		version = "Name: %%prog\n%s" % git_version.verbose_msg
+	)
+	parser.add_option("-f", "--format", metavar = "extension", action = "append", default = [], help = "Set the image output format by setting the filename extension (default = \"png\").  Can be given multiple times to generate plots in multiple formats.")
+	parser.add_option("--no-filter", action = "store_true", help = "Do not apply smoothing/normalization filters to data, plot raw bin values.")
+	parser.add_option("-v", "--verbose", action = "store_true", help = "Be verbose.")
+	options, filenames = parser.parse_args()
+
+	if not options.format:
+		options.format = ["png"]
+
+	return options, (filenames or [None])
+
+
+#
+# =============================================================================
+#
+#                                     Blah
+#
+# =============================================================================
+#
+
+
+def clip_binned_array_1d(binnedarray, xlim):
+	imin, = binnedarray.bins[xlim[0],]
+	imax, = binnedarray.bins[xlim[1],]
+	coords, = binnedarray.bins.centres()
+	return coords[imin:imax], binnedarray.at_centres()[imin:imax]
+
+
+def clip_binned_array_2d(binnedarray, xlim, ylim):
+	imin, jmin = binnedarray.bins[xlim[0], ylim[0]]
+	imax, jmax = binnedarray.bins[xlim[1], ylim[1]]
+	xcoords, ycoords = binnedarray.bins.centres()
+	return xcoords[imin:imax], ycoords[jmin:jmax], binnedarray.at_centres()[imin:imax,jmin:jmax]
+
+
+def snr2_chi2_plot(key, denominator_xcoords, denominator_ycoords, denominator_data, numerator_xcoords, numerator_ycoords, numerator_data, ncontours = 49):
+	fig = figure.Figure(figsize=(3, 3))
+	FigureCanvas(fig)
+	axes = fig.add_axes((.15, .15, .95 - .15, .90 - .15))
+	axes.loglog()
+
+	denominator_data = numpy.nan_to_num(numpy.transpose(denominator_data))
+	numerator_data = numpy.nan_to_num(numpy.transpose(numerator_data))
+
+	if numpy.any(denominator_data) or numpy.any(numerator_data):
+		hi = max(denominator_data.max(), numerator_data.max())
+		contours = numpy.arange(hi - 30, hi, 1., dtype = "double")
+		numerator_cset = axes.contour(numerator_xcoords, numerator_ycoords, numerator_data, contours, cmap = cm.Reds)
+		denominator_cset = axes.contour(denominator_xcoords, denominator_ycoords, denominator_data, contours, cmap = cm.Greys)
+	axes.set_xlim([min(denominator_xcoords[0], numerator_xcoords[0]), max(denominator_xcoords[-1], numerator_xcoords[-1])])
+	axes.set_ylim([min(denominator_ycoords[0], numerator_ycoords[0]), max(denominator_ycoords[-1], numerator_ycoords[-1])])
+	#cbar = fig.add_axes((.75,.15,.1,.75))
+	#colorbar.Colorbar(cbar, cset)
+	instrument = key.split("-")[0]
+	axes.set_title(r"%s Event Density $\ln P(\rho^{2}, \chi^{2})$" % instrument)
+	axes.set_ylabel(r"$\chi^{2} / \mathrm{DOF}$")
+	axes.set_xlabel(r"$\rho^{2}$")
+	axes.xaxis.grid(True, which = "major,minor")
+	axes.yaxis.grid(True, which = "major,minor")
+	return fig
+
+
+def dA_plot(key, denominator_coords, denominator_data, numerator_coords, numerator_data):
+	fig = figure.Figure(figsize=(4, 4 / golden_ratio))
+	FigureCanvas(fig)
+	axes = fig.add_axes((.14, .15, .98 - .14, .90 - .15))
+
+	denominator_data = numpy.nan_to_num(denominator_data)
+	numerator_data = numpy.nan_to_num(numerator_data)
+
+	if numpy.any(denominator_data):
+		axes.plot(denominator_coords, denominator_data, "k-", label = "Background")
+	if numpy.any(numerator_data):
+		axes.plot(numerator_coords, numerator_data, "r-", label = "Injections")
+	ymin, ymax = axes.get_ylim()
+	axes.set_ylim((max(ymin, ymax - 14), ymax))
+	axes.legend(loc = "upper left")
+
+	instrument1, instrument2 = key.split("-")[:2]
+	axes.set_title(r"%s--%s Amplitude Ratio Distribution" % (instrument1, instrument2))
+	axes.set_ylabel(r"$\ln P$")
+	axes.set_xlabel(r"$\log_{10} \left|A_{\mathrm{%s}} / A_{\mathrm{%s}}\right|$" % (instrument1, instrument2))
+	axes.xaxis.grid(True, which = "major,minor")
+	axes.yaxis.grid(True, which = "major,minor")
+	return fig
+
+def df_plot(key, denominator_coords, denominator_data, numerator_coords, numerator_data):
+	fig = figure.Figure(figsize=(4, 4 / golden_ratio))
+	FigureCanvas(fig)
+	axes = fig.add_axes((.14, .15, .98 - .14, .90 - .15))
+
+	denominator_data = numpy.nan_to_num(denominator_data)
+	numerator_data = numpy.nan_to_num(numerator_data)
+
+	if numpy.any(denominator_data):
+		axes.plot(denominator_coords, denominator_data, "k-", label = "Background")
+	if numpy.any(numerator_data):
+		axes.plot(numerator_coords, numerator_data, "r-", label = "Injections")
+	ymin, ymax = axes.get_ylim()
+	axes.set_ylim((max(ymin, ymax - 14), ymax))
+	axes.legend(loc = "upper left")
+
+	instrument1, instrument2 = key.split("-")[:2]
+	axes.set_title(r"%s--%s Frequency Cutoff Asymmetry Distribution" % (instrument1, instrument2))
+	axes.set_ylabel(r"$\ln P$")
+	axes.set_xlabel(r"$\left({f_{\mathrm{cut}}}_{\mathrm{%s}} - {f_{\mathrm{cut}}}_{\mathrm{%s}}\right) / \frac{1}{2} \left({f_{\mathrm{cut}}}_{\mathrm{%s}} + {f_{\mathrm{cut}}}_{\mathrm{%s}}\right)$" % (instrument1, instrument2,instrument1, instrument2))
+	axes.xaxis.grid(True, which = "major,minor")
+	axes.yaxis.grid(True, which = "major,minor")
+	return fig
+
+
+def dt_plot(key, denominator_coords, denominator_data, numerator_coords, numerator_data):
+	fig = figure.Figure(figsize=(4, 4 / golden_ratio))
+	FigureCanvas(fig)
+	axes = fig.add_axes((.14, .15, .98 - .14, .90 - .15))
+
+	denominator_data = numpy.nan_to_num(denominator_data)
+	numerator_data = numpy.nan_to_num(numerator_data)
+
+	if numpy.any(denominator_data):
+		axes.plot(denominator_coords, denominator_data, "k-", label = "Background")
+	if numpy.any(numerator_data):
+		axes.plot(numerator_coords, numerator_data, "r-", label = "Injections")
+	ymin, ymax = axes.get_ylim()
+	axes.set_ylim((max(ymin, ymax - 14), ymax))
+	axes.legend(loc = "upper left")
+
+	instrument1, instrument2 = key.split("-")[:2]
+	axes.set_title(r"%s--%s Arrival Time Difference Distribution" % (instrument1, instrument2))
+	axes.set_ylabel(r"$\ln P$")
+	axes.set_xlabel(r"$t_{\mathrm{%s}} - t_{\mathrm{%s}}$ (s)" % (instrument1, instrument2))
+	axes.xaxis.grid(True, which = "major,minor")
+	axes.yaxis.grid(True, which = "major,minor")
+	return fig
+
+
+def nevents_plot(key, xcoords, denominator_data, numerator_data):
+	fig = figure.Figure(figsize = (4, 4 / golden_ratio))
+	FigureCanvas(fig)
+	axes = fig.add_axes((.14, .15, .98 - .14, .90 - .15))
+
+	denominator_data = numpy.nan_to_num(denominator_data)
+	numerator_data = numpy.nan_to_num(numerator_data)
+
+	axes.plot(xcoords, denominator_data, "ko-", label = "Background")
+	axes.plot(xcoords, numerator_data, "ro-", label = "Injections")
+	axes.legend(loc = "lower left")
+
+	axes.set_title("Number of Events Found in Coincidence")
+	axes.set_xlabel("Number of Events $N$")
+	axes.set_ylabel(r"$\ln P(N)$")
+	axes.xaxis.grid(True, which = "major,minor")
+	axes.yaxis.grid(True, which = "major,minor")
+
+	return fig
+
+def instrumentgroup_plot(key, xcoords, denominator_data, numerator_data):
+	fig = figure.Figure(figsize = (4, 4 / golden_ratio))
+	FigureCanvas(fig)
+	axes = fig.add_axes((.14, .15, .98 - .14, .90 - .15))
+
+	denominator_data = numpy.nan_to_num(denominator_data)
+	numerator_data = numpy.nan_to_num(numerator_data)
+
+	axes.plot(xcoords, denominator_data, "ko-", label = "Background")
+	axes.plot(xcoords, numerator_data, "ro-", label = "Injections")
+	axes.set_ticklabels([",".join(sorted(stringutils.category_to_instruments(i))) for i in xcoords])
+	axes.legend(loc = "upper right")
+
+	axes.set_title("Instrument Combinations")
+	axes.set_xlabel("Instrument Combination")
+	axes.set_ylabel(r"$\ln P(\mathrm{Instruments})$")
+	axes.xaxis.grid(True, which = "major,minor")
+	axes.yaxis.grid(True, which = "major,minor")
+
+	return fig
+
+def instrumentgroup_timingresidual_plot(key, denominator_xcoords, denominator_ycoords, denominator_data, numerator_xcoords, numerator_ycoords, numerator_data):
+	fig = figure.Figure(figsize = (4, 4 / golden_ratio))
+	FigureCanvas(fig)
+	axes = fig.add_axes((.14, .15, .98 - .14, .90 - .15))
+
+	denominator_data = numpy.nan_to_num(denominator_data)
+	numerator_data = numpy.nan_to_num(numerator_data)
+
+	for i in range(len(denominator_xcoords)):
+		if numpy.any(denominator_data[i,:]) or numpy.any(numerator_data[i,:]):
+			axes.plot(denominator_ycoords, denominator_data[i,:], label = "Background (%s)" % ", ".join(sorted(stringutils.category_to_instruments(i + 1))))
+			axes.plot(numerator_ycoords, numerator_data[i,:], label = "Injections (%s)" % ", ".join(sorted(stringutils.category_to_instruments(i + 1))))
+	ymin, ymax = axes.get_ylim()
+	# find the smallest global maximum of all curves
+	ymin = min(max(denominator_data[i,:].max(), numerator_data[i,:].max()) for i in range(len(denominator_xcoords)))
+	axes.set_ylim((ymin - 14, ymax))
+	axes.legend(loc = "upper right")
+
+	axes.set_title("RSS Timing Residual")
+	axes.set_xlabel("RSS Timing Residual (s)")
+	axes.set_ylabel(r"$\ln P$")
+	axes.xaxis.grid(True, which = "major,minor")
+	axes.yaxis.grid(True, which = "major,minor")
+
+	return fig
+
+
+#
+# =============================================================================
+#
+#                                     Main
+#
+# =============================================================================
+#
+
+
+options, filenames = parse_command_line()
+
+
+coincparamsdistributions, seglists = stringutils.load_likelihood_data(filenames, verbose = options.verbose)
+
+if options.verbose:
+	print("computing event densities ...", file=sys.stderr)
+if not options.no_filter:
+	coincparamsdistributions.finish(verbose = options.verbose)
+
+for (denominator_name, denominator_pdf), (numerator_name, numerator_pdf) in zip(sorted(coincparamsdistributions.denominator.densities.items()), sorted(coincparamsdistributions.numerator.densities.items())):
+	assert numerator_name == denominator_name
+	name = denominator_name
+	instruments = set(name.split("_")) & set(stringutils.StringCoincParamsDistributions.instrument_categories)
+	if name.endswith("_snr2_chi2"):
+		if options.verbose:
+			print("generating plots for %s ..." % name, file=sys.stderr)
+		denominator_xcoords, denominator_ycoords, denominator_data = clip_binned_array_2d(denominator_pdf, [10, 1e6], [.01, 1e4])
+		numerator_xcoords, numerator_ycoords, numerator_data = clip_binned_array_2d(numerator_pdf, [10, 1e6], [.01, 1e4])
+		fig = snr2_chi2_plot("%s" % name.replace("_", "-"), denominator_xcoords, denominator_ycoords, denominator_data, numerator_xcoords, numerator_ycoords, numerator_data)
+		for extension in options.format:
+			outname = "%s.%s" % (name, extension)
+			if options.verbose:
+				print("\twriting %s ..." % outname, file=sys.stderr)
+			fig.savefig(outname)
+	elif name.endswith("_dt"):
+		if options.verbose:
+			print("generating plots for %s ..." % name, file=sys.stderr)
+		dt = .010 + snglcoinc.light_travel_time(*instruments)
+		denominator_coords, denominator_data = clip_binned_array_1d(denominator_pdf, (-dt, +dt))
+		numerator_coords, numerator_data = clip_binned_array_1d(numerator_pdf, (-dt, +dt))
+		fig = dt_plot("%s" % name.replace("_", "-"), denominator_coords, denominator_data, numerator_coords, numerator_data)
+		for extension in options.format:
+			outname = "%s.%s" % (name, extension)
+			if options.verbose:
+				print("\twriting %s ..." % outname, file=sys.stderr)
+			fig.savefig(outname)
+	elif name.endswith("_dA"):
+		if options.verbose:
+			print("generating plots for %s ..." % name, file=sys.stderr)
+		denominator_coords, denominator_data = clip_binned_array_1d(denominator_pdf, (-2, +2))
+		numerator_coords, numerator_data = clip_binned_array_1d(numerator_pdf, (-2, +2))
+		fig = dA_plot("%s" % name.replace("_", "-"), denominator_coords, denominator_data, numerator_coords, numerator_data)
+		for extension in options.format:
+			outname = "%s.%s" % (name, extension)
+			if options.verbose:
+				print("\twriting %s ..." % outname, file=sys.stderr)
+			fig.savefig(outname)
+	elif name.endswith("_df"):
+		if options.verbose:
+			print("generating plots for %s ..." % name, file=sys.stderr)
+		denominator_coords, denominator_data = clip_binned_array_1d(denominator_pdf, (-0.6, +0.6))
+		numerator_coords, numerator_data = clip_binned_array_1d(numerator_pdf, (-0.6, +0.6))
+		fig = df_plot("%s" % name.replace("_", "-"), denominator_coords, denominator_data, numerator_coords, numerator_data)
+		for extension in options.format:
+			outname = "%s.%s" % (name, extension)
+			if options.verbose:
+				print("\twriting %s ..." % outname, file=sys.stderr)
+			fig.savefig(outname)
+	elif name == "nevents":
+		if options.verbose:
+			print("generating plots for %s ..." % name, file=sys.stderr)
+		fig = nevents_plot("%s" % name.replace("_", "-"), denominator_pdf.centres()[0], denominator_pdf.array, numerator_pdf.array)
+		for extension in options.format:
+			outname = "%s.%s" % (name, extension)
+			if options.verbose:
+				print("\twriting %s ..." % outname, file=sys.stderr)
+			fig.savefig(outname)
+	elif name == "instrumentgroup":
+		if options.verbose:
+			print("generating plots for %s ..." % name, file=sys.stderr)
+		fig = instrumentgroup_plot("%s" % name.replace("_", "-"), denominator_pdf.centres()[0], denominator_pdf.array, numerator_pdf.array)
+		for extension in options.format:
+			outname = "%s.%s" % (name, extension)
+			if options.verbose:
+				print("\twriting %s ..." % outname, file=sys.stderr)
+			fig.savefig(outname)
+	elif name == "instrumentgroup,rss_timing_residual":
+		if options.verbose:
+			print("generating plots for %s ..." % name, file=sys.stderr)
+		denominator_xcoords, denominator_ycoords, denominator_data = clip_binned_array_2d(denominator_pdf, [1, denominator_pdf.array.shape[0] + 0.5], [0, .02])
+		numerator_xcoords, numerator_ycoords, numerator_data = clip_binned_array_2d(numerator_pdf, [1, denominator_pdf.array.shape[0] + 0.5], [0, .02])
+		fig = instrumentgroup_timingresidual_plot("%s" % name.replace("_", "-").replace(",", "--"), denominator_xcoords, denominator_ycoords, denominator_data, numerator_xcoords, numerator_ycoords, numerator_data)
+		for extension in options.format:
+			outname = "%s.%s" % (name.replace(",", "_"), extension)
+			if options.verbose:
+				print("\twriting %s ..." % outname, file=sys.stderr)
+			fig.savefig(outname)

lalsuite-7.26.2.dev20251206.data/scripts/lalapps_synthesizeBstatMC

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

lalsuite-7.26.2.dev20251206.data/scripts/lalapps_synthesizeLVStats

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

lalsuite-7.26.2.dev20251206.data/scripts/lalapps_synthesizeTransientStats

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

lalsuite-7.26.2.dev20251206.data/scripts/lalapps_tconvert

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

lalsuite-7.26.2.dev20251206.data/scripts/lalapps_tmpltbank

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

lalsuite-7.26.2.dev20251206.data/scripts/lalapps_version

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

lalsuite-7.26.2.dev20251206.data/scripts/lalapps_xtefitstoframe

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

lalsuite-7.26.2.dev20251206.data/scripts/lalburst_cluster

@@ -0,0 +1,156 @@
+#!python
+#
+# Copyright (C) 2006,2012  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
+
+
+from lal.utils import CacheEntry
+
+
+from igwn_ligolw import utils as ligolw_utils
+from lalburst import git_version
+from lalburst import bucluster
+
+
+__author__ = "Kipp Cannon <kipp.cannon@ligo.org>"
+__version__ = "git id %s" % git_version.id
+__date__ = git_version.date
+
+
+#
+# =============================================================================
+#
+#                                 Command Line
+#
+# =============================================================================
+#
+
+
+def parse_command_line():
+	parser = OptionParser(
+		version = "Name: %%prog\n%s" % git_version.verbose_msg,
+		usage = "%prog [options] [file ...]",
+		description = "Run a single-instrument burst clustering algorithm on the sngl_burst events contained in LIGO Light Weight XML files.  Files can be listed on the command line and/or in one or more LAL cache files.  If no files are named, then input is read from stdin and written to stdout."
+	)
+	parser.add_option("--comment", metavar = "text", help = "Set the comment string to be recorded in the process table (default = None).")
+	parser.add_option("-c", "--cluster-algorithm", metavar = "[excesspower]", help = "Set clustering method (required).")
+	parser.add_option("-i", "--input-cache", metavar = "filename", action = "append", default = [], help = "Process the files listed in this LAL cache.")
+	parser.add_option("-p", "--program", metavar = "name", default = "lalapps_power", help = "Set the name of the program that generated the events as it appears in the process table (default = \"lalapps_power\").")
+	parser.add_option("-v", "--verbose", action = "store_true", help = "Be verbose.")
+	options, filenames = parser.parse_args()
+
+	if options.cluster_algorithm is None:
+		raise ValueError("missing required argument --cluster-algorithm")
+	if options.cluster_algorithm not in ("excesspower",):
+		raise ValueError("unrecognized --cluster-algorithm %s" % options.cluster_algorithm)
+
+	for cache in options.input_cache:
+		filenames += [CacheEntry(line).path for line in file(cache)]
+
+	return options, (filenames or [None])
+
+
+#
+# =============================================================================
+#
+#                                     Main
+#
+# =============================================================================
+#
+
+
+options, filenames = parse_command_line()
+
+
+prefunc = {
+	"excesspower": bucluster.ExcessPowerPreFunc
+}[options.cluster_algorithm]
+postfunc = {
+	"excesspower": bucluster.ExcessPowerPostFunc
+}[options.cluster_algorithm]
+testfunc = {
+	"excesspower": bucluster.ExcessPowerTestFunc
+}[options.cluster_algorithm]
+sortkeyfunc = {
+	"excesspower": bucluster.ExcessPowerSortKeyFunc
+}[options.cluster_algorithm]
+bailoutfunc = {
+	"excesspower": bucluster.ExcessPowerBailoutFunc
+}[options.cluster_algorithm]
+clusterfunc = {
+	"excesspower": bucluster.ExcessPowerClusterFunc
+}[options.cluster_algorithm]
+
+
+for filename in filenames:
+	#
+	# Load document
+	#
+
+	xmldoc = ligolw_utils.load_filename(filename, verbose = options.verbose)
+
+	# FIXME:  don't do this:  fix lalapps_power's output
+	if options.cluster_algorithm in ("excesspower",):
+		bucluster.add_ms_columns(xmldoc)
+
+	#
+	# Add process information
+	#
+
+	process = bucluster.append_process(xmldoc, cluster_algorithm = options.cluster_algorithm, comment = options.comment)
+
+	#
+	# Call clustering library
+	#
+
+	xmldoc, changed = bucluster.bucluster(
+		xmldoc,
+		program = options.program,
+		process = process,
+		prefunc = prefunc,
+		postfunc = postfunc,
+		testfunc = testfunc,
+		clusterfunc = clusterfunc,
+		sortkeyfunc = sortkeyfunc,
+		bailoutfunc = bailoutfunc,
+		verbose = options.verbose
+	)
+
+	#
+	# Finish process information
+	#
+
+	process.set_end_time_now()
+
+	#
+	# Write document
+	#
+
+	if changed:
+		ligolw_utils.write_filename(xmldoc, filename, verbose = options.verbose)
+	xmldoc.unlink()