set_areascal

Synopsis

Set the fractional area

set_areascal([id], area, [bkg_id])

Description

The set_areascal command sets the fractional area scale (areascal). In spectral analysis, the areascal is usually set to "1" and the ARF is used to scale the data.

• id - the id of the dataset to use; if not given, uses the default dataset id (id=1 by default, see "ahelp get_default_id")
• area - the areascal value [pixel]
• bkg_id - the id of the background, if setting the background value; default=None

Example 1

sherpa> set_areascal(0.75)

Set the areascal of the default dataset to 0.75.

Example 2

sherpa> set_areascal(2, 0.90)

Set the areascal of dataset id=2 to 0.90.

Example 3

sherpa> set_areascal(1, 0.75, 1)

Set the areascal for the first background of dataset id=1 to 0.75.

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_arf, set_backscal, set_bkg, set_coord, set_counts, set_data, set_exposure, set_grouping, set_quality, set_rmf, set_staterror, set_syserror

filtering

set_filter

methods

set_iter_method, set_iter_method_opt, set_method, set_method_opt

modeling

get_par, set_bkg_model, set_full_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, set_default_id

visualization

image_setregion