SolarSoft 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:27:54 2000.

List of Routines

ABSCAL Apply the FITS BZERO and BSCALE keyword values to a data array
ACGAUNT of R. Mewe (18-JUN-85) to full calculations of paper VI (Arnaut and Rothenflug for ion balances).
AD2XY Compute X and Y from RA and DEC and a FITS astrometry structure 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.
ADDTIME If optional keyword delta_min is supplied, then add a offset in decimal minutes to an external time (H,M,S,MS,D,M,Y). If optional keyword difference is supplied, return the difference as Value = [A] - [B], where Value will be minutes (floating).
ADD_PATH Add directory (and optionally all its subdirs) into IDL path
ADD_PROP Project : SOHO-CDS Name : ADD_PROP Purpose : Add a property to a map object Category : imaging Explanation : Syntax : add_prop,map,property=value
ADD_SYNOP Project : HESSI Name : ADD_SYNOP() Purpose : Adds a record to synoptic database Explanation : Syntax : ADD_SYNOP, DEF, STATUS Inputs : DEF = This is an anonymous structure containing
ADD_TAG Project : SDAC Name : ADD_TAG Purpose : add a tag to a structure Explanation : Use : NEW_STRUCT=ADD_TAG(STRUCT,TAG,TAG_NAME) Inputs : STRUCT = input structure (array or scalar)
ADJUST Adjust the range of an image. Adjusts the range of an image. Basically equivalent to using the ">" and "<" operators, except that pixels equal to MISSING are ignored and not changed by this procedure.
ADJUST_COLOR Adjust the color table with the cursor. Use the graphics cursor to control the lower limit and range of the
ADJUST_TIMES Name: adjust_times Purpose: check input times and adjust if required Input Parameters: t0 - start time - any Yohkoh format t1 - stop time Output Parameters:
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. One can also specify the precision of the declination in digits after the decimal point.
ADXY Use a FITS header to convert celestial (RA,Dec) to pixel coordinates Use an image header to compute X and Y positions, given the RA and Dec in decimal degrees.
AFFINE Apply the affine transformation given by the input parameters
AFFINE_SOLVE Calculate the parameters of a general affine image transformation given a set of points from two images: one of the images is assumed to be the reference image, the other is assumed to be an image translated, rotated, scaled, and possibly sheared relative to the reference image.
AFF_DIST PRINT,x(1),y(1)
AFHREAD Subroutine of WFPCREAD to read a GEIS header from an HST STSDAS image. This procedure reads a GEIS header from an HST image. It then looks if a .SHH file is present for FOC images to calculate better astrometry by getting the current PSANGLV3 from this file. Called by
AIDE Aide en ligne des logiciels NRH1
AIRTOVAC Convert air wavelengths to vacuum wavelengths Wavelengths are corrected for the index of refraction of air under standard conditions. Wavelength values below 2000 A will not be altered. Uses the IAU standard for conversion given in Morton (1991 Ap.J. Suppl. 77, 119)
AITOFF Convert Right Ascension, Declination to X,Y using an AITOFF projection. This procedure can be used to create an all-sky map in Galactic coordinates with an equal-area Aitoff projection. Output map coordinates are zero longitude centered.
AITOFF_GRID Produce an overlay of latitude and longitude lines over a plot or image The grid is plotted on the current graphics device. AITOFF_GRID assumes that the ouput plot coordinates span the x-range of -180 to 180 and the y-range goes from -90 to 90.
ALIGN_CUBE_CORREL Name: align_cube_correl Purpose: align a data cube via cross correlation; update coordinates Input Parameters: index - the header structures ; SSW standards w/pointing fields data - the data cube Calling Sequence:
ALL_VALS Find and sort unique values in an array
ALPHAGEN Name: alphagen Purpose: return array ['A', 'B', 'C'...] (sindgen with alpha) Calling Sequence: alpha=alphagen(10 [,/lower])
ALPHA_PAGE This procedure switches to alpha from graphics page under Tektronix.
AMEDIAN Works the same as MEDIAN, but the effect tapers off at the edges.
AMOEBA_C Project : SOHO - CDS Name : AMOEBA_C Purpose : Reiteratively fits an arbitrary function Explanation : Fits an arbitrary function to a series of data points via a least-squares reiterative technique. The procedure used is taken from Numerical Recipes.
AMOEBA_F Project : SOHO - CDS Name : AMOEBA_F Purpose : Reiteratively minimizes an arbitrary function Explanation : Minimizes an arbitrary function via a least-squares reiterative technique. The procedure used is taken from Numerical Recipes.
ANAHEAD returns just the header from a Rice compressed f0 file.
ANAHEAD2STRUCT Name: anahead2struct Purpose: convert an ana header (per lapalma) -> SSW structure
ANIMPROF Cette procedure trace une serie d'images unidimensionnelles (intensite et/ou polarisation)animees CATEGORY: NRH1 profils CALLING SEQUENCE: ANIMPROF,Images, Unit
ANYTIM This function converts one of several recognized time formats into the selected output format.
ANYTIM2CAL Project : SOHO - CDS Name : ANYTIM2CAL() Purpose : Converts (almost) any time format to calendar format.
ANYTIM2DD79 Convert time in any standard format to decimal d79,
ANYTIM2DOY Given a time in the form of a (1) structure, (2) 7-element time representation, or (3) a string representation, return the day of the year for that day
ANYTIM2EX Given a time in the form of a (1) structure, (2) 7-element time representation, or (3) a string representation, or (4) an array 2xN where the first dimension holds (MSOD, DS79) convert to the 7-element time representation (hh,mm,ss,msec,dd,mm,yy)
ANYTIM2INTS Given a time in the form of a (1) structure, (2) 7-element time representation, or (3) a string representation, or (4) an array 2xN where the first dimension holds (MSOD, DS79) convert to the a simple structure with .TIME and .DAY
ANYTIM2JD Project : SOHO - CDS Name : anytim2jd() Purpose : Converts any input time format to full Julian day.
ANYTIM2TAI Project : SOHO - CDS Name : ANYTIM2TAI() Purpose : Converts any standard CDS time format to TAI.
ANYTIM2UTC Project : SOHO - CDS Name : ANYTIM2UTC() Purpose : Converts (almost) any time format to CDS UTC format.
ANYTIM2UTPLOT Convert to the "utplot" time format of yy/mm/dd, hhmm:ss.xxx from any type of input
ANYTIM2WEEKINFO Purpose: return week-requested information for input time vector Input Parameters: times - time vector in any SSW format Output Parameters: years - integer year for input times weeks - integer week for input times
ANYTIM2WEEKS Given a starting and ending time, return a vector of week numbers and year numbers where the times fall
APER Compute concentric aperture photometry (adapted from DAOPHOT) APER can compute photometry in several user-specified aperture radii. A separate sky value is computed for each source using specified inner and outer sky radii.
APPEND_ARR Project : SOHO - CDS Name : APPEND_ARR Category : Utility Purpose : Manageable method for concatanating arrays Explanation : Syntax : IDL> result=append_arr(input,extra)
APPLY_LOCK Project : SOHO - CDS Name : APPLY_LOCK Purpose : create a LOCK file
ARCBAR Display a bar of a specified input size in arcminutes or arcseconds
ARCMIN2HEL Project : SOHO - CDS Name : ARCMIN2HEL() Purpose : Convert arcmin from sun centre to heliographic coords. Explanation : Converts an (x,y) position given in arcmins relative to the solar disk centre to heliographic coordinates for the date supplied ( default date = today).
ARR2GIF Project : SOHO-CDS Name : ARR2GIF Purpose : Write images to a series of GIF files Category : imaging Explanation : Syntax : IDL> arr2gif,images,file
ARR2STR Project : SSW Name : ARR2STR() Purpose : Convert an array to a delimited string.
ARRAY_JHUAPL Force given argument to be an array.
ARRAY_MATCH Project : SOHO - CDS Name : ARRAY_MATCH() Purpose : Detect if a vector matches any row or column of a 2D array Explanation : Search through a 2D array to see if any row (or column, if keyword COLUMN is set) of it is identical to (or matches) a given vector.
ARRAY_XOR Project : SOHO - CDS Name : ARRAY_XOR() Purpose : Returns the XOR elements of two arrays.
ARROW CATEGORY: Graphics
ARROW2 Wrapper routine for IDL user library ARROW routine.
ARROWS To display "weathervane" directional arrows on an astronomical image Overlays a graphic showing orientation of North and East.
ASCII Print ASCII characters based on its numerical decimal value.
ASK Gets a single letter response from the keyboard. Gets a single letter response from the keyboard. Only responses in the array VALID are allowed. The prompt string is printed, and GET_KBRD is called to read in the result.
ASMOOTH Project : SOHO - CDS Name : ASMOOTH() Purpose : Smooths a one or two-dimensional array. Category : Image-processing, SU:SERTSIM, Class3 Explanation : Does the same thing as the IDL built-in SMOOTH function, except 1. The effect tapers off at the edges of the array, instead
ASTDISP Print astronomical and pixel coordinates in a standard format This procedure (ASTrometry DISPlay) prints the astronomical and pixel coordinates in a standard format. X,Y must be supplied. RA,DEC may also be supplied, and a data number (DN) may also be supplied. With use of the Coords= keyword, a string containing the formatted data can be returned in addition or instead (with /silent)
ASTRMFIX Calculate a rough HST WFPC or FOC astrometry solution This program will calculate a rough HST WFPC or FOC astrometry solution using the keyword PSANGLEV3 which gives the angle of the V3 axis of HST. Called by WFPCREAD.
ASTRO Interactive utility for precession and coordinate conversion.
ASTROLIB Add the non-standard system variables used by the IDL Astronomy Library Also defines the environment variable or VMS logical ASTRO_DATA pointing to the directory containing data files associated with the IDL Astronomy library (system dependent).
ATIME Convert argument UT to string of format YY/MM/DD, HHMM:SS.XXX or YY/MM/DD, HH:MM:SS.XXX, if PUB is set
ATMOS atmosphere in units of cm2/gm
AVERAGE Averages an array over one or all of its dimensions. Calculates the average value of an array, or calculates the average value over one dimension of an array as a function of all the other
AVG Return the average value of an array, or 1 dimension of an array 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
AVG_WO_CR Project : SOHO - CDS Name : AVG_WO_CR() Purpose : Average together multiple images, ignoring cosmic rays Category : Class3, Analysis Explanation : Averages an array over one of it's dimensions. The average is done such that any pixels which are more than 3 sigma above the
AVOID_SPIKES Return the subscript list of data values which don't have spikes
A_B Compute B band interstellar extinction according to the RC2. The predicted B band extinction is computed as a function of Galactic position using the 21 parameter function given by deVaucouleurs 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 21 cm maps.
BARYVEL Calculates heliocentric and barycentric velocity components of Earth. BARYVEL takes into account the Earth-Moon motion, and is useful for radial velocity work to an accuracy of ~1 m/s.
BASELINE Project : SOHO - CDS Name : BASELINE() Purpose : Returns baseline value of the input array. Category : Class3, Analysis Explanation : This function estimates the baseline value of the input array. This is determined by rejecting all points more than two sigma
BASE_INTERP Project : SOHO - CDS Name : BASE_INTERP() Purpose : Interpolate to the base of a curve, ignoring outliers. Category : Class4, Interpolation Explanation : Makes a polynomial (by default linear) fit to the data, and removes any points which are far from the fit, before
BELL Project : SOHO - CDS Name : Bell Purpose : To ring the terminal bell a specified number of times.
BELLS Project : SOHO - CDS Name : BELLS() Purpose : Fits bell splines to data array.
BIGPICKFILE Project : SOHO - CDS Name : BIGPICKFILE Purpose : Pickfile, but with more space for everything.
BIN2DEC Project : SOHO - CDS Name : BIN2DEC Purpose : Convert binary representation to decimal integer.
BIN2HEX Project : SOHO - CDS Name : BIN2HEX Purpose : Convert binary representation to hexadecimal.
BINUP to rebin data into arbitrary dimensions
BITS Given a byte or integer, return a vector of 8 or 16 values which are the binary representation of the value.
BITS2 Given a byte or integer, return a vector of 8 or 16 values which are the binary representation of the value.
BLANK() To make a blank string with a given length
BLINK To allow the user to alternatively examine two or more windows within a single window.
BLINK_IMAGES Blinks two images together by modifying the color tables. A combined image is formed in which the lower bits are assigned to ARRAY1 and the higher bits to ARRAY2. Two color tables are defined relative to the current one so that the different images are shown by changing between these two color tables.
BLINK_MAP Project : SOHO-CDS Name : BLINK_MAP Purpose : blink two maps using XINTERANIMATE Category : imaging Explanation : Syntax : blink_map,map1,map2,_extra=extra
BOOST_ARRAY Append one array onto a destination array Add array APPEND to array DESTINATION, allowing the dimensions of DESTINATION to adjust to accomodate it. If both input arrays have the same number of dimensions, then the output array will have one additional dimension. Otherwise, the last dimension of DESTINATION will be incremented by one.
BOOST_TAG Project : SOHO - CDS Name : BOOST_TAG Category : Utility Purpose : boost a tag value Explanation : Useful for updating history tags in structures Syntax : IDL> new_struct=boost_tag(struct,value,tag_name)
BOXAVE Box-average a 1 or 2 dimensional array. This procedure differs from the intrinsic REBIN function in the following two ways:
BOX_AV Project : SOHO - CDS Name : BOX_AV() Purpose : Produce a box average of an array.
BOX_CRS Two-button equivalent of BOX_CURSOR for Microsoft Windows. Emulates the operation of a variable-sized box cursor (also known as a "marquee" selector). Differs from BOX_CURSOR in that only two mouse buttons are used. This makes it useful for Microsoft Windows, where all three buttons are not always available.
BOX_CURSOR Emulate the operation of a variable-sized box cursor This is a better improved version of BOX_CURSOR, a standard procedure from the IDL user library. The added keywords are: COLOR, ANYWHERE, EVENT_PRO, and STC4EVENT.
BOX_CURSOR2 Emulate the operation of a variable-sized box cursor This is a better improved version of BOX_CURSOR, a standard procedure from the IDL user library. The added keywords are: COLOR, ANYWHERE, EVENT_PRO, and STC4EVENT.
BOX_DATA Name: box_data Purpose: return data within user defined box
BPOW This function returns a broken(double) power-law for an input vector.
BPOW_TAPER NAME: bpow_taper PURPOSE: broken power-law function without discontinuities in the derivatives CALLING SEQUENCE: result = bpow_taper(x, a) x - independent variable, nominally energy in keV under SPEX a - parameters defined as
BPRECESS Precess positions from J2000.0 (FK5) to B1950.0 (FK4) Calculates the mean place of a star at B1950.0 on the FK4 system from the mean place at J2000.0 on the FK5 system.
BREAK_DOC this is a check of a two line purpose third purpose line
BREAK_FILE Break a filename into its component parts. Given a file name, break the filename into the parts of disk/logical, the directory, the filename, the extension, and the file version (for VMS)
BREAK_MAP Project : SOHO-CDS Name : BREAK_MAP Purpose : Break map up into small pieces Category : imaging Explanation : Syntax : f=break_map(map,pieces,size=size)
BREAK_PATH() Breaks up a path string into its component directories.
BREM_49 This function calculates the optically thin continuum thermal bremsstrahlung photon flux incident on the Earth from an isothermal plasma on the Sun. Normalization is for an emission measure on the Sun of 1.e49 cm-3
BSCALE Scale images into byte arrays suitable for displaying. Depending on the keywords passed, the routine BYTSCLI, FORM_INT or FORM_VEL is used to scale the image.
BSC_CHECK check that index or data structure is of type BSC
BSC_SPEC_PLOT Plot BCS observed or synthetic spectra
BSC_STRUCT Define the following BSC specific database structures * BSC_Index_Rec * BSC_Roadmap_Rec
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)
BTEST0 ????
BUILD_STR information encoded by wrt_str.pro
BYTE2INT Project : SOHO - CDS Name : BYTE2INT() Purpose : Convert byte(s) to integer(s), nothing else.
BYTESWAP Project : SOHO - CDS Name : BYTESWAP() Purpose : Swaps the bytes in an integer (as a function).
BYTSCLI Project : SOHO - CDS Name : BYTSCLI Purpose : Variation on BYTSCL which allows MAX < MIN. Explanation : BYTSCLI is a variation on the standard IDL BYTSCL routine. It allows for an inverted mapping of input values to output values where the keyword MAX is set less than the keyword MIN.
C2IDATE Cette procedure convertit la date chaine de caracteres, en binaire
CALCFLUX PROCEDURE DE CALCUL DE LA DENSITE DE FLUX DES IMAGES EN FONCTION DU TEMPS PROVENANT DE LA FONCTION LEC1D (IMAGE 1D DU
CALCPOS Cette procedure calcule les coordonnees heliographiques d'un point a partir des coordonnes instrumentales
CALC_VOLGAUSS Calcul du volume gaussien a partir des parametres d'une ellipse et de la valeur
CARR2EX Estimate the time of central meridian passage of a Carrington rotation number
CATEGORY Project : SOHO - CDS Name : CATEGORY Purpose : List procedure/function names and categories.
CCM_UNRED Deredden a flux vector using the CCM 1989 parameterization The reddening curve is that 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).
CDATE Cette fonction remplace le nom du mois sur 3 caracteres, par le numero du mois
CDD Change directory and set IDL prompt to current path name CDD stands for CD with directory name displayed. It is intended to replace CD. It offers several advantages that CD lacks: It makes the the IDL prompt to reflect the current directory path; it does not bomb
CDUP Change directory path to an upper level
CENTER_NRH2 Procedure de calcul et de traitement du FLUX des images contenues dans un fichier NRH2
CENTROIDW Calculate the weighted average of ARRAY
CFIT Project : SOHO - CDS Name : CFIT Purpose : Make a best fit of the sum of components to the supplied data
CFIT_APATCH Project : SOHO - CDS Name : CFIT_APATCH Purpose : Patch CFIT analysis result at specific points
CFIT_APIXLIST Project : SOHO - CDS Name : CFIT_APIXLIST() Purpose : Return masked CFIT analysis pixels given masking program
CFIT_BLOCK Project : SOHO - CDS Name : CFIT_BLOCK Purpose : Apply a component fit to a block of data.
CFIT_BPATCH Project : SOHO - CDS Name : CFIT_BPATCH Purpose : Patch block result at specific points
CFIT_ERRDEMO Project : SOHO - CDS Name : CFIT_ERRDEMO Purpose : Demonstrate analytical vs empirical errors of line fitting.
CHECKFONT This function changes the default widget hardware font to be one of the user's
CHECKVAR to its default values.
CHECK_COMPILE Name: check_compile Purpose: verify whether input module will compile (syntax checker) Input Parameters: module_name - name of idl procedure/function file to check Keyword Parameters: log - contents of output log file
CHECK_CONFLICT Project : SOHO - CDS Name : CHECK_CONFLICT Purpose : To check any conflict of IDL procedure/function names.
CHECK_DUP CHECK_DUP Check for duplicate file names and print list on screen. Written for VMS only. CALLING SEQUENCE: CHECK_DUP [,DIR=DIR, SEARCH=SEARCH, /YOHKOH_SDAC, FILE=FILE] SAMPLE CALL:
CHECK_EXT_TIME Project : SOHO - CDS Name : CHECK_EXT_TIME Purpose : Checks CDS external time values for logical consistency. Explanation : This procedure checks time values in CDS external format to ensure that the date-time values have valid values. If a value is found inaccurate, then these values are repaired
CHECK_FITS Check that keywords in a FITS header array match the associated data 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 appropriate to the dimensions
CHECK_FTP Project : SOHO/CDS Name : CHECK_FTP Purpose : check if ftp server is alive
CHECK_INT_TIME Project : SOHO - CDS Name : CHECK_INT_TIME Purpose : Checks CDS internal time values for logical consistency. Explanation : This procedure checks time values in CDS internal format to ensure that the milliseconds of day is neither negative nor larger than the number of milliseconds in the day in question.
CHECK_LOCK Project : SOHO - CDS Name : CHECK_LOCK Purpose : check if a LOCK file created by APPLY_LOCK has expired
CHECK_LOG Name: check_log Purpose: check idl batch logfile for abnormal termination Calling Sequence: check_log, logfile [user=user] Input Paramters: logfile - idl batch log to check
CHECK_SYNOP -- CHECK_SYNOP Include file for checking existence and write access to SYNOP DB
CHECK_TAPE_DRV Associates tape drive numbers with device files. *Unix only* This is an internal routine to the CDS/SERTS Unix tape handling utilities. It converts tape drive numbers to actual device names, and checks to make sure that the device file is open.
CHECK_TIME check to see that msod is within the range
CHG_CTABLE Change current color table in terms of gamma, bottom and top There are cases where there is a need to change the current color table in terms of gamma, first and last color index to use. This routine does exactly this.
CHILD_POINTER Project : SOHO - CDS Name : CHILD_POINTER() Purpose : to retrieve child of a pointer variable Category : Help Explanation : use appropriate WIDGET or HANDLE info routines Syntax : IDL> child=child_pointer(pointer)
CHKARG Determine calling arguments of procedure or function. Determines the calling arguments of an IDL procedure or function. Used by SCANPATH, but can also be called separately.
CHKLOG Determine actual name of logical or environment variable. This routine determines the actual name of a logical name (VMS) or environment variable (UNIX). In VMS the routine TRNLOG,/FULL is used; otherwise GETENV is used.
CHKTAG Project : SDAC Func Name : CHKTAG Purpose : Check for presence of a particular tag in a structure Explanation : Use : check=chktag(stc,tag) Inputs :
CHK_DIR() Check the validity of a directory name.
CHK_STRUCT_NAME Project : SDAC Name : CHK_STRUCT_NAME Purpose : check if a structure name is unique Explanation : Use : STATUS=CHK_STRUCT_NAME(SNAME) Inputs : SNAME = structure name to check
CHNIVEAUX Computation of contour levels Parameters: Cmax Highest contour to be drawn (input) Cmin Lowest contour to be drawn (opt. if linear scaling) (input) nlevels Number of contours to be drawn (input) Ctype Scaling of contour levels (input)
CH_SCALE scale text in graphics output to that of TEKTRONIX graphics also scale to multiplot environment SCALE TO Y DISTANCE, XSCALING MUST BE DONE IN SETTING UP DISPLAY. XSCALING ALLOWED USING KEYWORD Scaling for plot axes is different than for xyouts because of the scaling factor of 0.5 applied to plot text when any dimension of !p.multi exceeds 2. This factor is not applied to text labels in
CIC This function interpolates an irregularly sampled field to a regular grid using Cloud In Cell (nearest grid point gets weight 1-dngp, point on other side gets weight dngp, where dngp is the distance to the nearest grid point in units of the
CIRCLE_SYM Project : SOHO - CDS Name : CIRCLE_SYM Purpose : Define (part of) a circle as the user plotting symbol.
CIRRANGE To force an angle into the range 0 <= ang < 360.
CIR_MASK() Get indices of a circular mask over a 2D array There are cases where there is a need of getting indices of all pixels of a circular region in a 2D array. This routine does just that.
CLEANPLOT Reset all system variables (!P,!X,!Y,!Z) to their default values Reset all system variables (!P,!X,!Y,!Z) which are set by the user and which affect plotting to their default values.
CLEAN_EXPOSURE Project : SOHO - CDS Name : CLEAN_EXPOSURE Purpose : Clean cosmic rays from single (slit spectrogram) exposure
CLEAN_GIF To fix-up a gif image with a weird color table. Gifs, in general, have color tables in random order. It is helpful to have them sorted out in intensity order. CLEAN_GIF does that. It is designed to be used on memory-resident gif images or as a replacement for READ_GIF (with a slight change of parameter order from READ_GIF).
CLEAN_GOES GOES xray data due to the changes in the analogue filtering used to accommodate the full dynamic range.
CLEAN_GOES2 GOES xray data due to the changes in the analogue filtering used to accommodate the full dynamic range.
CLEAN_JOURNAL This procedure removes some of the output in journal files to make the resultant files more easily modified into procedures.
CLEAN_PATH Project : SOHO-CDS Name : CLEAN_PATH Purpose : clean up SSW path by reorganizing directories Category : utility Explanation : use this to move SUMER and YOHKOH UCON libraries to end of IDL path to avoid potential conflicts.
CLEARPLOT To clear the IDL plotting parameters
CLEAR_SCREEN Writes escape sequence to clear screen and set cursor to top left corner
CLEAR_STRUCT Project : SOHO - CDS Name : CLEAR_STRUCT Purpose : clear all field values in a structure Explanation : initializes field values by setting to 0 or blank strings as appropriate. Use : NEW_STRUCT=CLEAR_STRUCT(STRUCT)
CLEAR_UTPLOT Restores plotting structures !x and !y to their values prior to calls to SET_UTPLOT or UTPLOT..
CLIPBOX Project : SOHO - CDS Name : CLIPBOX Purpose : To draw a box around the outside of the clip box
CLON2EX Calculate times corresponding to input 'Carrington'
CLOSE_ANACUBE Close ANA data cube opened with OPEN_ANACUBE
CLS Clear screen (in Xterm's VT102 mode)
CMP_ALL_PRO Project : SOHO - CDS Name : CMP_ALL_PRO Purpose : Compares all procedure files in one path against another. Explanation : Use : CMP_ALL_PRO, PATH1, PATH2 Inputs : PATH1 = Primary path to use in the comparison. All the
CMP_FILES Project : SOHO - CDS Name : CMP_FILES() Purpose : Checks whether two text files are identical or not. Explanation : This routine reads in two text files and compares them line by line to determine if they are different or not, similar to the Unix routine "cmp".
CMP_LIBS Project : SOHO - CDS Name : CMP_LIBS Purpose : Compares one IDL library against another. Explanation : Compares all procedure files in one path against any matches found in another path. This routine differs from CMP_TREES in that it does not expect the two libraries to be organized in
CMP_TREES Project : SOHO - CDS Name : CMP_TREES Purpose : Compares all procedure files in one path against another. Explanation : Compares all procedure files in one path against the corresponding files in another parallel path. This routine differs from CMP_LIBS in that the two trees are expected to be
CNTRD Compute the centroid coordinates of a stellar object using the algorithm in the DAOPHOT FIND subroutine.
CNVT_COORD() Conversion between any 2 of 4 coord systems for solar images For image displaying, especially for the solar images, there can be at least four coordinate systems involved, and they are:
COEFDATA This procedures reads in coefficients needed to calculate xray xsections from 1-1000 keV. Coefficients are taken from McMaster et al 1968.
COLLEXC Compute effective excitation rate coefficients for a given Temperature in units of cm^3 s-1
COLORSET Select true color (24 bit) if available, or pseudo color (8 bit) visual consistently on X, Windows, and Macintosh.
COLOR_BAR Display a color bar on an image display screen. Unless the optional parameters are set, the user is prompted to enter in where the color bar should be placed.
COMBINE_COLORS Combines two color tables into one. Combines two color tables into the lower and upper parts of a combined color table. To use this color table, scale intensities using FORM_INT. Alternately, use the /COMBINED and /LOWER keywords with EXPTV and PUT, which then call FORM_INT and FORM_VEL automatically.
COMBINE_VEL Combines current color table with a velocity color table. Combines the current color table with the velocity color table as formed by LOAD_VEL.
COMDIM Collapse degenerate dimensions of an array.
COMPARE_STRUCT Compare all matching tag names and return differences Compare all matching Tags names (except for "except_Tags") between two structure arrays (may be different struct.defs.), and return a structured List of fields found different.
COMPILE_SFIT Project : SOHO - CDS Name : COMPILE_SFIT Purpose : Write and compile evaluation function for given SFIT
COMP_BGAUSS Project : SOHO - CDS Name : COMP_BGAUSS Purpose : Evaluate broadened Gaussian for use in CURVEFIT/CFIT/MCURVEFIT
COMP_CIRCLE This procedure compute the polar parameters to plot a circle
COMP_DATE Cette fonction compare 2 chaines de caracteres contenant des dates. Si la date 1 est posterieure a la date 2 elle retourne 1, sinon elle
COMP_FIL_LIST Compare two unix directory listings and produce a list of file names which differ in some way (size, time of creation, ownership, protection).
COMP_FITS_CEN Project : SOHO, YOHKOH Name : COMP_FITS_CEN Purpose : compute XCEN (or YCEN) from FITS standard keywords Category : imaging, FITS Explanation : Syntax : xcen=comp_fits_cen(crpix1,cdelt1,naxis1,crval1)
COMP_FITS_CRPIX Project : SOHO, YOHKOH Name : COMP_FITS_CRPIX Purpose : Compute CRPIX from FOV center Category : imaging, FITS Explanation : Syntax : crpix=comp_fits_crpix(cen,cdelt,naxis,crval)
COMP_GAUSS Project : SOHO - CDS Name : COMP_GAUSS Purpose : Evaluate gaussian component for use in CURVEFIT/CFIT/MCURVEFIT
COMP_POLY Project : SOHO - CDS Name : COMP_POLY Purpose : Evaluate polynomial component for fitting.
COMP_VOIGT Project : SOHO - CDS Name : COMP_VOIGT Purpose : Evaluate Voigt profile for use in CURVEFIT/CFIT/MCURVEFIT
CONCAT2D Project : SOHO - CDS Name : CONCAT2D() Purpose : Concatenate two or more 2-d arrays.
CONCAT3D Project : SOHO - CDS Name : CONCAT3D() Purpose : Concatenate two or more 3-d arrays.
CONCAT4DOS Concatenates IDL procedure files for copying to DOS machine. Concatenates IDL procedure files together into a form suitable for copying to a DOS machine.
CONCAT_DIR To concatenate directory and file names for current OS. The given file name is appended to the given directory name with the format appropriate to the current operating system.
CONCAT_STRUCT Project : SOHO - CDS Name : CONCAT_STRUCT Purpose : concatanate two structures Explanation : concatanates two structures by using COPY_STRUCT to avoid the problem of concatanating two differently named structures.
CONFAC Name: confac Purpose: simplify interface to congrid Input Parameters: image - image to congrid factor - congrid factor Keyword Parameters:
CONFIGURE_HTTP Name: configure_http Purpose: configure an HTTP server within the SSW environment Input Parameters: path_http - pathname for 'top HTTP' (prompted if not supplied) top_http - URL for 'top HTTP' (prompted if not supplied) Keyword_parameters:
CONFLX Calculate continuum flux in (ph s-1 A-1) or (erg s-1 A-1). The resultant flux assumes an emission measure of 1.e50 cm^3.
CONGRDI Interpolates an array into another array. This procedure interpolates an array into another array. It emulates CONGRIDI, except that the image is smoothed from edge to edge. Consequently, the points will not interpolate the same way. CONGRIDI uses the formula:
CONS_DEC Obtain the X and Y coordinates of a line of constant declination Returns a set of Y pixels values, given an image with tangent projection astrometry, and either (1) A set of X pixel values, and a scalar declination value, or (2) A set of declination values, and a scalar X value
CONS_RA Obtain the X and Y coordinates of a line of constant right ascension Return a set of X pixel values given an image with astrometry,
CONTV Places contour plots over displayed images. Places contour plots over images displayed with the EXPTV or similar
CONVERT_2_STREAM This procedure converts fixed-length-record files to stream files.
CONVOLVE Convolution of an image with a Point Spread Function (PSF) The default is to compute the convolution using a product of Fourier transforms (for speed).
CONV_A2H Converts arcmins-from-suncenter coordinates to heliographic
CONV_A2P To convert from a an angle from sun center to a pixel location
CONV_H2A Computes arcsecs-from-suncenter coordinates from heliographic coordinate inputs (inverse of CONV_A2H).
CONV_H2P To convert from a pixel location to heliocentric coordinates
CONV_STSDAS Convert internal format of an STSDAS image to host machine architecture Converts 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 VMS machine, then by default CONV_STSDAS assumes the image originated on VMS. If the host is VMS, then CONV_STSDAS assumes that the image originated on an IEEE machine (e.g. SparcStation).
CONV_UNIX_VAX To convert Unix IDL data types to Vax IDL data types. CONV_UNIX_VAX assumes the Unix IDL data type is IEEE standard in either big-endian or little-endian format.
CONV_VAX_UNIX To convert VAX IDL data types to UNIX (Sun,MIPS,etc.) IDL data types.
COORD_CONV This procedure computes the data, normal, and device coordinates for an input point that is any of the three types, and returns the 3 types in xout and yout in
COPY_STRUCT Copy all fields with matching tag names from one structure to another Fields with matching tag names are copied from one structure array to another structure array of different type. This allows copying of tag values when equating the structures of different types is not allowed, or when not all tags are to be copied. Can also recursively copy from/to structures nested within structures. Note that the number of elements in the output structure array is automatically adjusted to equal the length of input structure array. If this not desired then use pro copy_struct_inx which allows specifying via subscripts which elements are copied where in the arrays.
COPY_STRUCT_INX Copy matching tags & specified indices from one structure to another Copy all fields with matching tag names (except for "except_Tags") from one structure array to another structure array of different type. This allows copying of tag values when equating the structures of different types is not allowed, or when not all tags are to be copied. Can also recursively copy from/to structures nested within structures. This procedure is same as copy_struct with option to specify indices (subscripts) of which array elements to copy from/to.
COPY_TAG_VALUES Project : SOHO - CDS Name : COPY_TAG_VALUES Purpose : Copy tag values of one structure into another structure
COPY_VAR Project : SOHO - CDS Name : COPY_VAR Purpose : to copy data by pointer Category : utility Explanation : Copy data by moving address location. Effectively the same as: new_var=temporary(var)
CORREL_IMAGES Compute the 2-D cross-correlation function of two 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
CORRMAT_ANALYZE Find the optimal (x,y) offset to maximize correlation of 2 images Analyzes the 2-D cross-correlation function of two images and finds the optimal(x,y) pixel offsets. Intended for use with function CORREL_IMAGES.
COUNTDOWN Prints a message showing where you are in a long job. Calling COUNTDOWN,n_steps,/OPEN prints a character string consisting of some spaces, a slash, and the total number of steps. Then each subsequent call prints out the iteration number on the same line in the spaces before the slash. COUNTDOWN,/CLOSE then resets the behavior of the terminal to the default, and linefeeds to a new line.
COVSRT Repack the covariance matrix to the true order of the parameters Given the covariance matrix COVAR of a fit for MFIT of MA total parameters, and their ordering IA(i), repack the covariance matrix to the true order of the parameters. Elements associated with fixed parameters will be zero.
CP_FLUXPOS_NRH2 Cette fonction calcule le flux d'une position a un temps donne
CP_FLUX_NRH2 Cette procedure calcule le flux correspondant a des images
CRANGE This function returns the plot range limits for the X,Y, or Z coordinate. The values of !c.xrange depends on whether plot scale is linear or log. This function returns the ACTUAL values of the range by interrogating !(xyz).type.
CREATE_NRH_CFILE Cette procedure cree un fichier de type CFILE de NRH
CREATE_NRH_PFILE Cette procedure cree un fichier vide de type PFILE (positons) de NRH
CREATE_STRUCT Create an IDL structure from a list of tag names and dimensions Dynamically create an IDL structure variable from list of tag names and data types of arbitrary dimensions. Useful when the type of structure needed is not known until run time.
CREATE_UPDATE_TAR Project : SDAC Name : Create_update_tar Purpose : This procedure creates a tar file suitable for updating a remote file system.
CRE_LABELNRH Cette fonction cree une chaine servant pour la visualisation des donnees du NRH. Le contenu de la chaine retournee depend des indications fournies dans STR_LABEL
CROSSBAR This procedure overplots a crossbar for the procedures point and zoom_coor.
CROSS_CORR Perform a cross correlation match on two images
CROSS_CORR2 Takes two-dimensional cross-correlation of two arrays. The cross-correlations are calculated by shifting the second array by -NCORR to +NCORR pixels relative to the first array. This permutation is performed in both the X and Y directions.
CROSS_HAIR Plot a rectangle or cross hair on the current plotting device. This routine plots a rectangle or a cross hair on the current plotting device. The size and location of the rectangle or cross hair are saved in the common block CROSS_HAIR so that when it is called the next time, the previous rectangle or cross hair can be erased from the device screen.
CRS Simplified CURSOR, with continuous readout option. This procedure uses the routine CURSOR to find the coordinates, expressed in data units, of a point selected with the cursor.
CRUSH_KSAC -------------------------------------------------------------------------- Document name: crush_ksac.pro Created by: Liyun Wang, GSFC/ARC, May 2, 1995 Last Modified: Thu Dec 21 14:28:25 1995 (lwang@achilles.nascom.nasa.gov) --------------------------------------------------------------------------- Version 1, May 2, 1995, Liyun Wang, GSFC/ARC, written
CR_REJECT General, iterative cosmic ray rejection using two or more input images. Similar to the STSDAS task crrej. Uses a noise model input by the user, rather than determining noise empirically from the images themselves.
CSCALE Project : SOHO - CDS Name : CSCALE Purpose : my own color scale routine
CSPLINE Function to evaluate a natural cubic spline at specified data points Combines the Numerical Recipes functions SPL_INIT and SPL_INTERP
CT2LST To convert from Local Civil Time to Local Mean Sidereal Time.
CT2RGB Name: ct2rgb Purpose: return RGB for give IDL color table Input Parameters: table - RSI color table number (see loadct.pro) Output Parameters: r,g,b
CTRL_NRHFILE Cette fonction identifie le contenu d'un fichier: type de donnees, reseau etc....
CUBE_EDIT Name: cube_edit Purpose: edit 3D cube (mouse -OR- command line) w/optional rebin Input Parameters: incube - data cube to edit Output Parameters: outcube - optional output - the 'edited'/reduced cube
CUM_SUM the first index of an array.
CURDIR Name: curdir Purpose: return current directory History: slf, circa 1-Dec-1992 slf, 9-mar-1993 ; use cd, not spawn slf, 23-jan-1996 ; problem with UNIX 4.01 (which OS??)
CURFULL Like intrinsic CURSOR procedure but with a full-screen cursor 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
CURSOR_INFO Report cursor's position to a text widget. In image_tool, cursor's position is displayed in variety of ways depending on the display mode being set. When using the zoom feature, such position is also needed. Note: Each time when this routine is called, coordinates of a reference point in all three coordinate systems (device, data, and solar) have to be given. Since this routine has to tell if the cursor is within the plotting area, the reference point should therefore always be the lower left corner
CURVAL Display values associated with the cursor as it is moved over an image. CURVAL displays different information depending whether the user supplied an image array, and/or a FITS header array
CWF_COMPONENT Project : SOHO - CDS Name : CWF_COMPONENT Purpose : Compound widget showing one fit component
CWF_FIT Project : SOHO - CDS Name : CWF_FIT Purpose : Comp. widget for showing/editing Component Fit structures
CWF_STATUS Project : SOHO - CDS Name : CWF_STATUS Purpose : Comp. widget showing a CFIT structure's CONST/INCLUDE status.
CW_ALOGSLIDER The standard slider provided by the WIDGET_SLIDER() function is integer only. This compound widget provides a logarithmic floating point
CW_BSELECTOR CW_BSELECTOR is a compound widget that appears as a pull-down menu whose label shows the widget's current value. When the button is pressed, the menu appears and the newly selected value becomes the new title of the pull-down menu.
CW_CHECKBOX Project : SOHO - CDS Name : CW_CHECKBOX() Purpose : "Checkbox" or "cross-box" widget (status on/off).
CW_CUBEVIEW Project : SOHO - CDS Name : CW_CUBEVEIW Purpose : Compound widget for visualizing data n-cubes (0 < n < 8)
CW_DROPLIST() Create a compound widget to simulate a droplist widget
CW_ENTERB Project : SOHO - CDS Name : CW_ENTERB Purpose : A button with user editable content
CW_FILE_NAME Cette fonction demande un nom et controle le fichier correspondant
CW_FLIPSWITCH Project : SOHO - CDS Name : CW_FLIPSWITCH Purpose : Implements a pusbutton status switch (e.g., On/Off)
CW_GRID ******************************************************* UNCTION CW_GRID_GET_VALUE,id,value
CW_HEADER Cette procedure visualise le contenu du HEADER d'un fichier FITS
CW_INFILTRATE Project : SOHO - CDS Name : CW_INFILTRATE Purpose : Infiltrate a widget hierarchy to tap into its events.
CW_INFONRH Cette procedure affiche les caracteristiques principales du
CW_LABELNRH Tell what your routine does here. I like to start with the words: "This function (or procedure) ..." Try to use the active, present tense.
CW_LOADCT Project : SOHO - CDS Name : CW_LOADCT() Purpose : Color table picker w. gamma/top/bottom control.
CW_MOUSE Project : SOHO - CDS Name : CW_MOUSE() Purpose : Controlling the "Mouse button action" selection & display
CW_NRH_FILTER Ce compound widget definit un filter pour les fichiers FITS du NRH
CW_OPTPOS widget permettant de configurer les parametres du scan des images et du tri des sources en position
CW_PICKFILE_NRH Compound WIDGET for file selection Use DIALOG_PICKFILE to select a file, and shows the name of the
CW_PLOTSERIE Cette fonction gere les parametres de trace en fonction du temps des resultats de reduction de donnees du NRH
CW_PLOTZ[1] Project : SOHO - CDS Name : CW_PLOTZ() Purpose : One-window compound widget plot zoom
CW_PLOTZ[2] KEYWORD DEFAULTS/EXPLANATIONS All keywords not marked with * may be altered after widget creation through the WIDGET_CONTROL,CW_ID,SET_VALUE={:} mechanism. Widgety things
CW_POS Widget principale pour le recherche de positions dans un fichier d'images
CW_PSELECT Project : SOHO - CDS Name : CW_PSELECT Purpose : Simplified management of a pulldown selection menu
CW_PZOOM[1] Project : SOHO - CDS Name : CW_PZOOM() Purpose : One-window compound widget image zoom.
CW_PZOOM[2] KEYWORD DEFAULTS/EXPLANATIONS All keywords not marked with * may be altered after widget creation through the WIDGET_CONTROL,CW_ID,SET_VALUE={:} mechanism. Widgety things
CW_RD_STRING Cette fonction saisit une chaine de caracteres
CW_REGION Compound WIDGET pour la selection d'une region d'une image
CW_SCANSOURCE Widget permettant de faire un scan manuel d'une serie d'images
CW_SELFIELD COUMPOUND WIDGET de selection d'une region
CW_SWITCH Compound WIDGET for switch betewen different choices
CW_TEXT Project : SOHO - CDS Name : CW_TEXT Purpose : compound text widget that switches itself to a label when non-editable
CW_TMOUSE Project : SOHO - CDS Name : CW_TMOUSE() Purpose : Convert a draw-event into an action string.
CW_TVZOOM Compound widget for displaying zoomed images. (cf CW_ZOOM). This compound widget displays an original image in one window and another window in which a portion of the original window is displayed. The user may select the center of the zoom region, the zoom scale, the interpolation style, and the method of indicating the zoom center.
CW_XTD_NRHF Cette fonction permet de choisir l'extension dans un fichier de flux ou de position de centres actifs
CX_CANAUX ******************************************************* UNCTION CX_CANAUX_GET_VALUE,id,value
CX_HEURES ******************************************************* UNCTION CX_HEURES_GET_VALUE,id,value
DAOERF Calulates the intensity, and derivatives, of a 2-d Gaussian PSF Corrects for the finite size of a pixel by integrating the Gaussian over the size of the pixel. Used in the IDL-DAOPHOT sequence.
DAO_VALUE Returns the value of a DAOPHOT point-spread function at a set of points. 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
DARKLIMB_CORRECT or wavelength range and use to remove limb darkening effects from input image.
DARKLIMB_R Returns the constants, u or v, for a given central wavelength and wavelength range (bandpass) for input into the limb darkening function (see LIMBDARK_COR and LIMBDARK_PLOT)
DARKLIMB_U Returns the constant, u, for a given wavelength for input into the limb darkening function (see LIMBDARK_COR and LIMBDARK_PLOT)
DARKLIMB_V Returns the constant, v, for a given wavelength for input into the limb darkening function (see LIMBDARK_COR and LIMBDARK_PLOT)
DAT2GIF Project : SOHO-CDS Name : DAT2GIF Purpose : Write 2-d data to GIF file Category : imaging Explanation : Syntax : IDL> dat2gif,data,file
DATA2FILES Name: data2files Purpose: convert data (2D or 3D) -> file or file sequence Input Parameters: data - 2D or 3D data r,g,b - optional color table Keyword Parameters:
DATATYPE() Returns the data type of a variable. This routine returns the data type of a variable in a format specified by the optional flag parameter.
DATA_CHK (uses IDL size function results)
DATA_COMPRESS Compress and decompress data using UNIX compress or gzip by writing a temporary file.
DATA_PATHS environmentals named yd* where * is an integer (e.g. yd1)
DATA_QUALITY Name: data_quality Purpose: determine empirical data quality Input Parameters: images - 2D image or 3D image cube Output Parameters: function returns %GOOD OR Boolean (true=good)
DATA_SUM2FITS Name: data_sum2fits Purpose: add data summary fields to fits header (data not effected) Input Parameters: fitsfiles - list of FITS files to read & optionally update Keyword Parameters: satthresh - top cutoff level (ex: saturated pix level) - default=4090
DATA_TYPE NAME: data_type PURPOSE: Return the data type code from SIZE CALLING SEQUENCE: type=data_type(data) HISTORY: Drafted by A.McAllister, 8-jul-93.
DATE Convert day-of-year to a DD-MMM-YYYY string
DATE2DOY Convert yymmdd into DOY (day of the year). Input can be either string or integer. The year is an Optional return parameter.
DATE2MJD Project : SOHO - CDS Name : DATE2MJD() Purpose : Convert calendar dates to Modified Julian Days. Explanation : This procedure calculates the Modified Julian Day number from the year, month and day, or from the year, day-of-year. Use : Result = DATE2MJD(YEAR, MONTH, DAY)
DATE_CODE() Convert any date/time value into YYYYMMDD format.
DATE_CONV Procedure to perform conversion of dates to one of three possible formats. The following date formats are allowed
DATPLOT This procedure is used to OVERplot histograms between channel edges.
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
DBCIRCLE Find sources in a database within specified radius of specified center Database must include items named 'RA' and 'DEC' and must have previously been opened with DBOPEN
DBCLOSE procedure to close a data base file
DBCOMPARE Display two entries in an IDL database side by side in a column format
DBCOMPRESS Compress a .dbf database file after a call to DBDELETE The procedure DBDELETE will remove specified entries from a database but it will not free the unused space. DBCOMPRESS will compress the .dbf file so that it only contains valid entries.
DBCREATE Create a new data base (.dbf), index (.dbx) or description (.dbh) file A database definition (.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 Subroutine of DBEDIT_BASIC to edit a database on a dumb terminal. 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 Extract values of up to 12 items from an IDL database Procedure to extract values of up to 12 items from data base file, and place into IDL variables
DBEXT_DBF Subroutine of DBEXT to extract values of up to 15 items from a database 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() Search data base for entries with specified characteristics Function to search data base for entries with specified search characteristics.
DBFIND_ENTRY Subroutine of DBFIND to perform an entry number search This is a subroutine of dbfind and is not a standalone procedure It performs a entry number search.
DBFIND_SORT Subroutine of DBFIND to perform a search using sorted values 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 numbers which contain specified values of a given item. DBGET() is useful as an alternative to DBFIND() when the desired search values are not easily expressed as a string.
DBHELP List available databases or items in the currently open database 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 Subroutine of DBINDEX to create associated variable of correct datatype DBINDEX_BLK will offset into the file by a specified amount in preparation for writing to the file.
DBL2ARRAY Convert a 64 bit flag word to a byte array of 1's and 0's.
DBMATCH Find the entry number in a database for each element 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 an IDL database
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.
DBREPAIR Project : SOHO - CDS Name : DBREPAIR Purpose : Repairs problem with IEEE format databases. Category : Utilities, database Explanation : Version 1 of DB_ENT2EXT contained a bug where only the first element in an array was converted from IEEE to host format.
DBSEARCH Subroutine of DBFIND() to search a vector for specified values
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.
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 Quickly return a value of the specified item number Procedure to quickly return a value of the specified item number from the entry.
DB_CHECK Project : HESSI Name : DB_CHECK Purpose : check input search string for syntax errors
DB_ENT2EXT Convert a database entry to external (IEEE) data format Converts a database entry to external (IEEE) data format prior to writing it. Called from DBWRT.
DB_ENT2HOST Converts a database entry from external data format to host format. All items are extracted from the entry, and then converted to host format, and placed back into the entry. Called from DBRD and DBEXT_DBF.
DB_INFO Function to obtain information on opened data base file(s)
DB_ITEM Returns the item numbers and other info. for an item name. 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
DCD_FICPOINT Cette fonction decode le contenu d'une ligne correspondant a un point
DD Display directory stack used by PD and PPD
DEC2BIN Project : SOHO - CDS Name : DEC2BIN Purpose : Convert integer decimal number to binary representation.
DEC2HEX Project : SOHO - CDS Name : DEC2HEX Purpose : Convert a non-negative decimal integer to a hex string.
DEC2SUN Converts data written on a DEC machine to SUN format by swapping bytes appropriately for the type of the input data. The data on the DEC machine is assumed to be IEEE format with the byte order reversed: this is *not* VAX format! The routine converts between data from a DECStation and a Sun. Since both use IEEE format, dec2sun will also convert from sun format to DEC format.
DECOMP1D PROCEDURE DE DECOMPOSITION D'UN PROFIL RH UNIDIMENSIONNEL EN SOURCES ELEMENTAIRES (INTENSITE OU POLARISATION).
DEFAULT Project : SOHO - CDS Name : DEFAULT Purpose : Supply default values for variables
DEFAULTS Supply default volume, directory, and extension parts of a file name when not supplied.
DEFAULTS_2 Supply default volume, directory, and extension parts of a file name when not supplied.
DEFROI using the image display system and the cursor/mouse. CATEGORY: Image processing.
DEF_DIRLIST Define directory list using setenv or setlog Environment variables which point to a list of directories can end up to be very long. In VMS this can be a problem, because logical names cannot be longer than 256 characters. However, it is possible to get around this in VMS by assigning multiple values to a single logical name--a facility that does not exist in Unix.
DEF_FONT Name: def_font Purpose: return system dependent default fonts using system variable Keyword Parameters: init - switch, if set, return machine dependent defaults button,label,slider,text, - widget type specific values default - default (for all types)
DEF_MAP Project : SOHO-CDS Name : DEF_MAP Purpose : Define a basic 2x2 element image map Category : imaging Explanation : Syntax : def_map,map
DEF_SYNOP Project : HESSI Name : DEF_SYNOP Purpose : define structure for synoptic DB record Category : HESSI Synoptic analysis Explanation : Syntax : IDL> def_synop,synop
DEF_YSSYSV values are assigned elsewhere
DELETE_ANALYSIS Project : SOHO - CDS Name : DELETE_ANALYSIS Purpose : Delete a CFIT ANALYSIS structure, freeing the handles.
DELETE_FILE Project : SOHO - CDS Name : DELETE_FILE() Purpose : Delete a named file.
DELFPOS Detruit les fichiers utilises par le module de recherche de positions
DELVARX Delete variables for memory management (can call from routines) Like intrinsic DELVAR function, but can be used from any calling level
DEL_SYNOP Project : HESSI Name : DEL_SYNOP,CAT_NUM Purpose : Delete a record from synoptic database Explanation : Syntax : DEL_SYNOP, DEF, STATUS Inputs : CAT_NUM = catalog number to delete
DEREDD Deredden then Stromgren parameters given for a value of E(b-y) See the procedure UVBYBETA for more info.
DERIV_ARR Procedure to return the rate of change of the
DERIV_LUD NUMERICAL DIFFERENTIATION: This subroutine calculates the derivative of a tabulated function by converting an integral representation of the derivative to a matrix equation and solving this by the method of regularization (see Craig and Brown, Inverse Problems in Astronomy). ***************************************************************************
DESPIKE_GEN Remove (cosmic ray) spikes from an image.
DETABIFY Replaces tabs in character strings with 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
DETREND Removes linear or higher order polynomial trends from 1-D data
DET_ELLIP Cette routine permet de connaitre les ellipses que l'on peut determiner avec 3 distances consecutives du tableau d d: tableau des distances calcul�es par trv_dist gra: tableau des 8 petits axes grb: tableau des 8 grands axes tet: tableau des angles d'inclinaisons des ellipses
DET_XSEC return the detector cross-section in 1/cm at energy=e in keV;
DEVICELIB Definitions needed for the SERTS graphics device library. Defines variables and common blocks needed for the SERTS graphics device library. Adds system variables !BCOLOR and !ASPECT.
DHELP Diagnostic HELP (activated only when DEBUG reaches DLEVEL) This routine acts similarly to the HELP command, except that it is activated only when the environment variable DEBUG is set to be equal to or greater than the debugging level set by DLEVEL (default to 1). It is useful for debugging.
DIFFERENCE_MOVIE Name: difference_movie Purpose: difference a data cube and provide some statistics Input Parameters: index - structure vector of input data - associated 3D cube Output Parameters:
DIFF_MAP Project : SOHO-CDS Name : DIFF_MAP Purpose : Difference two maps Category : imaging Explanation : Syntax : diff=diff_map(map1,map2)
DIFF_ROT() Computes the differential rotation of the sun
DIMREBIN Project : SOHO - CDS Name : DIMREBIN Purpose : As REBIN, but dimensions supplied as an array
DIMREFORM Project : SOHO - CDS Name : DIMREFORM Purpose : As reform, but dimensions supplied as an array
DIR_EXIST Name: dir_exist Purpose: check if elements of input list are existing directories Input Parameters: dirlist - string/string array of directories to check Output: function returns boolean (0 - not directory, 1-directory)
DIR_SINCE Name: dir_since Purpose: directory listing for spcified age files Input Parameters: indir - directory(ies) or files to search infage - file age to consider (days) If positive, OLDER than this number of days
DISKFREE To return the number of free bytes available on the disk in megabytes. Also returns total and used bytes and file system and mount names.
DISK_HOG Name: disk_hog Purpose: show disk usage, order by size Input Parameters: path - if set, path for summary search (default is local user area) Calling Sequence: disk_hog [,path] [/hc]
DISMOUNT Emulates the VMS DISMOUNT function in Unix. Emulates the VMS DISMOUNT function in the Unix environment. Although this is not a standard IDL function, it is available as a separate LINKIMAGE routine for VMS.
DISPLAY_OK() Detect if device display has been set properly
DIST_CIRCLE Form a square array where each value is its distance to a given center. Returns a square array in which the value of each element is its distance to a specified center. Useful for circular aperture photometry.
DIST_ELLIPSE Create a mask array useful for elliptical aperture photemetry Form an 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.
DMY2YMD() To convert date string DD-MM-YY format to YY/MM/DD format.
DOC_HEAD Name: doc_head Purpose: return idl documentation header from source file Input Paramters: source - file name containing idl source code and header Output Paramters: header - all text between ;+ and ;-
DOC_LIBRARY2 To find a routine and to display the full contents of the file. Search in the order of !path. If a wildcard * is used, then all matches in !path are found.
DOC_LIB_UNIX Extract the documentation template of one or more procedures.
DOC_LIB_VMS Extract the documentation template of one or more procedures.
DOC_MENU Extract documentation template of one or more procedures. If NAME is not passed, then this procedure will first display a list of the directories in !PATH, and ask for the user to select one. Then a list of procedures in the selected directory are displayed, and the user is again asked to select one of them. Finally, the routine DOC_LIB_xxx, where xxx represents the operating system, is called to display the documentation in the file between the lines containing the characters ";+" and ";-".
DOC_SUMM Extract portions of documentation headers and present in some standardized format
DONT_USE_THIS To print a message to the screen asking that the routine not be used and optionally lists the name of the routine that should be
DOY2DATE convert DOY and year to month and day.
DOY2UTC Project : SOHO - CDS Name : DOY2UTC() Purpose : Converts day of year to internal CDS time format.
DOYTIM2EX Convert a string with day-of-year and time into external format. For example, the string "316 21:45" will be converted to [21,45,0,0,12,11,year]
DO_DEMO Name: do_demo Purpose: run an idl demo program (format can be IDL main routine) Input Parameters: demofile - name of file to demo (execute) - if none, menu select from files in $DIR_GEN_DOC with names: XXXdemo.pro Keyword Parameters:
DO_EIT_MAP Project : SOHO-CDS Name : DO_EIT_MAP Purpose : make EIT maps Category : planning Explanation : wrapper around mk_eit_map that works within SSW and CDS-SOFT Syntax : emap=do_eit_map(data,header,index=index)
DO_EIT_SCALING Project : SOHO-CDS Name : DO_EIT_SCALING Purpose : scale EIT images (degrid, take log, etc) Category : planning Explanation : Syntax : data=do_eit_scaling(data,header,index=index)
DO_FITSFILES Create FITS format files for all days between firstday and lastday for GOES 6, GOES 7, GOES 8, GOES 9, and GOES 10.
DO_REG_BACKUP To make a regular backup of a directory tree
DPRINT Diagnostic PRINT (activated only when DEBUG reaches DLEVEL) This routine acts similarly to the PRINT command, except that it is activated only when the environment variable DEBUG is set to be equal to or greater than the debugging level set by DLEVEL (default to 1). It is useful for debugging.
DRAWBOX Project : SOHO-CDS Name : DRAWBOX Purpose : Draw a rubber-band box (or circle) Category : imaging Explanation : This function draws a rubberband box (or circle) in the window specified by the positional parameter
DRAW_BOXCENSIZ To draw a box on the screen in either data or device coordinates by specifying the center and the size of the box
DRAW_BOXCORN To draw a box on the screen in either data or device coordinates
DRAW_CIRCLE Draw a circle. Calling Sequence: draw_circle, x0, y0, radius [, npts=npts] Input Parameters: x0 = Central x coordinate y0 = Central y coordinate radius = Radius
DRAW_GRID Draw a Stonyhurst grid (Also can draw Carrington grid).
DREXC Compute effective excitation rate due to dielectronic recombination. as a function of electron temperature in units of cm^3 s-1
DROT_COORD DROT_COORD Differentially rotate coordinates of a solar raster map Category: Maps Calling sequence: new_coord=DROT_COORD(map,t_ref)
DROT_MAP Project : SOHO-CDS Name : DROT_MAP Purpose : differentially rotate image contained within structure created by MAKE_MAP Category : imaging Explanation : Syntax : rmap=drot_map(map,duration)
DROT_MAP_FAST Project : SOHO-CDS Name : DROT_MAP_FAST Purpose : fast version of DROT_MAP Category : imaging Explanation : Just rotates central coordinates of map Syntax : rmap=drot_map(map,duration,time=time)
DROT_NAR Project : SOHO - CDS Name : DROT_NAR Purpose : Solar rotate NOAA AR pointings to given time Category : planning Explanation : Syntax : IDL> rnar=drot_nar(nar,time,count=count)
DROT_RASTER DROT_RASTER Differentially rotate solar raster maps Category: Maps Calling sequence: map_drot=DROT_RASTER(map [ , t_ref ] [ , REF_MAP=map_ref ]
DROT_XY Project : SOHO-CDS Name : DROT_XY Purpose : wrapper around ROT_XY to correct for roll in map Category : imaging Explanation : for rolled images, coordinates have to be corrected before applying solar rotation correction
DR_CARR If ARG is a time interval (in decimal days) this routine calculates the Carrington differential rotation for the latitude specified by LAT (in degrees, default is 0).
DR_PHOTO If ARG is a time interval (in decimal days) this routine calculates photosheric differential rotation for the latitude specified by LAT (in degrees, default is 0).
DSPLINE (DELUXE SPLINE) Perform cubic spline interpolation or linear interpolation
DSP_STRARR To display a string array in a text widget.
DSP_STRUCT Project : SOHO - CDS Name : DSP_STRUCT Purpose : Display contents of a structure as a pulldown menu.
DUMMY Name: dummy Purpose: force otherwise empty directory to be included in IDL path
DUMMYPLOTS This procedure is called by utplot to set up plot system variables without actually drawing a plot. Used to find out what the exact x limits (x.crange) of the plot will be.
DVOIGT_FIT Project: YOHKOH-BCS Name: DVOIGT_FIT Purpose: Double voigt function fit to line profile Syntax: v=dvoigt_fit(x,y,a,sigmaa,damp=damp) Category: Fitting y = data to fit
ECH_RS Cette procedure genere une echelle en RAYONS SOLAIRES a partir des coordonnees de debut et de fin (en rayons solaires)
ECRDESCD ecriture du descripteur HELIO ecrit le descripteur fixe de 64 points (*4) puis le descripteur caractere de longueur variable Les enregistrements sont de longueur fixe determinee par la taille des images ecrites apres le descripteur.
ECRPOS ecrit au format HELIO un fichier de type F(TIME) - un fichier de positions associees 1D ou - un fichier de positions associees 2D ou - un fichier de flux
EDGE_PRODUCTS commonly used quantities for plotting and scaling.
EIT__DEFINE Project : HESSI Name : EIT__DEFINE Purpose : Define an EIT map object Category : imaging maps Explanation : The map object is actually a structure with a pointer field. The map structure is stored in this pointer.
ELLIPSE Return function value and its derivatives of an ellipse
EMENU same as WMENU but can handle almost infinite size lists
ENABLEFLAG Reenable a previously set but disabled image display flag. Reenables one of the previously set flag fields in the !IMAGE structure. Only use this routine if the value has already been set by SETFLAG, but the value was disabled with UNSETFLAG.
EPLOT Error bars are drawn for each element. If input errors are 1-d, then they are concatanated to 2-d
EQPOLE Convert RA and Dec to X,Y using an equal-area polar projection. The output X and Y coordinates are scaled to be between -90 and +90 to go from equator to pole to equator. Output map points can be centered on the north pole or south pole.
EQPOLE_GRID Produce an overlay of latitude and longitude lines over a plot or image Grid is written on the current graphics device using the equal area polar projection. EQPOLE_GRID assumes that the output plot coordinates span the x and y ranges of -90 to 90 for a region that covers the equator to the chosen pole. The grid is assumed to go from the equator to the chosen pole.
ERROR_BARS Procedure by Eric Carzon, Hughes/STX Added to Kim Tolbert's GOES Widget Program Calculates error bars on GOES data. 2/93, Goddard Solar DAC set variables for ebars and ebar values
ERRPLOT Overplot error bars over a previously drawn plot.
ESPAWN Project : SOHO - CDS Name : ESPAWN Purpose : spawn a UNIX shell command and return STDIO and STDERR Category : OS Explanation : regular IDL spawn command doesn't return an error message Syntax : IDL> espawn,cmd,out
EULER Transform between Galactic, celestial, and ecliptic coordinates. Use the procedure ASTRO to use this routine interactively
EUTPLOT Plot error bars on previously (using UTPLOT) drawn plot with universal time labelled X axis. If start and end times have been set, only data between those times is displayed.
EVAL_CFIT Project : SOHO - CDS Name : EVAL_CFIT Purpose : Evaluates a component fit at given points.
EVAL_SFIT Project : SOHO - CDS Name : EVAL_SFIT Purpose : Evaluate "short" fit structure at given points.
EVENTS_BY_TIME Project : SDAC Name : EVENTS_BY_TIME Purpose : This procedure finds events for different instruments over input time intervals.
EVENT_MOVIE Name: event_movie Purpose: form a 3D plot movie from UT events (via evt_grid) Input Parameters: times - event times (any SSW format, index structures, etc.) Output Parameters: outimg - movie cube of plots with events overlayed
EVENT_MOVIE_DEFAULTS Name: event_movie_defaults Purpose: set some color "defaults" for event_movie.pro Input Parameters: event_type: - type of desired event/defaults (defaults=goes w/yohkoh fem) Output Parameters: NONE:
EVT_GRID To annotate previously drawn utplot output with event times
EX2DOW To convert from the standard 7 element time array (HH,MM,SS,MSEC,DD,MM,YY) to a day of week number for that date. (0=sunday, 1=monday,6=saturday).
EX2FID Given a 7-element time array, generate the fileID (YYMMDD.HHMM) for that time.
EX2INT Convert conventional date and time into days since 1979 and milliseconds of day. Calling Sequence: Ex2Int, time, msod, ds79
EX2WEEK To convert from any standard times to a week number.
EXEC_STRUCT Project : SOHO - CDS Name : EXEC_STRUCT Category : structures, utility Purpose : Execute CREATE_STRUCT to dynamically create new structure Explanation : Syntax : IDL> new_struct=exec_struct(pairs,struct=struct)
EXIST Project : SDAC Name : EXIST Purpose : To See if variable Exists Explanation : So obvious, that explaining it will take more lines than the code. Use : A=EXIST(VAR)
EXPAND_TILDE Project : SOHO - CDS Name : EXPAND_TILDE Purpose : expand tilde in UNIX directory names
EXPAND_TV Expands and displays an image. This procedure expands an image to the dimensions MX, MY and displays it at position IX, IY on the image display screen. Called from EXPTV and other routines.
EXPTV Uses SCALE_TV and EXPAND_TV to display an image. SCALE_TV is called to scale the image, and EXPAND_TV is called to display the image. As much of the image display screen as possible is
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.
EXTEND_MATRIX() Extand dimension of a given matrix by attaching a submatrix There may be cases where one wants to extend a (MxN) matrix to [(M+K)xN], [(K+M)xN], [Mx(N+K)], or [Mx(K+N)], where K is an integer number. This routine does exactly this.
EXTGRP Extract the group parameter information out of SXREAD output This procedure extracts the group parameter information out of a header and parameter variable obtained from SXREAD. This allows astrometry, photometry and other parameters to be easily SXPARed by conventional methods and allows the image and header to be saved in a SIMPLE format.
EXTRACT_ARR Extracts sub-array from array usings center, array bounds protect
EXTRACT_FID Name: extract_fid Purpose: extract embedded FIDS from file names, return fids and times NOTE: ** broke out and optimized logic into EXTRACT_FIDS.PRO ** Input Paramters: filenames - string array of filenames with embedded FID
EXTRACT_FIDS Name: extract_fids Purpose: find & extract embedded FIDS in file names Input Parameters: filenames - string array of filenames with embedded FIDs fmt=[...xxxYYMMDD.HHMM[SS]... ...xxxYYMMDD_HHMM[SS]...] Output Paramters:
EXTRACT_SOURCES Cette procedure recherche et extrait d'une image 2D, une ou plusieurs sources (volume gaussien)
EXT_RANGE Project : SOHO - CDS Name : EXT_RANGE() Purpose : Calculate extended range for plotting variables.
EZFIT Project : SOHO - CDS Name : EZFIT Purpose : Easy Gauss fit to data.
FACTOR Find prime factors of a given number.
FAKE_POINT_STC() Create a fake pointing structure for IMAGE_TOOL to use
FASTFIT Project : SOHO - CDS Name : FASTFIT Purpose : Least-squares fit of linear function without error analysis Explanation : Fits a linear function to a series of data points via a least-squares technique. This routine differs from FITTER in that no error analysis is
FBLUE Project : YOHKOH-BCS Name : FBLUE Purpose : Compute 2 component gaussian where one is blueshifted Explanation : Gaussian is sum of 2 gaussians in which width of blueshifted component is proportional to blueshift velocity.
FBLUE_FIT Project : YOHKOH-BCS Name : FBLUE_FIT Purpose : Fit double gaussian + quadratic using a blueshift model Explanation: Category : fitting Syntax : yfit = fblue_fit(x,y,a,fac=fac)
FCHECK to its default values.
FCOLOR This function is used with LINECOLORS.PRO for defaults if the device does not support colors.
FDECOMP Routine to decompose a file name for any operating system
FID2EX Given a fileID, generate the 7-element time array
FID2TIME Project : SOHO - SUMER Name : FID2TIME Purpose : Infer file time from file ID name with "_yymmdd_hhmmss" Category : I/O Explanation : Same as EXTRACT_FID, but sets missing elements to 0 Syntax : IDL> times=fid2time(files)
FILE2FID Project : SOHO-CDS Name : FILE2FID Purpose : move files from a directory into another based on file date/time Category : planning Explanation : looks at files encoded with "_yyyymmdd_hhmm"
FILE2TIME Name: file2time Purpose: convert filenames (...[YY]YYMMDD?HHMM[SS]...) -> time Input Parameters: filearray - string array assumed to contain ....[YY]YYMMDD?HHMM[SS]... Keyword Parameters:
FILEEXT Returns the extension of the file named filename. The function searches for the three characters following the last dot in the name filename.
FILES_NEWER Name: files_since Purpose: return files in newer than file Input Parameters: directory - directory to start search (recursive if tree) reference - reference file (ex: a dbase file) OR integer number of days old
FILES_SEARCH Search all files in a set of Unix sub-directories for an input string
FILETIMES Name: filetimes Purpose: return start and stop times in Yohkoh reformatted files Input Parameters: files - array of reformatted file names Ouput Paramters: startt - start time of file in external format (7,n)
FILE_ACC This routine is intended to supplement the IDL findfile function. For a given unix path name, e.g '/disk2/bowen/adas/file', this routine returns certain information. 1. Whether the path exists. 2. Whether the user has read permission. 3. Whether the user has write permission. 4. Whether the user has execute permission. 5. What the file type is i.e file, directory etc. The routine works by spawning various UNIX commands and interpreting the information returned. A directory listing
FILE_APPEND Name: file_append Purpose: append text to text file - optionally, only append uniq text Input Parameters: file - file name - if no such file exists, open new file text - text to append - string or string array Keyword Parameters:
FILE_COMPRESS Name: file_compress Purpose: provide IDL interface to gzip and Unix compress utility Input Paramters: inname - file name or vector of file names to compress Output Parameters: outname - compressed file names (same dimension as inname)
FILE_DELETE Name: file_delete Purpose: system/shell independent file delete Input Parameters: files - scaler string or vector string array of filenames to delete Output Paramters: status - sucess 1 -> deleted or not there to begin with
FILE_DIFF Name: file_diff Purpose: check for ascii file difference (boolean) Input Parameters: f1, f2 - ascii file names Calling Sequence: truth=file_diff(file1, file2 [/idlpro] )
FILE_EXIST false(0) if no files found
FILE_INFO file_info To return information about the file that is not included in the FSTAT return CALLING SEQUENCE: nfil = file_info(infil, finfo) infil - The input file to find the information for. It
FILE_INFO2 file_info2 To return information about the file from "ls -l" output CALLING SEQUENCE: nfil = file_info2(infil, finfo) nfil = file_info2(dummy, finfo, ls=ls) infil - The input file to find the information for. It
FILE_LIST Given a set of directories (and optionally a partial filename with a wildcard), generage a list of file names/directories
FILE_MENU Given a set of directories (and optionally a partial filename with a wildcard), display a menu to allow the user to select the file he wants.
FILE_OR_STRING Project : SOHO - CDS Name : FILE_OR_STRING Purpose : check if a valid filename or string datatype is being input Category : utility Explanation : useful when ASCII input to a program can come from an file or a string variable
FILE_PATH Name: file_path Purpose: find file in tree (recursive version of RSI filepath.pro) Input Parameters: file - file name to find topdir - top directory for tree search (default is $IDL_DIR) Calling Sequence:
FILE_PURGE Purge files that have similar file names. Purge is based on file name (alphabetical listing) or by reverse creation date.
FILE_PURGE_SIZES Name: file_purge_sizes Purpose: purge files > -OR- < some file size threshold Input Parameters: files - the file list to consider (may alternately use PATH and PATTERN) Keyword Parameters: PATH - path to 'look' in
FILE_SIZE Name: file_size Purpose: return file sizes - optionally as string with units Keyword Parameters: string - if set, output is string auto - if set, auto-scale (ex: Kb, Mb, ....) total - if set, total all file sizes before string/auto applied
FILE_STAT Project : SOHO - SSW Name : FILE_STAT() Purpose : Vector version of FSTAT Category : Utility, Operating_system Explanation : Vector version of FSTAT Syntax : Result = FILE_STAT( FILES )
FILE_UNCOMPRESS Name: file_uncompress Purpose: provide IDL interface to standard unix uncompress & gzip utility Input Paramaters: inname - file name or vector of file names to gunzip or uncompress Output Parameters: outname - uncompressed file names (same dimension as inname)
FILL_BOX Project : SOHO - CDS Name : FILL_BOX Purpose : To fill a plot box with one of a selection of patterns.
FILL_CATEGORY Project : SOHO - CDS Name : FILL_CATEGORY Purpose : Load save file with current categories
FILL_MISSING Project : SOHO - CDS Name : FILL_MISSING Purpose : Fill in missing pixels in a data array Category : Class3, Analysis, Interpolation Explanation : Uses bilinear interpolation to fill in missing pixels in a data Syntax : FILL_MISSING, ARRAY, MISSING [, DIMENSION ]
FILL_TFTD Project : SOHO - CDS Name : FILL_TFTD Purpose : Load save file with current one-liners
FILM_THUMBNAIL Name: film_thumbnail Purpose: embed thumbnail image in "film" (make www logos/thumbnails) Input Parameters: thumbnail - image to enclose in film Output: function returns thumbnail embedded in "film" bitmap (always byte)
FILTER_IMAGE Identical to MEDIAN or SMOOTH but handle edges and allow iterations. Computes the average and/or median of pixels in moving box, replacing center pixel with the computed average and/or median, (using the IDL smooth or median functions). The main reason for using this function is the options to also process the pixels at edges and corners of image, and, to apply iterative smoothing simulating convolution with Gaussian, and/or to convolve image with a Gaussian kernel.
FILT_DATA Project : SOHO-CDS Name : FILT_DATA Purpose : filter data according to specified criteria Category : utility Explanation : Syntax : ij=filt_data(data)
FIND Find positive brightness perturbations (i.e stars) in an image Also returns centroids and shape parameters (roundness & sharpness). Adapted from 1986 STSDAS version of DAOPHOT.
FINDFILE_LIST This procedure takes a list of files and path (!path format) and returns the directory or library of the first occurrence for each
FINDPRO Find all locations of procedure in the IDL !PATH The procedure is searched in all IDL Libraries or directories given in the !PATH system variable. Finds and returns the paths of all examples of the procedure in the directories listed in the path.
FINDVAL Uses linear interpolation to obtain xval or yval with respect to input X,Y arrays. This function differs from INTERPOL in that if finds multi-valued cases.
FIND_ALL_DIR() Finds all directories under a specified directory. This routine finds all the directories in a directory tree when the root of the tree is specified. This provides the same functionality as having a directory with a plus in front of it in the environment variable IDL_PATH.
FIND_CAT MINCHAR = min chars required for input category name NAME = set to search by name EXACT = set for exact match SITE = search SITE specific info databases UPDATE = update memory copy of DBASE if disk copy changed
FIND_COMMON Project : SOHO - CDS Name : FIND_COMMON() Purpose : Find which elements are common to the input vectors.
FIND_COMPRESSED Project : SOHO-SUMER Name : FIND_COMPRESSED Purpose : find compressed version of a file Category : utility,i/o Explanation : looks for an input file. If not found, looks for a compressed version (.Z, and .gz), decompresses it
FIND_DATA_RUNS Project : SOHO - CDS Name : FIND_DATA_RUNS() Purpose : Detect runs of data in an array and return their boundaries.
FIND_DRAW_WIDGET Project : SOHO - CDS Name : FIND_DRAW_WIDGET() Purpose : Find the widget ID corresponding to a draw window.
FIND_DUP Project : SOHO - CDS Name : FIND_DUP() Purpose : Function to identify duplicate values in a vector.
FIND_FID Project : HESSI Name : FIND_FID Purpose : find files based on encoded fid names (yymmdd_hhmm) Category : HESSI, GBO, utility Explanation : Syntax : IDL> find_fid,tstart,tend,files
FIND_FILE Project : SOHO - CDS Name : FIND_FILE() Purpose : Fixing builtin FINDFILE() problem
FIND_FILES Project : SOHO - CDS Name : FIND_FILES Purpose : Find multiple files in a multiple path
FIND_FITS_BAD Finds the element numbers in tarray and yarray that have bad points that need to be eliminated and interpolated over. Bad points means any of the following are true: 1. flux value is -99999. 2. the moon is eclipsing the Sun 3. the detector is off
FIND_GOES_DATA find_goes_data looks for the device containing a requested time of GOES data. It searches seven places: sdac::goes_disk0:[goes] newmax::dua0:[hxrbs] newmax::dua1:[hxrbs] newmax::dub0:[hxrbs]
FIND_IX primary array for the values in the secondary array
FIND_LIMB2 Find the solar coordinates from an aspect camera image. Uses the IDL function SOBEL to differentiate, then fits to circle. Return sun center coordinates, solar radius, error estimate, and oblateness estimate determined from the Fourier spectrum of the limb location. Outputs are in (real) pixel units.
FIND_PROC Project : SOHO - CDS Name : FIND_PROC Category : Utility, help Purpose : Find routine in SSW tree Explanation : Used in WWW search engine Syntax : IDL> find_proc,proc
FIND_SYNOP Project : HESSI Name : FIND_SYNOP Purpose : FIND Synoptic data files in Archive Category : HESSI, Synoptic, utility Explanation : Syntax : IDL> find_synop,t1,t2,files
FIND_VALUE Project : SOHO - CDS Name : FIND_VALUE() Purpose : Finds where an array is equal to a value. Category : Class4, Numerical Explanation : This procedure finds the index of the point closest to the specified value, and then performs a bilinear interpolation.
FIND_WIND_DIR Project : HESSI Name : FIND_WIND_DIR() Purpose : Finds all directories under a specified directory under windows. Explanation : This routines finds all the directories in a directory tree when the root of the tree is specified. This provides the same functionality as having a directory with a plus in front of it
FIND_WITH_DEF() Searches for files with a default path and extension. Finds files using default paths and extensions, similar to using the DEFAULT keyword with the OPEN statement in VMS. Using this routine together with environment variables allows an OS-independent approach to finding files.
FITEXY Best straight-line fit to data with errors in both coordinates Linear Least-squares approximation in one-dimension (y = a + b*x), when both x and y data have errors
FITS2GIF Project : SOHO - CDS Name : FIT2GIF Purpose : convert FITS file to a GIF image file Explanation : Reads a FITS file, byte scales it, and then writes it to a GIF file. Use : FITS2GIF,INFILE
FITS2MAP Project : SOHO-CDS Name : FITS2MAP Purpose : Make an image map from a FITS file Category : imaging Explanation : Syntax : fits2map,file,map
FITS2TIME Name: fits2time Purpose: convert fits header times to Yohkoh convention Input Parameters: header - fits header or fits file name array Keyword Parameters: soho - switch, if set, fits header is SOHO time convention
FITSDIR Provide a brief description of the primary headers of FITS disk files. The values of the FITS keywords NAXISi, OBS-DATE (or TDATEOBS or DATE), TELESCOPE (or INSTRUME), OBJECT (or TARGNAME), EXPTIME (and INTEG) are displayed. All of these are commonly used FITS keywords and all except EXPTIME are officially reserved FITS keywords. Keyword names in parentheses are searched if the primary keyword is not
FITSHEAD2STRUCT Name: fitshead2struct Purpose: convert FITS header->struct, optionally add useful standard TAGS Input Parameters: head - FITs header array (ex: output from ) template - use this template structure (after first call, for example) Keyword Parameters:
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
FITSRGB_TO_TIFF Combine separate red, green, and blue FITS images into TIFF format The output TIFF (class R) file can have colors interleaved either either by pixel or image. The colour mix is also adjustable.
FITSTAPE Subroutine to perform FITS tape I/O. For VMS or Unix 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 between different representations of the CD matrix in a FITS header According the paper, "Representations of Celestial Coordinates in FITS" by Griesen and Calabretta, available at http://www.cv.nrao.edu/fits/documents/wcs/wcs.html the rotation of an image from standard coordinates is represented by a coordinate description (CD) matrix. However, there have been several different representations proposed for the CD matrix. Currently, (November 1998), the preferred form is CDn_m (as used in IRAF), which contains both rotation & plate scale info. However, an earlier draft of Griesen & Calabretta proposed the CD00n00m form.
FITS_CLOSE Close a FITS data file
FITS_DATATYPE() Return datatype of FITS data for the given BITPIX value
FITS_DISP_MONTH To display a single image per day for a single month
FITS_HELP To print a summary of the primary data units and extensions in a
FITS_INFO Provide information about the contents of a FITS file Information includes number of header records and size of data array. Applies to primary header and all extensions. Information can be printed at the terminal and/or stored in a common block
FITS_INTERP Interprets a FITS header and returns a structure with the tagnames matching the FITS keywords and tag values equal to the keyword values. RO fits_interp, header, result, $ inname=inname, instruc=instruc, ishort=ishort, fshort=fshort INPUT PARAMETERS:
FITS_OPEN Opens a FITS (Flexible Image Transport System) data file.
FITS_READ To read a FITS file.
FITS_WRITE To write a FITS primary data unit or extension.
FITS__DEFINE Project : HESSI Name : FITS__DEFINE Purpose : Define an FITS map object Category : imaging maps Explanation : The map object is actually a structure with a pointer field. The map structure is stored in this pointer.
FITTER Project : SOHO - CDS Name : FITTER Purpose : Least-squares fit of linear function Explanation : Fits a linear function to a series of data points via a least-squares technique. Use : FITTER, X, Y, FDER, PARAM [, PERR ]
FIT_CIRCLE Fit a circle to vector of points.
FIT_GAUSS Project : SOHO - CDS Name : FIT_GAUSS Purpose : Fits a gaussian plus a quadratic to data points Explanation : Fit Y=F(X) where: F(X) = A0*EXP(-Z^2/2) + A3 + A4*X + A5*X^2 and Z=(X-A1)/A2
FIT_SPEC Project : SOHO - CDS Name : FIT_SPEC Purpose : fit spectra
FIX_DATE Project : SOHO-CDS Name : FIX_DATE Purpose : Fix date that uses digit month into one with a string month Category : utility Explanation : Syntax : fdate=fix_date(date)
FIX_STRLEN() Make a string have a fixed length by appending spaces.
FLAG_LONG_NAMES Flags procedure names that would appear the same under DOS Flags sets of IDL procedure names which have the same first eight characters. These would appear to b