Plot horizon distance from ranking statistics

This MR will change the horizon distance plotting program in the DAG: instead of creating one horizon distance plot from reference PSDs, the new program create the horizon distance from the ranking statistic for each template bank bin. The main changes that affect the DAG workflow are summarized below:

• gstlal_inspiral_pipe: change plotting program from gstlal_plot_psd_horizon to gstlal_inspiral_plot_rankingstats_horizon (previously called gstlal_inspiral_plot_psd_horizon which does not accurately describe what it actually does, also see miscellaneous changes below).
• inspiral.py: update the horizon_dist_layer for the new plotting program.
• gstlal_inspiral_summary_page: horizon distances plots are put inside a new UI component (report.ImagePagination) so that all the plots will not be fetched at the same time and can be paginated.
• make the above changes to new style DAG workflow as well.

Miscellaneous changes:

• add new plotting module called horizon.py
• update the gstlal_plot_psd_horizon to use horizon.py module,
• renamed gstlal_inspiral_plot_psd_horizon --> gstlal_inspiral_plot_rankingstats_horizon

Note: this MR depends on gstlal-visualisation/ligo-scald!36 (merged), it's better not to merged before that request has been merged.

gstlal/bin/gstlal_play

@@ -20,12 +20,6 @@
 from optparse import OptionParser
 import sys
 
-import gi
-gi.require_version('Gst', '1.0')
-from gi.repository import GObject, Gst
-GObject.threads_init()
-Gst.init(None)
-
 import lal
 
 from ligo.lw import utils as ligolw_utils
@@ -34,6 +28,7 @@ from gstlal import multirate_datasource
 from gstlal import pipeparts
 from gstlal import simplehandler
 from gstlal.psd import read_psd
+from gstlal.stream import Stream
 from ligo.lw.utils import segments as ligolw_segments
 from ligo.lw import lsctables, ligolw
 
@@ -193,63 +188,43 @@ if options.veto_segments_file is not None:
 else:
 	veto_segments = None
 
-# building the event loop and pipeline
-mainloop = GObject.MainLoop()
-pipeline = Gst.Pipeline("gstlal_play")
-handler = simplehandler.Handler(mainloop, pipeline)
-
 #
 # the pipeline
 #
 # A basic src
-head, _, _ = datasource.mkbasicsrc(pipeline, gw_data_source_info, instrument, verbose = options.verbose)
+stream = Stream.from_datasource(gw_data_source_info, instrument, verbose=options.verbose)
 
-# if whitening, leverage mkwhitened_multirate_src() otherwise just resample
+# if not whitening, just resample
 if options.whiten:
-	head = multirate_datasource.mkwhitened_multirate_src(pipeline, head, [options.rate], instrument, psd, track_psd = True, veto_segments = veto_segments)[options.rate]
+	stream = stream.condition(options.rate, instrument, psd=psd, track_psd=True, veto_segments=veto_segments)
 else:
-	head = pipeparts.mkresample(pipeline, head, quality = 9)
-	head = pipeparts.mkcapsfilter(pipeline, head, "audio/x-raw, rate=%d" % options.rate)
+	stream = stream.resample(quality=9).capsfilter(f"audio/x-raw, rate={options.rate:d}")
 
 # handle filtering
 if options.high_pass_filter is not None and options.low_pass_filter is not None:
-	head = pipeparts.mkaudiochebband(pipeline, head, lower_frequency = options.high_pass_filter, upper_frequency = options.low_pass_filter)
+	stream = stream.audiochebband(lower_frequency=options.high_pass_filter, upper_frequency=options.low_pass_filter)
 elif options.high_pass_filter is not None:
-	head = pipeparts.mkaudiocheblimit(pipeline, head, cutoff = options.high_pass_filter, mode = "high-pass")
+	stream = stream.audiocheblimit(cutoff=options.high_pass_filter, mode="high-pass")
 elif options.low_pass_filter is not None:
-	head = pipeparts.mkaudiocheblimit(pipeline, head, cutoff = options.low_pass_filter, mode = "low-pass")
+	stream = stream.audiocheblimit(cutoff=options.low_pass_filter, mode="low-pass")
 
 # necessary audio convert and amplify 
-head = pipeparts.mkaudioconvert(pipeline, pipeparts.mkaudioamplify(pipeline, head, options.amplification))
+stream = stream.audioamplify(options.amplification).audioconvert()
 if options.sample_format is not None:
-	head = pipeparts.mkcapsfilter(pipeline, head, "audio/x-raw, format=%s" % options.sample_format)
+	stream.stream.capsfilter(f"audio/x-raw, format={options.sample_format}")
 
 if options.output is None:
-	pipeparts.mkautoaudiosink(pipeline, head)
+	stream.autoaudiosink()
 elif options.output.endswith(".wav"):
-	pipeparts.mkfilesink(pipeline, pipeparts.mkwavenc(pipeline, head), options.output)
+	stream.wavenc().filefink(options.output)
 elif options.output.endswith(".flac"):
-	pipeparts.mkfilesink(pipeline, pipeparts.mkflacenc(pipeline, head), options.output)
+	stream.flacenc().filefink(options.output)
 elif options.output.endswith(".ogg"):
-	head = pipeparts.mkoggmux(pipeline, pipeparts.mkvorbisenc(pipeline, head))
-	pipeparts.mkfilesink(pipeline, head, options.output)
+	stream.vorbisenc().oggmux().filefink(options.output)
 elif options.output.endswith(".txt") or options.output in ("/dev/stdout", "/dev/stderr"):
-	pipeparts.mknxydumpsink(pipeline, head, options.output)
+	stream.nxydumpsink(options.output)
 else:
 	raise ValueError("unrecognized format for --output")
 
-# Allow Ctrl+C or sig term to gracefully shut down the program for online
-# sources, otherwise it will just kill it
-if gw_data_source_info.data_source in ("lvshm", "framexmit"):# what about nds online?
-	simplehandler.OneTimeSignalHandler(pipeline)
-
-# Seek
-if pipeline.set_state(Gst.State.READY) == Gst.StateChangeReturn.FAILURE:
-	raise RuntimeError("pipeline failed to enter READY state")
-if gw_data_source_info.data_source not in ("lvshm", "framexmit"):# what about nds online?
-	datasource.pipeline_seek_for_gps(pipeline, gw_data_source_info.seg[0], gw_data_source_info.seg[1])
-
-# run
-if pipeline.set_state(Gst.State.PLAYING) == Gst.StateChangeReturn.FAILURE:
-	raise RuntimeError("pipeline failed to enter PLAYING state")
-mainloop.run()
+# play
+stream.start()