libgs.visualisation.FrequencyPlot

class libgs.visualisation.FrequencyPlot(name, get_spectrum, wfall=None, title=None, **fig_args)[source]

A frequency spectrum plot for use within a libgs dashboard web-application.

Note

FrequencyPlot needs a callable that it can query to obtain the frequency and spectrum information. Normally this would be hardware.RadioBase.get_spectrum(). If you are implementing a non-standard radio, ensure you consult that documentation for the format of the callable.

Note

FrequencyPlot uses the live_data identifier ‘freq’

Parameters:
  • name – The identifying name of the plot
  • get_spectrum – A callable that should return the current frequency vector and spectrum. Normally this would be the method from a RadioBase derived object.
  • wfall (optional) – The waterfall plot to connect to
  • title (optional) – The title of the frequency plot
  • (optional (**fig_args) – Any other kw argument is passed directly to bokeh.plotting.Figure when creating the figure.

Methods

connect() Start regular callbacks to the specified get_spectrum function
create_fig(sources) The create_fig method shall set up a Bokeh Figure object appropriately and return it
disconnect() Stop regular callbacks to the get_spectrum function

Attributes

Inherited from base class

live_data
live_props
name