Sets a user-defined line identification (or general model description)
for the model in the MDL output.
sherpa> <modelname> lineid "model description string"
where <modelname> is a name that has been given to a model component by
the user.
This command allows a user to associate an arbitrary string with a
particular Sherpa model. This assocation can then be stored (and
retrieved) when the session is stored as an MDL file, or it can be
retrieved using the sherpa_update_mdl or sherpa_get_mdl commands. The
intended use is to allow the user to put line identifications (such as
"Fe XVII 15.01 line") to Sherpa models, such as a gaussian or delta
function. These identifications are then stored in the MDL file, or
in the output of routines such as mdl2latex.
This command in no way changes the model parameters or how the model
is fit, and the associated string is not displayed when the SHOW
command is used. It only appears in the MDL file or the S-lang
structure returned by sherpa_update_mdl/sherpa_get_mdl.
Set a line id for a model component:
sherpa> ngauss[g1]
g1.fwhm parameter value [0.1]
g1.pos parameter value [22.10]
g1.ampl parameter value [1]
sherpa> g1 lineid "O VII Forbidden line"
- sherpa
-
autoest,
background,
create,
create_model,
createparamset,
fit,
freeze,
get_defined_models,
get_model_params,
get_models,
get_num_par,
get_par,
get_stackexpr,
getx,
gety,
guess,
instrument,
integrate,
is_paramset,
jointmode,
kernel,
linkparam,
mdl,
modelexpr,
modelstack,
nestedmodel,
noise,
paramprompt,
paramset,
pileup,
rename,
run_fit,
set_par,
set_paramset,
set_stackexpr,
source,
thaw,
truncate,
unlink
|
![[CIAO Logo]](../imgs/ciao_logo_navbar.gif){kind=logo}