Chandra X-Ray Observatory
Skip to the navigation links
Last modified: December 2010

Jump to: Description · Example · Bugs · See Also

AHELP for CIAO 4.3 Sherpa v1


Context: info


List all current model IDs.




Sherpa allows users to construct arbitrarily complex models from model components (e.g., Gaussians, Lorentzians, XSPEC models, etc.). These model expressions can then be assigned to Sherpa data sets, so that the models can be fit to the data. This function lists the IDs of all current, active models in a Sherpa session, i.e., all models which have been assigned to a data set to be fit. A model ID is the same as the ID of the data set to which it has been assigned, though the user has the option to assign an alternate model ID to a given model with the set_model command. However, in this case, the list_model_ids() function will return both the user-defined model ID *and* the ID of the data set to which that model has been assigned. The list_model_ids() function accepts no input arguments.


sherpa> list_model_ids()

The list_model_ids() function lists the model IDs of all active models in a Sherpa session. A model ID is the same as the ID of the data set to which it has been assigned. If a user assigns an alternate ID to a model, such as "bkg_model", both the user-defined model ID *and* the ID of the associated data set will be returned by list_model_ids(). (In this example, the set_model function is used to assign models to four data sets, as well as to assign a string model ID to a model expression.)

	    sherpa> set_model(1, xsphabs.abs1)
	    sherpa> set_model(2, xspowerlaw.p1)
	    sherpa> set_model(3, abs1*p1)
       sherpa> set_model("src", gauss1d.g1)
       sherpa> set_model(4, get_model("src"))

       sherpa> list_model_ids()
	     [1, 2, 3, 4, 'src']


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

See Also

show_bkg_model, show_bkg_source
add_model, add_user_pars, clean, create_model_component, delete_bkg_model, delete_model, delete_model_component, get_model, get_model_autoassign_func, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_order_plot, get_par, get_pileup_model, get_source, get_source_component_image, get_source_component_plot, image_model, image_model_component, image_source, image_source_component, integrate, link, load_table_model, load_user_model, reset, save_model, save_source, set_bkg_model, set_full_model, set_model_autoassign_func, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, set_xsxset
plot_model, plot_model_component, plot_source, plot_source_component
delete_psf, load_conv
save_delchi, save_resid
calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth
contour_model, contour_ratio, contour_resid, get_ratio, get_resid

Last modified: December 2010
Smithsonian Institute Smithsonian Institute

The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory. 60 Garden Street, Cambridge, MA 02138 USA.   Email: Smithsonian Institution, Copyright © 1998-2019. All rights reserved.