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

Synopsis

Module functions to load source and background data from a FITS binary table into Sherpa

Syntax

Integer_Type load_fitsbin([Integer_Type], {String_Type | Struct_Type})
Integer_Type load_bfitsbin([Integer_Type], {String_Type | Struct_Type})

Success/Error Return Values: 1/0

Arguments:

(1) Data set number (default 1)

(2) FITS binary table filename, or

(2) S-Lang variable output by readbintab()

Description

The function load_fitsbin() loads data from a FITS binary table into a Sherpa data set. The function load_bfitsbin() loads data from a FITS binary table into the background associated with a Sherpa source data set. (The brackets indicate an optional letter in the function name, with ``[b]'' representing functions to use with background data. Note that background functions currently assume that the setting of multiback in the Sherpa state object is 0, i.e., that only one background dataset is allowed per source dataset.)

See the related Sherpa command READ for more information.

Example 1

sherpa> () = load_fitsbin(,"example.fits")
sherpa> () = load_fitsbin(1,"example.fits")
sherpa> () = load_bfitsbin(,"example.fits")
sherpa> () = load_bfitsbin(1,"example.fits")

The first two commands will load data from the FITS binary table into Sherpa source data set 1. The last two commands will load data from the FITS binary table into the background associated with Sherpa source data set 1.

Example 2

sherpa> foo = readbintab("example.dat")
sherpa> () = load_fitsbin(1,foo)

Here the data are read into the S-Lang variable ``foo''. The load_fitsbin() function then reads the data from arrays which are part of the variable ``foo''.

Example 3

sherpa gt; () = load_fitsbin(1,"example.pha[cols CHANNEL,COUNTS]")

Here is an example using Data Model syntax. With this function, the file name can include virtual file syntax to specify the FITS file extension from which data are read (the default is the first FITS binary table extension), and the columns from which data are read.

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.