About Chandra Archive Proposer Instruments & Calibration Newsletters Data Analysis HelpDesk Calibration Database NASA Archives & Centers Chandra Science Links

Skip the navigation links
Last modified: December 2008

URL: http://cxc.harvard.edu/sherpa4.1/create_model_component.py.html
AHELP for Sherpa 4.1

create_model_component

Context: py.sherpa

Synopsis

Create a new model component

Syntax

create_model_component( typename, name )

Description

The create_model_component command is an explicit means of setting and naming a model by type. It is called implicitly when the set_model command ("ahelp set_model") is used. The model is created with parameters set to the default values.

  • typename - the type of model to establish; see "ahelp models" for a list of options
  • name - the name for the model. Once assigned, it is in the local variable scope.

This command is equivalent to "typename.name" when using the default model automatic assignment function; see "ahelp set_model_autoassign_func" for more information.

Example 1

sherpa> create_model_component("powlaw1d", "p1")
sherpa> list_model_components()
['p1']

Create an instance of a 1D powerlaw model named "p1". The model is established with the default settings:

sherpa> print(p1)
powlaw1d.p1
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   p1.gamma     thawed            1          -10           10
   p1.ref       frozen            1     -3.4e+38      3.4e+38
   p1.ampl      thawed            1            0      3.4e+38

Example 2

sherpa> create_model_component("bbody", "bb")
sherpa> list_model_components()
['bb']

Establish a blackbody model named "bb" with the default settings:

sherpa> print(bb)
bbody.bb
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   bb.space     thawed            0            0            1 0 - energy | 1 - wave
   bb.kT        thawed            1          0.1        1e+03        keV
   bb.ampl      thawed            1        1e-20        1e+20

sherpa> print(bb.ampl)
val     = 1
min     = 1e-20
default = 1
max     = 1e+20
units   =
frozen  = False
link    = None

Bugs

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

Last modified: December 2008



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