Command summary

This is a list of commands available in ASTERIX. These are loosely grouped by their function. Shortform and macro commands are shown with suffixes '+' and '*' respectively.

1. Instrument Interfaces
   1. ROSAT commands (PSPC and HRI specific)

      SHOWXRT

      Show observation information stored in header file

      XRTCONV

      Converts ROSAT FITS datasets into HDS format

      XRTINDEX

      Extracts header information from ROSAT FITS files

      XRTHOT

      Extracts hotspot/deadspot information from HRI datafiles

      XRTCORR

      Corrects XRT datafiles for vignetting effects etc..

      XRTHK

      Produce list of times based on housekeeping parameters

      XSORT

      Sorts ROSAT PSPC and HRI raw data into ASTERIX datasets

      XRTRESP

      Creates an energy response structure within a spectral NDF

      XRTSUB

      Subtracts an XRT background from an XRT source file

      XRTORB

      Create orbital information file for use in BARYCORR

      XSPOKES

      Defines the ribs region on a PSPC image

      XRTBCKBOX*

      Sorts XRT data using a radius optimisation algorithm

      XRTBOX*

      Allows a image region to be selected and used for sorting

      XRTEXPMAP

      Constructs exposure maps by dithering background images

      XPSSCORR

      Converts PSS XRT source counts into a flux

      XRAD

      Calculates the PSF radius for a PSPC source

      XRAD90

      Calculates the 90% PSF radius for a PSPC source

   2. ROSAT commands (WFC Pointed Phase specific). Some of these are defined by typing WFCSTART from the command line.

      WFCAUTO*

      Provides automatic analysis of one or more RWODs (Rosat WFC Observation Datasets)

      WFCBACK

      Produce background subtracted image given raw image

      WFCBOP*

      Performs background threshold optimisation for a WFC observation

      WFCCOUNTS*

      Produces statistics on a source seen in a WFC image.

      WFCDBM

      Maintain a database of WFC observations

      WFCDISK*

      Copies the contents of an RWOD (Rosat WFC Observation Dataset) to disk.

      WFCEXP

      Exposure correct a WFC binned dataset

      WFCHK

      Create time series of housekeeping parameters

      WFCIMAGE*

      Creates filter specific WFC counts, flux and exposure images.

      WFCLIGHT*

      Creates a background subtracted, exposure corrected, light curve for a source in the current image (interactive use only)

      WFCPOSX

      Get the exposure at a point in the WFC FOV

      WFCSLOTS

      Selects a set of filter defined observation slots

      WFCSLMRG

      Merges 2 sets of time slots together

      WFCSORT

      Sorts events into ASTERIX binned or event datasets

      WFCSPC*

      Creates a background subtracted, exposure corrected, spectral dataset for a source in the current image (interactive use only)

      WFCSPEC

      Creates a WFC spectral file

      WFCSUB*

      Subtracts a background light curve from a source light curve. Both input light curves must be exposure corrected before use.

2. Event Processing Commands - these all work on EVENT datasets.

   EVBIN

   Creates a binned dataset from an event dataset.

   EVCSUBSET

   Extracts a circular or annular region from an event dataset. Output is an event dataset.

   (EVLIST

   Displays the DATA_ARRAY component of all lists in an event dataset.)

   EVMERGE

   Merges two or more event datasets.

   EVPHASE

   Create a phase list given an ephemeris

   EVPOLAR

   Polar binning of event dataset

   EVSIM

   Creates a simulated event dataset

   EVSORT

   Reorder events on basis of a list's value.

   EVSUBSET

   Linearly extracts a subset from an event dataset.

3. Binned Dataset Commands

   ASMOOTH

   Smooth a dataset with an adaptive filter

   AXCENTROID

   Centroid an dataset wrt to one axis

   AXCONV

   Expands spaced axes for use in KAPPA etc.

   AXFLIP

   Reverses directions of any or all of dataset's axes

   AXORDER

   Re-order axes of a dataset

   AXSHOW

   Display list of axis attributes for binned dataset

   BINMERGE

   Merges up to ten datasets.

   BINSUBSET

   Subsets a binned dataset.

   CORRECT

   Applies exposure and dead time correction

   ENMAP

   Creates 2D image of mean energy of photons in 3d dataset

   INTERP

   Reconstitutes bad pixels by spline interpolation

   MEANDAT

   Finds mean or sum of up to 20 datasets

   POLYFIT

   Fits 1-d polynomial(s) to a dataset.

   PROJECT

   Project data along one axis.

   RADOPT

   Finds optimum SNR radius for a given source

   RATIO

   Gives the ratio of two bands on any axis in an n-d array.

   REBIN

   Rebins a binned dataset.

   SIGNIF

   Changes an input dataset to its weighted significance.

   SCATTERGRAM

   Produce scatter plot of one array versus another

   SMOOTH

   Smooths an n-d datafile with a user-selectable mask.

   SPLINEFIT

   Finds splines to 1D or 2D data

   SYSERR

   Adds a constant percentage to the variance of each point.

   VALIDATE

   Basic validation of binned dataset

