Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/set_default_id.html
Jump to: Description · Examples · PARAMETERS · Notes · Bugs · See Also


AHELP for CIAO 4.13 Sherpa v1

set_default_id

Context: utilities

Synopsis

Set the default data set identifier.

Syntax

set_default_id(id)

id - int or str

Description

The Sherpa data id ties data, model, fit, and plotting information into a data set easily referenced by id. The default identifier, used by many commands, is changed by this command. The current setting can be found by using `get_default_id` .


Examples

Example 1

After the following, many commands, such as `set_source` , will use 'src' as the default data set identifier:

>>> set_default_id('src')

Example 2

Restore the default data set identifier.

>>> set_default_id(1)

PARAMETERS

The parameter for this function is:

Parameter Definition
id The default data set identifier to be used by certain Sherpa functions when an identifier is not given, or set to none .

Notes

The default Sherpa data set identifier is the integer 1.


Bugs

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

See Also

confidence
set_conf_opt, set_covar_opt, set_proj_opt
data
set_areascal, set_arf, set_backscal, set_bkg, set_coord, set_counts, set_data, set_dep, set_exposure, set_grouping, set_quality, set_rmf, set_staterror, set_syserror
filtering
set_filter
info
get_default_id
methods
set_iter_method, set_iter_method_opt, set_method, set_method_opt
modeling
get_par, get_xsabund, get_xscosmo, get_xsxsect, get_xsxset, set_bkg_model, set_bkg_source, set_full_model, set_model, set_par, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, set_xsxset
statistics
set_prior, set_sampler, set_sampler_opt, set_stat
utilities
set_analysis
visualization
image_setregion