UIT Library

The following is a listing of the entire contents of this library for IDL. Click on an individual procedure name to view its header and source code. This listing is a shortened form of the much longer entire library help file. This may be handy for text searchs, be beware that some of these are huge and may take a long time to load or even crash your browser.

[Go Back to Main Search Page]

Last modified: Thu Dec 21 21:30:13 2000.

List of Routines

ABSCAL Provide an absolute calibration using the BZERO and BSCALE keywords in an FITS header
AD2XY Compute an X and Y position given the RA and DEC and the astrometry parameters CD, CRPIX, and CRVAL. A tangent (gnomonic) projection is computed directly; other projections are computed using WCSXY2SPH. AD2XY is meant to be used internal to other procedures. For interactive purposes, use ADXY.
ADSTRING Return RA and Dec as character string in sexigesimal format. RA and Dec may be entered as either a 2 element vector or as 2 scalars. You may also specify the precision of the declination in digits after the decimal point.
ADXY Use an image header to compute X and Y positions, given the RA and Dec in decimal degrees.
ANNSTATS Integrate flux in annular apertures and get std. dev. in each annulus. User responsible for subtracting sky first. See notes (1) and (2) below.
APER Procedure (adapted from DAOPHOT) to compute concentric aperture photometry. A separate sky value is determined for each source using specified inner and outer sky radii.
APEROI Procedure to compute aperture photometry for arbitrarily shaped aperture defined by DEFROI (DEFine Region Of Interest) The sky value is input.
ARCBAR Create and display a bar of a specified input size in arcminutes
ARROWS To display "weathervane" directional arrows on an astronomical image showing orientation of North and East.
ASCENDING_NODE To compute the right ascension of the ascending node of an orbit at a given time during a shuttle mission.
ASTDISP This procedure prints of the X,Y,RA,DEC,DN in a standard format. X,Y must be supplied. RA,DEC may also be supplied, and a DN may also be supplied.
ASTRO Interactive astronomical utitlity for precession and coordinate
ASTROM Computes parameters describing a linear fit to a plate solution using the algorithm supplied by R. S. HARRINGTON, USNO Use the procedure ASTROMIT for interactive use of this program
ASTROMIT Uses the procedure ASTROM to derive an astrometry solution from a set of reference star positions and coordinates. The reference stars may be culled interactively to obtain the best astrometric solution. The procedure writes to a file ASTROM.DMP during each iteration.
ASTSCALE Transfer astrometry from condensed image to full-resolution image, or between any two images differing _only_ in plate scale. Astrometry is transferred from header in an array to header on disk.
AVG Calculate the average value of an array, or calculate the average value over one dimension of an array as a function of all the other
A_B Compute interstellar extinction in the B bandpass as a function of galactic position using the 21 parameter function given by deVaucoulers in the 2nd Reference Catalog of Galaxies (RC2). Note that this formula is no longer used in the RC3 and that reddenings are instead obtained from the Burstein-Heiles maps.
BAKFILE To perform a fog-level correction on an image, using a bilinear interpolation technique.
BAKSUB To perform a fog-level correction on an image, using a bilinear interpolation technique.
BDRASTROM Add astrometry from the HDRS database into a UIT FITS header.
BIGDIV Divide a image in one file by another (flatfield) image and write to a third file. Do in 8 steps to save virtual memory. The numerator image and the denominator image must be the same size, INTEGER*2 datatype and the dimensions must be an even multiple of 512 x 512 (usually 2048 x 2048).
BLINK To allow the user to alternatively examine two or more windows within a single window.
BORDER To blacken out a border around an image. (50 pixels wide)
BOXAVE Box-average a 1 or 2 dimensional array. This procedure differs from the intrinsic REBIN function in the follow 2 ways:
BPRECESS Calculate the mean place of a star at B1950.0 on the FK4 system from the mean place at J2000.0 on the FK5 system.
BRUZUAL Extract a spectrum from the BRUZUAL database (Bruzual & Chalrot, 1993, ApJ, 405, 538) for a specified model at specified ages. Meant to be analogous to the procedure CLUST_FLUX
BSORT Function to sort data into ascending order, like a simple bubble sort. original subscript order is maintained when values are equal (FIFO). (This differs from the IDL SORT routine alone, which may rearrange order for equal values)
BUILDAST Build an ASTROMETRY structure from given data. If data are not supplied, prompt for all necessary. A CD matrix must be supplied and will not be prompted.
BYTESWAP To swap the bytes in an image array.
CALFIX Updates calibration keywords in a UIT FITS header to use the latest values. Exposure time is read from the NEWFRAMES data base. Absolute calibration is set to the Landsman 10-Dec In-Flight calibration. These are the values used in REV 2.
CCM_UNRED Deredden a flux vector according to the parameterization of Cardelli, Clayton, and Mathis (1989 ApJ. 345, 245), including the update for the near-UV given by O'Donnell (1994, ApJ, 422, 158). Parameterization is valid from the IR to the far-UV (3.5 microns to 0.1 microns).
CCRTWARP Warps an image to match a reference image. Prompts the user to pick out corresponding sources on two display channels using cursor. Neighborhood of cursor is searched for centroid in the image array. POLY_2D used to do real work a couple of layers down.
CDEL To delete a window and update the common blocks.
CDROT Rotates matrix by an angle.
CHAN To display a different image window and update the common blocks.
CHARCURVE To fetch the UIT characteristic curve from its file and return it to the calling level.
CHECKERBOARD To create a checkerboard array (alternating bytes 0 and 255) One use of CHECKERBOARD is to study resolution and distortion on the TV display
CHECK_FITS Given a FITS array IM, and a associated FITS or STSDAS header HDR, this procedure will check that (1) HDR is a string array, and IM is defined and numeric (2) The NAXISi values in HDR are appropiate to the dimensions
CHKDTYPE PUROPOSE: Compares Datatype of an Image to that stored in its header, and corrects the header if any discrepancy is found (at user's discretion) CALLING SEQUENCE: CHKDTYPE, IM, HD [, /INFO, /SILENT, /AUTO] IM - 2-dimensional image
CHNGCAM For UIT images. Transforms astrometry for an NUV image to that for an FUV image in the same acquisition.
CHNGXY To convert x and y values based on the reference frame of one header into x and y values based on the reference frame of a new header.
CINIT To initialize the common block TV, TEK, IMAGES, and TAPEINFO (on
CIRCINT Integrate flux in circular apertures. User responsible for subtracting sky first. See notes (1) and (2) below.
CIRRANGE To force an angle into the range 0 <= ang < 360.
CLEANPLOT Reset all system variables (!P,!X,!Y,!Z) set by the user which affect plotting to their default values.
CLUSTMOD Return the flux of a model star cluster as a function of mass at a specified age and at specified wavelengths
CLUST_FLUX Returns the flux of a model star cluster at a specified wavelength as a function of time.
CNTRD Compute centroid coordinates of a stellar object using the algorithm in the DAOPHOT FIND subroutine.
COLOR2PHOT Extracts objects from a UITPHOT table, selecting those with colors and magnitudes between an interactively specified ranges.
COLORMAG Create a color-magnitude plot from 2 uitphot tables.
COMPRESS Create a compressed image on disk. Combines the function of STRD, HREBIN, and STWRT.
COMP_NITE To determine the sunset and sunrise times for a shuttle in orbit during a given range of time.
CONS_DEC Returns a set of Y pixels values, given an image with astrometry, and
CONS_RA Return a set of X pixel values given an image with astrometry,
CONTRAST Use the mouse to change the slope and Y intercept of the color lookup table on an X windows display.
CONV_STSDAS Convert the internal format of an STSDAS image (.hhh and .hhd file) to the host machine architecture. Useful for copying STSDAS files between different machines. If the host is not a Vax, then by default CONV_STSDAS assumes the image originated on a Vax. If the host is a Vax, then CONV_STSDAS assumes that the image originated on an IEEE machine (e.g. SparcStation).
CONV_VAX_UNIX To convert VAX IDL data types to UNIX (Sun,MIPS,etc.) IDL data types. The architecture is obtained from IDL sys.var. !VERSION.ARCH.
COORDPLOT Compares two sets of coordinates by plotting vectors between original and final positions. Results are plotted on an IDL plot window.
COORD_INDEX A SHOWPHOT procedure to find cross-index two sets of coordinates, looking for unique matches.
COPYCHAN To copy an image from one window to another. X-windows version
CORREL_IMAGES Computes the 2-D cross-correlation function of two images for a range of (x,y) shifting by pixels of one image relative to the other.
CORREL_OPTIMIZE Find the optimal (x,y) pixel offset of image_B relative to image_A, by means of maximizing the correlation function.
CORRMAT_ANALYZE Analyze the 2-D cross-correlation function of two images and find the optimal(x,y) pixel offsets. Intended for use with function CORREL_IMAGES.
CROAM To allow a user to roam around an image using the mouse cursor. Works on SparcStations but not on VaxStations (see restrictions).
CROLL Roll the current color lookup table at a fixed rate.
CRTWARP Warps an image to match a reference image. Prompts the user to pick out corresponding sources on two display channels using cursor. Neighborhood of cursor is searched for max pixel. POLY_2D used to do real work a couple of layers down. Use CCRTWARP to use centroid position rather than position of max pixel value.
CT2LST To convert local civil time to local mean sidereal time.
CTV Load an array to the image display. It differs from the native IDL procedure TV in the following ways:
CTVPARAMS Used by CTV and CTVSCL to sort out numerical (integer) parameters and FITS header.
CTVRD Read an image displayed on the TV into an IDL variable. It differs from the function TVRD in three ways: (1) CTVRD is a procedure, wheras TVRD is a function (2) If a starting position X0,Y0 or image size XSIZE,YSIZE is not supplied, CTVRD will use the values supplied by the last call to CTV or CTVRD (3) The default channel is the current window, rather than
CTVSCL Load an array to the image display after byte scaling. It differs from the IDL procedure TVSCL in the following ways:
CURFULL This program is designed to essentially mimic the IDL CURSOR command, but using a full screen cursor rather than a small cross cursor. Uses OPLOT and X-windows graphics masking to emulate the cursor.
CURS Selects an X windows cursor shape
CURVAL Display values associated with the cursor as it is moved over an image. Users on the IVAS or DeAnza may prefer the closely related procedure
CWARPLIST Allows user to cursor-select corresponding sources as shown on two different display channels. Lists of corresponding X, Y coordinates returned. Source located at centroid in image array, in box surrounding cursor position.
CZOOM Display part of an image (or graphics) from the current window expanded in another window. The cursor is used to mark the center of the zoom.
DAOERF Calulates the intensity of a 2 dimensional gaussian PSF at a pixel position x, by integrating between x-0.5 and x+0.5. It differs from ERF in 2 ways (to agree with DAOPHOT calls): (1) The number of output elements in F and PDER is identical with the number of elements in X and Y (2) The order of the parameter vector A is different
DAO_VALUE This function returns the value of a point-spread function at a given point. The value of the point-spread function is the sum of a two-dimensional integral under a bivariate Gaussian function, and a value obtained by interpolation in a look-up table. DAO_VALUE will optionally compute the derivatives wrt X and Y
DARKSPOT Draw circles around UIT's infamous dead spots, including compensating for GEOMed images. Image should be displayed in the current window.
DATATYPE Returns data type as a string. Makes it easier to do data type dependent operations.
DATE DATE converts day-of-year to ordinary Gregorian date; works on cumulative day from 1-JAN-1979 (for instance), as well as more well-mannered days-of-year.
DATE2EURO CHANGE FORMAT OF DATE-0BS PARAMETER IN A FITS HEADER FROM 'DD-MON-YYYY' TO 'DD/MM/YY'.
DATE_CONV Procedure to perform conversion of dates to one of three possible
DAYCNV Converts julian dates to gregorian calendar dates
DBBUILD Build a database by appending new values for every item. The database must be opened for update (with DBOPEN) before calling DBBUILD.
DBCIRCLE Find sources in a database within a specified radius of a specified center. Database should include RA and DEC items and should previously be opened with DBOPEN
DBCLOSE procedure to close a data base file
DBCREATE Create new data base file or modify description. A database definition file (.dbd) file must already exist. The default directory must be a ZDBASE: directory.
DBDELETE Deletes specified entries from data base
DBEDIT Interactively edit specified fields in a database. The value of each field is displayed, and the user has the option of changing or keeping the value. Widgets will be used if they are available.
DBEDIT_BASIC Interactively edit specified fields in a database. The value of each field is displayed, and the user has the option of changing or keeping the value.
DBEXT Procedure to extract values of up to 12 items from data base file, and place into IDL variables
DBEXT_DBF Procedure to extract values of up to 12 items from a data base file. This is a subroutine of DBEXT, which is the routine a user should
DBEXT_IND routine to read a indexed item values from index file
DBFIND Function to search data base for entries with specified search characteristics.
DBFIND_ENTRY This is a subroutine of dbfind and is not a standalone procedure It performs a entry number search.
DBFIND_SORT This is a subroutine of dbfind and is not a standalone procedure It is used to limit the search using sorted values
DBFPARSE Parse the search string supplied to DBFIND. Not a standalone routine
DBGET Find entry number of fields which contain specified values in a specified item. DBGET is an altnerative to DBFIND when the desired search values are not easily expressed as a string.
DBHELP Procedure to either list available databases (if no database is currently open) or the items in the currently open database.
DBINDEX Procedure to create index file for data base
DBINDEX_BLK To set up an associated variable of the correct data-type and offset into the file by some amount in preparation for writing to the file.
DBMATCH Find one entry number in a database for each element in a vector of item values. DBMATCH is especially useful for finding a one-to-one correspondence between entries in different databases, and thus to create the vector needed for database pointers.
DBOPEN Routine to open data base files.
DBPRINT Procedure to print specified items from a list of database entries
DBPUT Procedure to place a new value for a specified item into a data base file entry.
DBRD procedure to read an entry from a data base file or from linked multiple databases.
DBSEARCH Search a vector for specified values This is a subroutine of dbfind and is not a standalone procedure
DBSORT Routine to sort list of entries in data base
DBTITLE function to create title line for routine dbprint
DBUPDATE Update columns of data in a database -- inverse of DBEXT Database must be open for update before calling DBUPDATE
DBVAL procedure to extract value(s) of the specified item from a data base file entry.
DBWIDGETS Interactive OBprogram that can open databases, close databases, provide information and help about databases, extract information from databases, and draw boxes around sources in an image found in a specified database.
DBWRT procedure to update or add a new entry to a data base
DBXPUT routine to replace value of an item in a data base entry
DBXVAL procedure to quickly return a value of the specified item number from the entry
DB_CONV To take the data generated from "Dbwidgets.pro" and convert it into usable form.
DB_INFO Function to obtain information on opened data base file(s)
DB_ITEM procedure to return the item numbers and other information of a specified item name
DB_ITEM_INFO routine to return information on selected item(s) in the opened
DB_OR Combine two vectors of entry numbers, removing duplicate values. DB_OR can also be used to remove duplicate values from any longword
DB_TITLES Print database name and title. Called by DBHELP
DEC2DMS To convert a value from decimal degrees to deg:min:sec.
DEFINE Use the SETLOG procedure of VMS IDL to emulate the DCL DEFINE command, or use the SETENV procedure of UNIX IDL to set an environment
DEMO Return the file name string of a file in the IDL directory tree. Directory = sub_directory name or null string for main level. name = file name.
DEREDD Deredden then Stromgren parameters given for a value of E(b-y) See the procedure UVBYBETA for more info.
DETABIFY Replaces tabs in character strings with the appropriate number of spaces. The number of space characters inserted is calculated to space out to the next effective tab stop, each of which is eight characters
DFITSRD Convert true disk FITS formatted file(s) into STSDAS formatted file(s). Disk FITS refers to files (that can be created by IRAF or AIPS) that keep the exact format (e.g. 2880 byte record length) of a FITS tape. STSDAS files have a detached header and 512 byte record length.
DFITSREAD Procedure will read a disk FITS file and write to a STSDAS disk file. The header is placed in .HHH and the data is placed in the file .HHD. This procedure is called by DFITSRD which is the procedure that an interactive user would normally use.
DFITSWRITE Procedure will write an internal SDAS file to a FITS file on disk. Note: Called by DFITSWRT
DFITSWRT Convert ST/SDAS formatted files to true disk FITS formatted file(s). D(isk) fits: refers to files (that can be created by IRAF or AIPS) that keep the exact format (e.g. 2880 byte record length) of a FITS tape. ST/SDAS files: has detached header and 512 byte record length.
DIR Emulates the DCL command DIRECTORY or the UNIX command ls in its simplest (brief) form.
DISP_ENTRY Write the photometry information to the screen or to a file.
DISP_IMAGE To display the image loaded in the Image_Blk COMMON block.
DISTWARP To warp an image using the UIT image distortion models, either removing the distortion from an image or putting the distortion back into an undistorted image.
DIST_CIRCLE Form a square array in which the value of each element is its distance to a specified center. Useful for circular aperture
DIST_COORD_CONV To apply the image distortion coordinate transformation equations upon a set of coordinates.
DIST_ELLIPSE Form a square array in which the value of each element is equal to the semi-major axis of the ellipse of specified center, axial ratio, and position angle, which passes through that element. Useful for elliptical aperture photometry.
DIST_MODEL_COEF To return the image distortion model coefficients for a camera.
DST_INFO To read in the next section of the header in a DAOPHOT image file.
DS_STARFIT crude fit for star gaussian psf
DUALSEARCH Simultaneously display subimages from a far-UV image array and the corresponding near-UV image array to enable a user to visually detect and investigate objects that appear brighter in the FUV than in the NUV. The output gathered on the object(S) will be stored in a file unless otherwise specified.
EDT Call the EDT editor to edit a file.
EMACS Call the EMACS editor to edit a file.
EULER Transform between galactic, celestial, and ecliptic coordinates. Use the procedure ASTRO to use this routine interactively
EVE Call the EVE editor to edit a file.
EXTAST Extract astrometry parameters from a FITS image header. The astrometry in the header can be in either CD (Coordinate description) format, or CROTA and CDELT (AIPS-type) format. However, the output astrometry will always be in CD format.
EXT_PHOT Extracts position and photometric information for a specific entry in a UITPHOT FITS table.
FBTAPE Read in a fixed-block ASCII text tape file.
FDECOMP Routine to decompose file name. On VMS machines the decomposition is disk + directory + name + qualifier + version On non-VMS machines the decomposition is directory + name + qualifier
FETCHFILE To transfer a file from a VAX computer to a SUN workstation or from a SUN workstation to a VAX computer.
FETCHIMAGE To transfer an image from a VAX to a SUN workstation or from a SUN workstation to a VAX. The image is BYTESWAPPED by this procedure to account for differences in system architechures unless the NOSWAP keyword is present and non-zero.
FFVAR Returns the variance of an array of 20 micron pixels as a function of the relative intensity of those pixels, for UIT, using the final preflight characteristic curve and flat fields. Lab data for this calculation comes from the FUV (B) camera. It interpolates linearly on flatfielded lab flatfield exposures. Input and output are in H units.
FIND Find positive brightness perturbations (i.e stars) in a 2 dimensional image and compute centroids, and shape parameters, Adapted from 1986 STSDAS version of DAOPHOT.
FINDSCRATCH Automatically identify scratches in images and remove by replacing scratch with interpolation of nearest neighbors.
FITEXY Linear Least-squares approximation in one-dimension (y = a + b*x), when both x and y data have errors (e.g. Gaussian noise).
FITS2X Read FITS file from tape directly into an IDL image array and FITS header array. One can optionally provide a compression factor to compress the image before writing into the IDL arrays. The procedure is useful for quickly checking the FITS images on a tape
FITSBYTE To convert an image array from FITS byte ordering to the ordering used by the computer.
FITSDIR Provide a brief description of the FITS files on a disk. The values of the FITS keywords NAXISi, OBS-DATE, TELESCOPE, OBJECT, EXPTIME are displayed. All of these are commonly used FITS keywords and all except EXPTIME are officially reserved FITS keywords.
FITSLIST Procedure will read FITS files from a tape on the specified tape unit. The headers are placed in file NAME, with the default extension of .LIS. Headers are also displayed at the terminal. FOR VMS IDL ONLY!
FITSNET Submits a job to the NSESCC IBM 3081 to cause an image to be sent over
FITSRD Interactive procedure to read FITS tape files into SDAS/FITS disk files. FOR VMS IDL ONLY.
FITSREAD Procedure to read a FITS file from a tape on the specified tape unit. The header is placed in .HHH and the data is placed in the file .HHD. This procedure is called by FITSRD which is the interactive procedure for normal use. FOR VMS
FITSTAPE Function to perform FITS tape I/O. Called by FITSREAD. FOR VMS IDL ONLY!
FITSWRITE Procedure will write an internal SDAS file to a FITS tape on the specified tape unit. Called by FITSWRT
FITSWRT Interactive procedure to write internal SDAS file(s) to a FITS tape
FITS_CD_FIX Convert from the representation of the CD matrix in a FITS header with an underscore (e.g. CDn_m) to that with all integers (e.g. CD00n00m). According to the proposed World Coordinate System standard by Griesen and Calabretta, the CD00n00m form is to be preferred and does not include the plate scale, so that CDELT* keywords are also needed. The CD1_1 form (used in IRAF) includes the plate scale (CDELT) factor.
FITS_CONV This program will convert the string data computed "showfits.pro" into usable form.
FIXCHAR Repairs an error made in BDR in formatting character strings in headers. Changes XXXXXXXX='YYY'
FIXQ13 Fix the EQUINOX keyword of images from the BDR Quick 13 data stream. The EQUINOX keyword in some of these data products was mistakenly set to 1950 -- FIXQ13 will set the EQUINOX keyword to 2000.00
FLAT FLAT transforms the image of a galaxy so that the galaxy appears face-on. Either a nearest-neighbor approximations or a bilinear interpolation may be used.
FLATDIV Divide a image in one file by another (flatfield) image and write to a third file. Do in 16 steps to save virtual memory. The numerator image and the denominator image must be the same size, INTEGER*2 datatype and the dimensions must be an even multiple of 512 x 512 (usually 2048 x 2048).
FLUX2MAG Convert from flux (ergs/s/cm^2/A) to magnitudes. Use MAG2FLUX for the opposite direction.
FLUXAVG Integrates spectral energy distribution over filter.
FOGCNORM To compute the fog levels in the corners of an image for a normal
FOGCOMP To compute the fog levels in the corners of an image.
FOGCSUB To compute the fog levels in the corners of an image for a substepped UIT image.
FOGINTER To adjust an image for fog using a bilinear interpolation of the fog in the four corners.
FOGSTAT Computes the mean and standard deviation from the sum and sum of squares of a set of data elements.
FOGSUM To compute the sum and sum of squares of an array, using only the elements which fall within a set of limits.
FORPRINT Print a set of vectors by looping over each index value. If W and F are equal length vectors, then the statement IDL> forprint, w, f is equivalent to IDL> for i = 0, N_elements(w)-1 do print,w(i),f(i)
FTADDCOL Routine to add a field to a FITS ASCII table
FTCREATE Procedure to create a new (blank) FITS ASCII table and header with the specified size.
FTDELCOL Delete a column of data from a FITS table
FTDELROW Delete a row of data from a FITS table
FTDIR Provide a brief description of the disk FITS ASCII tables on a directory. The # of columns and rows, and the extension name are displayed for each table found. Use TBDIR to display FITS binary
FTGET function to return value(s) from specified column of a FITS ASCII table
FTHELP Routine to print a description of a disk ASCII FITS table
FTHMOD Procedure to modify header information for a specified field in a FITS table.
FTINFO Procedure to return information on the specified field in a FITS ASCII table.
FTKEEPROW Subscripts (and reorders) a FITS table. A companion piece to FTDELROW.
FTPRINT Procedure to print specified columns and rows of a FITS table
FTPUT Procedure to add or update a field in an FITS table
FTREAD Procedure to read an internal FITS table file
FTSIZE Procedure to return the size of a FITS ASCII table.
FTSORT Sort a FITS ASCII table according to a specified field
FTSRCOR Positional source correlation between FITS tables.
FTWRITE Procedure to write an FITS table to disk
FXADDPAR Add or modify a parameter in a FITS header array.
FXHREAD Reads a FITS header from an opened disk file. Reads a FITS header from an opened disk file.
FXPAR Obtain the value of a parameter in a FITS header. The first 8 chacters of each element of HDR are searched for a match to NAME. If the keyword is one of those allowed to take multiple values ("HISTORY", "COMMENT", or " " (blank)), then the value is taken as the next 72 characters. Otherwise, it is assumed that the next character is "=", and the value (and optional comment) is then parsed from the last 71 characters. An error occurs if there is no parameter with the given name.
FXPARPOS Finds position to insert record into FITS header. Finds the position to insert a record into a FITS header. Called from
FXREAD Read basic FITS files. Read the primary array from a disk FITS file. Optionally allows the user to read in only a subarray and/or every Nth pixel.
F_FORMAT Choose a nice F format for displaying an array of REAL data. Called by TVLIST, IMLIST.
GCIRC Computes rigorous great circle arc distances.
GETDEFPAR getdefpar procedure to get default parameters from parameter file CALLING SEQUENCE: defpar,dfile,names,dpar,descr dfile - default parameter file name without extension extension will be .def in derectory zdef:
GETFILE This function helps the user retrieve a file in IDL. Better than FileView since you can have several disks in your user defined tree under FILETREE.DAT in your home (VMS: SYS$LOGIN) directory. See notes for a detailed description. Best when used with Xwindows (or other devices that support the MENU function,) but it is functional in text
GETFILES This procedure allows you to interatively specify a list of files by specifying a single file per line or a range of files separated by a dash or comma.
GETHD To get the current UIT characteristic curve from an associated data file. As of 5-Dec-1991 the current HD curve is 'CALIB3'.
GETLOG Returns the correct logical directory for the given operating system. E.G. dat: for vms, $DAT/ for unix.
GETLUT Read a set of color tables from a file
GETOPT Function to convert a string supplied by the user into a valid scalar or vector. Distinct elements in the string may be separated by either a comma or a space. The output scalar or vector can be specified to be either integer or floating point. A null string is converted to a zero. !ERR is set to the number of elements supplied.
GETPAR HRS parameter processing routine.
GETPRO Extract a procedure from an IDL Library or directory given in the !PATH system variable and place it in the current default directory (presumably to be edited by the user). GETPRO can also be used to obtain a copy of the default startup file.
GETPSF To generate a point-spread function (PSF) from one or the sum of several stars. The PSF is represented as a 2-dimensional gaussian (integrated over each pixel) and a lookup table of residuals. The lookup table and gaussian parameters are output as an STSDAS (modified FITS) image file. The PSF file created by GETPSF can be read with the procedure RDPSF. Adapted from 1986 STSDAS version of DAOPHOT
GETROT Derive the counterclockwise rotation angle, and the X and Y scale factors of an image, from a FITS image header. First parameter may be either an image header or a CD matrix (in radians).
GETTOK Function to retrieve the first part of the string until the character char is encountered.
GETWAVE Create a wavelength vector from a FITS header of a spectrum The FITS header must contain a CRVAL1 keyword and a CRPIX1 or CD1_1 keyword.
GETWRD Return the n'th word from a text string.
GET_COORDS A general purpose routine that takes user input for angular coordinates and returns floating-point values. The user may input as floating point or sexigesimal. If user inputs RA then it is the calling procedure's job to convert hours to degrees if needed. Since the input string is parsed character-by-character, ANY character that is not a digit, minus sign or decimal point may be used as a delimiter. i.e. acceptable examples of user input are: 1:03:55 -10:15:31 1 3 55.0 -10 15 31 1*3 55 -10abcd15efghij31
GET_DATE Return the current date in DD/MM/YY format. This is the format required by the DATE and DATE-OBS keywords
GET_EQUINOX Return the equinox value from a FITS header. Checks for 3 possibilities (1) If the EQUINOX keyword is found and has a numeric value, then this value is returned (2) If the EQUINOX keyword has the values 'J2000' or 'B1950', then either 2000. or 1950. is returned. (3) If the EQUINOX keyword is not found, then GET_EQUINOX will return the EPOCH keyword value. This usage of EPOCH is disparaged.
GET_KUR_WAVE Quickly return the wavelength grid used in the 1992 Kurucz models
GET_ORBIT To get the launch, orbit, and acquisition information from the user.
GET_STRING To get a string from the user.
GET_TARGET To get from the user the right ascension,declination of the target to be processed and the start,stop time range (in MET) to process the target over.
GET_UIT_MAG Use Kurucz model atmospheres to compute the flux of a star through a specified UIT filter (or Johnson B or V filter), given its intrinisic bolometric luminosity and effective temperature. User can optionally specify the stellar distance, reddening E(B-V) and metalicity. Useful for transforming theoretical HR diagrams to an observational
GET_WINDOW Return the index of the next available window
GKER Returns a smooth two-dimensional gaussian of the specified size and
GLACTC Program to convert right ascension (ra) and declination (dec) to galactic longitude (gl) and latitude (gb) (j=1) or vice versa (j=2).
GRCOL Assign colors to pixel values of 255 (or specified pixel values) in a X-windows color lookup table. This emulates the graphics color assignment procedure in the DeAnza and the IVAS. However, since X-windows systems do not have a graphics overlay, the image will also be affected. Use PIXCOLOR for more general control of the image color table.
GROUP Procedure in DAOPHOT sequence to place stars with non-overlapping PSF profiles into distinct groups
GSSSADXY This procedure converts RA and DEC to (X,Y) image pixels for a GSSS image. The sky coordinates may be printed and/or returned in variables.
GSSSEXTAST This procedure extracts the astrometry information from a header and places it in a structure for use with GSSSxyad.
GSSSXYAD This procedure converts (X,Y) image coordinates to sky coordinates. The sky coordinates may be printed and/or returned in variables.
GSSS_STDAST This procedure takes a header with GSSS astrometry and writes roughly equivalent SDAS astrometry into the header. ***Note that the GSSS astrometry will be no longer valid, because GSSS_STDAST modifies the CRPIX values***
HASTROM Perform a linear transformation (with POLY_2D) on an image so that its astrometry is identical with that in a reference header. This procedure can be used to align two images.
HBOXAVE Box average an image array using the function BOXAVE and update the FITS header array. This procedure is recommended for integer images when photometric precision is desired, because it performs intermediate steps using REAL*4 arithmetic. Otherwise, the procedure HREBIN is much
HCONGRID Expand or contract an image using CONGRID and update the associated FITS header array.
HEADERSTRING Convert information in FITS header to a one-string summary.
HEADFITS Read a FITS file header record
HELIO Compute (low-precision) Heliocentric coordinates for the planets. Adapted from the book Celestial Basic
HELIO_JD Convert geocentric (reduced) Julian date to heliocentric julian date (i.e. correct for extra light travel time between Earth and Sun)
HEXTRACT Extract a subimage from an array and create a new FITS header with updated astrometry for the subarray
HINFO Describe information in a FITS image header in a nice format. The input can be either a FITS string array, or the filename of a .HHH file.
HOST_TO_IEEE To translate an IDL variable from IEEE-754 representation (as used, for example, in FITS data ), into the host machine architecture.
HPRECESS Precess the astrometry in a FITS header to a new equinox
HPRINT Print a FITS header (or any other string array) at the the terminal by printing 1 line at a time. Needed because IDL will add an extra space to the 80 character FITS lines, causing a space to appear betweeen lines.
HREBIN Expand or contract a FITS or SDAS image using REBIN and update the header array. The size of the new image must be an integer factor of the original image size. User can either overwrite the input array, or write to new variables.
HREVERSE Reverse an image about either the X or Y axis, and create a new header with updated astrometry for the reversed image.
HROT Rotate an image (cubic, bilinear or nearest neighbor interpolation) and create a new FITS header with updated astrometry for the rotated
IDLBDR Emulate the BDR reduction of a UIT image. This procedure is specific to the UIT Vax or Unix machines at GSFC. Subract a 2-d BAKFOG, linearize, and flat field a UIT density image.
IEEE_TO_HOST To translate an IDL variable in IEEE-754 representation (as used, for example, in FITS data ), into the host machine architecture.
IMCIRCLE To blank out the area on an image outside a circle of specified radius and specified center.
IMCONTOUR Contour plot labeled with astronomical coordinates. The type of coordinate display is controlled by the keyword TYPE Set TYPE=0 (default) to measure distances from the center of the image (IMCONTOUR will decide whether the plotting units will be in arc seconds, arc minutes, or degrees depending on image size.) Set TYPE=1 for standard RA and Dec labeling
IMDBASE Locate sources within a specified IDL database that are within a
IMF Returns values of an N-component power-law logarithmic initial mass function, normalized so that the total mass distribution equals one
IMG2PHOT To get stellar positions from a displayed image by cursor and search UITPHOT tables for them. Photometric information and, if a second table is available, colors are extracted.
IMG_INIT To read an image in from disk and display it. The image is saved in a common block, along with the header and a set of scale factors (used to convert coordinates).
IMLABEL To label an image which has been displayed on the workstation with pixel values, or right ascension and declination if astrometry info is present in the header. Will also write to a postscript file.
IMLIST Display pixel values on an image surrounding a specified X,Y center. IMLIST is similar to TVLIST but the center pixel is supplied directly by the user, rather than being read off of the image display
IMWARP Warps an image to move a given set of x, y coordinates to correspond to another set of x, y coordinates ('reference' coordinates).
INTERLUT Use the mouse to control the lower limit and range of the color table.
IRAFDIR Provide a brief description of the IRAF images on a directory
IRAFRD Read an IRAF (OIF) file and read into an IDL image and header arrays. Program will prompt for the file name if not supplied.
IRAFWRT Write IDL data in IRAF (OIF) format (.imh and .pix files). Does the reverse of IRAFRD.
ISARRAY Determine if arg is an array.
ISOSTR To select isolated stars.
ITT Load or disable an intensity transformation table (ITT). It is usually used to either (1) enhance weak features or (2) reverse positive and negative.
ITTSTARS To display on the screen a series of stars of evenly spaced, known, magnitudes for comparison to an already-displayed image.
IUEAPER Measures flux in an anatomically correct IUE large aperture as projected on 'image'; centered at ra,dec with long axis position angle 'pos_ang' from north and draws the aperture outline on the image (if no /NODRAW)
JDCNV Converts Gregorian dates to Julian days
JPRECESS Calculate the mean place of a star at J2000.0 on the FK5 system from the mean place at B1950.0 on the FK4 system.
JULDATE Convert from calender to Reduced Julian Date
KURUCZ Generates fluxes for the 1991 Kurucz stellar models The calling sequence to this version of KURUCZ differs from that in
KURUCZ_LYC Quickly return the total number of Lyman continuum photons for a Kurucz model flux of specified temperature, gravity, and metallicity. This program is designed for speed, since it is called many times during evaluation of a star cluster evolution model.
KURUCZ_LYC_1979 Quickly obtain the number of Lyman continuum photons from a KURUCZ (1979) model interpolated in termperature.
KUR_INT Quickly obtain a (1993) Kurucz model flux interpolated in temperature. These program is designed for speed, since it is called many times during evaluation of a star cluster evolution model.
KUR_INT_1979 Quickly obtain a (1979) Kurucz model flux interpolated in temperature. This program is designed for speed, since it is called many times during evaluation of a star cluster evolution model.
LEGEND This procedure makes a legend for a plot. The legend can contain a mixture of symbols, linestyles, Hershey characters (vectorfont), and filled polygons (usersym).
LEGENDTEST Test the legend procedure.
LINFIT To make a least squares fit to data with a straight line: Y = A + B*X (IDL version of Bevington's LINFIT program)
LINTERP Linearly interpolate tabulated data from one data grid to another. Use QUADTERP for quadratic interpolation.
LINTERPOL Interpolate in the log as a function of the log.
LOG_G Use Stefan's law to return the log of the surface gravity of a star given its mass, effective temperature, and bolometric luminosity.
LOOK To allow the user to determine visibilities of a target (or targets) through an easy-to-use widget interface.
M83 Quickly display an image of M83 on the current image plane OUTPUT PARAMETERS: M83 - 512 x 512 byte image array of M83 MODIFICATION HISTORY Adapted for SUN Workstation IDL Version 2, J. Isensee, Sept., 1990 Included VAX and SUN paths for M83vis.dat, N. Collins, Nov., 1990
MAEDER_INIT Initialize the MAEDER common block, using the evolutionary models of Schaller et al. (1992) and Schaerer et al. (1993)
MAEDER_INIT_OLD Initialize the MAEDER common block using the OLDMAEDER database.
MAG2FLUX Convert from magnitudes to flux (ergs/s/cm^2/A). Use FLUX2MAG for the opposite direction.
MAG2PHOT Extracts objects from a UITPHOT table, selecting those with magnitudes between an interactively specified range.
MAKEPUBPLOT Draw plots that were designed using ApJPLOT to the screen (or a PostScript file).
MAKESYM Call USERSYM to create one of the below plot symbols.
MAKE_2D Convert an N element X vector, and an M element Y vector, into N x M arrays giving all possible combination of X and Y pairs. Useful for obtaining the X and Y positions of each element of a regular grid.
MAKE_ASTR Build an astrometry structure from input parameter values This structure can be subsequently placed in a FITS header with
MANAD2PHOT To get a celestial coordinate from the user and search the photometry table for it. If found, photometry is extracted and returned.
MANXY2PHOT To get a cartesian coordinate from the user and search the photometry table for it. If found, photometry is extracted and returned.
MAN_PROC Provides online documentation for IDL topics. If the current graphics device supports widgets, a graphical user interface is used. Otherwise, a more basic version which is a cross between Unix man pages and VMS online help is used. The help is organized in a two level hierarchy --- Level 1 is the global subject, and Level 2 supplies help on subjects within each global subject.
MASS_GRID Set up a grid of initial masses for calculating a cluster luminosity. The grid is set up so that it becomes approximately 10 times finer for post main-sequence stars.
MATCH Routine to match values in two vectors.
MATCHCOORD To search a set of coordinates, looking for the element corresponding to a test coordinate.
MEDARR To combine a series of arrays into a single array by filling each pixel in the output array with the median of the corresponding pixels in the input arrays.
MINMAX Return a 2 element array giving the minimum and maximum of a vector or array. This is faster than doing a separate MAX and MIN.
MKHDR Make a minimal primary FITS image header or a minimal FITS IMAGE extension header. If an array is supplied then the created FITS header will be appropiate to the supplied array. Otherwise, the user can specify the dimensions and datatype.
MMM Estimate the sky background, assuming that contaminated sky pixel values overwhelmingly display POSITIVE departures from the true value. Adapted from DAOPHOT routine of the same name.
MOONPOS To compute the RA and Dec of the Moon at a given date.
MP_BASIC Provides on-line documentation for IDL topics. The style is a cross between Unix man pages and VMS on-line help. The help is organized in a two level hierarchy --- Level 1 is the global subject, and Level 2 supplies help on subjects within each global subject. If !D.WINDOW is not -1, (window system in use) the mouse is used to prompt for subjects; otherwise, the normal tty interface is used. This routine is used when in Widget IDL and widgets are not available.
MP_WIDGETS[1] Provides a graphical user interface to the online documentation. The topic is selected by pressing a button at the top. Subtopics a displayed in a scrolling list on the left side. Pressing a mouse button while pointing at a subtopic causes the information on that topic to be displayed in the large text region on the right.
MP_WIDGETS[2] If a procedure name but no help is found in the selected .HELP file, check the ROUTINES.HELP file to see if it is in there. Returns the help text in the form of a string, or a null string if no help is found. Added, 18 Sep 1992. JDO HSTX (Alphabet soup central)
MULTREGRESS Perform multiple linear regression on a set of points. A fairly complete set of regression statistics is available for later analysis of the coefficients.
NEWASTROM Adds the NEWASTROM directory to the !PATH. Also restores compiled versions of all the NEWASTROM procedures
NEWS Print changes to the MOUSSE software in reverse chronological order
NEWXY Read positions of uitphot sources from a FITS table. Divide by 4 and load into a new table.
NINT Nearest integer function. Similar to the intrinsic ROUND function introduced in IDL V3.1, but the default type returned by NINT is INTEGER rather than LONG
NSTAR Simultaneous point spread function fitting (adapted from DAOPHOT)
NULLTRIM Function to trim a string of all characters after and including the first null character (ascii 0)
OLDASTROM Adds the OLDASTROM directory to the !PATH. Also restores compiled versions of all the OLDASTROM procedures
OLD_KURUCZ Generates KURUCZ fluxes for the 284 models presented in Ap J (Suppl) 40,1,1979 and the 96 additional models in Howarth and Lynas-Gray (1989). Use the procedure KURUCZ to obtain the newest (1991) Kurucz models.
ONE_ARROW Draws an arrow labeled with a single character on the current graphics device. Called, for example, by ARROWS to create a "weathervane" showing the N-E orientation of an image.
ONE_RAY Draws a ray from a given starting point for a given length at a given
OPLOTERR Over-plot data points with accompanying X or Y error bars.
ORDINAL Convert an integer to a correct English ordinal string: i.e., 1st, 2nd, 3rd, 4th ....
OSFCNVRT Returns the correctly formatted logical directory syntax for the host operating system.
PARJUST To right justify numerical values in parameter string array
PDSHEAD Print the header information from a PDS tape record. This procedure is called by PDSRD
PDSRD Procedure to read any record or range of records from a PDS tape. Image can be ANY size up to 8192 x 4096. If no variable is supplied tape will still be read and checked for parity errors. Parity errors will be displayed on screen, but will not stop the procedure. Output array will be reduced in size by a factor of nbox.
PFLX2MAG Converts a flux to magnitude units, using the expression: mag = -2.5 log(flux) - 21.1 This expression was extracted from the procedure UIT_APER.
PHODIS Read positions and magnitudes of uitphot sources from a FITS table. Indicate with numbers where they are on the currently displayed image.
PIXCOLOR Assign colors to specified pixel values in a color lookup table
PIXELCHECK Determine if specified coordinates are in a UIT dark spot.
PKFIT This procedure is called by GETPSF to perform the one-star least-squares fit in the DAOPHOT sequence
PLANCK To calculate the Planck function in units ergs/cm2/s/a
PLCEN Computes the R.A. and Dec. of the actual plate center of a UIT image (pixel 1024.5, 1024.5). The CRPIXn values computed by UITAAM or UITRAM -- to which the CRVALn correspond -- will not in general be these numbers.
PLOTCT Plot the red, green and blue 256-element color vectors.
PLOTDATE This procedure puts the user name, calling program and system time and date in the corner of a plot.
PLOTERR Plot data points with accompanying X or Y error bars.
PLOTHIST Plot the histogram of an array with the corresponding abcissa.
PLOTOPEN procedure to open plot journal file CALLING SEQUENCE: plotopen,name name - (optional) file name to place plots If not supplied then plots are placed in TEK.PLT SIDE EFFECTS:
PLOTPRINT PLOTPRINT Sends a plot file create using PLOTOPEN to the HRS laser printer. CALLING SEQUENCE: plotprint,name name - (optional) name of plot file (string) or version
PLOTSYM Define useful plotting symbols not in the standard !PSYM definitions. After symbol has been defined with PLOTSYM, a plotting command should follow with either PSYM = 8 or !P.PSYM = 8 (see USERSYM)
PLOTVAL Read cursor positions off a plot. Analogous to CURVAL for images.
PLOTXYZ Set up coordinate system for 3-D plots
PLOT_KEYWORDS Return default value(s) of plotting keywords. Useful inside of a plotting procedure.
PLOT_RESULTS To display the results of a LOOK run in graphical form on the current plot device.
PLTIME Add a date and time to a pre-existing plot. Date is written vertically in the lower right hand corner. PLTIME should be called subsequent to the main plotting commands.
POIDEV Return an integer random deviate drawn from a Poisson distribution with a specified mean. Adapted from procedure of the same name in "Numerical Recipes" by Press et al. (1986), Section 7.3
PRECESS Precess coordinates from EQUINOX1 to EQUINOX2. For interactive display, one can use the procedure ASTRO which calls PRECESS or use the /PRINT keyword. The default (RA,DEC) system is FK5 based on epoch J2000.0 but FK4 based on B1950.0 is available via the FK4 keyword.
PRECESS_ASTROM Precess an astrometry solution to a new equinox.
PRECESS_CD Precess CD (coordinate description) matrix from a FITS header from EPOCH1 to EPOCH2. Called by HPRECESS
PREPUBPLOT To catenate a series of vectors (up to ten) into a single array, in a format suitable for using with the routine PubPlot.
PRETEK Read the current image from the window and store it with all the graphics and color table info included. Then a simple TV command will display the image on the Tek machine and it will look just like on your workstation.
PROFILE Allow the operator to mark two points on the image display with the cursor. Extract and return the points along the line. Optionally, return the X and Y values of each extracted point.
PSFSTR To interactively select or delete stars with known x and y. A compressed version of images larger than the screen size should be loaded in image plane 0, before calling PSFSTR.
PSIMLABEL To write an image from the currently active window and its imlabel to a postscript file. The text comes out MUCH nicer than if you just use TVLASER from the screen.
PSPLOT Routine to close and print a postscript plot file. On VMS, will send to the postscript laser printer defined by the logical PSLASER; if this logical is not defined, then the default is UIT$POSTSCRIPT In Uinix, routine will check to see if a printer is defined in the environment variable PSPRINTER. If PSPRINTER is not defined, then default is psuit.
PUBPLOT[1] Create a graphical interface to the PLOT routine and allow the user to set/unset/reset various PLOTTING keywords. Intended to aid in making slick plots suitable for publications.
PUBPLOT[2] XX = X axis values YY = Y axis (ordinate) values. Y has N elements or is NxM matrix where N is the number of elements in X. X1...X9 = Optional additional X axis inputs. If they are present, each Xn will be one data set. Y1...Y9 = Optional additional Y axis inputs. If they are present, each
PUTAST Put astrometry parameters into a given FITS header.
PUTFILE To transfer a file from a SUN workstation to a VAX computer or from a VAX computer to a SUN workstation.
PUTIMAGE To transfer an image from a SUN workstation to a VAX or from a DECnet VAX to a SUN workstation. The image is BYTESWAPPED by this procedure to account for differences in system architechures unless the NOSWAP keyword is present and non-zero.
QGET_STRING To get a string from the keyboard without echoing it to the screen.
QMPLOT QMPLOT ON SUN: Routine to close Tektronics emulation to the QMS plot file opened by SETPLOT,5. ON VAX: Send a QUIC plot file generated by IDL to the Laser Grafix 800
QSIMP Integrate a function to specified accuracy using the extended trapezoidal rule. Adapted from algorithm in Numerical Recipes, by Press et al. (1986) p. 111.
QTRAP Integrate a function to specified accuracy using the extended trapezoidal rule. Adapted from Numerical Recipes, p. 111.
QUADTERP Quadratically interpolate (3 point Lagrangian) a function Y = f(X) at specified grid points. Use LINTERP for linear interpolation
RADEC To convert right ascension and declination from decimal degrees to sexigesimal hours (for R.A.) and degrees( for Dec.).
RDGST Reads Ra,Dec, magnitude, and classification code from ST guide star files into IDL arrays. User will be prompted to optionally select stars by position (RA and Dec of center, and field size) and by
RDPSF Read the SDAS file created by GETPSF in the DAOPHOT sequence; combine the gaussian with the residuals to create an output PSF array.
RDUITFIL Read UIT filter curves and wavelength grids
RD_SCAN_NOTES Access the SCANS, FRAMES, and IPSREAL databases and display desired items for requested frames.
READCOL Read a free-format ASCII data file with columns of data into IDL variables. Lines of data not meeting the specified format (e.g. comments) are ignored. Columns may be separated by commas or spaces. Use READFMT to read a fixed-format ASCII file.
READFITS Read a FITS file into IDL data and header variables.
READFMT Quickly read a fixed format ASCII data file into IDL variables. Lines of data not meeting the specified format (e.g. comments) are ignored. To read a free format ASCII data file use the procedure
READGUIDE To read a guide star catalog file, storing the contents into an array of structures.
READ_DST To read a DTA image file (default extension = .DST) of the format used by DAOPHOT (CalTech data structure) from disk into an IDL array.
READ_KEY To read a keystroke and return its ASCII equivalent, unless an ESCAPE sequence was produced. In that case, if the sequence is recognized, a code is returned.
READ_MTL To read a file containing MTL/PTL target information.
REDSHIFT Interactively convert between Redshift, Z, velocity, V (km/s) or distance, D (Mpc). Optionally specify value of Hubble constant
REFSCL To display a reference scale, indicating the behavior of the color table. The reference scale can either be placed in a separate window (default) or overlaid on the current image
REMCHAR Remove all appearances of character (char) from string (st)
REMOVE Contract a vector or up to 7 vectors by removing specified
REM_DUP Function to remove duplicate values from a vector.
REPCHR Replace all occurences of one character with another in a text string. (Use the procedure REPSTR to replace more than one character.)
REPORT_ORBIT To display the current orbital information in a set of text widgets.
REPORT_RESULTS To write the results of a LOOK run to a set of widgets.
REPSTR String substitution as in many text editors. Replace all occurences of one substring by another.
RE_X_INDEX To perform the cross referencing between the two UITPHOT FITS tables using user-supplied definitions of what defines a match between the
RINTER Cubic interpolates an image at a set of reference points points. Optionally obtain the X and Y derivatives at
RISE_SET To determine the acquisition and observation times for an object during a range of time.
SAVE_RESULTS To write the results of a LOOK run to disk, both in text and graphical form.
SAVLUT Read current color tables and save them in a file or in arrays.
SCRATCH Interactively removes scratches or other elongated defects from an image. *SCRATCH will now display image on the screen.* User then calls SCRATCH and uses mouse to select the end points of each scratch. Each point along that line of specified width (def = 5) is replaced with the average of the adjacent points, or if the /INTERP keyword is specified, with the linear interpolation of adjacent points.
SCREEN_SELECT Routine to allow a user to make an interactive screen selection from a list (array) of strings. This procedure determines whether to use dumb terminal version, the non- widget x-windows version or the widget version by examining the !D.NAME system variable.
SCR_ATTRIB To set the screen attribute to those given, in the given order.
SCR_CHARSET To change the character sets.
SCR_CURMOV To mov the cursor around the screen relative to its original position.
SCR_CURPOS To position the cursor at the specified screen location. Unspecified coordinates are set to one. Please note that the ESCAPE sequence expects the coordinates to be counted from (1,1).
SCR_ERASE To erase portions of the terminal screen.
SCR_OTHER To allow the user to issue any ESCAPE sequence.
SCR_RESET To reset the terminal.
SCR_SCROLL To define the scrolling area on the screen. Please note that the line coordinates should be counted from 1.
SD This procedure uses the commands SETDEF and DEFINE to change or display the default directory.
SDIR Provides brief DCL-like directory listing sorted on file
SELECT_O Routine to allow a user to make an interactive screen selection from a list (array) of strings. This assumes a non-x-windows device.
SELECT_W This procedure creates a non-exclusive menu of items in widget form. More than one item may be selected or 'de-selected'. Normally called by SCREEN_SELECT
SELECT_X Routine to allow a user to make an interactive screen selection from a list (array) of strings. This assumes an x-windows device.
SETDEF To permit the VMS default directory to be changed from within IDL.
SETORB To create and save a structure containing the orbit and launch information. This structure is passed to the C functions whenever they are called; this eliminates the problem of having the C global variables disappear up returning from a C function.
SETPARVAL setparval procedure to change a parameter value setparval,st,names,par st - new parameter value (string) 'name=value' names - string array of parameter names INPUT/OUTPUT:
SETPLOT To direct subsequent plot to the specified plotting device. Currently set for the available plotting devices at the Goddard LASP computers. It differs from SET_PLOT in the following ways: (1) Typing SETPLOT without any parameters will give a menu of available plotting devices. (2) The user is informed of the subsequent plotting device. (3) The user can either specify the device name or the device number.
SFR Obtain a flux per unit solar mass of a star cluster with continuous star formation as a function of wavelength.
SHOWFITS To permit the user to interactively obtain data from FITS headers and tables from a specified directory. The user should then use FITS_CONV to convert the data to proper form.
SHOWPHOT To permit the user to interactively get the UITPHOT magnitudes of stars from a field and from a table.
SHOWUIT Quick and dirty read and display of a UIT image. The image must be smaller than the image display size. SHOWUIT determines the best scaling by examining the data range of the variance of the sky.
SHOW_COLOR To draw boxes around the positions common to both FITS tables.
SHOW_STAR To draw a box around one or more positions from a UITPHOT FITS table.
SIGMA Calculate the standard deviation value of an array, or calculate the standard deviation over one dimension of an array as a function of all the other dimensions.
SIGN Returns SIGN (-1, 0 or +1) of NUM. If NUM is an array, SIGN returns an array of -1, 0 and 1.
SINCE_VERSION Determine if the current release of IDL (as given in the !VERSION.RELEASE system variable) comes after the user specified
SIXLIN Compute linear regression coefficients by six different methods. Adapted from the FORTRAN program (Rev. 1.1) supplied by Isobe, Feigelson, Akritas, and Babu Ap. J. Vol. 364, p. 104 (1990). Suggested when there is no understanding about the nature of the scatter about a linear relation, and NOT when the errors in the variable are calculable.
SIXTY Converts decimal number to sexigesimal. Reverse of TEN function.
SKY Determine the sky level in an image by applying the procedure MMM to approximately 4000 uniformly spaced pixels. Adapted from the DAOPHOT routine of the same name.
SPEC_DIR Provide a complete file specification by appending a default disk or directory if necessary.
SPYGLASS To allow user to select a position on a compressed image and display a portion of a full resolution image, centered on this position. If both headers contain astrometry, then the images do not have to be aligned.
SQUARE Modify !P.POSITION, (if necessary) so that the current plotting area is square. To return to the default plotting window set !P.POSITION=0 !P.POSITION must be reset every time the plotting device is changed.
SRCOR To correlate the sources on 2 lists.
STACK images on disk (should be more than two) and if desired a stacked variance array. Please refer to the RESTRICTIONS below before attempting to run this program.
STARAST Compute an exact astrometry solution using the positions and coordinates from 2 or 3 reference stars. If 2 stars are used, then the X and Y plate scales are assumed to be identical, and the axis are assumed to be orthogonal. Use of three stars will allow a unique determination of each element of the CD matrix.
STARHOP Interactively compute centroided x and y values for stars with known right ascension and declination. A compressed version of images larger than the screen size should be loaded in image plane 0, before calling STARHOP.
STARMOD Returns stellar parameters (effective temperature, luminosity, mass) for stars of given initial mass and age from the stellar evolution sequence of Schaller et al. (1992)
STARMOD_INT Interpolate the evolutionary models of Schaller et al (1992) in initial mass
STAR_EVOL Determine the flux of a star at a specified wavelength as a function of age
STAR_LYC Calculate the number of Lyman continuum photon as a function of age for a star of specified initial mass.
STAR_RAD Return a stellar radius given effective temperature and bolometric luminosity, using Stefan's law
STDIR Provide a brief description of the SDAS images on a directory
STRD Open an SDAS file and read into an array. Combines the functions of SXREAD and SXOPEN. Program will prompt for the file name
STREBCASC Function to converts an EBCDIC string scalar or array to its ASCII equivalent. Similar to the IDL Version 1 routine of the same name.
STRINGAD Converts a string of sexigesimal coordinates to their decimal form.
STRN The main and original purpose of this procedure is to convert a number to and unpadded string (i.e. with no blanks around it.) However, it has been expanded to be a multi-purpose formatting tool. You may specify a length for the output string; the returned string is either sut to that length or padded to be that length. You may specify characters to be used in padding and which side to be padded. Finally, you may also specify a format for the number. NOTE that the input "number" need not be a number; it may be a string, or anything. It is converted to string.
STRNUMBER Function to determine if a string is a valid numeric value.
STSECTION Using the cursor, you pick a spot on a compressed image you have displayed. A subimage centered on that spot is extracted from an STSDAS disk file containing the full resolution version of the image. By default, you'll get a 512 x 512 section of a 2048 x 2048 full-res
STSUB Read a subset of a space telescope SDAS image file. User can specify a subimage range or a step size Called by STSUBIM
STSUBIM Open an STSDAS file and read a portion of the file into an array. An enhanced version of STRD. Program will prompt for the file name and subimage bounds.
STWINDOW Cull ra and dec arrays, and output only the ones in a rectangular window with a specified center, width, and height User is prompted for field center width and height.
STWRT Write an STSDAS header and/or 2-D array to disk (.hhh and .hhd files) without groups!
SUBSTAR DAOPHOT procedure to subtract a scaled point spread function at specified star position(s).
SUBSTEP_GEOM Create a geometrically corrected version of a substepped UIT image. This routine will both rotate to North-Up orientation and correct UIT image distortion.
SUNPOS To compute the RA and Dec of the Sun at a given date.
SVEXTAST Return original BDR astrometry.
SXADDHIST Procedure to add history line(s) to FITS header
SXADDPAR Add or modify a parameter in a FITS or STSDAS header array.
SXDELPAR Procedure to delete a keyword parameter(s) from a FITS header
SXGINFO Return datatype, starting byte, and number bytes for all group parameters in an STSDAS file. Obtaining these values greatly speed up execution time in subsequent calls to SXGPAR.
SXGPAR SXGPAR obtain group parameter value in SDAS/FITS file CALLING SEQUENCE: result = sxgpar(h,par,name,type,sbyte,nbytes) h - header returned by SXOPEN par - parameter block returned by SXREAD or multiple
SXHCOPY SXHCOPY copies selected portions of one header to another CALLING SEQUENCE: sxhcopy,h,keyword1,keyword2,hout h - input header keyword1 - first keyword to copy
SXHEDIT Routine to interactively edit a SDAS header on diskusing EDT if on a VAX, or EMACS if on a SUN..
SXHMAKE Create a basic St header file from an IDL data array
SXHPRINT To send a header file to a printer (with each card comprising one line
SXHREAD Procedure to read a FITS header from disk. This version of SXHREAD can read three types of disk files (1) VMS Fixed record length 80 byte files, or GEIS files with
SXHWRITE Procedure to write an STSDAS or FITS header to disk as a STSDAS
SXMAKE Create a basic St header file from an IDL Array before writing data.
SXOPEN Open a Space Telescope formatted header file. Save the parameters required subsequent SX routines in the common block Stcommn. Optionally save the header in the string array Header, and the history in the string array History. Open the data file associated with this header on the same unit.
SXPAR Obtain the value of a parameter in a FITS header
SXPARPOS Find the position to insert a record into a FITS header. Called from
SXREAD Read a Space Telescope STSDAS image file
SXWRITE Write a group of data and parameters in ST format to a STSDAS data file.
SYSINT To initialize the workstation image windows and related IDL common blocks. All windows are deleted, all zoom factors set to unity, and all roam factors set to zero. The normal pixel logic (GXcopy) is implemented (device,set_graphics=3).
TABINV To find the effective index of a function value in an ordered vector.
TABLE_APPEND Routine to append STSDAS tables to create a single table. Input tables must all have identical columns.
TABLE_CALC Adds a new table column from a expression using existing columns
TABLE_DELETE Delete specified rows from an STSDAS table
TABLE_EXT routine to extract columns from an stsdas table
TABLE_HELP Procedure to decribe an SDAS table file.
TABLE_LIST Procedure to list contents of an STSDAS table. This does not print the table in tabular form but instead for each row prints the column name followed by its value (one column per
TABLE_PRINT Routine to print an stsdas table.
TABLE_SORT Procedure to sort an STSDAS table by the specified column
TABWARP Counterpart of IMWARP for tables. Transforms a list of coordinates on one image to a list of coordinates on another image, according to a table of matched fiducial points.
TAB_ADDCOL Procedure to add a new column to an existing stsdas table.
TAB_COL Procedure to extract column information from table control block
TAB_CREATE Procedure to create a new table file.
TAB_DEL Delete specified row(s) from an STSDAS table
TAB_EXPAND routine to expand the size of an SDAS table file.
TAB_FORTOSPP Procedure to convert a FORTRAN format to an SPP format specfication.
TAB_INIT To read a pair of FITS tables in. These tables are stored in common blocks for later use.
TAB_MODCOL Modify column description in a STSDAS table
TAB_NULL function to locate null values within a vector of values from an STSDAS table.
TAB_NULLROW Insert null row(s) into a STSDAS table
TAB_PRINT Routine to print an stsdas table.
TAB_PUT Procedure to place new values into a STSDAS table.
TAB_READ Procedure to read an SDAS table file
TAB_SIZE Routine to extract the table size from a table control block
TAB_SORT Procedure to sort table by the specified column
TAB_SPPTOFOR This procedure converts an spp format specification to a normal Fortran format specification.
TAB_VAL Routine to read a column from an SDAS table file
TAB_WRITE Routine to write an stsdas table to disk
TARGET_RISE To determine the MET at which target acquisition or observation
TARGET_SET To determine the MET at which target acquisition or observation
TBLFIX Updates magnitudes in UITPH1 and UITPH2 output FITS tables to use the latest calibration. Exposure time is read from the FRAMES database. The current absolute calibration is the Landsman 10-dec-91 value
TCOLOR To display the contents of two windows together in a "true-color" configuration, assigning each one of the three "primary" colors: Red, Blue, or Green.
TEK Restore the image and color table info from a .sav file created by PRETEK.PRO Display on tek machine.
TEN Converts sexigesimal number to decimal. Inverse of SIXTY function.
TENV() Converts sexigesimal number to decimal. Like TEN but allows vector
TEXTCLOSE procedure to close file for text output as specifed by the (non-standard) system variable !TEXTOUT.
TEXTOPEN Procedure to open file for text output. The type of output device (disk file or terminal screen) is specified by the TEXTOUT keyword or the (nonstandard) system variable !TEXTOUT.
TICLABELS Used to display images with right ascension and declination axes. This routine creates labels for already determined tic marks (every other tic mark)
TICPOS Procedure to specify distance between tic marks for astronomical coordinate overlays. User inputs number an approximate distance between tic marks, and the axis length in degrees. TICPOS will return a distance between tic marks such that the separation is a round multiple in arc seconds, arc minutes, or degrees
TICS For use in labelling a displayed image with right ascension and declination axes. An approximate distance between tic marks is input, and a new value is computed such that the distance between tic marks is in simple increments of the tic label values.
TIC_ONE For use in labelling images with right ascension and declination axes. This routine determines the position in pixels of the first tic.
TMULT Compute Transpose(A)#A in about 2/3 of the time of the native IDL matrix multiplication routine by taking advantage of the fact that this matrix is symmetrical. This IDL routine is, in fact, a front-end for the shared image TransMult, now in the CPROG file.
TO_HEX Translate a non-negative decimal integer to a hexadecimal string
TRAPZD Compute the nth stage of refinement of an extended trapezoidal rule. This procedure is called by QSIMP and QTRAP. Adapted from Numerical Recipes, Section 4.2. TRAPZD is meant to be called iteratively from a higher level procedure.
TRUXY Reads the (X,Y) position of the television cursor and converts it to the X,Y position on the corresponding image array. (These positions are identical only for an unroamed, unzoomed image with with pixel (0,0) of the image placed at position (0,0) on the TV.)
TSUM Trapezoidal summation of the area under a curve. This procedure was formerly know as INTEG
TVAD Move cursor to a specified RA and Dec
TVAPER Display an 16 aperture growth curve in the vicinity of a star. Image must be displayed before calling TVAPER. Should generally be used only on isolated stars. The TELESCOP keyword in the FITS header is used to determine whether to use the appropiate defaults for UIT
TVBALL Interactively adjust the lower limit and range of a linear color table. TVBALL is similar to CONTRAST but it allows one to individually control each of the red, blue, and green color guns. It is especially useful when different color guns have been assigned to different image planes with COLOR. The user interfaces with the procedure through the mouse, using the mouse buttons to issue various commands.
TVBOX Draw a box(es) or rectangle(s) of specified width centered on the cursor, or at specified position(s).
TVCIR Quickly draw circles around stars and display their IDs or index numbers on the right or left. Keywords allow selection of circle radius (RAD), size of ID print (SZE), printing on left of stars (OFFST=-1) and suppression of circles (CIRC=-1). If an array of IDs is used and some elements are blank or -1, TVCIR will not print by the star.
TVCIRCLE Draw a circle or circles of specified radius centered on the cursor, or at specified position
TVCNTRST Interactively change upper and lower limits on data to be displayed
TVCURSOR Toggle the cursor on or off, or move cursor to coordinates X,Y.
TVDBASE Draw boxes in the around the sources found in specified database on the image in the active window.
TVELLIPSE Draw an ellipse on the current graphics device.
TVERAS To clear the designated windows and subchannels of the workstation. It is based upon the IDL Version 1 intrinsic procedure of the same
TVLABEL Write text to workstation window. The procedure is identical to XYOUTS except for the following (1) User will be prompted, if necessary, for the position, size and content of the text to be written. Position may be specified by the current cursor position. (2) TVLABEL assumes X and Y positions are given in unzoomed, unroamed device coordinates.
TVLASER Prints screen onto a Postscript laser printer. Under VMS, TVLASER checks the logical name PSLASER to check which postscript printer to use. If none is supplied, then the default is UIT$POSTSCRIPT
TVLIST Cursor controlled listing of a TV image on the terminal.
TVSTATUS Display common blocks and global variables associated with the image display for each open window.
TVTIME Display current date and time in bottom right hand corner of TV. Useful before taking photographs.
TVXY Get the RA and Declination of the current cursor position Place the cursor at the desired position before calling this routine
TYPE Emulates VMS TYPE command. On a Unix machine, TYPE simply spawns to the more(1) command. On a Macintosh, refers user to editor.
T_APER Driver procedure (for APER) to compute concentric aperture photometry, with I/O to FITS tables. Adapted from DAOPHOT.
T_APPEND To merge tables produced by the "T_" photometry routines.
T_FIND[1] Find positive brightness perturbations (i.e stars) in a 2 dimensional image. Input and output are to FITS tables
T_FIND[2] Find positive brightness perturbations (i.e stars) in a 2 dimensional image. Input and output are to FITS tables
T_GETPSF Generate a point-spread function from one or the sum of several isolated stars using FITS table I/O. Residuals are written to an SDAS image file.
T_GROUP Procedure to place stars with non-overlapping PSF profiles into distinct groups. Input and output are to disk FITS tables
T_NSTAR Simultaneous point spread function fitting. Input and output are to disk FITS tables.
T_SUBGROUP Breaks up a "group" in a Mousse DAOPHOT photometry table (T_GROUP output) into new subgroups based on a revised radius.
T_SUBSTAR Subtract a scaled point spread function at specified star
UITASTROM Add a rough astrometry solution to a UIT FITS header. The rotation angle should be accurate to about 2 degrees, and the center of the image should be located to within about 30".
UITDIR Provide a brief description of the UIT images on a directory. Searches for the presence of BDR keywords BDRIPRG, ASTRPROG and and GEOMPROG to determine whether the image has been through BDR linearization (and flat-fielding), astrometry, and bicubic rotation to North up.
UITFILTER Convolve a spectrum through a UIT filter to obtain a flux. Optionally return the effective wavelength of the flux distribution.
UITLOADCT Load predefined color tables. This version includes the standard IDL color tables (0-15), as well as the customized UIT color tables (16-31) on UIT_DATA:
UIT_AD2XY Compute an X and Y position given the RA and DEC and a UIT astrometry structure returned by UIT_EXTAST. A tangent (gnomonic) projection is assumed. AD2XY is meant to be used internal to other procedures. For interactive purposes, use ADXY.
UIT_APER Procedure (from DAOPHOT) to compute concentric aperture photometry. A separate sky value is determined for each aperture using specified inner and outer sky radii. This version uses the FFVAR function to determine the variance of the photographic intensities. The procedure UIT_MMM is used to determine the sky background.
UIT_EXTAST Extract astrometry parameters from a UIT FITS image header. The astrometry in the header can be in either CD (Coordinate description) format, or CROTA and CDELT (AIPS-type) format. However, the output astrometry will always be in CD format.
UIT_FIND Find positive brightness perturbations (i.e stars) in a 2 dimensional image and compute centroids, and shape parameters, Adapted from DAOPHOT.
UIT_GETPSF To generate a point-spread function (PSF) from one or the sum of several stars. The PSF is represented as a 2-dimensional gaussian (integrated over each pixel) and a lookup table of residuals. The lookup table and gaussian parameters are output as an STSDAS (modified FITS) image file.
UIT_MMM Estimate the sky background, assuming that contaminated sky pixel values overwhelmingly display POSITIVE departures from the true value. This version of MMM has been modified for UIT data to always use the mean value of the data when the mean is less than 5.
UIT_NSTAR Simultaneous point spread function fitting (from DAOPHOT). Error analysis for photographic plate using FFVAR function
UIT_PKFIT This is the subroutine which does the actual one-star least-squares profile fit for UIT_GETPSF
UIT_XY2AD Compute R.A. and Dec in degrees from X and Y and the plate solutions in six-parameter format. A tangent (gnomonic) projection is assumed. XY2AD is meant to be used internal to other procedures. For interactive purposes use XYAD. UIT NEWASTROM version
UNRED Correct an (ultraviolet) flux vector for interstellar extinction. One can choose from 10 different extinction curves (or a user specified
UNZOOM_XY Converts X, Y position on the image display to the the X,Y position on the corresponding image array. (These positions are identical only for an unroamed, unzoomed image with with pixel (0,0) of the image placed at position (0,0) on the TV.)
UPPER_MASS Function that uses the Schaller et al. (1992) stellar evolutionary tracks to return the upper mass that needs to be considered for a star cluster of a given age.
UVBYBETA Derive dereddened colors, metallicity, and effective temperature from Stromgren colors. Adapted from FORTRAN routine of same name published by T.T. Moon, Communications of University of London Observatory, No. 78. Can be used either interactively or called from a main procedure.
VACTOAIR Convert vacuum wavelengths to air wavelengths, i.e. correct for the index of refraction of air under standard conditions. Wavelength values below 2000 A will not be altered. Accurate to about 0.005 A
VECT This function returns the given vector in parenthesized coordinates as in the form (X,Y). No limit on the number of dimensions. Also note that the vector does not need to be numbers. It may also be a string vector. e.g. ['X','Y']
VIDEO Overlays the positions of a set of reference stars derived from a rough astrometry solution. User can interactively adjust astrometry parameters to better match the overlay with stars on an image on the window display.
VT100 Erases screen and puts retrographics or selanar terminal into the VT100 mode.
WARPLIST Allows user to cursor-select corresponding sources as shown on two different display channels. Lists of corresponding X, Y coordinates returned. Source located at maximum pixel within box surrounding cursor position. Use CWARPLIST to use centroid to define position rather than maximum pixel value.
WCSSPH2XY To convert spherical (longitude and latitude -- sky) coordinates to x and y (map) angular coordinates. This procedure is the inverse of WCSXY2SPH. See WCS_DEMO for example of use.
WCSXY2SPH To convert x and y (map) coordinates to spherical (longitude and latitude or sky) coordinates. This procedure is the inverse of
WHELP Provides online documentation for IDL topics. If the current graphics device supports widgets, a graphical user interface is used. Otherwise, a more basic version which is a cross between Unix man pages and VMS online help is used. The help is organized in a two level hierarchy --- Level 1 is the global subject, and Level 2 supplies help on subjects within each global subject.
WHERENAN Find the positions of all values within an array that correspond to the IEEE NaN (not-a-number) special values.
WINDOW_STATE Returns an array indicating which workstation windows are open.
WRITEFITS Write an an IDL array into a disk FITS file. Works with all types of FITS files except random groups
WTITLE Add a title to the title bar of an existing IDL TV-window.
WZOOM Expands entire image (or graphics) from active window by integral multiples to specified amount, up to the largest possible square.
X2FITS Create basic FITS files on tape from IDL Arrays (any dimensions). A minimal FITS header is created by this program.
XE2AD Compute RA, DEC in Degrees (or radians) from Xi, Eta in ARCSEC (or radians). Originally intended for use internal to other procedures, although straight-forward enough for interactive use.
XHISTOGRAM To determine the histogram of an array with the corresponding abcissa.
XY2AD Compute R.A. and Dec in radians from X and Y and the plate solutions in six-parameter format. A tangent (gnomonic) projection is computed directly; other projections are computed using WCSXY2SPH. XY2AD is meant to be used internal to other procedures. For interactive purposes use XYAD.
XY2PHOT To search UITPHOT tables for the supplied image position. Photometric information and, if a second table is available, colors are extracted.
XYAD Use astrometry in a FITS image header to compute R.A. and Dec in decimal degrees from X and Y.
XYXY To use a pair of headers to convert X/Y positions from one frame
XYZ Calculate heliocentric X,Y, and Z coordinates for 1950.0 (The positive X axis is directed towards the equinox, the y-axis towards the point on the equator at right ascension 6h, and the z axis toward the north pole of the equator.
YDN2MD Convert from year and day number of year to month and day of month.
YMD2DN Convert from year, month, day to day number of year.
ZANG Determine the angular size of an object as a function of redshift in a Friedmann cosmology (homogeneous, isotropic universe with zero cosmological constant)
ZBRENT Find the zero of a 1-D function up to specified tolerance. This routine assumes that the function is known to have a zero.
ZENPOS To supply the zenith RA and Dec in radians corresponding to a supplied
ZERO Erase an image within a window (without deleting the window)
ZOOM_XY Converts X, Y position on the image array to the the X,Y position on the current image display. (These positions are identical only for an unroamed, zoomed image with with pixel (0,0) of the image placed at position (0,0) on the TV.)
ZPARCHECK Routine to check user parameters to a procedure