pipeparts.plot module

Module for producing plotting elements

pipeparts.plot.channelgram(pipeline: Pipeline, src: Element, **properties: dict) → Element

Scrolling channel amplitude plot, generates video showing a scrolling plot of channel amplitudes.

Args:

pipeline:

Gst.Pipeline, the pipeline to which the new element will be added

src:

Gst.Element, the source element

**properties:

dict, keyword arguments to be set as element properties

Notes:

Available Properties:

plot_width:

float, default 0.0, width of the plot in seconds. (0 = 1/framerate)

References:

[1] ChannelGram Implementation: gstlal/gstlal/gst/python/lal_channelgram.py

Returns:

Element, the plot element

pipeparts.plot.histogram(pipeline: Pipeline, src: Element) → Element

Histogram plot, generates a video showing a histogram of the input time series.

Args:

pipeline:

Gst.Pipeline, the pipeline to which the new element will be added

src:

Gst.Element, the source element

References:

[1] HistogramPlot Implementation: gstlal/gstlal/gst/python/lal_histogramplot.py

Returns:

Element, the plot element

pipeparts.plot.spectrum(pipeline: Pipeline, src: Element, **properties: dict) → Element

Power spectrum plot, generates a video showing a power spectrum (e.g., as measured by lal_whiten).

Args:

pipeline:

Gst.Pipeline, the pipeline to which the new element will be added

src:

Gst.Element, the source element

**properties:

dict, keyword arguments to be set as element properties

Notes:

Available properties:

f_min:

float, default 10.0, Lower bound of plot in Hz

f_max:

float, default 4000.0, Upper bound of plot in Hz

References:

[1] SpectrumPlot Implementation: gstlal/gstlal/gst/python/lal_spectrumplot.py

Returns:

Element, the plot element