get_data_plot

sherpa.astro.ui.get_data_plot(id=None, recalc=True)

Return the data used by plot_data.

Parameters
  • id (int or str, optional) – The data set that provides the data. If not given then the default identifier is used, as returned by get_default_id.

  • recalc (bool, optional) – If False then the results from the last call to plot_data (or get_data_plot) are returned, otherwise the data is re-generated.

Returns

data – An object representing the data used to create the plot by plot_data. The relationship between the returned values and the values in the data set depend on the data type. For example PHA data are plotted in units controlled by sherpa.astro.ui.set_analysis, but are stored as channels and counts, and may have been grouped and the background estimate removed.

Return type

a sherpa.plot.DataPlot instance

See also

get_data_plot_prefs

Return the preferences for plot_data.

get_default_id

Return the default data set identifier.

plot_data

Plot the data values.