plot_energy_flux

Context: plotting

Synopsis

Plot the calculated energy flux distribution

Syntax

plot_energy_flux( [lo=None], [hi=None, id=1, num=7500, bins=75,
correlated=False, recalc=True, overplot=False,numcores] )

Description

The plot_energy_flux command plots the calculated energy flux distribution, which is the flux distribution for the model component accounting for the errors on the model parameters.

The sample_energy_flux() command can be used to return an array of flux values drawn from this distribution.

The plot_energy_flux command is parallelized to make use of multi-core systems (i.e., laptops or desktops with 2 or 4 cores) to provide significant improvements in efficiency compared to previous releases of Sherpa; the 'numcores' argument may be used to specify how the cores should be used when the command is run.

Function arguments

lo - lower photon bound; the default value of None means that the lower limit if the instrument model (ARF and RMF) should be used.
hi - upper photon bound; the default value of None means that the upper limit if the instrument model (ARF and RMF) should be used.
id - the id of the dataset to use; if not given, uses the default dataset id (id=1 by default, see "ahelp get_default_id")
num - number of samples used in the distribution (the default value is 7500)
bins - number of bins used to bin the distribution into a histogram (bins=75 by default)
correlated - whether to use a multi- or uni-variate distribution to sample the parameter values. The default value of False means use a uni-variate distribution, whilst True means use a multi-variate distribution.
recalc - should the arrays be recomputed for the plot? The default value of True means that the plot values will be re-computed, otherwise the previously-plotted values will be re-used.
overplot - should the new plot be overlaid in the plotting window? If False, which is the default value, then the plot window will be cleared before creating the plot, otherwise the data will be added to the existing plot.
numcores - number of cores to use in parallelization; default is to use all cores available (2 or 4)

The plot is displayed in a ChIPS plotting window. If there is no plotting window open, one is created. If a plotting window exists, the overplot parameter value determines whether the new plot is overlaid on any existing plots in the window or if the window is cleared before the plot is drawn.

ChIPS commands may be used within Sherpa to modify plot characteristics and create hardcopies; refer to the ChIPS website for information.

Plotting Multiple Objects

To plot multiple Sherpa objects - e.g. data, model, fit, residuals - in a single window, use the plot command.

Examples

Example 1

sherpa> plot_energy_flux()

Plot the energy flux distribution for the default dataset.

Example 2

sherpa> plot_energy_flux(0.5, 7)

Plot the energy flux distribution for the default dataset, between 0.5 and 7.0 keV.

Example 3

sherpa> plot_energy_flux(id="src")
sherpa> plot_energy_flux(0.5, 7, id="src", overplot=True)
sherpa> set_histogram(["line.color", "blue"])

Plot the energy flux distribution the "src" dataset, using the full energy range, and then overplot the 0.5 to 7 keV distribution as the blue histogram.

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.