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/is_subtracted.html
Hardcopy (PDF): A4 | Letter
AHELP for CIAO 3.4 is_subtracted Context: sherpa

Synopsis

Module function to determine if whether the specified dataset is background-subtracted.

Syntax

Integer_Type is_subtracted([Integer_Type])

Arguments:

(1) Dataset number (default 1)

Description

This function returns 1 if the background has been subtracted in the specified source dataset.

See the related Sherpa commands SUBTRACT and UNSUBTRACT for more information.

Example

Determine if dataset 1 is background subtracted:

sherpa> DATA example.pha
The inferred file type is PHA.  If this is not what you want, please 
specify the type explicitly in the data command.
WARNING: using systematic errors specified in the PHA file.
RMF is being input from:
  <directory_path>/example2.rmf
ARF is being input from:
  <directory_path>/example2.arf
Background data are being input from:
  <directory_path>/example2_bkg.pha
sherpa> is_subtracted
0
sherpa> SUBTRACT
sherpa> is_subtracted(1)
1

The 0 returned from the first call indicates that no, dataset 1 is not background subtracted. (Unlike XSPEC, Sherpa does not automatically subtract background data upon input.) The 1 returned from the second call, issued after the SUBTRACT command, indicates that yes, dataset 1 is now background-subtracted.

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.