Synopsis
Change the fractional area factor of a PHA data set.
Syntax
set_areascal(id, area=None, bkg_id=None)
Description
The area scaling factor of a PHA data set is taken from the AREASCAL keyword, but it can be changed once the file has been loaded.
PARAMETERS
The parameters for this function are:
| Parameter | Type information | Definition |
|---|---|---|
| id | int or str, optional | The identifier for the data set to use. If not given then the default identifier is used, as returned by `get_default_id` . |
| area | number | The scaling factor. |
| bkg_id | int, str, or None, optional | Set to identify which background component to set. The default value ( none ) means that this is for the source component of the data set. |
Notes
The function does not follow the normal Python standards for parameter use, since it is designed for easy interactive use. When called with a single un-named argument, it is taken to be the `area` parameter. If given two un-named arguments, then they are interpreted as the `id` and `area` parameters, respectively. The remaining parameters are expected to be given as named arguments.
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
- get_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
- methods
- set_iter_method, set_iter_method_opt, set_method, set_method_opt
- modeling
- get_par, set_bkg_model, set_bkg_source, set_full_model, set_model, set_par, set_pileup_model, set_source
- statistics
- set_prior, set_sampler, set_sampler_opt, set_stat
- utilities
- set_analysis, set_default_id
- visualization
- image_setregion