|
|
Add parameters to a user-defined model
add_user_pars( modelname, parnames, [parvals, parmins, parmaxs,
parunits, parfrozen] )
The add_user_pars command sets up a user-defined model with
parameter values which can be use in model definitions.
Refer to the load_user_model help file for information on
creating a model
("ahelp load_user_model")
.
Note that all the parameters must be defined at the same time
by add_user_pars. Each time the command is run, it overwrites
any previously-defined parameters for the model.
-
modelname - the name of the model to which the parameters
should be added
-
parnames - list of names for the new parameters ;
default=None
-
parvals - list of parameter values; default=0
-
parmins - list of minimum values for the parameter ;
default=-3.40282e+38
-
parmaxs - list of maximum values for the parameter ;
default=3.40282e+38
-
parunits - list of parameter units;
default=None
-
parfrozen - list of whether the parameters are frozen;
default=False
(the parameter is thawed)
The parameters must be specified in the order that the
function expects. That is, if the
function has two parameters, pars[0]=slope and
pars[1]=y-intercept, then the call to "add_user_pars" must be
["slope", "yint"] (and not ["yint", "slope"]).
More information on creating custom models is available on
the Sherpa website.
sherpa> load_user_model( myline, "ml", )
sherpa> add_user_pars( ml, ["m","b"] )
Load a user model called "ml" and then add two parameters,
"m" and "b". The default settings for the parameter values,
units, etc. are used.
sherpa> add_user_pars( custom, ["slope"], [30], parunits=["cm/s"],
parfrozen=[True] )
Add a parameter called "slope" to the model "custom". The
initial parameter value is 30, the units are cm/s, and the
parameter is frozen.
- py.sherpa
-
calc_chisqr,
calc_energy_flux,
calc_model_sum,
calc_photon_flux,
calc_source_sum,
calc_stat,
clean,
contour_model,
contour_ratio,
contour_resid,
create_model_component,
dataspace1d,
dataspace2d,
delete_bkg_model,
delete_model,
delete_model_component,
delete_psf,
eqwidth,
get_bkg_plot,
get_default_id,
get_model,
get_model_autoassign_func,
get_model_plot,
get_num_par,
get_order_plot,
get_par,
get_pileup_model,
get_ratio,
get_resid,
get_source,
image_model,
image_source,
integrate,
link,
list_bkg_ids,
list_data_ids,
list_model_ids,
load_arf,
load_arrays,
load_ascii,
load_bkg,
load_bkg_arf,
load_bkg_rmf,
load_data,
load_image,
load_multi_arfs,
load_multi_rmfs,
load_pha,
load_rmf,
load_table,
load_table_model,
load_user_model,
pack_image,
pack_pha,
pack_table,
plot_model,
plot_source,
reset,
save_data,
save_image,
save_pha,
save_table,
set_bkg_model,
set_model,
set_model_autoassign_func,
set_pileup_model,
set_source,
unpack_arf,
unpack_arrays,
unpack_ascii,
unpack_bkg,
unpack_data,
unpack_image,
unpack_pha,
unpack_rmf,
unpack_table
|
![[Sherpa Logo]](../imgs/sherpa_logo_navbar.gif){kind=logo}