Windt 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

• ATOMIC_WEIGHT ATOMIC_WEIGHT Function to return the atomic weight of specified chemical elements. CALLING SEQUENCE: Result=ATOMIC_WEIGHT(SYMBOL) SYMBOL - A string or string array specifying the name or names
• BESELI_FRACT BESELI_FRACT This function returns the Modified Bessel Function of the First Kind of Order N, for any N, i.e., including fractional and negative orders. CALLING SEQUENCE: Result = BESELI_FRACT(X, N)
• BESELK_FRACT BESELK_FRACT This function returns the Modified Besel Function of the Second Kind of order N, for any N, i.e., including fractional and negative orders. CALLING SEQUENCE: Result = BESELK_FRACT(X, N)
• CHEM2LBL CHEM2LBL Convert a 'chemical name', i.e. a string containing characters and numbers - H2O, for example - into a string containing formatting commands so that the numbers become subscripts when using the result in IDL graphics. For example: "H2O" would come back as "H!d2!nO".
• CHISQR CHISQR Compute the Chi Square statistic of a function and a fit to the function. CALLING SEQUENCE: Result=CHISQR(Y,SIGMA_Y,YFIT) Y - Input array.
• CLEAR CATEGORY: Stupid little convenience routines. Clear the screen, just like the Unix command. CALLING SEQUENCE: CLEAR RESTRICTIONS:
• CONT_IMAGE CONT_IMAGE Overlay an image and a contour plot. CALLING SEQUENCE: CONT_IMAGE, IMAGE[,X,Y] IMAGE - 2 dimensional array to display. OPTIONAL INPUTS:
• CONT_IMAGE2 CONT_IMAGE2 Display an image and overlayer the contours from a second image. CALLING SEQUENCE: CONT_IMAGE2, IMAGE1, IMAGE2, X, Y IMAGE1 = Image to display. IMAGE2 = Image from which contours are drawn.
• CURVE_LABEL CURVE_LABEL Draw labels close to one or more (up to 30) curves that have been previously plotted. CALLING SEQUENCE: CURVE_LABEL,X,Y1,[Y2,Y3,Y4,Y5],LABELS=LABELS, $ [COLOR=COLOR,XPOSITION=XPOSITION,YOFFSET=YOFFSET]
• CW_CURVE_LABEL CW_CURVE_LABEL A compound widget used to select the position for a curve label; this widget is intended to be used in conjunction with the CURVE_LABEL procedure in this directory, in that this widget lets the user select a value from a slider from 0 to one, corresponding to the XPOSITION keyword in CURVE_LABEL.
• CW_DRAWSIZE CW_DRAWSIZE A compound widget used to change the size of an existing draw widget. The widget contains fields for the X and Y draw size (in pixels), an Apply button, and optionally a Done button. CATEGORY:
• 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_PLOTAXES CW_PLOTAXES A compound widget used to change the type, range and style (bit 0) values of one or more plot axis structure variable. A CW_PLOTAXIS (single axis) widget is created for each element of the LABELS input parameter. The widget also includes an Apply button, and (optionally) a Done button.
• CW_PLOTAXIS CW_PLOTAXIS A compound widget used to change the type, range and style (bit 0 only) values of plot axis structure variable. CATEGORY: Compound widgets. CALLING SEQUENCE:
• CW_PLOTLABEL CW_PLOTLABEL A compound widget used to select the position for a plot label or legend. This widget is intended to be used in conjunction with the PLOT_TEXT or LEGEND procedures in this directory, in that this widget lets the user select one of 13 pre-defined positions corresponding to the POSITION keyword in PLOT_TEXT
• CW_PLOTSTYLE CW_PLOTSTYLE A compound widget used to set values for the graphics keywords COLOR, LINESTYLE, THICK, PSYM, and SYMSIZE. CATEGORY: Compound widgets. CALLING SEQUENCE:
• CW_PLOTSTYLES CW_PLOTSTYLES A compound widget used to set values for the graphics keywords COLOR, LINESTYLE, THICK, PSYM, and SYMSIZE, for several plot variables. A CW_PLOTSTYLE (single variable) widget is created for each element of the LABELS input parameter. The widget also includes an Apply button, and (optionally) a Done button.
• CW_PLOTTITLE_CHAR CW_PLOTTITLE_CHAR A compound widget used to set values for the graphics keywords CHARSIZE, SUBTITLE, and TITLE. The widget contains fields for these parameters, an Apply button, and (optionally) a Done button. CATEGORY:
• CW_VECTOR CW_VECTOR A compound widget used to get input necessary to create a "vector", in the spirit of the VECTOR function in this directory, i.e, get input for the MIN, MAX, and PTS values. The widget also lets the user specify the increment between points, and whether the point spacing is linear or
• DGTZ_IMAGE DGTZ_IMAGE A widget application to interactively measure distances in an image, either between two points, two horizontal lines, or two vertical lines. CATEGORY: Image analysis
• DGTZ_PLOT DGTZ_PLOT A widget application used to extract (X,Y) values from an image of plot. For example, you can use this program to extract data from a published plot that you've scanned and converted to an image array. CALLING SEQUENCE:
• DIALOG A popup widget dialog box to get user input. Like WIDGET_MESSAGE, which is better in some cases, but this widget also includes fields and lists. CATEGORY: CALLING SEQUENCE: Result = DIALOG([TEXT])
• DISPLAY_FONT DISPLAY_FONT Display the font sets listed in the IDL User's Guide. CALLING SEQUENCE: DISPLAY_FONT[,FONT_NUMBER,HARDWARE=HARDWARE] OPTIONAL INPUT PARAMETERS: FONT_NUMBER - The font index. If not supplied, the user is
• DLIB A cheesy alias to DOC_LIBRARY, with a name that's easier to CATEGORY: Cheesy aliases. MODIFICATION HISTORY: D. L. Windt, Bell Labs, April 1990. windt@bell-labs.com
• ELECTRON_MFP ELECTRON_MFP This function returns the elastic mean-free-path for electrons of energy E, in a material having density N, and atomic number Z. CALLING SEQUENCE: Result = ELECTRON_MFP(Z,A,RHO,E) Z = Atomic number
• EPLOT EPLOT Plot x vs y, with vertical error bars on y. CALLING SEQUENCE: EPLOT,Y,SIGY EPLOT,X,Y,SIGY EPLOT,Y,SIGY_UP,SIGY_DOWN
• EROM EROM Read up to ten columns of data from a text file. This program can be used to read data written by the MORE program. The file to be read must be such that if the data are space-separated, then all variables are numeric; String
• ERRORF_FIT ERRORF_FIT fit y=f(x) where: f(x) = a0*errorf((x-a1)/a2))+a3+x*a4 CALLING SEQUENCE: YFIT = ERRORF_FIT(X,Y,A) X - independent variable, must be a vector.
• EXPO_FIT Fit y=f(x) where: F(x) = a0*exp(-abs(x-a1)/a2)+a3 a0 = height of exp, a1 = center of peak, a2 = 1/e width, Estimate the parameters a0,a1,a2,a3 and then call curvefit. CALLING SEQUENCE: YFIT = EXPO_FIT(X,Y,A)
• FILE_DATE FILE_DATE Determine Unix file creation date. CALLING SEQUENCE: Result=FILE_DATE(FILE_NAME) FILE_NAME - A string specifying the name of the file Result - a string specifying the file creation date.
• FINDEX search. The resulting output may be used with INTERPOLATE.
• FRACTAL_FIT FRACTAL_FIT Fit y=f(x) where: F(x) = a0/(x^a1) [+a2] Estimate the parameters a0,a1[,a2] and then call curvefit. CALLING SEQUENCE: YFIT = FRACTAL_FIT(X,Y,A,BACKGROUND=BACKGROUND)
• FWHM FWHM Interactively measure the full-width-half-max of a region of a curve that has been previously plotted. CALLING SEQUENCE: RESULT=FWHM(XAXIS,YAXIS) XAXIS - The x axis variable which has been plotted.
• GAUSSEXPO_FIT GAUSSEXPO_FIT Fit y=f(x) where: f(x) = a0*exp(-z^2/2)+a3*exp(-abs(x-a4)/a5)+a6 and z=(x-a1)/a2 a0 = height of gaussian, a1 = center of gaussian, a2 = 1/e width of ; gaussian, a3 = height of exponential, a4 = center of exponential, ; a5 = 1/e width of exponential,
• GAUSS_FIT GAUSS_FIT Fit y=f(x) where: f(x) = a0*exp(-z^2/2) + a3 and z=(x-a1)/a2 a0 = height of gaussian, a1 = center of gaussian, a2 = 1/e width, a3 = background.
• GAUS_CONVOL NAME: GAUS_CONVOL Convolve a function with a gaussian. CALLING SEQUENCE: Result=GAUS_CONVOL(X,Y,SIG) X - vector of independent variables.
• GET_PEAK GET_PEAK Interactively find the local maximum of a previously plotted curve, and indicate it on the plot. CALLING SEQUENCE: Result=GET_PEAK(XAXIS,YAXIS) XAXIS = the x axis variable which has been plotted.
• GET_PT GET_PT Digitize a point on a previously plotted curve, and return the corresponding array element. CALLING SEQUENCE: Result = GET_PT(XAXIS,YAXIS,XPOINT,YPOINT) XAXIS - the x axis vector which was used to make the plot.
• GET_ROI GET_ROI Get a region-of-interest of a previously plotted curve. CALLING SEQUENCE: Result=GET_ROI(XAXIS,YAXIS) XAXIS = the x axis variable which has been plotted. YAXIS = the y axis variable which has been plotted.
• GHOSTVIEW GHOSTVIEW Use the Unix ghostview program to view an IDL postscript file CALLING SEQUENCE: GHOSTVIEW [,FILE=FILE] KEYWORD PARAMETERS: FILE - the name of the file to view. Default is idl.ps
• GREEK This function returns the string needed to draw the specified greek character using either the vector graphics font no. 4, or PostScript font 9. If (!d.name eq 'PS') and (!p.font eq 0), then the PostScript font will be used. Otherwise, the vector font will be used. CALLING SEQUENCE:
• KAISER_BESSEL KAISER_BESSEL Window function for Fourier Transform filtering. CATEGORY: Signal, image processing. CALLING SEQUENCE: Result = KAISER_BESSEL(N1) (for 1D)
• LEGEND LEGEND Add to a plot a legend containing lines and plotting symbols, enclosed in a box. CALLING SEQUENCE: LEGEND,LABELS LABELS - n-element string array of labels.
• LPRINT LPRINT Close an IDL graphics file and print it. CALLING SEQUENCE: LPRINT KEYWORD PARAMETERS: NORETURN - set this keyword to inhibit executing
• LS CATEGORY: Stupid little convenience routines. List the contents of the current directory, like the Unix 'ls' command. CALLING SEQUENCE: LS[,NAME]
• MAKE_LATEX_TBL MAKE_LATEX_TBL Create a LaTeX format table. CALLING SEQUENCE: MAKE_LATEX_TBL,ARRAY,TFILE ARRAY - (n,m) array of data. TFILE - string specifying the name of the '.tex' file to create.
• 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.
• MORE MORE Print one or more variables on the screen or to a file, using the MORE keyword to printf. CALLING SEQUENCE: MORE,v0[,v1,v2,...v19] V0,V1,...V19 - Any type of array variables; they must all be
• OEPLOT OEPLOT Overplot x vs y, with vertical error bars on y. CALLING SEQUENCE: OEPLOT,Y,SIGY OEPLOT,X,Y,SIGY OEPLOT,Y,SIGY_UP,SIGY_DOWN
• PLOT_MOVIE PLOT_MOVIE Display an animated sequence of X-Y plots in a window. CALLING SEQUENCE: PLOT_MOVIE,X,Y[,Y1,Y2,Y3,Y4] INPUT PARAMETERS: X = N_x-element array, common to all Y vectors
• PLOT_PRINT PLOT_PRINT A widget-based interface for creating and printing IDL graphics output files. The widget allows the user to select an output device type (PS, PCL, or HP), and specify whether or not to use color, the color depth (for PS), the plot orientation (landscape or portrait), the size of the
• PLOT_TEXT PLOT_TEXT Add text in a box to a plot. The text is located in one of 12 possible positions (i.e., upper left corner, lower right corner, etc.) CALLING SEQUENCE: PLOT_TEXT,TEXT_ARRAY[,POSITION=POSITION]
• PROFILE_NI PROFILE_NI Extract a profile from an image noninteractively. CALLING SEQUENCE: Result = PROFILE_NI(IMAGE,COORDS) IMAGE - data array. May be any type except complex. COORDS - 2 x 2 array of x and y coordinate of profile endpoints,
• PWD CATEGORY: Stupid little convenience routines. Print the current directory, like the Unix 'pwd' command. CALLING SEQUENCE: PWD MODIFICATION HISTORY:
• RECROI RECROI Define a rectangular region of interest of an image using the image display system and the cursor/mouse. CATEGORY: Image processing. CALLING SEQUENCE:
• RECTANGLE RECTANGLE Draw a rectangle on a plot. CALLING SEQUENCE: RECTANGLE,X0,Y0,XLENGTH,YLENGTH X0, Y0 - Points specifying a corner of the rectangle. XLENGTH, YLENGTH - the lengths of the sides of the rectangle,
• REC_IMAGE REC_IMAGE Extract a rectangular portion of a previously displayed image. CALLING SEQUENCE: SMALL_IMAGE=REC_IMAGE(BIG_IMAGE) BIG_IMAGE = array containing original image SMALL_IMAGE = portion of big_image
• ROI_WIDTH ROI_WIDTH Measure the width of a region of curve that has been previously plotted. The region is defined to be within ymin and ymax of a digitized region of the curve. CALLING SEQUENCE: Result=ROI_WIDTH(XAXIS,YAXIS)
• ROTATION ROTATION Rotate two vectors by a specified amount. CALLING SEQUENCE: ROTATION,X,Y,DEG,NX,NY X,Y :orignal data point pairs
• SHIFT_PLOT SHIFT_PLOT Interactively slide a previously plotted array using the mouse. CALLING SEQUENCE: SHIFT_PLOT,X[,Y,SHIFT=SHIFT] X,Y - array variables KEYWORD PARAMETERS:
• SHOW_CT SHOW_CT Make a window and show the first 32 colors in the current color table. CALLING SEQUENCE: MODIFICATION HISTORY: David L. Windt, Bell Labs, November 1989
• SINC SINC Function to return the value of the SINC function, i.e., sin(x)/x. CALLING SEQUENCE: Result = SINC(X) X - Input value. Scalar or array.
• SINCSQUARE_FIT SINCSQUARE_FIT Fit y=f(x) where: F(x) = a0*( sin(a1*(x-a2))/(a1*(x-a2)) )^2 + a3 Estimate the parameters a0,a1,a2,a3 and then call curvefit. CALLING SEQUENCE: YFIT = SINC_FIT(X,Y,A)
• SMALL_WINDOW SMALL_WINDOW Make a 500x400 graphics window. CATEGORY: Stupid little convenience routines. CALLING SEQUENCE: SMALL_WINDOW [,WINDOW_NUM]
• SP PURPOSE: Execute SET_PLOT, and optionally some handy settings. CALLING SEQUENCE: SP[,DEVICE,N_PLOTS] OPTIONAL INPUTS: DEVICE = 0 for set_plot,'PS'
• SQUARE_PLOT SQUARE_PLOT Define !p.region so plots come out with aspect ratio of 1. CALLING SEQUENCE: SQUARE_PLOT KEYWORD PARAMETERS: CENTER - set to center plot in window.
• SYM SYM This function provides a convenient way to utilize the USERSYM procedure to create an extended choice of plotting symbols, and is intended to be used directly with the PSYM keyword to PLOT, OPLOT, etc. CALLING SEQUENCE:
• SYMBOLS SYMBOLS Create custom plotting symbols CALLING SEQUENCE: SYMBOLS,SYMBOL_NUMBER,SCALE SYMBOL_NUMBER: 1 = open circle
• TEXT_WIDTH TEXT_WIDTH Function to determine the actual displayed width (approximately!) of a string of text, in normalized character units, accounting for the fact that non-equal spacing is used when such a string is displayed on a plot using XYOUTS. This function is used, for example, by the PLOT_TEXT and
• TRACK_PLOT TRACK_PLOT A procedure to plot X vs Y in a widget, track the cursor position, and interactively display the Y(X) value. CALLING SEQUENCE: TRACK_PLOT,X,Y X, Y - 1-D arrays
• VALUE_TO_INDEX VALUE_TO_INDEX Given a (1D) ARRAY and a scalar VALUE, determine the array INDEX corresponding to the element of the array that is closest in magnitude to the specified value. CALLING SEQUENCE: Index=VALUE_TO_INDEX(ARRAY, VALUE)
• VECTOR Make a vector of PTS points, with values ranging from MIN to MAX. CALLING SEQUENCE: Result = VECTOR(MIN,MAX,PTS) MIN - Starting value for vector. MAX - Ending value for vector.
• XWD2GIF Convert an XWD image file to a GIF image file. CALLING SEQUENCE: XWD2GIF[,FILE=FILE] KEYWORDS: FILE - The name of the XWD file. If the XWD file is called file.xwd, then the newly created gif file will be called