About Chandra Archive Proposer Instruments & Calibration Newsletters Data Analysis HelpDesk Calibration Database NASA Archives & Centers Chandra Science Links

Skip the navigation links
Last modified: 22 April 2008

URL: http://cxc.harvard.edu/ciao4.0/download/scripts/index.html
Hardcopy (PDF): A4 | Letter

CIAO 4.0 Contributed Scripts


Many data analysis tasks, particularly those that involve a formulaic procedure or many repetitions of a process, can be greatly simplified with scripts. Analysis scripts allow users to extend the functionality of a software package by writing custom "tools" to fit their specific needs. CIAO provides extensive support for the S-Lang scripting language, but shell and Perl scripts can also be used.

Please note that these scripts are not official CIAO tools. When using one of these scripts, you should always be aware of exactly what the script is doing, as you are responsible for the validity of any scientific results obtained from it. If you find a problem with a script, please notify the CXC Helpdesk. Known issues with the scripts are included in the CIAO bug pages.


Installation

The installation instructions explain how to install the script package (CIAO_4.0_scripts.tar), as well as how to run individual scripts.


Download the Script Package

CIAO_4.0_scripts.tar Last Updated:
17 Mar 2008
All the scripts listed on this page, packaged for seamless integration with CIAO; see README_CIAO_scripts for more information.

A VERSION.CIAO_scripts file is included in the scripts package. This allows you to check if you are working with the newest set of scripts:

unix% cat $ASCDS_CONTRIB/VERSION.CIAO_scripts 
17 Mar 2008  14:21:26 EDT

The VERSION.CIAO_scripts file is updated when you install a newer scripts package.

History of Changes

Package Version Script Changes
17 Mar 2008 add_grating_spectra Added execute permission to the script in the tarfile.
04 Feb 2008 add_grating_spectra Updated to v3.4. Several broken Unix "tail" commands were replaced with the CIAO tool dmkeypar.
13 Dec 2007 multiple scripts The scripts package has been updated for the CIAO 4.0 release. The Analysis Scripts section of the release notes has a list of all the changes made.

The Script Update History has a record of all changes made to the scripts package since the most recent CIAO release.


Scripts included in the Package (by category)

Data Preparation
Script Associated thread(s) Language Version Last update
acis_bkgrnd_lookup The ACIS "Blank-Sky" Background Files slsh 2.0 25-Apr-2007
Find the ACIS "blank-sky" datasets in the CALDB matching your observation; acis_bkgrnd_lookup help page
acis_set_ardlib Setting the Observation-specific Bad Pixel Files slsh 1.5 21-Jan-2005
Update ardlib.par files to find bad pixel lists; acis_set_ardlib help page
analyze_ltcrv.sl Filtering Lightcurves S-Lang 1.6 11-Apr-2007
An alternative algorithm for cleaning lightcurves; analyze_ltcrv.sl help page
lc_clean.sl The ACIS "Blank-Sky" Background Files S-Lang 1.10 5-Apr-2007
Clean a lightcurve to match the ACIS "blank-sky" datasets; lc_clean.sl help page
Imaging
Script Associated thread(s) Language Version Last update
get_sky_limits Match the Binning of an Image slsh 1.9 22-Mar-2006
Find the required binning to match two images; get_sky_limits help page
merge_all Using merge_all to Compute ACIS Exposure Maps and Fluxed Images; Merging Data from Multiple Imaging Observations Perl 3.8 06-Dec-2007
Combine arbitrary number of ObsIDs, create exposure maps and fluxed images; merge_all help page
mkBgReg.pl, mkSubBgReg.pl An Image of Diffuse Emission Perl 1.1 11-Oct-2002
Create a smoothed, exposure-corrected image of diffuse emission; mkBgReg.pl help page, mkSubBgReg.pl help page
Imaging Spectroscopy
Script Associated thread(s) Language Version Last update
acis_fef_lookup Extract ACIS Spectra for Pointlike Sources and Make RMFs and ARFs and Step-by-Step Guide to Creating ACIS Spectra (among others) slsh 1.21 16-Mar-2007
Find the FITS Embedded Function file for use by mkrmf; acis_fef_lookup help page
acisspec Coadding Spectra and Weighted Responses sh 4.1 07-Feb-2007
Extract point-like and extended ACIS spectra with weighted responses or coadd acis spectra; acisspec help page
psextract Extract ACIS Spectra for Pointlike Sources and Make RMFs and ARFs sh 4.0.1 07-Feb-2007
Extract source and background ACIS spectra for point-like sources and build associated ARFs and RMFs; psextract help page
Grating Spectroscopy
Script Associated thread(s) Language Version Last update
add_grating_orders Extract Coadded and Grouped Nth-Order Source & Background Spectra and ARFs sh 2.4 19-Mar-2007
Add positive and negative diffraction orders of a grating PHA spectra and the corresponding ARFs; add_grating_orders help page
add_grating_spectra Add Grating Spectra and Average ARFs sh 3.4 4-Feb-2008
Add two source and background grating PHA spectra, average the corresponding ARFs, and group the coadded spectrum; add_grating_spectra help page
fullgarf Create Grating ARFs for HETG/ACIS-S and LETG/ACIS-S data sh 4.1.1 26-Apr-2007
Create a grating ARF for a particular order; fullgarf help page
tg_bkg PHA Background File for XSPEC sh 1.1 28-Jul-2005
Create PHA background file for use in XSPEC; tg_bkg help page
Hardcopy (PDF): A4 | Letter
Last modified: 22 April 2008


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.