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

Skip the navigation links
Last modified: 28 July 2008

Contextual list of Ahelp files for CIAO 4.0

Jump to: Main AHELP page | Alphabetical List

ahelp caldb calibration chandra concept dm group gui modules obsvis paramio pixlib proposaltools py.crates py.transform region sl.crates sl.transform slang stackio tools

Context Topic Summary
ahelp ahelp Access the CIAO help documentation.

caldb calCreateInfo Create a CALDB structure for use in other CALDB calls.
calFindFile Query the Calibration Database for a file
calGetData Returns the code name stored in the CALDB structure.
calGetDate Returns the observation start date stored in the CALDB structure.
calGetDetector Returns the name of the detector stored in the CALDB structure.
calGetError Returns the severity of the last CALDB error.
calGetFilter Returns the name of the filter stored in the CALDB structure.
calGetInstrument Returns the name of the instrument stored in the CALDB structure.
calGetQuery Returns the value of the query expression stored in the CALDB structure.
calGetTelescope Returns the name of the telescope stored in the CALDB structure.
calGetTime Returns the observation start time stored in the CALDB structure.
calPrintInfo Display the contents of the CALDB structure
calSetData Sets the data product code name for the next CALDB query.
calSetDate Sets the date for the next CALDB query.
calSetDetector Sets the name of the detector in the CALDB structure.
calSetExpression Sets the boundary condition(s) for the CALDB query.
calSetFilter Sets the filter to be used in a CALDB query.
calSetInstrument Sets the name of the instrument in the CALDB structure.
calSetTelescope Sets the name of the telescope in the CALDB structure.
calSetTime Sets the time for the next CALDB query.

calibration ardlib Analysis Reference Data Library
caldb CALibration DataBase (CALDB)

chandra coords Coordinate systems used in Chandra analysis
eventdef Column definition in Chandra event files
level Describes the amount of processing performed to create a given product.
mtl A description of the Mission Time Line (MTL)
pileup An overview of pileup in the Chandra ACIS detector.
times "Times" used in Chandra datasets and Chandra data analysis

concept autoname Autonaming is a feature available in various tools for automatically naming an output file based upon the name of an input file.
ciao Chandra Interactive Analysis of Observations
merging_rules A description of the merging rules used when combining header information.
parameter Describes the parameter interface used by CIAO.
session A session is a conceptual notion of how various CIAO applications interact with each other to form an integrated data analysis environment.
stack How to set a parameter to more than one value using a stack.
subspace Describes the filtering applied to a file

dm dmascii Using the Data Model with text files
dmbinning The CIAO binning syntax
dmcols Selecting columns in a table
dmfiltering The CIAO filtering syntax
dmimages Images in CIAO: logical and physical coordinate systems
dmimfiltering The CIAO filtering syntax for images
dmintro The Data Model library underlies most of the CXC tools.
dmopt Controlling data model internal options
dmregions CIAO region filtering syntax
dmsyntax The Data Model syntax for filtering and binning files.
dm The CIAO Data Model

group grpAdaptiveSnr Adaptively group an array by signal to noise.
grpAdaptive Group an array by the number of counts per group using an adaptive scheme.
grpBinFile Group an array using the grouping applied to another dataset.
grpBinWidth Group an array into a set of equal-width groups (by group width).
grpBin Group an array using low and high boundaries.
grpGetChansPerGroup Calculate the number of channels (elements) in each group.
grpGetGroupSum Apply the supplied grouping to an array.
grpGetGrpNum Calculate the group number for each element in the array.
grpMaxSlope Group an array so that its absolute gradient is above a user-defined limit.
grpMinSlope Group an array so that its absolute gradient is below a user-defined limit.
grpNumBins Group an array into a set of equal-width groups (by number of groups).
grpNumCounts Group an array by the number of counts per group.
grpSnr Group an array by signal to noise.

gui analysis-menu The "Analysis" menu in CIAO GUIs allows users to run command-line tools.
ciao.par Parameter file to configure options for CIAO applications.
ciaoshmem Provides information on and configuration of CIAO sessions.
gui Graphical User Interface (GUI)
peg Parameter Editor Gui (for CXCDS parameter interface)
prism Format-independent file browsing GUI
taskmonitor GUI to run a task as a background process and display the output

modules caldb The S-Lang interface to the CXC CALDB library
group The S-Lang interface to the CXC grouping library
paramio The S-Lang interface to the CXC parameter system
pixlib The S-Lang interface to the CXC pixlib library
region The S-Lang interface to the CXC region library
stackio The S-Lang interface to the CXC stack library

