get_data_plot

sherpa.ui.get_data_plot(id: IdType | None = None, recalc: bool = True, copy: bool = True)

Return the data used by plot_data.

Changed in version 4.19.0: The plot object is now copied by default. To get the previous behaviour set the copy attribute to False.

Parameters:

idint, str, or None, optional: The data set that provides the data. If not given then the default identifier is used, as returned by get_default_id.
recalcbool, 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.
copybool, optional: Is the plot object copied before being returned? If so then the plot attributes will not be changed by multiple calls to this routine.

Returns:

dataa sherpa.plot.DataPlot instance: 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.