Last modified: December 2020

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

reset

Context: modeling

Synopsis

Reset the model parameters to their default settings.

Syntax

reset(model=None, id=None)

model - optional
id - int or string, optional

Description

The `reset` function restores the parameter values to the default value set by `guess` or to the user-defined default. If the user set initial model values or soft limits - e.g. either with `set_par` or by using parameter prompting via `paramprompt` - then `reset` will restore these values and limits even after `guess` or `fit` has been called.


Examples

Example 1

The following examples assume that the source model has been set using:

>>> set_source(powlaw1d.pl * xsphabs.gal)

Example 2

Fit the model and then reset the values of both components ( pl and gal ):

>>> fit()
>>> reset()

Example 3

Reset just the parameters of the pl model component:

>>> reset(pl)

Example 4

Reset all the components of the source expression for data set 2.

>>> reset(get_source(2))

PARAMETERS

The parameters for this function are:

Parameter Definition
model The model component or expression to reset. The default is to use all source expressions.
id The data set to use. The default is to use all data sets with a source expression.

Bugs

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

See Also

data
get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_source_plot
info
list_model_ids, show_bkg_model, show_bkg_source
modeling
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_num_par_frozen, get_num_par_thawed, get_order_plot, get_par, get_pileup_model, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, get_source_plot, get_xsabund, get_xscosmo, get_xsxsect, get_xsxset, guess, image_model, image_model_component, image_source, image_source_component, integrate, link, load_table_model, load_template_interpolator, load_template_model, load_user_model, normal_sample, save_model, save_source, set_bkg_model, set_bkg_source, set_full_model, set_model, set_model_autoassign_func, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, set_xsxset, t_sample, uniform_sample
plotting
get_cdf_plot, get_pdf_plot, get_pvalue_plot, get_pvalue_results, plot_cdf, plot_model, plot_model_component, plot_pdf, plot_pvalue, plot_scatter, plot_source, plot_source_component, plot_trace
psfs
delete_psf, load_conv
saving
save_delchi, save_resid
utilities
calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth
visualization
contour_model, contour_ratio, contour_resid