4. Conversion Commands

   ASTCONV

   Converts between old and new ASTERIX binned datasets.

   AST2QDP

   Convert a 1D dataset to QDP format

   ASTQDP

   Invoke AST2QDP and then QDP on the file created

   AST2XSP

   Convert spectrum from Asterix to Xspec format

   (EVBIN

   Creates a binned dataset from an event dataset.)

   EXPORT

   Outputs one or more datasets to text file

   HDS2TEXT

   Convert HDS objects to text (opposite of TEXT2HDS)

   IMPORT

   Reads a text file into an ASTERIX binned dataset

   TEXT2HDS

   Convert text file to HDS

   FITS2HDS

   Convert FITS file to HDS

5. Display Commands

   ASTDEFS

   List ASTERIX customizable parameters

   AXSHOW

   Display list of axis attributes for binned dataset

   BINLIST

   Displays a 1D binned dataset.

   EVLIST

   Displays the DATA_ARRAY component of all lists in an event dataset.

   HEADER

   Displays header and processing information in a dataset

   HIST

   Displays history of a dataset.

   SSDUMP

   Displays contents of source search results file

6. Math Commands

   ARITHMETIC

   Performs basic arithmetic (+,-,/,*) on two data objects.

   ADD+

   Invokes ARITHMETIC in + mode

   SUBTRACT+

   Invokes ARITHMETIC in - mode

   MULTIPLY+

   Invokes ARITHMETIC in * mode

   DIVIDE+

   Invokes ARITHMETIC in / mode

   OPERATE

   Performs operations e.g. LOG10 on a dataset.

7. Time Series Analysis Commands
   1. Non-interactive analysis commands

      ACF

      Computes a 1d auto-correlation function

      BARYCORR

      Applies barycentric correction to binned and event datsets

      CROSSCORR

      Cross correlates two 1D series.

      CROSSPEC

      Computes the cross spectrum of two 1D datasets

      DIFDAT

      Differences adjacent bins to reduce low frequency noise

      DYNAMICAL

      Finds power spectrum of successive segments of a time series

      EVPHASE

      Add a phase list to an event dataset

      FOLDBIN

      Folds a time-series into phase bins at a given period

      PHASE

      Converts a time-series into a phase series.

      POWER

      Finds the power spectrum of a full unweighted 1D dataset

      SINFIT

      Finds a periodogram of irregularly spaced 1D data.

      TIMSIM

      Generates simulated time series

      VARTEST

      Test a source/background time series pair for variability

   2. Interactive time series editor

      TLOAD

      Load a time series into the system for plotting and tinkering with.

      TCLOSE

      Release the time series and close down the system.

      TPLOT

      Plot the time series

      TCHOP

      Chop up the display into separate plots of contiguous data.

      TWHOLE

      Use the whole time series including gaps.

      TSLICE

      Select a time slice to keep or discard.

      TZAP

      Remove individual points.

      TSELECT

      Select a subset of time segments for display.

      TSAVE

      Save the data in their current status.

      TONOFF

      Write out on-off times in MJD for currently selected good data.

8. Image Processing Commands
   1. Interactive

      ISTART

      Start up image processing system

      INEW

      Load new image

      ICLOSE

      Close down image processing system

      IDISPLAY

      Display current image

      IBOX

      Define rectangular section of image

      IWHOLE

      Select whole image

      IZOOM*

      Zoom in on section of image

      IUNZOOM*

      Redisplay whole image

      ISCALE

      Rescale image

      ICONTOUR

      Contour current image

      IGRID

      Puts grid over image in specified coords

      ICOLOUR

      Change colour table

      IPLOT

      Display current 1D plot

      ILIMITS

      Changes axis limits on 1D plot

      ISTYLE

      Set plotting style of 1D plot

      ITITLE

      Change title of current image or plot

      IZONES

      Changes zones on display surface

      ICLEAR

      Clear current plotting zone

      ISTATS

      Gives basic statistics on pre-selected region of image

      IBOXSTATS+

      Select region and give statistics

      IMARK

      Marks sources on image

      IREMOVE

      Remove sources from image

      IPEAKS

      Find and mark peaks above threshold

      INOISE

      Adds gaussian noise to image

      IZAP

      Removes individual pixels from image

      IPATCH

      Patches bad quality pixels in image

      IPOLYFILL

      Fill data area defined by user selected polygon

      IPOLYFILLQ+

      Fill quality area defined by user selected polygon

      IBLUR

      Blur image by Gaussian or Box filter

      IBROWSE

      Look at data values around selected point

      IPEEKV+

      Look at variances

      IPEEKQ+

      Look at quality

      IHIST

      Histogram pixels inside current box

      IRADIAL

      Produces radial plot

      IPSF

      Puts PSF profile on 1D plot

      IAZIMUTH

      Produces azimuthal distribution

      ISLICE

      Takes a 1-d slice from an image

      IPREVIOUS

      Go back to previous image

      ISAVE

      Save current image to file

      ISAVE1D

      Save current 1D data to file

      ICURRENT

      Get current positions etc

   2. Non-interactive

      IMOSAIC

      Merges several non-congruent images

      IPOLAR

      Produce a polar surface brightness profile of an image

      IXCONV

      2D convolution of a pair of images

      IDTODMS*

      Convert decimal degrees to dd:mm:ss

      IDMSTOD*

      Convert dd:mm:ss to decimal degrees

      IDTOHMS*

      Convert decimal degrees to hh:mm:ss

      IHMSTOD*

      Convert hh:mm:ss to decimal degrees