obsvis obsvis ObsVis is the Observation Visualizer created at the Chandra Science Center in Cambridge Massachusetts, USA.

paramio paccess Returns the path to the specified parameter file.
paramclose Close a parameter file opened by paramopen.
paramopen Open a parameter file.
pgets Read/write individual parameter values from S-Lang.
pget Get a parameter value within S-Lang.
plist_names List parameter names for a single tool from S-Lang.
pquery Query a parameter value from S-Lang.
pset Set a parameter value within S-Lang.
punlearn Restore the system defaults for a parameter file from S-Lang.

pixlib pix_apply_aspect Convert from FPC to Sky tangent coordinates by applying an aspect solution.
pix_chip_to_fpc Convert from the Chip to Focal Plane coordinate (FPC) system.
pix_chip_to_gdp Convert from the Chip to Grating Dispersion Plane (GDP) coordinate system.
pix_chip_to_tdet Convert from the Chip to Tiled Detector (TDET) coordinate system.
pix_close_pixlib Convert between different Chandra coordinate systems in S-Lang
pix_deapply_aspect Convert from Sky tangent coordinates to FPC by reversing the aspect solution.
pix_disp_config Display the current settings of the pixlib module.
pix_dmTanPixToWorld Convert from FPC to World (celestial) coordinates by applying an aspect solution.
pix_dmTanWorldToPix Convert from World (celestial) to FPC coordinates by applying an aspect solution.
pix_fpc_to_chip Convert from the Focal Plane (FPC) to Chip coordinate system.
pix_fpc_to_gdp Convert from the Focal Plane (FPC) to Grating Dispersion Plane (GDP) coordinate system.
pix_fpc_to_msc Convert from the Focal Plane (FPC) to Mirror Spherical (MSC) coordinate system.
pix_gac_to_gdp Convert from the Grating diffracted Angular coordinates (GAC) to Grating Dispersion Plane (GDP) coordinate system.
pix_gdp_to_gac Convert from the Grating Dispersion Plane (GDP) to Grating diffracted Angular coordinates (GAC) system.
pix_get_energy Return the photon energy corresponding to a given grating dispersion (GAC) value.
pix_get_flength Return the value of the telescope focal length used by the pixlib module.
pix_get_grating_angle Return the grating angle of the currently-selected grating arm.
pix_get_grating_period Return the grating period of the currently-selected grating arm.
pix_get_grating_wavelength Return the photon wavelength corresponding to a given grating dispersion (GAC) value.
pix_get_rowland Return the value of the Rowland Circle diameter used by the pixlib module.
pix_init_pixlib Initialize the pixlib library.
pix_set_aimpoint Set the aim point to be used by the pixlib module.
pix_set_detector Set the detector to use in the pixlib routines.
pix_set_fpsys Set the focal plane system for the pixlib module.
pix_set_gdpsys Set the grating dispersion plane (GDP) system for the pixlib module.
pix_set_grating Set the grating arm and order to use in the pixlib module.
pix_set_gzo Set the grating zero-order position for the pixlib module.
pix_set_simoffset Set the stage position for the pixlib module.
pix_set_tdetsys Set the tiled detector plane system for the pixlib module.
pix_tdet_to_chip Convert from the Tiled Detector (TDET) to Chip coordinate system.

proposaltools colden Interactive program to evaluate the neutral hydrogen column density at a given direction on the sky
dates DATES is an interactive calendar and time conversion tool.
pimms PIMMS (Portable, Interactive Multi-Mission Simulator) converts source fluxes and count rates between missions.
precess Interactive astronomical coordinate conversion program that provides precession of equatorial coordinates and conversion between equatorial, ecliptic, galactic, and supergalactic coordinates
prop-coords Defines available coordinate systems for Chandra Proposal Tools
prop-time Defines available calendars and timescales for Chandra Proposal Tools
prop-tools Tools that aid in the preparation and submission of Chandra proposals

