IDL 4.0.1 Procedures 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]

List of Routines

• ANNOTATE This procedure is a general purpose drawing program/widget to annotate displays. Drawing objects include text, lines, arrows, polygons, rectangles, circles, and ellipses.
• ARROW CATEGORY: Graphics
• A_CORRELATE This function computes the autocorrelation Px(L) or autocovariance Rx(L) of a sample population X as a function of the lag (L).
• BAR_PLOT Create a bar graph, or overplot on an existing one.
• BASE_ALLOC $Id: base_alloc.pro,v 1.7 1994/06/01 23:08:48 ali Exp $ Base object class definition. Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY Written by: Joshua Goldstein, 12/93
• BETA The introduction of the BETA function as a built in system routine in IDL 4.0 caused inconvenience to customers with existing code in which BETA had been used as a variable, because IDL system routines have precedence over variable names. To minimize this problem, RSI has renamed BETA back to NR_BETA (its old name).
• BGROUP_ALLOC $Id: bgroup_alloc.pro,v 1.8 1995/01/20 19:41:01 tonyh Exp $ WidBGroup Widget Button Group (CW_BGROUP) class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY
• BILINEAR Bilinearly interpolate a set of reference points.
• BINOMIAL This function computes the probabilty (bp) such that: Probability(X => v) = bp where X is a random variable from the cumulative binomial distribution (Bernouli distribution).
• BIN_DATE This function converts a standard form ascii date/time string to a binary string.
• BISECT_PDF This function computes the cutoff value x such that the probabilty of an observation from the given distribution, less than x, is a(0). u and l are the upper and lower limits for x, respectively. a(1) and a(2) are degrees of freedom, if appropriate. funct is a string specifying the probability density function. BISECT_PDF is not intended to be a user-callable function.
• BLK_CON This function computes a "fast convolution" of a digital signal and an impulse-response sequence.
• BMPBTN_ALLOC $Id: bmpbtn_alloc.pro,v 1.12 1995/01/20 19:41:01 tonyh Exp $ WidBmpBtn Widget Bitmap Button class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY
• BOX_CURSOR Emulate the operation of a variable-sized box cursor (also known as a "marquee" selector).
• BUTTON_ALLOC $Id: button_alloc.pro,v 1.8 1995/01/20 19:41:01 tonyh Exp $ WidButton Widget Button class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY
• CALDAT Return the month, day and year corresponding to a given julian date. This is the inverse of the function JULDAY.
• CALENDAR Display a calandar for a month or an entire year using IDL's plotting subsystem. This IDL routine imitates the Unix cal
• CDF_EXISTS Test for the existence of the CDF library
• CHEBYSHEV Implements forward and reverse Chebyshev polynomial expansion of a set of data.
• CHISQR_CVF This function computes the cutoff value (v) such that: Probability(X > v) = p where X is a random variable from the Chi-square distribution with (df) degrees of freedom.
• CHISQR_PDF This function computes the probabilty (p) such that: Probability(X <= v) = p where X is a random variable from the Chi-square distribution with (df) degrees of freedom.
• CIR_3PNT This procedure returns the radius and center of a circle, given 3 points on the circle. This is analogous to finding the circumradius and circumcircle of a triangle; the center of the circumcircle is the point at which the three perpendicular bisectors of the triangle formed by the points meet.
• COMFIT This function fits the paired data {X(i), Y(i)} to one of six common types of appoximating models using a gradient-expansion least-squares method. The result is a vector containing the model parameters.
• COMPLEXROUND This function rounds a complex scalar or array.
• COND This function computes the condition number of an N by N array.
• CONGRID Shrink or expand the size of an array by an arbitrary amount. This IDL procedure simulates the action of the VAX/VMS CONGRID/CONGRIDI function.
• COORD2TO3 Return 3D data coordinates given the normalized X and Y screen coordinates and one of the three data coordinates.
• CORRELATE This function computes the linear Pearson correlation coefficient of two n-element vectors or the Correlation Matrix of an M x N array. Alternatively, this function computes the covariance of two n-element vectors or the Covariance Matrix of an M x N array.
• CRAMER This function solves an n by n linear system of equations using Cramer's rule.
• CREATE_VIEW This procedure sets the various system variables required to define a coordinate system and a 3-D view. This procedure builds the system viewing matrix (!P.T) in such a way that the correct aspect ratio of the data is maintained even if the display window is not square. CREATE_VIEW also sets the "Data" to "Normal" coordinate conversion factors (!X.S, !Y.S, and !Z.S) so that center of the unit cube will be located at the center of the display
• CROSSP Evaluate the vector or cross-product of vectors v1 and v2.
• CTI_TEST This function constructs a "contingency table" from an array of observed frequencies and tests the hypothesis that the rows and columns are independent using an extension of the chi-squared goodness-of-fit test. The result is a two-element vector contain- ing the chi-squared test statistic X2 and probability of obtaining a value of X2 or greater.
• CT_LUMINANCE Calculate the luminance of colors.
• CURVEFIT Non-linear least squares fit to a function of an arbitrary number of parameters. The function may be any non-linear function. If available, partial derivatives can be calculated by the user function, else this routine will estimate partial derivatives with a forward difference approximation.
• CV_COORD Converts 2-D and 3-D coordinates between the RECTANGULAR, POLAR, CYLINDRICAL, and SPHERICAL coordinate systems.
• CW_ANIMATE This widget displays an animated sequence of images using X-windows Pixmaps. This is a compound widget, based on the XINTERANIMATE procedure, with the following advantages: - It can be included in other applications. - Multiple copies can be run simultaneously.
• CW_ARCBALL CW_ARCBALL is a compound widget for intuitively specifying three-dimensional orientations.
• CW_BGROUP CW_BGROUP is a compound widget that simplifies creating a base of buttons. It handles the details of creating the proper base (standard, exclusive, or non-exclusive) and filling in the desired buttons. Events for the individual buttons are handled transparently, and a CW_BGROUP event returned. This event can return any one of the following: - The Index of the button within the base. - The widget ID of the button. - The name of the button. - An arbitrary value taken from an array of User values.
• CW_CLR_INDEX CW_CLR_INDEX is a compound widget for the selection of a color index. A horizontal color bar is displayed. Clicking on the bar sets the color index.
• CW_COLORSEL CW_COLORSEL is a compound widget that displays all the colors in the current colormap and allows the user to select the color indices via the mouse or with sliders.
• CW_DEFROI Widget to define a region of interest within a widget drawable.
• CW_DICE CW_DICE is a compound widget that implements a single die. This widget uses a button with a bitmap label.
• CW_FIELD This widget cluster function manages a data entry field widget. The field consists of a label and a text widget. CW_FIELD's can be string fields, integer fields or floating-point fields. The default is an editable string field.
• CW_FORM CW_FORM is a compound widget that simplifies creating forms which contain text, numeric fields, buttons, and droplists. Event handling is also simplified.
• CW_FSLIDER The standard slider provided by the WIDGET_SLIDER() function is integer only. This compound widget provides a floating point
• CW_ORIENT This compound widget provides a means to interactively adjust the three dimensional drawing transformation (!P.T). The compound widget only returns events when !P.T has been altered.
• CW_PDMENU CW_PDMENU is a compound widget that simplifies creating pulldown menus. It has a simpler interface than the XPDMENU procedure, which it is intended to replace. Events for the individual buttons are handled transparently, and a CW_PDMENU event returned. This event can return any one of the following: - The Index of the button within the base. - The widget ID of the button. - The name of the button. - The fully qualified name of the button. This allows different sub-menus to contain buttons with the same
• CW_RGBSLIDER CW_RGBSLIDER is a compund widget that provides three sliders for adjusting color values. The RGB, CMY, HSV, and HLS color systems can all be used. No matter which color system is in use, the resulting color is always supplied in RGB, which is the base system for IDL.
• CW_ZOOM This compound widget displays two images: an original image in one window and a portion of the original image in another. The user may select the center of the zoom region, the zoom scale, the interpolation style, and the method of indicating the zoom center.
• C_CORRELATE This function computes the cross correlation Pxy(L) or cross covariance Rxy(L) of two sample populations X and Y as a function of the lag (L).
• DEFROI using the image display system and the cursor/mouse. CATEGORY: Image processing.
• DEMO_MODE Returns true if IDL is in Demo Mode.
• DERIV Perform numerical differentiation using 3-point, Lagrangian interpolation.
• DERIVSIG This function computes the standard deviation of a derivative as found by the DERIV function, using the input variables of DERIV and the standard deviations of those input variables.
• DETERM This function computes the determinant of an N by N array.
• DIGITAL_FILTER Compute the coefficients of a non-recursive, digital filter. Highpass, lowpass, bandpass and bandstop filters may be constructed with this function.
• DISSOLVE A digital "dissolve" effect for images. Copies the pixels (arranged into square tiles) from the image to the display in pseudo-random
• DIST Create a rectangular array in which each element is proportional to its frequency. This array may be used for a variety of purposes, including frequency-domain filtering and making pretty pictures.
• DL_DOS Extract the documentation template of one or more procedures (DOS
• DL_MAC Extract the documentation template of one or more procedures (Macintosh
• DL_UNIX Extract the documentation template of one or more IDL modules (procedures or functions).
• DL_VMS Extract the documentation template of one or more procedures.
• DOC_LIBRARY Extract the documentation template of one or more IDL modules (procedures or functions). This command provides a standard interface to the operating-system specific DL_DOS, DL_UNIX, and DL_VMS procedures.
• DRAW_ALLOC $Id: draw_alloc.pro,v 1.7 1994/06/01 23:08:48 ali Exp $ Widget Draw class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY Written by: Joshua Goldstein, 12/93
• EFONT This widget provides a vector font editor and display.
• EIGENVEC This function computes the eigenvectors of an N by N real, non- symmetric array using inverse subspace iteration. The result is a complex array with a column dimension equal to N and a row dimension equal to the number of eigenvalues.
• ERRPLOT Plot error bars over a previously drawn plot.
• EXPAND Array magnification (CONGRIDI like except that this really works!)
• EXTRAC The EXTRAC function returns as its result any rectangular sub-matrix or portion of the parameter array. When parts of the specified subsection lie outside the bounds of the array, zeros are entered into these outlying elements.
• EXTRACT_SLICE This function returns a 2-D planar slice extracted from 3-D volumetric data. The slicing plane may be oriented at any angle, and may pass through any desired location in the
• FACTORIAL This function computes the factorial N! as the double-precision product, (N) * (N-1) * (N-2) * ...... * 3 * 2 * 1.
• FIELD_ALLOC $Id: field_alloc.pro,v 1.8 1995/01/20 19:41:01 tonyh Exp $ WidField Widget Field class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY
• FILEPATH Given the name of a file in the IDL distribution, FILEPATH returns the fully-qualified path to use in opening the file. Operating system dependencies are taken into consideration. This routine is used by RSI to make the User Library portable.
• FLICK Flicker between two output images at a given rate.
• FLOW3 Draw lines representing a 3D flow/velocity field.
• FSLID_ALLOC $Id: fslid_alloc.pro,v 1.7 1994/06/01 23:08:48 ali Exp $ WidFslider Widget Fslider class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY
• FUNCT Evaluate the sum of a Gaussian and a 2nd-order polynomial and optionally return the value of its partial derivatives. Normally, this function is used by CURVEFIT to fit the sum of a line and a varying background to actual data.
• FV_TEST This function computes the F-statistic and the probability that two vectors of sampled data have significantly different variances. This type of test is often refered to as the F-variances Test.
• FX_ROOT This function computes real and complex roots (zeros) of a univariate nonlinear function.
• F_CVF This function computes the cutoff value (v) such that: Probability(X > v) = p where X is a random variable from the F distribution with (dfn) and (dfd) degrees of freedom.
• F_PDF This function computes the probabilty (p) such that: Probability(X <= v) = p where X is a random variable from the F distribution with (dfn) and (dfd) degrees of freedom.
• GAMMA The introduction of the GAMMA function as a built in system routine in IDL 4.0 caused inconvenience to customers with existing code in which GAMMA had been used as a variable, because IDL system routines have precedence over variable names. To minimize this problem, RSI has renamed GAMMA to NR_GAMMA.
• GAMMA_CT Apply gamma correction to the color table.
• GAUSS2DFIT Fit a 2 dimensional elliptical gaussian equation to rectilinearly
• GAUSSFIT Fit the equation y=f(x) where:
• GAUSS_CVF This function computes the cutoff value (v) such that: Probability(X > v) = p where X is a random variable from the standard Gaussian (Normal) distribution with a mean of 0.0 and a variance of 1.0
• GAUSS_PDF This function computes the probabilty (p) such that: Probability(X <= v) = p where X is a random variable from the standard Gaussian (Normal) distribution with a mean of 0.0 and a variance of 1.0
• GETHELP This function is used to get information on variables in the routine that called this function. The function builts a string array that contains information that follows the format that is used by the IDL HELP command.
• GS_ITER This function solves an n by n linear system of equations using Gauss-Seidel iteration.
• HANNING Window function for Fourier Transform filtering. May be used for both the Hanning and Hamming windows.
• HDF_EXISTS Test for the existence of the HDF library
• HILBERT Return a series that has all periodic terms shifted by 90 degrees.
• HIST_2D Return the density function (histogram) of two variables.
• HIST_EQUAL Return a histogram-equalized image or vector.
• HLS Make a color table based on the HLS (Hue, Lightness, Saturation)
• HSV Make a color table based on the HSV (Hue, Saturation, and Value)
• H_EQ_CT Histogram-equalize the color tables for an image or a region of the display.
• H_EQ_INT Interactively histogram-equalize the color tables of an image or a region of the display. By moving the cursor across the screen, the amount of histogram equalization is varied.
• IBETA This function computes the incomplete beta function, Ix(a, b).
• IBETA_PDF This function computes the incomplete beta function. It is called by the probability density functions in this directory. See the function IBETA() in the "math" subdirectory for the user-callable version of the incomplete beta function.
• IGAMMA This function computes the incomplete gamma function, Px(a).
• IGAMMA_PDF This function computes the incomplete gamma function using a series representation. It is called by the probability density functions in this directory. See the function IGAMMA() in the "math" subdirectory for the user-callable version of the incomplete gamma
• IMAGE_CONT Overlay an image and a contour plot.
• INTERPOL Linearly interpolate vectors with a regular or irregular grid.
• INT_2D This function computes the double integral of a bivariate function F(x,y) with limits of integration from A to B for x and from P(x) to Q(x) for y.
• INT_3D This function computes the triple integral of a trivariate function F(x,y,z) with limits of integration from A to B for X, from P(x) to Q(x) for Y and from U(x,y) to V(x,y)
• INT_TABULATED This function integrates a tabulated set of data { x(i) , f(i) }, on the closed interval [min(X) , max(X)].
• JULDAY Calculate the Julian Day Number for a given month, day, and year. This is the inverse of the library function CALDAT. See also caldat, the inverse of this function.
• KRIG_2D This function interpolates a regularly or irregularly gridded set of points Z = F(X,Y) using kriging.
• KW_TEST This function tests the hypothesis that three or more sample popultions have the same mean of distribution against the hypothesis that they differ. The popultions may be of equal or unequal lengths. The result is a two-element vector containing the test statistic H and the one-tailed probability of obtaining a value of H or greater from a chi-square distribution. This type of test is often refered to as the Kruskal-Wallis H-Test.
• LABEL_ALLOC $Id: label_alloc.pro,v 1.8 1995/01/20 19:41:01 tonyh Exp $ WidLabel Widget Label class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY
• LABEL_DATE This function labels axes with dates.
• LADFIT This function fits the paired data {X(i), Y(i)} to the linear model, y = A + Bx, using a "robust" least absolute deviation method. The result is a two-element vector containing the model parameters, A
• LEEFILT Performs the Lee filter algorithm on an image array using a box of size 2N+1. This function can also be used on vectors.
• LINFIT This function fits the paired data {X(i), Y(i)} to the linear model, y = A + Bx, by minimizing the chi-square error statistic. The result is a two-element vector containing the model parameters, A and B.
• LIST_ALLOC $Id: list_alloc.pro,v 1.7 1995/01/20 19:41:01 tonyh Exp $ Widget List class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY Written by: Joshua Goldstein, 12/93
• LJLCT Load standard color tables for LJ-250/252 printer.
• LL_ARC_DISTANCE This function returns the longitude and latitude [lon, lat] of a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az), from a specified location Lon_lat0.
• LOADCT Load predefined color tables.
• LU_COMPLEX This function solves an N by N complex linear system using LU decomposition. The result is an N-element complex vector. Alternatively, this function computes the generalized inverse of an N by N complex array using LU decomposition. The result is an N by N complex array.
• MAN_PROC Provide online documentation for IDL topics. If the current graphics device supports widgets, a graphical user interface is used. Otherwise, a more basic version that is a cross between the 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.
• MAP_CONTINENTS Used to read in the index file for each map data file
• MAP_IMAGE This function returns the Image_Orig image warped to fit the map specified by the system variable !Map. Image_Orig must be centered at 0.
• MAP_PATCH This function returns an interpolated grid in device space, given a set of rectangularly gridded values, in latitude/longitude space on the globe.
• MAP_SET The procedure map_set establishes the axis type and coordinate conversion mechanism for mapping points on the earth's surface, expressed in latitude and longitude, to points on a plane, according to one of ten possible map projections. The user may may select the map projection, the map center, polar rotation and geographical limits.
• MD_TEST This function tests the hypothesis that a sample population is random against the hypothesis that it is not random. The result is a two-element vector containing the nearly-normal test statistic Z and the one-tailed probability of obtaining a value of Z or greater. This test is often refered to as the Median Delta Test.
• MESH_OBJ MESH_OBJ generates a polygon mesh (vertex list and polygon list) that represent the desired primitive object. The available primitive objects are: triangulated surface, rectangular surface, polar surface, cylindrical surface, spherical surface, surface of extrusion, surface of revolution, and ruled surface.
• MIN_CURVE_SURF This function Interpolates a regularly- or irregularly-gridded set of points with either a minimum curvature surface or a thin-plate-spline surface.
• MK_HTML_HELP Given a list of IDL procedure files (.PRO), VMS text library files (.TLB), or directories that contain such files, this procedure generates a file in the HTML format that contains the documentation for those routines that contain a DOC_LIBRARY style documentation template. The output file is compatible with World Wide Web browsers.
• MK_LIBRARY_HELP Given a directory or a VMS text library containing IDL user library procedures, this procedure generates a file in the IDL help format that contains the documentation for those routines that contain a DOC_LIBRARY style documentation template. The output file is compatible with the IDL "?" command.
• MODIFYCT Update the distribution color table file "colors1.tbl" or the user-supplied file with a new table.
• MOMENT This function computes the mean, variance, skewness and kurtosis of an n-element vector.
• MP_BASIC Provide online documentation for IDL topics. The style is a cross between Unix man pages and VMS online 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.
• MP_WIDGETS Provide 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.
• MULTI Expand the current color table to wrap around N times.
• M_CORRELATE This function computes the multiple correlation coefficient of a dependent variable and two or more independent variables.
• NCDF_EXISTS Test for the existence of the NetCDF library
• NORM 1) This function computes the Euclidean norm of a vector.
• OPLOTERR Overplot data points with accompanying error bars.
• PDMENU_ALLOC $Id: pdmenu_alloc.pro,v 1.9 1995/01/20 19:41:01 tonyh Exp $ WidPdmenu Widget Pull Down Menu class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY
• PICKFILE This function allows the user to interactively pick a file. A file selection tool with a graphical user interface is created. Files can be selected from the current directory or other directories.
• PLOTERR Plot data points with accompanying error bars. (See also OPLOTERR.)
• PLOT_3DBOX This procedure plots data in a 3-dimensional box, with options to have the data displayed on the walls surrounding the plot area.
• PLOT_FIELD This procedure plots a 2-dimensional field.
• PNT_LINE This function returns the perpendicular distance between the point P0 and the line between points L0 and L1.
• POLAR_CONTOUR Produce a contour plot from data in polar coordinates. Data may be in a regular or scattered grid.
• POLAR_SURFACE This function interpolates a surface from polar coordinates (R, Theta, Z) to rectangular coordinates (X, Y, Z).
• POLY Evaluate a polynomial function of a variable.
• POLYFITW Perform a least-square polynomial fit with optional error estimates.
• POLYWARP Perform polynomial spatial warping.
• POLY_AREA Return the area of a polygon given the coordinates of its vertices.
• POLY_FIT Perform a least-square polynomial fit with optional error estimates.
• POPD Change the current working directory to the directory saved on the top of the directory stack maintained by the PUSHD and POPD User Library procedures. This top entry is then removed.
• PRIMES This function computes the first K prime numbers. The result is a K-element vector of type long integer.
• PRINTD Display the contents of the directory stack maintained by the PUSHD and POPD User Library procedures.
• PROFILE Extract a profile from an image.
• PROFILES Interactively draw row or column profiles of an image in a separate
• PROJECT_VOL This function returns a two dimensional image that is the projection of a 3-D volume of data onto a plane (similar to an X-ray). The returned image is a translucent rendering of the volume (the highest data values within the volume show up as the brightest regions in the returned image). Depth queing and opacity may be used to affect the image. The volume is projected using a 4x4 matrix, so any type of projection may be used including perspective. Typically the system viewing matrix (!P.T) is used as the 4x4 matrix.
• PSAFM Given an Abobe Font metric file, this procedure generates an AFM file in the format that IDL likes. This new file differs from the original in the following ways:
• PSEUDO Generate a pseudo-color table based on the LHB, (lightness, hue, and brightness) system and load it.
• PS_SHOW_FONTS This procedure displays all the PostScript fonts that IDL knows about, with both the StandardAdobe and ISOLatin1 encodings. Each display takes a separate page, and each character in each font is shown with its character index.
• PURPOSE: CATEGORY: Compound widgets. CALLING SEQUENCE: widget = CW_TMPL(parent) PARENT - The ID of the parent widget. KEYWORD PARAMETERS:
• PUSHD Push a directory onto the top of the directory stack maintained by the PUSHD and POPD User Library procedures.
• P_CORRELATE This function computes the partial correlation coefficient of a dependent variable and one particular independent variable when the effects of all other variables involved are removed.
• RANKS This function computes the magnitude-based ranks of a sample population X. Elements of identical magnitude "ties" are ranked according to the mean of the ranks that would otherwise be assigned. The result is a vector of ranks equal in length to X.
• RDPIX Interactively display the X position, Y position, and pixel value of the cursor.
• READ_BMP This function reads a Microsoft Windows Version 3 device independent bitmap file (.BMP).
• READ_GIF Read the contents of a GIF format image file and return the image and color table vectors (if present) in the form of IDL variables.
• READ_INTERFILE Simplistic Interfile (v3.3) reader. Can only read a series of images containing byte,int,long,float or double data where all images have the same height and with. Result is returned in a 3-D array.
• READ_PICT Version 2 Format. This format is used by the Apple Macintosh Computers.
• READ_PPM Read the contents of a PGM (gray scale) or PPM (portable pixmap for color) format image file and return the image in the form of an IDL variable. PPM/PGM format is supported by the PMBPLUS and Netpbm packages.
• READ_SPR This function reads a row-indexed sparse matrix from a specified file and returns it as the result. Row-indexed sparse matrices are created by using the Numerical Recipes routine NR_SPRSIN.
• READ_SRF Read the contents of a Sun rasterfile and return the image and color table vectors (if present) in the form of IDL variables.
• READ_SYLK Reads the contents of a sylk (Symbolic Link) format spreadsheet data file and returns a cell data range (if present) in the form of an IDL variable.
• READ_WAVE READ a .wave or .bwave file created by the Advanced Data Visualizer into an series of IDL variables.
• READ_X11_BITMAP Read bitmaps stored in the X11 format.
• READ_XWD Read the contents of files created by the XWD (X Windows Dump) command and return the image and color table vectors in the form of IDL variables.
• RECON3 This function can reconstruct a 3-dimensional data array from two or more images (or projections) of an object. For example, if you placed a dark object in front of a white background and then photographed it three times (each time rotating the object a known amount) then these three images could be used with RECON3 to approximate a 3-D volumetric representation of the object. RECON3 also works with translucent projections of an object. RECON3 returns a 3-D byte array. RECON3 uses the back-projection method. In medical imaging and other applications, a method known as "Filtered Backprojection" is often desired. This may
• REDUCE_COLORS This procedure reduces the number of colors used in an image by eliminating pixel values without members.
• REGRESS Perform a multiple linear regression fit.
• RESOLVE_ALL Resolve (by compiling) all procedures and functions. This is useful when preparing .sav files containing all the IDL routines required for an application.
• REVERSE Reverse the order of rows or columns in an array or vector.
• ROT Rotate, magnify or demagnify, and/or translate an image.
• RSTRPOS This function finds the last occurrence of a substring within an object string. If the substring is found in the expression, RSTRPOS returns the character position of the match, otherwise it returns -1.
• RS_TEST This function tests the hypothesis that two sample popultions, {X(i), Y(i)}, have the same mean of distribution against the hypothesis that they differ. The result is a two-element vector containing the nearly-normal test statistic Z and the one-tailed probability of obtaining a value of Z or greater. This type of test is often refered to as the Wilcoxon Rank-Sum Test or Mann- Whitney U-Test.
• R_CORRELATE This function computes Spearman's (rho) or Kendalls's (tau) rank correlation of two n-element vectors. The result is a two-element vector containing the rank correlation coefficient and the two-sided significance level of its deviation from zero.
• R_TEST This function tests the hypothesis that a binary sequence (a sequence of 1s and 0s) represents a "random sampling". This test is based on the "theory of runs" and is often refered to as the Runs Test for Randomness. The result is a two-element vector containing the nearly-normal test statistic Z and the one-tailed probability of obtaining a value of Z or greater.
• SCALE3 Set up transformation and scaling for basic 3D viewing.
• SCALE3D Scale the 3D unit cube (a cube with the length of each side equal to 1) into the viewing area.
• SEARCH2D This function finds "objects" or regions of similar data values within a 2-D array of data. Given a starting location and a range of values to search for, SEARCH2D will find all the cells within the array that are within the specified range of values, and have some path of connectivity through these cells to the starting location. In addition to searching for cells within a global range of data values, SEARCH2D can also search for adjacent cells whose values deviate from their neighbors within specified tolerances. See the procedure "SEARCH3D" for the three dimensional case.
• SEARCH3D This function finds "objects" or regions of similar data values within a 3-D array of data. Given a starting location and a range of values to search for, SEARCH3D will find all the cells within the volume that are within the specified range of values, and have some path of connectivity through these cells to the starting location. In addition to searching for cells within a global range of data values, SEARCH3D can also search for adjacent cells whose values deviate from their neighbors within specified tolerances. See the procedure "SEARCH2D" for the two dimensional case.
• SETUP_KEYS Set up function keys for use with IDL.
• SFIT This function determines a polynomial fit to a surface.
• SHADE_SURF_IRR Make a shaded surface representation of an irregulary gridded elevation dataset.
• SHOW3 Show a 2D array three ways in a display that combines SURFACE, CONTOUR, and an image (color/gray scale pixels).
• SHOWFONT This procedure displays a vector-drawn font on the current graphics device.
• SHOWINFO Copyright (c) 1991-1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. RO ShowInfoEventHndlr, event
• SKEY_DEC Under Unix, the number of function keys, their names, and the escape sequences they send to the host computer vary enough between various keyboards that IDL cannot be written to understand all keyboards. Therefore, it provides a very general routine named DEFINE_KEY that allows the user to specify the names and escape sequences. This routine uses DEFINE_KEY to enter the keys for a DEC VT200-style keyboard.
• SKEY_HP Under Unix, the number of function keys, their names, and the escape sequences they send to the host computer vary enough between various keyboards that IDL cannot be written to understand all keyboards. Therefore, it provides a very general routine named DEFINE_KEY that allows the user to specify the names and escape sequences. This routine uses DEFINE_KEY to enter the keys for the HP 9000 series 300 keyboard.
• SKEY_MIPS Under Unix, the number of function keys, their names, and the escape sequences they send to the host computer vary enough between various keyboards that IDL cannot be written to understand all keyboards. Therefore, it provides a very general routine named DEFINE_KEY that allows the user to specify the names and escape sequences. This routine uses DEFINE_KEY to enter the keys for the MIPS RS series keyboard.
• SKEY_SGI escape sequences they send to the host computer vary enough between various keyboards that IDL cannot be written to understand all keyboards. Therefore, it provides a very general routine named DEFINE_KEY that allows the user to specify the names and escape sequences. This routine uses DEFINE_KEY to enter the keys for a Sun keyboard.
• SKEY_SUN Under Unix, the number of function keys, their names, and the escape sequences they send to the host computer vary enough between various keyboards that IDL cannot be written to understand all keyboards. Therefore, it provides a very general routine named DEFINE_KEY that allows the user to specify the names and escape sequences. This routine uses DEFINE_KEY to enter the keys for a Sun keyboard.
• SLICER Widget based application to show 3D volume slices and isosurfaces.
• SLIDER_ALLOC $Id: slider_alloc.pro,v 1.8 1995/01/20 19:41:01 tonyh Exp $ WidSlider Widget Slider class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY
• SLIDE_IMAGE Create a scrolling graphics window for examining large images. By default, 2 draw widgets are used. The left draw widget shows a reduced version of the complete image, while the draw widget on the right displays the actual image with scrollbars that allow sliding the visible window.
• SPH_4PNT Given four 3-dimensional points, this procedure returns the center and radius necessary to define the unique sphere passing through those points.
• SPH_SCAT Interpolate to a regular grid given scattered samples on the surface of a sphere.
• SPLINE This function performs cubic spline interpolation.
• SPLINE_P This procedure performs parameteric cubic spline interpolation.
• STRETCH Stretch the image display color tables so the full range runs from one color index to another.
• STR_SEP This routine cuts a string into pieces which are separated by the separator string.
• SURFR Set up 3D transformations.
• SVDFIT Perform a general least squares fit with optional error estimates.
• SWAP_ENDIAN This fucntion reverses the byte ordering of arbitrary scalars, arrays or structures. It may be used, for example, to make little endian numbers big, or big endian numbers little.
• S_TEST This function tests the hypothesis that two sample popultions, {X(i), Y(i)}, have the same mean of distribution against the hypothesis that they differ. The result is a two-element vector containing the maximum number of signed differences between corresponding pairs of X(i) and Y(i) and the one-tailed level of significance. This type of test is often refered to as the Sign
• T3D Implement three-dimensional transforms.
• TEK_COLOR Load a color table similar to the default Tektronix 4115 color table.
• TESTDEMO Main program to run a demonstration program. This IDL program reads a script file, showing each line that is executed and waiting a fixed period of time after each statement is executed. The first character of each line has the following significance: ; for comment, line is printed and there is no wait. @ to execute a new file.
• TEST_HP CATEGORY: Graphics Drivers.
• TEST_LJ[1] Procedure to load a group of 16, 8, or 4 (depending on keyword) colors for the LJ-250 . If 8 or fewer colors are to be defined, it is assumed that 180 dpi resolution mode will be accessed. In this case, selection is from a pre-defined set of 8 colors. For 16 colors, any combination of the 256 available LJ-250 colors may be selected. The group chosen here is an attempt to select a table which uses
• TEST_LJ[2] Procedure to test the basic plotting capabilities of the LJ-250 driver, including color selection.
• TEST_LJ[2] Procedure to test the monochrome linestyle capability of the IDL LJ-250 driver.
• TEST_LJ[3] Procedure to generate a series of TV images on a page, for an LJ-250 driver test. Monochrome (depth=1) is used, so that the dithering may be tested.
• TEST_LJ[4] Procedure to test landscape and portrait graphics using both 90 and 180 dpi LJ-250 resolutions. A total of four output files will be generated.
• TEST_LJ[5] Procedure to create two disk files illustrating different depth (bit plane) renditions available on the LJ-250 .
• TEST_LJ[6] Procedure to create an output file for use on the LJ-250, which will use the library procedure SHOW3.
• TEST_LJ[7] To exercise and demonstrate various aspects of the IDL driver for the Digital Equipment Corporation LJ-250 color printer.
• TEST_PCL[1] Procedure to test the basic plotting capabilities of the pcl driver
• TEST_PCL[2] Procedure to generate a series of TV images on a page, for a pcl driver
• TEST_PCL[2] Procedure to test the linestyle capability of the IDL pcl driver
• TEST_PCL[3] Procedure to test landscape and portrait graphics using all three optimization methods. A total of six output files will be generated. Note: All three optimization levels (0,1,2) are used; since not all devices will support all levels, garbage could result.
• TEST_PCL[4] To exercise and demonstrate various aspects of the HP PCL (Printer Command Language) IDL driver.
• TEST_TRUE $Id: test_true.pro,v 1.1 1993/04/02 18:38:01 idl Exp $ Procedure to test IDL true color operation unction col,r,g,b ;Return the color index, given R, G, and B
• TEXT_ALLOC $Id: text_alloc.pro,v 1.8 1995/01/20 19:41:01 tonyh Exp $ Widget Text class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY Written by: Joshua Goldstein, 12/93
• THREED Plot a 2D array as a pseudo 3D plot.
• TIFF_DUMP Dump the Image File Directories of a TIFF File. This procedure is used mainly for debugging.
• TIFF_READ Read 8-bit or 24-bit images in TIFF format.
• TIFF_WRITE Write 8-bit or 24-bit images in TIFF format.
• TIME_TEST General purpose IDL benchmark program that performs approximately 20 common operations and prints the time
• TM_TEST This function computes the Student's t-statistic and the probability that two vectors of sampled data have significantly different means. The default assumption is that the data is drawn from populations with the same true variance. This type of test is often refered to as the
• TPLT_ALLOC $Id: tplt_alloc.pro,v 1.6 1995/01/20 19:41:01 tonyh Exp $ WidTemplate Sample Class definition file Copyright (c) 1993, Research Systems, Inc. All rights reserved. MODIFICATION HISTORY Written by: Joshua Goldstein, 12/93
• TRI_SURF This function Interpolates a regularly or irregularly gridded set of points with a smooth quintic surface.
• TS_COEF This function computes the coefficients used in a Pth order autoregressive time-series forecasting model. The result is a P-element vector whose type is identical to X.
• TS_DIFF This function recursively computes the forward differences, of an N-element time-series, K times. The result is an N-element differenced time-series with its last K elements as zeros.
• TS_FCAST This function computes future values of a stationary time-series using a Pth order autoregressive model. The result is an N_FUTURE-element vector whose type is identical to X.
• T_CVF This function computes the cutoff value (v) such that: Probability(X > v) = p where X is a random variable from the Student's t distribution with (df) degrees of freedom.
• T_PDF This function computes the probabilty (p) such that: Probability(X <= v) = p where X is a random variable from the Student's t distribution with (df) degrees of freedom.
• UNIQ Return the subscripts of the unique elements in an array.
• VEL Draw a velocity (flow) field with arrows following the field proportional in length to the field strength. Arrows are composed of a number of small segments that follow the streamlines.
• VELOVECT Produce a two-dimensional velocity field plot.
• VERT_T3D This function tranforms 3-D points by a 4x4 transformation matrix. The 3-D points are typically an array of polygon vertices that were generated by SHADE_VOLUME or MESH_OBJ.
• VORONOI This procedure computes the Voronoi polygon of a point within an irregular grid of points, given the Delaunay triangulation. The Voronoi polygon of a point contains the region closer to that point than to any other point.
• WARP_TRI This function warps images using control (tie) points.
• WF_DRAW This procedure draws weather fronts of various types with spline smoothing.
• WIDALLOC $Id: widalloc.pro,v 1.7 1994/06/01 23:08:48 ali Exp $ WidAlloc Widget Editor allocation related routines. Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY
• WIDBUILD $Id: widbuild.pro,v 1.9 1994/06/01 23:08:48 ali Exp $ WidBuild Widget Editor common routines related to building dialog boxes. Mostly. Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY
• WIDDEP $Id: widdep.pro,v 1.11 1994/06/01 23:08:48 ali Exp $ Dependent Dep object class definition. Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY Written by: Joshua Goldstein, 12/93
• WIDED An IDL dialog Editor. Lets one graphically produce a widget
• WIDEDIT $Id: widedit.pro,v 1.8 1994/06/01 23:08:48 ali Exp $ Cut/Paste/Copy/Edit dialog routines. These are the other 'Top Level' dialogs and as main, have many externally visible hooks (c.f. wided.com) Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited.
• WIDFILE $Id: widfile.pro,v 1.16 1995/01/26 03:32:11 billo Exp $ Widget File class library Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY Written by: Joshua Goldstein, 12/93
• WIDMAIN $Id: widmain.pro,v 1.12 1995/01/26 03:31:38 billo Exp $ Main object class definition. Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY Written by: Joshua Goldstein, 12/93
• WIDUTIL $Id: widutil.pro,v 1.8 1994/06/01 23:08:48 ali Exp $ Miscellaneous Utility functions and procedures Copyright (c) 1993, Research Systems, Inc. All rights reserved. Unauthorized reproduction prohibited. MODIFICATION HISTORY Written by: Joshua Goldstein, 12/93
• WRITE_BMP This procedure writes a Microsoft Windows Version 3 device independent bitmap file (.BMP).
• WRITE_GIF Write an IDL image and color table vectors to a GIF (graphics interchange format) file.
• WRITE_NRIF Write an IDL image and color table vectors to an NCAR Raster Interchange Format (NRIF) rasterfile.
• WRITE_PICT Version 2 Format. This format is used by Apple Macintosh
• WRITE_PPM Write an image to a PPM (true-color) or PGM (gray scale) file. PPM/PGM format is supported by the PMBPLUS and Netpbm packages.
• WRITE_SPR This procedure writes a row-indexed sparse matrix stucture to a specified file. A row-indexed sparse matrix is created by the Numerical Recipes routine NR_SPRSIN.
• WRITE_SRF Write an IDL image and color table vectors to a Sun rasterfile.
• WRITE_SYLK Writes the contents of an IDL variable to a sylk (Symbolic Link) format spreadsheet data file.
• WRITE_WAVE Write a three dimensional IDL array to a .wave or .bwave file for use with the Wavefront Visualizer.
• XBM_EDIT This routine allows users to create and edit bitmaps for use with IDL widgets as icons.
• XDISPLAYFILE Display an ASCII text file using widgets and the widget manager.
• XDISTFILE Displays ASCII text files from the IDL distribution. Unlike XDISPLAYFILE, this routine understands that under VMS, IDL routines are packed in VMS text libraries.
• XFONT XFONT is a modal widget for selecting and viewing an X Windows font.
• XINTERANIMATE Display an animated sequence of images using X-windows Pixmaps. The speed and direction of the display can be adjusted using the widget interface.
• XLOADCT A graphical interface to the LOADCT user library procedure. XLOADCT displays the current color map and provides an array of buttons, one per availible predefined color table. Using the mouse to press these buttons causes the corresponding color map to be loaded.
• XMANAGER Provide main event loop and management for widgets created using IDL.
• XMNG_TMPL This routine is a template for widgets that use the XManager. Use this template instead of writing your widget applications from
• XMTOOL Provide a tool for viewing Widgets currently being managed by the
• XPALETTE Interactively create color tables using the RGB, CMY, HSV, and HLS color systems using the mouse, three sliders, and a cell for each color index. Single colors can be defined or multiple color indices between two endpoints can be interpolated.
• XREGISTERED This function returns true if the widget named as its argument is currently registered with the XMANAGER as an exclusive widget, otherwise this routine returns false.
• XSQ_TEST This function computes the chi-squared goodness-of-fit test between observed frequencies and the expected frequencies of a theoretical distribution. The result is a two-element vector containing the chi-squared test statistic X2 and probability of obtaining a value of X2 or greater.
• XSURFACE This routine provides a graphical interface to the SURFACE and SHADE_SURFACE commands. Different controls are provided to change the viewing angle and other plot parameters. The command used to generate the resulting surface plot is shown in a text window.
• XVAREDIT This routine provides an editor for any IDL variable.
• ZOOM Display part of an image (or graphics) from the current window enlarged in another window.
• ZOOM_24 Display part of a 24-bit color image from the current window expanded in another window. (This procedure was modified from the 8-bit procedure ZOOM).