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

Skip the navigation links
Last modified: 10 November 2009

URL: http://cxc.harvard.edu/ciao4.1/download/scripts/index.html

CIAO 4.1 Contributed Scripts and Modules


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

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


Installation

The installation instructions explain how to install the script package (CIAO_4.1_scripts.tar), as well as how to use the components.


Download the Script Package

CIAO_4.1_scripts.tar Last Updated:
10 Nov 2009
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 
10 Nov 2009

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

History of Changes

Package Version Name Changes
10 Nov 2009 SherpaCL

The PRINT command now takes a GUI option to take advantage of the ChIPS printer dialog window. The output from the CONVERT command has been improved for a number of situations. The ChIPS C and D commands now rok correctly, but no longer support ranges other than "ALL". See 'AHELP CHANGES' from within SherpaCL for more information.

check_ciao_caldb

Updated to avoid a spurious warning message when CALDB version 4.1.4 (or later) is installed.

03 Nov 2009 SherpaCL

A new, interactive interface that allows users to use CIAO 3.4 syntax for Sherpa and ChIPS commands in CIAO 4. The language that can be used is currently limited. Refer to "ahelp sherpacl" and the SherpaCL page on the Sherpa website for more information and usage examples.

lc_clean()
lc_sigma_clip()

Both have been updated to better handle data with "extreme" lightcurves: either by erroring out or being able to create GTI files which contain a large number of time intervals.

The screen output (when verbose is set) has been modified to provide more information on the length of each interval.

deflare New script: allows user to choose between the lc_clean() or lc_sigma_clip() routine from the lightcurves.py module to remove flares from lightcurves.
04 Aug 2009 ciao_contrib The new file ciao_utils.sl was omitted from the 03 August update.
03 Aug 2009 sherpa_contrib The sherpa_utils (S-Lang or Python help) module has been updated to include save_instmap_weights (S-Lang or Python help); its use is described in the Calculating Spectral Weights for mkinstmap (S-Lang or Python) thread.
ciao_contrib A new module - ciao_utils (S-Lang or Python help) - has been added; it contains two routines for data analysis: simple_stats (S-Lang or Python help) and simple_hist (S-Lang or Python help).
check_ciao_caldb The script has been updated to check the existence of the CALDB in a more intelligent way. Functionality is unchanged.

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


Scripts and Modules (by category)

Installation
Name Associated thread(s) Language Last update
check_ciao_caldb slsh 17-Apr-2009
A tool to test the installation of the CIAO Calibration Database (CALDB); check_ciao_caldb help page
Data Preparation and Analysis
Name Associated thread(s) Language Last update
acis_bkgrnd_lookup The ACIS "Blank-Sky" Background Files (S-Lang or Python) slsh 12-Nov-2008
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 21-Jan-2005
Update ardlib.par files to find bad pixel lists; acis_set_ardlib help page
check_ctiapp.sh sh 9-Dec-2008
Adds the CTI_APP header keyword to a file, using the value of the CTI_CORR header keyword to set the correct value.
deflare Python 3-Nov-2009
Allows user to choose between the lc_clean() or lc_sigma_clip() routine from the lightcurves.py module to remove flares from lightcurves.
lightcurves Filtering Lightcurves (S-Lang or Python)
The ACIS "Blank-Sky" Background Files (S-Lang or Python)
S-Lang,Python 3-Nov-2009

The lightcurves (S-Lang or Python help) module contains two routines for identifying flares in lightcurves:

  1. lc_clean (S-Lang or Python help): clean a lightcurve to match the ACIS "blank-sky" datasets;
  2. lc_sigma_clip (S-Lang or Python help): an alternative algorithm for cleaning lightcurves that uses sigma clipping to reject outliers. Prior to CIAO 4.1 this routine was called analyze_ltcrv and only available in S-Lang.
ciao_utils ciao_contrib.utils S-Lang,Python 3-Aug-2009

The ciao_utils (S-Lang or Python help) module contains some simple data-analysis routines.