py.crates add_col Add a column to a crate.
add_image Add an image to a crate.
add_key Adds a keyword to a crate.
col_exists Does the column exist in the crate?
cratedata A brief description of CrateData object types in the CRATES library.
crates CRATES - A high-level I/O interface for Python
delete_col Removes a column from the crate.
delete_image Removes the image from a crate.
delete_key Delete a keyword from a crate.
get_axis_transform Returns the axis transform associated with specified Image Crate.
get_colvals Get the column values from a crate.
get_col_names Returns a list of the column names in the crate.
get_col Get the column, as a CrateData object, from a crate.
get_crate_item_type Returns the type of the Crate component as a string.
get_crate_type Returns the type of the Crate as a string.
get_imagevals Returns the image values from an image crate.
get_image_shape Returns an array providing the image dimensions from a crate.
get_image Returns the image, as a CrateData object, from a crate.
get_keyval Returns the value of the keyword in a crate, specified by name or number.
get_key_names Returns the names of the keywords in a crate.
get_key Returns the keyword, as a CrateKey object, from a crate.
get_number_cols Returns the number of columns in the crate.
get_number_rows Returns the number of rows in the crate.
get_transform_matrix Returns the transform matrix associated with the specified transform in a crate.
get_transform Returns the requested transform from a crate.
is_arf Determine if the input Crate contains an ARF.
is_pha Determine if the input Crate represents a PHA file.
is_rmf Determine if the input Crate contains a RMF.
key_exists Does the crate contain a given keyword.
print_axis_names Displays the axis names of an image.
print_col_names Displays the names of the columns contained in the input Crate.
print_key_names Displays the names of the keywords contained in the input Crate.
read_arf Loads an ARF file and returns an ARFCrate.
read_file Reads in FITS or ASCII data and return a crate object.
read_pha Loads a PHA file and returns a PHACrate.
read_rmf Loads an RMF file and returns an RMFCrate.
set_colvals Change the values of a column in a crate.
set_imagevals Sets the image values to input data array.
set_keyval Sets the keyword in a crate to a value.
write_arf Writes the ARFCrate to an output file.
write_file Writes the crate to an output file.
write_pha Writes the PHACrate to an output file.
write_rmf Writes a RMFCrate to an output file.

py.transform apply_transform Apply the specified transform to the given data and return the result.
copy_transform Create a copy of the transform.
get_transform_type Returns a string indicating the Transform Class Type.
transform TRANSFORMS - A high-level interface for the Transform library

region regArea Calculate the area enclosed by a region.
regExtent Calculate the bounding box of a region.
regInsideRegion Is a point (or set of points) inside a region?
regParse Parse a region for use by the routines in the region library
regPrintRegion Print out details about a region.
regRegionString Print out details about a region.

sl.crates add_col Add a column to a crate.
add_image Add an image to a crate.
add_key Adds a keyword to a crate.
col_exists Does the column exist in the crate?
cratedata A brief description of CrateData object types in the CRATES library.
crates CRATES - A high-level I/O interface for S-Lang
delete_col Removes a column from the crate.
delete_image Removes the image from a crate.
delete_key Delete a keyword from a crate.
get_axis_transform Returns the axis transform associated with specified Image Crate.
get_colvals Get the column values from a crate.
get_col_names Returns a list of the column names in the crate.
get_col Get the column, as a CrateData object, from a crate.
get_crate_item_type Returns the type of the Crate component as a string.
get_crate_type Returns the type of the Crate as a string.
get_imagevals Returns the image values from an image crate.
get_image_shape Returns an array providing the image dimensions from a crate.
get_image Returns the image, as a CrateData object, from a crate.
get_keyval Returns the value of the keyword in a crate, specified by name or number.
get_key_names Returns the names of the keywords in a crate.
get_key Returns the keyword, as a CrateKey object, from a crate.
get_number_cols Returns the number of columns in the crate.
get_number_rows Returns the number of rows in the crate.
get_transform_matrix Returns the transform matrix associated with the specified transform in a crate.
get_transform Returns the requested transform from a crate.
is_arf Determine if the input Crate contains an ARF.
is_pha Determine if the input Crate represents a PHA file.
is_rmf Determine if the input Crate contains a RMF.
key_exists Does the crate contain a given keyword.
print_axis_names Displays the axis names of an image.
print_col_names Displays the names of the columns contained in the input Crate.
print_key_names Displays the names of the keywords contained in the input Crate.
read_arf Loads an ARF file and returns an ARFCrate.
read_file Reads in FITS or ASCII data and return a crate object.
read_pha Loads a PHA file and returns a PHACrate.
read_rmf Loads an RMF file and returns an RMFCrate.
set_colvals Change the values of a column in a crate.
set_imagevals Sets the image values to input data array.
set_keyval Sets the keyword in a crate to a value.
write_arf Writes the ARFCrate to an output file.
write_file Writes the crate to an output file.
write_pha Writes the PHACrate to an output file.
write_rmf Writes a RMFCrate to an output file.