9. Parameter Commands

   GLOBAL

   Displays the current values of all global parameters.

10. Spectral analysis commands

    FREEZE

    Freezes parameter(s) in spectral model.

    (IGNORE+

    Allows spectral channels to be excluded from fitting.)

    (RESTORE+

    Reinstates spectral channels for fitting.)

    SBG

    Associate background file with a spectrum

    SBIN

    Rebin spectrum to even out counts in each bin.

    SDATA

    Define datasets to be fitted.

    SEDIT

    Interactively edit a spectral model description.

    SERROR

    Evaluates confidence region for spectral model parameters.

    SFIT

    Fits spectral model to one or more datasets.

    SFLUX

    Evaluates flux from defined model over energy band.

    SGRID

    Construct n-D grid of fit statistic/reoptimised parameters against grid parameters

    SMODEL

    Allows user definition of muti-component spectral model.

    SPLOT

    Plots data, fits and residuals.

    SSHOW

    Display current model parameters to any ascii device

    THAW

    Frees spectral model parameter (after FREEZEing).

11. Statistical analysis commands

    BINSUM

    Integrates a dataset - use for cumulative distributions

    COMPARE

    Compares two datafiles or a file and a model.

    FREQUENCY

    Produces a histogram of values in a data array.

    KSTAT

    Calculates the Kendall K statistic for a 1-d dataset.

    STATISTIX

    Finds mean,standard deviation etc.. of a data array

12. Quality processing commands

    IGNORE+

    Invokes QUALITY in IGNORE mode: sets temporary bad quality bit

    QUALITY

    General quality manipulation application.

    RESTORE+

    Invokes QUALITY in RESTORE mode: clears temporary bad quality bit. (Only availible in ICL)

    SETQUAL+

    Invokes QUALITY in SET mode: sets quality to specified value.

    MAGIC

    Sets magic values

    MASK

    Sets quality mask value

13. HDS editor commands

    HCOPY

    Recursively copies an HDS object

    HCREATE

    Creates an HDS object in a file

    HDELETE

    Deletes an HDS object

    HDIR

    Displays the components of an HDS file or structure

    HDISPLAY

    Displays the contents of an HDS primitive

    HFILL

    Fills a primitive object with one value

    HGET

    Get HDS object attributes to environment

    HMODIFY

    Change the value(s) in an existing object.

    HREAD

    Reads from an ASCII (or binary) file to an HDS object

    HRENAME

    Renames an HDS object

    HRESET

    Set values in HDS primitive to 'undefined'

    HRESHAPE

    Alters size of dimensions in an HDS primitive array

    HRETYPE

    Change type of a structured object

    HTAB

    Simultaneously displays several HDS primitive vectors

    HTRACE

    Displays full HDS tree structure

    HWRITE

    Writes an HDS primitive to an ASCII (or binary) file

14. Source Searching Commands

    BSUB

    Background subtraction program

    COVERAGE

    Convert PSS sensivity map to coverage function

    CREPSF

    Create dataset containing psf description

    EVSIM

    Create simulated event datasets

    IMSIM

    Create simulated image datasets

    PSS

    Search a binned dataset for sources

    SPCONVOL

    Convolve a spatial response with a source model

    SPRESP

    Attach a spatial response to a dataset

    SSCARIN

    Export source search results to binary SCAR catalogue

    SSDUMP

    Dumps source search results to an ascii file

    SSGET

    Extracts source search results data items to environment

    SSMERGE

    Merge two or more source results together

15. GRAFIX display commands

    DOPEN

    Open a device for interactive plotting by any subsystem.

    DCLOSE

    Force closure of current device.

    DERASE

    Clear the display surface.

    DLIST

    List valid device names.

    DSHOW

    Show information about current device.

    GDRAW

    Draw 1D or 2D data, or plot data from a multiple dataset.

    GMULTI

    Creates and manipulates multiple datasets.

    GSET

    Sets plotting attributes for a dataset or an interactive sub-system.

    GLOAD

    Load and hold open a dataset for interactive plotting.

    GCLOSE

    Release a loaded dataset.

    G_POS

    Specifiy position of plotting window for primitive plotting.

    G_WINDOW

    Define world coordinate limits of plotting window.

    G_AXES

    Plot axes.

    G_MOVE

    Move to a given position without plotting.

    G_PLOT

    Plot from current position to specified position.

    G_LINE

    Draw a line through a given series of points.

    G_MARK

    Plot markers at specified points.

    G_LABEL

    Put labels on plot.

    G_TEXT

    Put text at arbitrary position.

    G_CURS

    Return cursor position in world coordinates.