get_model_component

Context: modeling

Synopsis

Returns the parameters for the specified model component

Syntax

get_model_component(name)

Description

name - variable name representing the model component

The get_model_component command returns the parameter values and settings currently defining the specified model component (the get_model function returns the full model by data set ID). This command is useful in scripting since any portion of the model parameter information it returns can be stored to a variables and therefore easily accessed and manipulated within a script. Furthermore, it allows the user to view model settings before the model has been assigned to a data set, whereas the show_model and get_model commands do not. The show_model command ("ahelp show_model") is recommended to simply print the current model to the screen after the model has been assigned to a data set.

Examples

Example 1

sherpa> src1 = get_model_component("p1")

Store the parameters defining the model component "p1" to the variable "src1."

sherpa> set_source(xsphabs.abs1*powlaw1d.p1)
sherpa> fit()
sherpa> src1 = get_model_component("p1")
sherpa> print(src1)
powlaw1d.p1
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   p1.gamma     thawed      1.63768          -10           10           
   p1.ref       frozen            1 -3.40282e+38  3.40282e+38           
   p1.ampl      thawed  0.000131805            0  3.40282e+38   

sherpa> print(src1.gamma)
val         = 1.63768019074
min         = -10.0
max         = 10.0
units       = 
frozen      = False
link        = None
default_val = 1.0
default_min = -10.0
default_max = 10.0

sherpa> print(src1.gamma.max)
10.0

sherpa> src1.gamma.max = 12.

Return the current parameter values defining the power law model component named "p1" and store them in the variable "src1". Return the individual model parameter "p1.gamma" stored in "src1"; change the maximum value for this parameter to a new value.

Example 2

sherpa> create_model_component("gauss1d", "g1")
sherpa> g1_pars = get_model_component("g1")
sherpa> g1_pars.fwhm.val = 3.
sherpa> g1pars.fwhm.frozen = True

Create a 1D Gaussian model component named "g1" and store it to the variable "g1_pars". Use the "g1_pars" variable to set the FWHM value of the model to 3, and then freeze it so that it does not vary in the next fit.

Bugs

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