Module functions for noticing source and background filter ranges in 1-D datasets.
Integer_Type set_notice([Integer_Type],Float_Type,Float_Type)
Integer_Type set_snotice([Integer_Type],Float_Type,Float_Type)
Integer_Type set_bnotice([Integer_Type],Float_Type,Float_Type)
Success/Error Return Values: 1/0
Arguments:
(1) Dataset number (default 1)
(2) The lower bound for the notice range (default no lower bound)
(3) The upper bound for the notice range (default no upper bound)
The commands set_notice, set_snotice,
and set_bnotice allow the user to specify data ranges
to notice in both source and background datasets, a source dataset, or
a background dataset respectively. These functions may only be applied
to 1-D data. Use
set_notice2d to
set include regions in images.
Note that these functions work in the space given by the current
ANALYSIS setting, e.g., if the setting is
ENERGY, then the defined bounds are assumed to be in
energy units. Note that in CIAO 3.1 set_notice
will work only if instrument models for both source and background are
set.
See the related Sherpa commands
NOTICE
and
IGNORE
for more information.
Read in a PHA file with instrument; notice the data below 1 keV:
sherpa> () = load_dataset(1,"example.pha")
sherpa> set_notice(1,,1)
1
sherpa> ANALYSIS
Analysis Space for Dataset 1: Energy
Continue Example 1,
notice all data between 3 and 6 Angstroms:
sherpa> ANALYSIS WAVE
sherpa> set_notice(,3.0,6.0)
1
Continue Example 2,
now noticings all source data above 9 keV:
sherpa> ANALYSIS ENERGY
sherpa> set_snotice(1,9.0,)
1
The corresponding background data above 9 keV are still ignored.
- sherpa
-
analysis,
get_groups,
ignore,
notice,
set_filter,
set_groups,
set_ignore,
set_ignore2d,
set_ignore_all,
set_ignore_bad,
set_notice2d,
set_notice_all
|