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

Alphabetical list of Ahelp files for CIAO 4.0

Jump to: Main AHELP page | Contextual List

A C D E F G H I K L M O P Q R S T V W

    Topic Context Summary
A acisreadcorr tools Flag and relocate out-of-time CCD events
acisspec tools (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 tools Find the matching ACIS "blank-sky" dataset for an observation
acis_build_badpix tools Create an observation-specific bad-pixel file
acis_classify_hotpix tools Determine whether a suspicious pixel is hot or affected by an afterglow.
acis_detect_afterglow tools Identify and flag cosmic ray afterglows (L1)
acis_fef_lookup tools Find the FITS Embedded Function file for use by mkrmf
acis_find_hotpix tools Identify pixels that have an unusually large (or small) number of events.
acis_process_events tools Produce or update TIME, coordinates, PI, GRADE, and STATUS information in ACIS event files
acis_run_hotpix tools Identify and flag "hot" pixels and cosmic-ray "afterglows."
acis_set_ardlib tools Sets the bad pixel parameters of the ardlib file to the given file
aconvolve tools Convolve an N-dimensional image with a kernel
acrosscorr tools Cross-correlate two N-dimensional images or autocorrelate an image
add_col py.crates Add a column to a crate.
add_col sl.crates Add a column to a crate.
add_grating_orders tools Add positive and negative diffraction orders of a grating PHA spectra and the corresponding ARFs
add_grating_spectra tools Add two, source and background, grating PHA spectra, averages the corresponding ARFs, and group the coadded spectrum.
add_image py.crates Add an image to a crate.
add_image sl.crates Add an image to a crate.
add_key py.crates Adds a keyword to a crate.
add_key sl.crates Adds a keyword to a crate.
ahelp ahelp Access the CIAO help documentation.
analysis-menu gui The "Analysis" menu in CIAO GUIs allows users to run command-line tools.
analyze_ltcrv tools analyze_ltcrv.sl - An algorithm for cleaning lightcurves
apowerspectrum tools Compute the power spectrum of an N-dimensional input array, or from two columns (independent/dependent variable) in an input file
apply_transform py.transform Apply the specified transform to the given data and return the result.
apply_transform sl.transform Apply the specified transform to the given data and return the result.
ardlib calibration Analysis Reference Data Library
arestore tools restore image resolution using deconvolution techniques
asphist tools Bin the aspect solution into a 3D histogram of duration vs pointing offset and roll offset.
autoname concept Autonaming is a feature available in various tools for automatically naming an output file based upon the name of an input file.
axbary tools Apply barycentric corrections to event times, GTIs, and header values.

C calCreateInfo caldb Create a CALDB structure for use in other CALDB calls.
caldb calibration CALibration DataBase (CALDB)
caldb modules The S-Lang interface to the CXC CALDB library
calFindFile caldb Query the Calibration Database for a file
calGetData caldb Returns the code name stored in the CALDB structure.
calGetDate caldb Returns the observation start date stored in the CALDB structure.
calGetDetector caldb Returns the name of the detector stored in the CALDB structure.
calGetError caldb Returns the severity of the last CALDB error.
calGetFilter caldb Returns the name of the filter stored in the CALDB structure.
calGetInstrument caldb Returns the name of the instrument stored in the CALDB structure.
calGetQuery caldb Returns the value of the query expression stored in the CALDB structure.
calGetTelescope caldb Returns the name of the telescope stored in the CALDB structure.
calGetTime caldb Returns the observation start time stored in the CALDB structure.
calPrintInfo caldb Display the contents of the CALDB structure
calSetData caldb Sets the data product code name for the next CALDB query.
calSetDate caldb Sets the date for the next CALDB query.
calSetDetector caldb Sets the name of the detector in the CALDB structure.
calSetExpression caldb Sets the boundary condition(s) for the CALDB query.
calSetFilter caldb Sets the filter to be used in a CALDB query.
calSetInstrument caldb Sets the name of the instrument in the CALDB structure.
calSetTelescope caldb Sets the name of the telescope in the CALDB structure.
calSetTime caldb Sets the time for the next CALDB query.
celldetect tools Use a "sliding cell" to search for sources
ciao.par gui Parameter file to configure options for CIAO applications.
ciaoshmem gui Provides information on and configuration of CIAO sessions.
ciao concept Chandra Interactive Analysis of Observations
colden proposaltools Interactive program to evaluate the neutral hydrogen column density at a given direction on the sky
col_exists py.crates Does the column exist in the crate?
col_exists sl.crates Does the column exist in the crate?
coords chandra Coordinate systems used in Chandra analysis
copy_transform py.transform Create a copy of the transform.
copy_transform sl.transform Create a copy of the transform.
cratedata py.crates A brief description of CrateData object types in the CRATES library.
cratedata sl.crates A brief description of CrateData object types in the CRATES library.
crates py.crates CRATES - A high-level I/O interface for Python
crates sl.crates CRATES - A high-level I/O interface for S-Lang
csmooth tools Adaptively smooth a 2-D image

D dates proposaltools DATES is an interactive calendar and time conversion tool.
delete_col py.crates Removes a column from the crate.
delete_col sl.crates Removes a column from the crate.
delete_image py.crates Removes the image from a crate.
delete_image sl.crates Removes the image from a crate.
delete_key py.crates Delete a keyword from a crate.
delete_key sl.crates Delete a keyword from a crate.
destreak tools Remove streak events from ACIS data
dmappend tools Append multiple blocks/extensions to an existing output file.
dmarfadd tools Add multiple ARF files together, weighting by exposure.
dmascii dm Using the Data Model with text files
dmbinning dm The CIAO binning syntax
dmcols dm Selecting columns in a table
dmcontour tools Make contour regions from a 2-D image
dmcoords tools Convert between Chandra coordinate systems
dmcopy tools Filter and bin tables and images.
dmdiff tools Compare values in two FITS files.
dmextract tools 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.
dmfiltering dm The CIAO filtering syntax
dmfilth tools Replace pixel values in source regions of an image with values interpolated from surrounding background regions
dmgroupreg tools Translates DS9 regions and groups to CIAO format.
dmgroup tools Group a specified column in a table with various options
dmgti tools Create a Good Time Interval from limits placed on time-based files (event and Mission Time Line files).
dmhedit tools Edit datamodel file headers
dmhistory tools Extracts the tool history from the file header
dmimages dm Images in CIAO: logical and physical coordinate systems
dmimfiltering dm The CIAO filtering syntax for images
dmimg2jpg tools Make a color JPEG image (or EPS) from three image files
dmimgcalc tools Perform arithmetic on images
dmimghist tools Create a histogram of the pixel values in a 2-D image
dmimgpick tools Maps image values to rows in a table
dmimgthresh tools Set low (or high) intensity or exposure regions of an image to a constant value.
dmintro dm The Data Model library underlies most of the CXC tools.
dmjoin tools Join two files whose sampling is different.
dmkeypar tools Retrieve information about a keyword from an input file
dmlist tools List contents or structure of a file.
dmmakepar tools Write header keywords to a parameter file
dmmakereg tools Convert a region string to a CXC FITS region file
dmmerge tools Merge two or more compatible tables (e.g. event files) into one.
dmopt dm Controlling data model internal options
dmpaste tools Add new columns to a table.
dmreadpar tools Create header keywords from a parameter file
dmregions dm CIAO region filtering syntax
dmregrid tools Rebin a stack of 2-dimensional images.
dmsort tools Sort a table.
dmstat tools Compute statistics for images and columns in tables.
dmsyntax dm The Data Model syntax for filtering and binning files.
dmtcalc tools Modify and create columns in a table
dmtype2split tools Create a type 1 PHA output file for specified rows of a type 2 PHA file.
dm dm The CIAO Data Model

E eventdef chandra Column definition in Chandra event files

F fullgarf tools Create a grating ARF for a particular order and grating for a given observation.

G get_axis_transform py.crates Returns the axis transform associated with specified Image Crate.
get_axis_transform sl.crates Returns the axis transform associated with specified Image Crate.
get_colvals py.crates Get the column values from a crate.
get_colvals sl.crates Get the column values from a crate.
get_col_names py.crates Returns a list of the column names in the crate.
get_col_names sl.crates Returns a list of the column names in the crate.
get_col py.crates Get the column, as a CrateData object, from a crate.
get_col sl.crates Get the column, as a CrateData object, from a crate.
get_crate_item_type py.crates Returns the type of the Crate component as a string.
get_crate_item_type sl.crates Returns the type of the Crate component as a string.
get_crate_type py.crates Returns the type of the Crate as a string.
get_crate_type sl.crates Returns the type of the Crate as a string.
get_imagevals py.crates Returns the image values from an image crate.
get_imagevals sl.crates Returns the image values from an image crate.
get_image_shape py.crates Returns an array providing the image dimensions from a crate.
get_image_shape sl.crates Returns an array providing the image dimensions from a crate.
get_image py.crates Returns the image, as a CrateData object, from a crate.
get_image sl.crates Returns the image, as a CrateData object, from a crate.
get_keyval py.crates Returns the value of the keyword in a crate, specified by name or number.
get_keyval sl.crates Returns the value of the keyword in a crate, specified by name or number.
get_key_names py.crates Returns the names of the keywords in a crate.
get_key_names sl.crates Returns the names of the keywords in a crate.
get_key py.crates Returns the keyword, as a CrateKey object, from a crate.
get_key sl.crates Returns the keyword, as a CrateKey object, from a crate.
get_number_cols py.crates Returns the number of columns in the crate.
get_number_cols sl.crates Returns the number of columns in the crate.
get_number_rows py.crates Returns the number of rows in the crate.
get_number_rows sl.crates Returns the number of rows in the crate.
get_sky_limits tools Find the region covered by an image in sky coordinates
get_src_region tools Outputs regions that have counts higher than background
get_transform_matrix py.crates Returns the transform matrix associated with the specified transform in a crate.
get_transform_matrix sl.crates Returns the transform matrix associated with the specified transform in a crate.
get_transform_type py.transform Returns a string indicating the Transform Class Type.
get_transform_type sl.transform Returns a string indicating the Transform Class Type.
get_transform py.crates Returns the requested transform from a crate.
get_transform sl.crates Returns the requested transform from a crate.
group modules The S-Lang interface to the CXC grouping library
grpAdaptiveSnr group Adaptively group an array by signal to noise.
grpAdaptive group Group an array by the number of counts per group using an adaptive scheme.
grpBinFile group Group an array using the grouping applied to another dataset.
grpBinWidth group Group an array into a set of equal-width groups (by group width).
grpBin group Group an array using low and high boundaries.
grpGetChansPerGroup group Calculate the number of channels (elements) in each group.
grpGetGroupSum group Apply the supplied grouping to an array.
grpGetGrpNum group Calculate the group number for each element in the array.
grpMaxSlope group Group an array so that its absolute gradient is above a user-defined limit.
grpMinSlope group Group an array so that its absolute gradient is below a user-defined limit.
grpNumBins group Group an array into a set of equal-width groups (by number of groups).
grpNumCounts group Group an array by the number of counts per group.
grpSnr group Group an array by signal to noise.
gui gui Graphical User Interface (GUI)

H hrc_build_badpix tools Create observation-specific bad pixel file for HRC
hrc_dtfstats tools Calculate statistics from hrc_calc_dead_time and a GTI
hrc_process_events tools Correct HRC event positions, times, PHA, etc.

I is_arf py.crates Determine if the input Crate contains an ARF.
is_arf sl.crates Determine if the input Crate contains an ARF.
is_pha py.crates Determine if the input Crate represents a PHA file.
is_pha sl.crates Determine if the input Crate represents a PHA file.
is_rmf py.crates Determine if the input Crate contains a RMF.
is_rmf sl.crates Determine if the input Crate contains a RMF.

K key_exists py.crates Does the crate contain a given keyword.
key_exists sl.crates Does the crate contain a given keyword.

L lc_clean tools lc_clean.sl - Clean a lightcurve to match the ACIS "blank-sky" datasets
level chandra Describes the amount of processing performed to create a given product.

M merge_all tools Combine any number of observations. If desired, create corresponding exposure maps and exposure-corrected images.
merging_rules concept A description of the merging rules used when combining header information.
mkacisrmf tools Generate an RMF for Chandra imaging data
mkarf tools Generate an ARF for Chandra imaging data (and grating 0-th order)
mkbgreg tools Creates a stack of background regions for a given source list
mkexpmap tools Generate a Chandra imaging exposure map (effective area vs. sky position)
mkgarf tools Generate a Chandra Grating ARF for one detector element.
mkgrmf tools Generate an RMF for Chandra grating data
mkinstmap tools Generate a Chandra instrument map (effective area vs. detector position)
mkpsf tools Extract a point spread function (PSF) from the PSF library.
mkrmf tools Generate an RMF for Chandra imaging data
mksubbgreg tools Subtracts source regions from background regions
mkwarf tools Generate a weighted ARF for Chandra ACIS data
mtl_build_gti tools Create Good Time Interval from Mission Time Line and limits
mtl chandra A description of the Mission Time Line (MTL)

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

P paccess paramio Returns the path to the specified parameter file.
paccess tools Gives the location of a tool's parameter file
paramclose paramio Close a parameter file opened by paramopen.
parameter concept Describes the parameter interface used by CIAO.
paramio modules The S-Lang interface to the CXC parameter system
paramopen paramio Open a parameter file.
pdump tools Dumps the values of the parameters, with one parameter per line.
peg gui Parameter Editor Gui (for CXCDS parameter interface)
pgets paramio Read/write individual parameter values from S-Lang.
pget paramio Get a parameter value within S-Lang.
pget tools Get parameter values
pileup chandra An overview of pileup in the Chandra ACIS detector.
pimms proposaltools PIMMS (Portable, Interactive Multi-Mission Simulator) converts source fluxes and count rates between missions.
pixlib modules The S-Lang interface to the CXC pixlib library
pix_apply_aspect pixlib Convert from FPC to Sky tangent coordinates by applying an aspect solution.
pix_chip_to_fpc pixlib Convert from the Chip to Focal Plane coordinate (FPC) system.
pix_chip_to_gdp pixlib Convert from the Chip to Grating Dispersion Plane (GDP) coordinate system.
pix_chip_to_tdet pixlib Convert from the Chip to Tiled Detector (TDET) coordinate system.
pix_close_pixlib pixlib Convert between different Chandra coordinate systems in S-Lang
pix_deapply_aspect pixlib Convert from Sky tangent coordinates to FPC by reversing the aspect solution.
pix_disp_config pixlib Display the current settings of the pixlib module.
pix_dmTanPixToWorld pixlib Convert from FPC to World (celestial) coordinates by applying an aspect solution.
pix_dmTanWorldToPix pixlib Convert from World (celestial) to FPC coordinates by applying an aspect solution.
pix_fpc_to_chip pixlib Convert from the Focal Plane (FPC) to Chip coordinate system.
pix_fpc_to_gdp pixlib Convert from the Focal Plane (FPC) to Grating Dispersion Plane (GDP) coordinate system.
pix_fpc_to_msc pixlib Convert from the Focal Plane (FPC) to Mirror Spherical (MSC) coordinate system.
pix_gac_to_gdp pixlib Convert from the Grating diffracted Angular coordinates (GAC) to Grating Dispersion Plane (GDP) coordinate system.
pix_gdp_to_gac pixlib Convert from the Grating Dispersion Plane (GDP) to Grating diffracted Angular coordinates (GAC) system.
pix_get_energy pixlib Return the photon energy corresponding to a given grating dispersion (GAC) value.
pix_get_flength pixlib Return the value of the telescope focal length used by the pixlib module.
pix_get_grating_angle pixlib Return the grating angle of the currently-selected grating arm.
pix_get_grating_period pixlib Return the grating period of the currently-selected grating arm.
pix_get_grating_wavelength pixlib Return the photon wavelength corresponding to a given grating dispersion (GAC) value.
pix_get_rowland pixlib Return the value of the Rowland Circle diameter used by the pixlib module.
pix_init_pixlib pixlib Initialize the pixlib library.
pix_set_aimpoint pixlib Set the aim point to be used by the pixlib module.
pix_set_detector pixlib Set the detector to use in the pixlib routines.
pix_set_fpsys pixlib Set the focal plane system for the pixlib module.
pix_set_gdpsys pixlib Set the grating dispersion plane (GDP) system for the pixlib module.
pix_set_grating pixlib Set the grating arm and order to use in the pixlib module.
pix_set_gzo pixlib Set the grating zero-order position for the pixlib module.
pix_set_simoffset pixlib Set the stage position for the pixlib module.
pix_set_tdetsys pixlib Set the tiled detector plane system for the pixlib module.
pix_tdet_to_chip pixlib Convert from the Tiled Detector (TDET) to Chip coordinate system.
pline tools Display the parameter values, with all parameters on a single line
plist_names paramio List parameter names for a single tool from S-Lang.
plist tools List the contents of a parameter file.
pquery paramio Query a parameter value from S-Lang.
pquery tools Query whether a parameter exists and, if so, get and return its value.
precess proposaltools Interactive astronomical coordinate conversion program that provides precession of equatorial coordinates and conversion between equatorial, ecliptic, galactic, and supergalactic coordinates
print_axis_names py.crates Displays the axis names of an image.
print_axis_names sl.crates Displays the axis names of an image.
print_col_names py.crates Displays the names of the columns contained in the input Crate.
print_col_names sl.crates Displays the names of the columns contained in the input Crate.
print_key_names py.crates Displays the names of the keywords contained in the input Crate.
print_key_names sl.crates Displays the names of the keywords contained in the input Crate.
prism gui Format-independent file browsing GUI
prop-coords proposaltools Defines available coordinate systems for Chandra Proposal Tools
prop-time proposaltools Defines available calendars and timescales for Chandra Proposal Tools
prop-tools proposaltools Tools that aid in the preparation and submission of Chandra proposals
pset paramio Set a parameter value within S-Lang.
pset tools Set parameter values on the command line
psextract tools Extract source and background ACIS spectra for point-like sources and build associated ARFs and RMFs.
psf_project_ray tools Project rays generated by ChaRT onto a semi-infinite detector plane.
punlearn paramio Restore the system defaults for a parameter file from S-Lang.
punlearn tools Restore system default parameter values

Q quizcaldb tools Find calibration files in the CALDB

R read_arf py.crates Loads an ARF file and returns an ARFCrate.
read_arf sl.crates Loads an ARF file and returns an ARFCrate.
read_file py.crates Reads in FITS or ASCII data and return a crate object.
read_file sl.crates Reads in FITS or ASCII data and return a crate object.
read_pha py.crates Loads a PHA file and returns a PHACrate.
read_pha sl.crates Loads a PHA file and returns a PHACrate.
read_rmf py.crates Loads an RMF file and returns an RMFCrate.
read_rmf sl.crates Loads an RMF file and returns an RMFCrate.
regArea region Calculate the area enclosed by a region.
regExtent region Calculate the bounding box of a region.
regInsideRegion region Is a point (or set of points) inside a region?
region modules The S-Lang interface to the CXC region library
regParse region Parse a region for use by the routines in the region library
regPrintRegion region Print out details about a region.
regRegionString region Print out details about a region.
reproject_aspect tools Modify aspect solution file RA, Dec, and roll or updfile WCS to minimize position differences between two source lists.
reproject_events tools Regrid an event file (or stack) to a common tangent point
reproject_image_grid tools Projects image from one WCS to another
reproject_image tools Projects image from one WCS to another
rmfimg tools Create a simple image of an RMF or ARF file

S session concept A session is a conceptual notion of how various CIAO applications interact with each other to form an integrated data analysis environment.
set_colvals py.crates Change the values of a column in a crate.
set_colvals sl.crates Change the values of a column in a crate.
set_imagevals py.crates Sets the image values to input data array.
set_imagevals sl.crates Sets the image values to input data array.
set_keyval py.crates Sets the keyword in a crate to a value.
set_keyval sl.crates Sets the keyword in a crate to a value.
skyfov tools Make a field-of-view region in sky coordinates
slang slang The S-Lang programing language
slsh slang Evaluate and run S-Lang code.
specextract tools Extract source and background ACIS spectra for point-like and extended sources and build associated WMAPs, ARFs and RMFs.
sso_freeze tools Reproject sky x and y coordinates into a Solar System Object centered reference frame.
stackio modules The S-Lang interface to the CXC stack library
stack concept How to set a parameter to more than one value using a stack.
stk_append stackio Add an item (or items) to a stack.
stk_build stackio Build a stack from text input (file name or regular expression).
stk_build tools stk_build is used to build a stack from a user-defined string. The output is to stdout, stderr, or a file.
stk_change_current stackio Change the current element of a stack.
stk_change_num stackio Change the given element of a stack.
stk_close stackio Close a stack.
stk_count stackio Returns the number of elements in a stack.
stk_count tools stk_count is used to count the number of items in a stack. The output is to the stk_count parameter file.
stk_current stackio Returns the current position of the stack.
stk_delete_current stackio Deletes the current element from the stack.
stk_delete_num stackio Deletes the specified element from the stack.
stk_disp stackio Display the contents of a stack.
stk_expand_n stackio Create a numbered stack of N elements.
stk_read_next stackio Returns the next element from a stack.
stk_read_num stackio Returns the selected element from a stack.
stk_read_num tools 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_rewind stackio Rewind the stack to its starting position.
stk_set_current stackio Sets the current position of the stack.
stk_where tools stk_where finds the location of an item in a stack
subspace concept Describes the filtering applied to a file
syntax tools Syntax used for writing mathematical operations in dmtcalc, dmimgcalc, and dmgti

T taskmonitor gui GUI to run a task as a background process and display the output
tgdetect tools Detect and centroid the zero order image in a spatial sub-region of a grating event list.
tgextract2 tools Bin event list grating wavelengths column into a one-dimensional counts histogram, by source, grating part, and diffraction order. Optionally bin background spectrum.
tgextract tools Bin event list grating wavelengths column into a one-dimensional counts histogram, by source, grating part, and diffraction order.
tgidselectsrc tools Filter an input source list based upon a SNR threshold.
tgmatchsrc tools Match sources between two source lists by their 2-D separation files.
tg_bkg tools Creates a PHA background file for use in XSPEC
tg_create_mask tools Create a region file to define spectrum sky boundaries
tg_resolve_events tools Assign grating events to spectral orders; use detector energy resolution for order separation, if available.
times chandra "Times" used in Chandra datasets and Chandra data analysis
transform py.transform TRANSFORMS - A high-level interface for the Transform library
transform sl.transform TRANSFORMS - A high-level interface for the Transform library

V vtpdetect tools Voronoi Tessellation and Percolation (VTP) source detection

W wavdetect tools Mexican-Hat Wavelet source detection (wtransform+wrecon)
wcs_match tools Create a frame transformation to minimize the aspect difference between data from the same sky region.
wcs_update tools Modify aspect solution file RA, Dec, and roll or infile WCS based on a transformation matrix.
wrecon tools Combine wavelet transform coefficients into sources
write_arf py.crates Writes the ARFCrate to an output file.
write_arf sl.crates Writes the ARFCrate to an output file.
write_file py.crates Writes the crate to an output file.
write_file sl.crates Writes the crate to an output file.
write_pha py.crates Writes the PHACrate to an output file.
write_pha sl.crates Writes the PHACrate to an output file.
write_rmf py.crates Writes a RMFCrate to an output file.
write_rmf sl.crates Writes a RMFCrate to an output file.
wtransform tools Obtain wavelet transform coefficients for poisson image data

Jump to: Main AHELP page | Contextual 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.