Imaging
Name Associated thread(s) Language Last update
get_sky_limits Match the Binning of an Image slsh 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 1-Jun-2009
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 11-Oct-2002
Create a smoothed, exposure-corrected image of diffuse emission; mkBgReg.pl help page, mkSubBgReg.pl help page
sherpa_utils sherpa_contrib.utils Calculating the Spectral Weights for mkinstmap (S-Lang or Python) S-Lang,Python 3-Aug-2009

The sherpa_utils (S-Lang or Python help) module contains routines for calculating the weights file for mkinstmap.

Imaging Spectroscopy
Name Associated thread(s) Language 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 12-Nov-2008
Find the FITS Embedded Function file for use by mkrmf; acis_fef_lookup help page
acisspec Coadding Spectra and Weighted Responses sh 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 30-May-2008
Extract source and background ACIS spectra for point-like sources and build associated ARFs and RMFs; psextract help page
Grating Spectroscopy

A number of scripts for grating data analysis which use ISIS, the Interactive Spectral Interpretation System, are available from the MIT/CXC S-Lang Packages webpage. Note that ISIS is not packaged with CIAO; users have to download and install it separately.

Name Associated thread(s) Language Last update
add_grating_orders Extract Coadded and Grouped Nth-Order Source & Background Spectra and ARFs sh 30-May-2008
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 30-May-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 1-Jun-2009
Create a grating ARF for a particular order; fullgarf help page
tg_bkg PHA Background File for XSPEC sh 28-Jul-2005
Create PHA background file for use in XSPEC; tg_bkg help page
Sherpa
Name Associated thread(s) Language Last update
SherpaCL Python 3-Nov-2009
An interactive interface that allows users to use CIAO 3.4 syntax for Sherpa and ChIPS commands in CIAO 4. The language that can be used is currently limited. Refer to "ahelp sherpacl" and the SherpaCL page on the Sherpa website for more information and usage examples.
sherpa_profiles sherpa_contrib.profiles Radial and elliptical profiles of Image Data (S-Lang or Python) S-Lang,Python 17-Apr-2009
Allows users to create radial (or elliptical) profiles of 2D imaging data, including model fits, from within Sherpa to allow users to visually inspect the quality of the results; see sherpa_profiles (S-Lang or Python help).
sherpa_flux_dist sherpa_contrib.flux_dist Calculating Uncertainties by Simulating Flux Distributions (S-Lang or Python) S-Lang,Python 17-Apr-2009
Create and plot the distribution of flux values due to the uncertainties on model parameters; see sherpa_flux_dist (S-Lang or Python help).
sherpa_utils sherpa_contrib.utils Radial and elliptical profiles of Image Data (S-Lang or Python) S-Lang,Python 17-Apr-2009
Utility routines for Sherpa users; see sherpa_utils (S-Lang or Python help).
chart_spectrum Preparing to Run ChaRT (S-Lang or Python) S-Lang,Python 02-Mar-2009
Create a source spectrum for which you would like a PSF to be simulated; the spectrum is used as input to ChaRT
ChIPS
Name Associated thread(s) Language Last update
SherpaCL Python 3-Nov-2009
An interactive interface that allows users to use CIAO 3.4 syntax for Sherpa and ChIPS commands in CIAO 4. The language that can be used is currently limited. Refer to "ahelp sherpacl" and the SherpaCL page on the Sherpa website for more information and usage examples.
Crates
Name Associated thread(s) Language Last update
crates_utils crates_contrib.utils S-Lang,Python 17-Apr-2009
Utility routines for Crates users; see crates_utils (S-Lang or Python help).
CIAO
Name Associated thread(s) Language Last update
ciao_contrib S-Lang,Python 17-Apr-2009
The ciao_contrib (S-Lang or Python help) module loads in all the routines from the sherpa_contrib (S-Lang or Python help) and crates_contrib (S-Lang or Python help) modules.
ISIS

A number of scripts for data analysis which use ISIS, the Interactive Spectral Interpretation System, are available from the MIT/CXC S-Lang Packages webpage. Note that ISIS is not packaged with CIAO; users have to download and install it separately.

Last modified: 10 November 2009


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.