Last modified: June 2019

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/plot_instmap_weights.html
AHELP for CIAO 4.11 Sherpa v1

plot_instmap_weights

Context: contrib

Synopsis

Plot up the model spectrum in the form required by mkinstmap

Syntax

plot_instmap_weights( [id=None, fluxtype="photon"] )

Description

The plot_instmap_weights() command creates a plot of the current model values in the form expected by the CIAO mkinstmap tool. Please see the Calculating Spectral Weights thread for further information on how to use this routine.

Loading the routine

The routine can be loaded into Sherpa by saying:

from sherpa_contrib.utils import *

Arguments

Name Default value Description
id None (which means use the value of get_default_id) Which dataset to use.
fluxtype "photon" The units for the instrument map are cm^2 count / <fluxtype>. The valid options for this argument are "photon" (the default) or "erg".
overplot False If True then the data is added to the current plot, otherwise a new plot is created.
clearwindow True If True then clear out the current plot area of all existing plots. This is not used if overplot is set.

Examples

Example 1

sherpa> plot_instmap_weights()

Create a plot of the model weights for the default dataset.

Example 2

sherpa> plot_instmap_weights(fluxtype="erg")

Here the weights are for use in creating an instrument map in units of cm^2 count / erg rather than the default of cm^2 count / photon.


Changes in the scripts 4.11.4 (2019) release

Plotting can now use matplotlib

The plot_instmap_weights() routine now uses the Sherpa plot backend (controlled by the plot_pkg setting in a user's ~/.sherpa.rc file), rather than always using ChIPS.

Optional argument

The clearwindow optional arguments has been added to plot_instmap_weights.


Bugs

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

See Also

contrib
estimate_weighted_expmap, get_data_prof, get_data_prof_prefs, get_delchi_prof, get_delchi_prof_prefs, get_fit_prof, get_instmap_weights, get_model_prof, get_model_prof_prefs, get_resid_prof, get_resid_prof_prefs, get_source_prof, get_source_prof_prefs, plot_chart_spectrum, plot_marx_spectrum, prof_data, prof_delchi, prof_fit, prof_fit_delchi, prof_fit_resid, prof_model, prof_resid, prof_source, save_instmap_weights, sherpa_utils
data
get_arf_plot, get_bkg_plot
modeling
normal_sample, t_sample, uniform_sample
plotting
get_energy_flux_hist, get_lrt_plot, get_lrt_results, get_photon_flux_hist, get_pvalue_plot, get_pvalue_results, get_split_plot, plot, plot_arf, plot_bkg, plot_cdf, plot_chisqr, plot_data, plot_delchi, plot_energy_flux, plot_fit, plot_model, plot_model_component, plot_order, plot_pdf, plot_photon_flux, plot_pvalue, plot_ratio, plot_resid, plot_scatter, plot_source, plot_source_component, plot_trace, set_xlinear, set_xlog, set_ylinear, set_ylog
psfs
plot_kernel
statistics
get_chisqr_plot, get_delchi_plot
visualization
contour_resid