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 2006

URL: http://cxc.harvard.edu/ciao3.4/set_ignore.html
Hardcopy (PDF): A4 | Letter
AHELP for CIAO 3.4 set_ignore Context: sherpa

Synopsis

Module functions for ignoring source and background filter ranges in 1-D datasets.

Syntax

Integer_Type set_ignore([Integer_Type],Float_Type,Float_Type)
Integer_Type set_signore([Integer_Type],Float_Type,Float_Type)
Integer_Type set_bignore([Integer_Type],Float_Type,Float_Type)

Success/Error Return Values: 1/0

Arguments:

(1) Dataset number (default 1)

(2) The lower bound for the ignore range (default no lower bound)

(3) The upper bound for the ignore range (default no upper bound)

Description

The commands set_ignore, set_signore, and set_bignore allow the user to specify data ranges to ignore 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_ignore2d to set exclude 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_ignore will work only if instrument models for both source and background are set.

See the related Sherpa commands NOTICE and IGNORE for more information.

Example 1

Read in a PHA file with instrument; ignore the lowest-energy channels:

sherpa> () = load_dataset(1,"example.pha")
sherpa> set_ignore(1,,0.3)
1
sherpa> ANALYSIS
Analysis Space for Dataset 1: Energy

In this example, all data below 0.3 keV are ignored in dataset 1.

Example 2

Continue Example 1, ignoring all data between 6 and 12 Angstroms:

sherpa> ANALYSIS WAVE
sherpa> set_ignore(,6,12)
1

Example 3

Continue Example 2, now ignoring all source data above 9 keV:

sherpa> ANALYSIS ENERGY
sherpa> set_signore(1,9,)
1

The corresponding background data above 9 keV are still noticed.

Bugs

See the Sherpa bug pages online for an up-to-date listing of known bugs.

Hardcopy (PDF): A4 | Letter
Last modified: December 2006



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.