A file that contains the psd plotting module code. More...

Namespaces
namespace	python.plotpsd
	psd plotting module

Functions
	python.plots.psd.summarize_coinc_xmldoc (coinc_xmldoc)
	python.plots.psd.axes_plot_cummulative_snr (axes, psds, coinc_xmldoc)
	python.plots.psd.latex_horizon_distance (Mpc)
	python.plots.psd.axes_plot_psds (axes, psds, coinc_xmldoc=None)
	python.plots.psd.plot_psds (psds, coinc_xmldoc=None, plot_width=640)
	python.plots.psd.plot_cumulative_snrs (psds, coinc_xmldoc, plot_width=640)

Detailed Description

A file that contains the psd plotting module code.

Review Status

Definition in file psd.py.

Function Documentation

◆ axes_plot_cummulative_snr()

axes_plot_cummulative_snr	(	axes,
		psds,
		coinc_xmldoc )

Definition at line 65 of file psd.py.

◆ axes_plot_psds()

axes_plot_psds	(	axes,
		psds,
		coinc_xmldoc = None )

Places a PSD plot into a matplotlib Axes object.

@param axes An Axes object into which the plot will be placed.

@param psds A dictionary of PSDs as REAL8FrequencySeries keyed by
instrument

@param coinc_xmldoc An XML document containing a single event with all
of the metadata as would be uploaded to gracedb.  This is optional.

Definition at line 126 of file psd.py.

◆ latex_horizon_distance()

latex_horizon_distance ( Mpc )

Definition at line 111 of file psd.py.

◆ plot_cumulative_snrs()

plot_cumulative_snrs	(	psds,
		coinc_xmldoc,
		plot_width = 640 )

Produces a matplotlib figure of cumulative SNRs.

@param psds A dictionary of PSDs as REAL8FrequencySeries keyed by
instrument

@param coinc_xmldoc An XML document containing a single event with all
of the metadata as would be uploaded to gracedb.

@param plot_width How wide to make the figure object in pixels
(ignored if axes is provided).

Definition at line 225 of file psd.py.

◆ plot_psds()

plot_psds	(	psds,
		coinc_xmldoc = None,
		plot_width = 640 )

Produces a matplotlib figure of PSDs.

@param psds A dictionary of PSDs as REAL8FrequencySeries keyed by
instrument

@param coinc_xmldoc An XML document containing a single event with all
of the metadata as would be uploaded to gracedb.  This is optional.

@param plot_width How wide to make the figure object in pixels
(ignored if axes is provided).

Definition at line 204 of file psd.py.

◆ summarize_coinc_xmldoc()

summarize_coinc_xmldoc ( coinc_xmldoc )

Definition at line 46 of file psd.py.

Namespaces

Functions