sl.transform apply_transform Apply the specified transform to the given data and return the result.
copy_transform Create a copy of the transform.
get_transform_type Returns a string indicating the Transform Class Type.
transform TRANSFORMS - A high-level interface for the Transform library

slang slang The S-Lang programing language
slsh Evaluate and run S-Lang code.

stackio stk_append Add an item (or items) to a stack.
stk_build Build a stack from text input (file name or regular expression).
stk_change_current Change the current element of a stack.
stk_change_num Change the given element of a stack.
stk_close Close a stack.
stk_count Returns the number of elements in a stack.
stk_current Returns the current position of the stack.
stk_delete_current Deletes the current element from the stack.
stk_delete_num Deletes the specified element from the stack.
stk_disp Display the contents of a stack.
stk_expand_n Create a numbered stack of N elements.
stk_read_next Returns the next element from a stack.
stk_read_num Returns the selected element from a stack.
stk_rewind Rewind the stack to its starting position.
stk_set_current Sets the current position of the stack.

tools acisreadcorr Flag and relocate out-of-time CCD events
acisspec (1) Extract source and/or background ACIS imaging spectra for both point-like and extended sources; (2) coadd ACIS spectra; (3) build weighted ARFs and RMFs.
acis_bkgrnd_lookup Find the matching ACIS "blank-sky" dataset for an observation
acis_build_badpix Create an observation-specific bad-pixel file
acis_classify_hotpix Determine whether a suspicious pixel is hot or affected by an afterglow.
acis_detect_afterglow Identify and flag cosmic ray afterglows (L1)
acis_fef_lookup Find the FITS Embedded Function file for use by mkrmf
acis_find_hotpix Identify pixels that have an unusually large (or small) number of events.
acis_process_events Produce or update TIME, coordinates, PI, GRADE, and STATUS information in ACIS event files
acis_run_hotpix Identify and flag "hot" pixels and cosmic-ray "afterglows."
acis_set_ardlib Sets the bad pixel parameters of the ardlib file to the given file
aconvolve Convolve an N-dimensional image with a kernel
acrosscorr Cross-correlate two N-dimensional images or autocorrelate an image
add_grating_orders Add positive and negative diffraction orders of a grating PHA spectra and the corresponding ARFs
add_grating_spectra Add two, source and background, grating PHA spectra, averages the corresponding ARFs, and group the coadded spectrum.
analyze_ltcrv analyze_ltcrv.sl - An algorithm for cleaning lightcurves
apowerspectrum Compute the power spectrum of an N-dimensional input array, or from two columns (independent/dependent variable) in an input file
arestore restore image resolution using deconvolution techniques
asphist Bin the aspect solution into a 3D histogram of duration vs pointing offset and roll offset.
axbary Apply barycentric corrections to event times, GTIs, and header values.
celldetect Use a "sliding cell" to search for sources
csmooth Adaptively smooth a 2-D image
destreak Remove streak events from ACIS data
dmappend Append multiple blocks/extensions to an existing output file.
dmarfadd Add multiple ARF files together, weighting by exposure.
dmcontour Make contour regions from a 2-D image
dmcoords Convert between Chandra coordinate systems
dmcopy Filter and bin tables and images.
dmdiff Compare values in two FITS files.
dmextract Make a histogram table file (e.g. PHA file, lightcurve file) from a table column. Generate count histogram on supplied regions for a spatial table or image file.
dmfilth Replace pixel values in source regions of an image with values interpolated from surrounding background regions
dmgroupreg Translates DS9 regions and groups to CIAO format.
dmgroup Group a specified column in a table with various options
dmgti Create a Good Time Interval from limits placed on time-based files (event and Mission Time Line files).
dmhedit Edit datamodel file headers
dmhistory Extracts the tool history from the file header
dmimg2jpg Make a color JPEG image (or EPS) from three image files
dmimgcalc Perform arithmetic on images
dmimghist Create a histogram of the pixel values in a 2-D image
dmimgpick Maps image values to rows in a table
dmimgthresh Set low (or high) intensity or exposure regions of an image to a constant value.
dmjoin Join two files whose sampling is different.
dmkeypar Retrieve information about a keyword from an input file
dmlist List contents or structure of a file.
dmmakepar Write header keywords to a parameter file
dmmakereg Convert a region string to a CXC FITS region file
dmmerge Merge two or more compatible tables (e.g. event files) into one.
dmpaste Add new columns to a table.
dmreadpar Create header keywords from a parameter file
dmregrid Rebin a stack of 2-dimensional images.
dmsort Sort a table.
dmstat Compute statistics for images and columns in tables.
dmtcalc Modify and create columns in a table
dmtype2split Create a type 1 PHA output file for specified rows of a type 2 PHA file.
fullgarf Create a grating ARF for a particular order and grating for a given observation.
get_sky_limits Find the region covered by an image in sky coordinates
get_src_region Outputs regions that have counts higher than background
hrc_build_badpix Create observation-specific bad pixel file for HRC
hrc_dtfstats Calculate statistics from hrc_calc_dead_time and a GTI
hrc_process_events Correct HRC event positions, times, PHA, etc.
lc_clean lc_clean.sl - Clean a lightcurve to match the ACIS "blank-sky" datasets
merge_all Combine any number of observations. If desired, create corresponding exposure maps and exposure-corrected images.
mkacisrmf Generate an RMF for Chandra imaging data
mkarf Generate an ARF for Chandra imaging data (and grating 0-th order)
mkbgreg Creates a stack of background regions for a given source list
mkexpmap Generate a Chandra imaging exposure map (effective area vs. sky position)
mkgarf Generate a Chandra Grating ARF for one detector element.
mkgrmf Generate an RMF for Chandra grating data
mkinstmap Generate a Chandra instrument map (effective area vs. detector position)
mkpsf Extract a point spread function (PSF) from the PSF library.
mkrmf Generate an RMF for Chandra imaging data
mksubbgreg Subtracts source regions from background regions
mkwarf Generate a weighted ARF for Chandra ACIS data
mtl_build_gti Create Good Time Interval from Mission Time Line and limits
paccess Gives the location of a tool's parameter file
pdump Dumps the values of the parameters, with one parameter per line.
pget Get parameter values
pline Display the parameter values, with all parameters on a single line
plist List the contents of a parameter file.
pquery Query whether a parameter exists and, if so, get and return its value.
pset Set parameter values on the command line
psextract Extract source and background ACIS spectra for point-like sources and build associated ARFs and RMFs.
psf_project_ray Project rays generated by ChaRT onto a semi-infinite detector plane.
punlearn Restore system default parameter values
quizcaldb Find calibration files in the CALDB
reproject_aspect Modify aspect solution file RA, Dec, and roll or updfile WCS to minimize position differences between two source lists.
reproject_events Regrid an event file (or stack) to a common tangent point
reproject_image_grid Projects image from one WCS to another
reproject_image Projects image from one WCS to another
rmfimg Create a simple image of an RMF or ARF file
skyfov Make a field-of-view region in sky coordinates
specextract Extract source and background ACIS spectra for point-like and extended sources and build associated WMAPs, ARFs and RMFs.
sso_freeze Reproject sky x and y coordinates into a Solar System Object centered reference frame.
stk_build stk_build is used to build a stack from a user-defined string. The output is to stdout, stderr, or a file.
stk_count stk_count is used to count the number of items in a stack. The output is to the stk_count parameter file.
stk_read_num stk_read_num is used to read one element of a user-defined stack. The output is to the outelement field of the stk_read_num parameter file.
stk_where stk_where finds the location of an item in a stack
syntax Syntax used for writing mathematical operations in dmtcalc, dmimgcalc, and dmgti
tgdetect Detect and centroid the zero order image in a spatial sub-region of a grating event list.
tgextract2 Bin event list grating wavelengths column into a one-dimensional counts histogram, by source, grating part, and diffraction order. Optionally bin background spectrum.
tgextract Bin event list grating wavelengths column into a one-dimensional counts histogram, by source, grating part, and diffraction order.
tgidselectsrc Filter an input source list based upon a SNR threshold.
tgmatchsrc Match sources between two source lists by their 2-D separation files.
tg_bkg Creates a PHA background file for use in XSPEC
tg_create_mask Create a region file to define spectrum sky boundaries
tg_resolve_events Assign grating events to spectral orders; use detector energy resolution for order separation, if available.
vtpdetect Voronoi Tessellation and Percolation (VTP) source detection
wavdetect Mexican-Hat Wavelet source detection (wtransform+wrecon)
wcs_match Create a frame transformation to minimize the aspect difference between data from the same sky region.
wcs_update Modify aspect solution file RA, Dec, and roll or infile WCS based on a transformation matrix.
wrecon Combine wavelet transform coefficients into sources
wtransform Obtain wavelet transform coefficients for poisson image data

Jump to: Main AHELP page | Alphabetical List
Last modified: 28 July 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.