ESRG UCSB 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

• ACOSD Return the inverse cosine of a value, in degrees rather then radians.
• ADDPATH ROUTINE: addpath PURPOSE: USEAGE: addpath,pathname,cut=cut INPUT: pathname Name of new path to add to this session's directory path. if pathname is already present in !path no action is taken.
• AIRMASS spherical earth effects
• ARMBASETIME number of seconds since jan 1, 1970 00:00:00 UTC. This procedure converts base_time to the current date in yymmdd format, and the number of hours since the most recent Grenich midnight (00:00:00 UTC).
• ASIND Return the inverse sine of a value, in degrees rather then radians.
• AUTORANGE and return a properly formatted tick label. This routine can be used with the axis procedure to add additional axis which are not linearly related to the original axis (see example)
• AVERAGE FUNCTION: This procedure computes the AVERAGE of a the nk fields stored in the array tab (nbcol,nblign,nk). INPUTS : tab --> 3 dimensional array (nbcol x nblign x nk) OUTPUTS : moy --> average of the fields (nbcol x nblign) stdv --> standard deviation (nbcol x nblign) nb --> number of points used in the average
• AXGAP ROUTINE: axgap,pos PURPOSE: draw a "gap symbol" to indicate a gap in the axis number scale. USEAGE: axgap,pos INPUT: pos two element vector indicating x,y data coordinates of the axis break
• AZIMUTH computes the angle between the gradient direction of the field and the y direction (angle measured clockwise). This is is useful for computing the satellite or solar azimuth angle when all you know are the satellite or solar zenith angles. For example the relative azimuth at each point in a satellite image is given by
• BALLOON_DRAG ROUTINE: balloon_drag PURPOSE: compute drag on shere USEAGE: result=balloon_drag(r,rho,v,cd) KEYWORD INPUT: r balloon radius in meters (default=1.0 m) v wind velocity (mph) (default=5 m/s)
• BALLOON_LIFT ROUTINE: balloon_lift PURPOSE: compute lifting capacity of a helium balloon USEAGE: result=balloon_lift(r,rho,kg=kg) KEYWORD INPUT: r balloon radius in meters (default=1.0 m) rho air density at operating alitude (defualt=1.29 kg/m3)
• BARPLOT ROUTINE: barplot PURPOSE: produce a bar plot USEAGE: barplot y bar values fltarr(n) KEYWORD INPUT: nbar number of barplot overlays. Should only be set on the first
• BC wall to wall cross hairs to help read numbers off of plot axis. The graphics function is set to 6 for eXclusive OR. This allows the cross hairs to be drawn and erased without disturbing the contents of the window. Hit RMB to exit
• BOXONMAP Emulate the operation of a variable-sized box cursor (also known as a "marquee" selector).
• BOXPOS output is in normalized coordinates
• CAPTION figures. The character size is determined by the number of characters per line.
• CLASSIFY ROUTINE: CLASSIFY FUNCTION: Display the physical locations of points selected on the basis of image quantities, xa and ya. An interactive cursor box is used to select clusters of points from the 2-d scatter plot of xa vs ya. These points are drawn on a
• CLASSPLT 1. 2-d scatter plot of yy vs xx 2. physical position of selected classes with respect to coastline features.
• CLOUD_ART ROUTINE: cloud_art PURPOSE: draw an idealized cloud USEAGE: cloud_art,pos,bumps=bumps INPUT: pos normal coordinates of cloud frame, [xll,yll,xur,yur] where ll=lower left corner and ur=upper right corner
• CLSTRSHD of a scene. the cluster shade is a test of skewness in the greylevel histogram of each superpixel.
• CMPLXGEN ROUTINE: cmplxgen USEAGE: result=cmplxgen(nx,ny[,/center]) nx,ny dimensions of output KEYWORD INPUT: center if set RESULT is shifted so that the (0,0) point is the central element of the complex array
• COLOR_BAR ROUTINE: color_bar PURPOSE: draw a horizontal color bar USEAGE: color_bar INPUT: levels a vector of physical values (required)
• COLOR_FRAME ROUTINE: color_frame PURPOSE: draw a color background on which to overlay plots USEAGE: result=color_frame(color,pos=pos,xmargin=xmargin,ymargin=ymargin) color the background color of the plot frame KEYWORD INPUT:
• COLOR_KEY NOTE: COLOR_KEY is intended to replace PUT_COLOR_SCALE
• COLOR_PAL ROUTINE: color_pal AUTHOR: Terry Figel, ESRG, UCSB 10-21-92 CALLING SEQUENCE: color_pal PURPOSE: Displays Color palette in a seperate window
• COMPASS on the on the earth's surface, compute the great-circle distance and compass heading from the central point. Distances and azimuth angles about the central point are provided in KM and Degrees.
• CONFILL ROUTINE: confill PURPOSE: display a contour plot with filled contours USEAGE: confill,z,x,y,xrange=xrange,yrange=yrange,charsize=charsize,$ title=title,stitle=stitle,xtitle=xtitle,ytitle=ytitle,$ aspect=aspect,colors=colors,range=range,nlevels=nlevels,$ rmarg=rmarg,pcharsize=pcharsize,lcharsize=lcharsize,$
• CONNECTED are part a continous set of adjacent pixels. Those pixel groupings which contain fewer than NSTRING "on" pixels are
• CONTLEV ROUTINE: contlev PURPOSE: find a good set of contour levels USEAGE: result=contlev(a) INPUT: a an array KEYWORD INPUT:
• COSD Return the cosine of an angle specified in degrees rather than radians.
• COSSCATANG Return the scattering angle of the incident and emerging rays. NOTE: the scattering angle is defined as 180 degrees when sza = vza = 0 and phi = 180.
• COV ################################## program calculates the coefficiency of var1 and var2 ################################## Jan. 1, 1993 ro cov,var1, var2 std1=mstdev(var1,mean1)
• CRYSTAL properties equivalent to a irregular crystal shape.
• CURBOX x1,x2,y1,y2 coordinates of box edges. If XWIN,YWIN,XRNG,YRNG are set, then input is in data coordinates, otherwise in normalized coordinates. KEYWORD PARAMETERS: If this keyword is set, the initial position of the cursor is given by X1,X2,Y1,Y2
• CURSIM pixel values and positions.
• CURSX ROUTINE: cursx USEAGE: cursx,xx,yy,verbose=verbose PROCEDURE: Use the graphics cursor to find xy point on plot. xy point is written to pop-up widget. If a single argument is supplied (XX) it is interpreted as an image or z value which will be evaluated when
• DAVERAGE finds the daylight hour average of yy at each latitude point. Average values are for spring or fall equinox
• DAY2JUL REQUIRED INPUTS: mon ranges from 1-12 day ranges from 1-31 year OUTPUTS: julday Julian day, ranges from 1-365(366)
• DAYAVE given values of day_of_year and latitude
• DCOLORS scale. If SQUEEZE is set pre-existing color scale is squeezed to fit between color index n_elements(r) and !d.n_colors.
• DEGRADE FUNCTION degrade PURPOSE: degrade image resolution by a factor of two USEAGE: result=degrade(array) INPUT: array an image array of dimension NX x NY, where both nx ny are divisible by 2. If nx or ny are not divisible by
• DENS2D of points with coordinate x and y
• DIGITIZE ROUTINE: digitize PURPOSE: digitize hardcopy graphical information. USEAGE: digitize,x,y INPUT: none KEYWORD INPUT: xr x axis range of hardcopy plot, prompted for if not supplied
• DOC ROUTINE: doc PURPOSE: find and display help for a named procedure USEAGE: doc,'name' name name of idl .pro file. Asterisk characters, "*", in NAME specify wild card matches to 1 or more arbitrary characters. PROCEDURE: DOC searches through the files /local/idl/help/*.help
• DOCKEY contain matches for specified keywords
• DYDX In most cases this should be more accurate than the IDL userlib procedure DERIV.
• EARTHDIST Calculate the great circle distance (in km) based on lats and lons.
• EI Set the system variable to allow for large pasting of data using X. Only necessary for the alphas. This has the side effect of not allowing use of the editing (arrow) keys. This procedure toggles this ability on and off. NOTE: This is probably a bug in IDL and therefore the need for this procedure will disappear in the near future.
• ENDPS close postscript file, reopen display
• EXPINT the exponential integral of index n is given by
• EYE ROUTINE: eye PURPOSE: draw an eye symbol to show observer position and look direction USEAGE: eye,x0,y0,angle=angle,size=size,color=color,icolor=icolor,$ data=data,device=device INPUT: x0,y0 coordinates of eye symbol position (normal coordinates by default)
• FIGNUM automatical increment a figure number index and draw the number on a sequence of plots.
• FILL_ARR ROUTINE: fill_arr USEAGE: fill_arr,a,ii fill_arr,a,ii,niter=niter,omega=omega,tol=tol,po=po PURPOSE: fill in undefined regions of a 2-d array by interpolation a array with some undefined points ii index array of good image points,
• FILL_IMAGE ROUTINE: fill_image USEAGE: fill_image,a,ii PURPOSE: fill in undefined regions of a 2-d array by interpolation a image array with some undefined points ii index array of bad image points, E.G., ii=where(aa eq 999)
• FINDEX ROUTINE: findex PURPOSE: Compute "floating point index" into a table for use with INTERPOLATE. USEAGE: result = findex(u,v) INPUT: u a monitically increasing or decreasing 1-D grid
• FINDRNG spanning range x1 to x2
• FINTERP UVAR(i,j,k...) into TABLE(*,i,j,k...) or TABLE(*). For example, if uvar(i,j) is half way between table(4,i,j) and table(5,i,j) then result(i,j)=4.5.
• FLICKER Flicker between two output images
• FLIGHT_ANGLE in coordinate system attached to an aircraft.
• FONTS INPUTS: none author: Paul Ricchiazzi jan94 Institute for Computational Earth System Science University of California, Santa Barbara
• FORDATA defining variable NAME with data values v
• FORDATIN ROUTINE: fordatin PURPOSE: read fortran data statements USEAGE: result=fordatin(file,varname) INPUT: file name of fortran source file containing target data statement (string)
• FORM_FEED routine write a form feed (ascii 12) to file connected to LUN useage form_feed,lun input lun unit number
• FREE_ALL ROUTINE: free_all PURPOSE: free up all logical units USEAGE: free_all OUTPUT: none DISCUSSION: Produces a list of all open files. For each item in the
• GENGRID of dimension (nn0,nn1,nn2,nn3,nn4) where nn0=n_elements(a0),
• GEN_COASTLINE ROUTINE: GEN_COASTLINE USEAGE: gen_coastline gen_coastline,alat,alon,file=file,image=image PURPOSE: generate coastal outline map for satellite images INPUTS: ALAT 2-D array of image latitude values (one value for each image pixel)
• GIF_READ ROUTINE: gif_read PURPOSE: copy image on current window to a gif image file USEAGE: gif_read,file file gif file name KEYWORD INPUT: view if set display the image
• GIF_WRITE ROUTINE: gif_write PURPOSE: copy image on current window to a gif image file USEAGE: gif_write,file file output file name, image will be written in gif image format KEYWORD INPUT: wid index of the idl window from which to copy the image,
• GLOBE_IMAGE ROUTINE globe_image AUTHOR: Terry Figel, ESRG, UCSB 10-21-92 USEAGE: globe_image,image globe_image,image,animation,title=title,limits=limits,$ windowsize=windowsize PURPOSE: Display an image on a rotating globe
• GLOBE_IMAGE2 ROUTINE globe_image AUTHOR: Terry Figel, ESRG, UCSB 10-21-92 USEAGE: globe_image,image globe_image,image,animation,title=title,limits=limits,$ windowsize=windowsize PURPOSE: Display an image on a rotating globe
• H2OSAT routine: h2osat purpose: compute saturated density of water vapor useage: result=h2osat(t) temp air temperature in kelvin result water vapor density at 100% saturation (g/m3) if keyword vp is set result is saturated water
• HILIGHT FUNCTION: This procedure - select values according to a user defined criterion - display the selected values. - display the histogram of the selected values in the array tab. INPUTS : tab1 --> 2 or 3 dimensional array (NO DEFAULT)
• HILITE ROUTINE: hilite,im,select EXAMPLE: hilite,avhrr1,where(avhrr3-avhrr4 lt 5.) PURPOSE: To hilite a region which satifies a specified set of conditions INPUT: im 2-D image array (any type but string) select Index array of points to hilite. These may be
• HIST call histo procedure to plot a histogram with correct values along the x-axis. Calculates min, max for you. If binsz is set, uses it, otherwise = 1.
• HIST2D Plot a 2-dimensional histogram.
• HISTO FUNCTION: This procedure displays the histogram of the array tab1. INPUTS : tab1 --> array : mini --> minimum value : maxi --> maximum value : bin --> size of bin
• HMS NAME: hms PURPOSE: convert time in seconds to a time string in hh:mm:ss format USEAGE: time_string=hms(time) INPUTS: time (seconds) RESTRICTIONS time must be positive KEYWORDS: none
• IMAGE_IT This routine plots an image onto a predifined coordinate system. The calling order would be map_set,/cont image_it,bytscl(image),lat,lon map_set,/cont Notice I used the bytscl of image, to take up the full color map
• INSIDE lie inside a given polygonal region
• INTEGRAL ROUTINE: integral USEAGE: result=integral(x,y,xrange=xrange,accumulate=accumulate) PURPOSE: integration by trapezoid rule x vector of x axis points. If XRANGE is not set, limits of integration will be from x(0) to x(n_elements(x)-1) If XRANGE is not set, X need not be monitonic.
• INTERP ROUTINE: interp PURPOSE: interpolate on a table of up to 5 dimensions USEAGE: result=interp(table,utab,u,[vtab,v,[xtab,x,[ytab,y,[ztab,z]]]]) table table of values depending on upto 5 parameters utab 1-d (monitonically increasing) table of 1st parameter u array of values of 1st parameter
• INTERSECT Return the an array that is the intersection of the two input arrays.
• JD2YMD Find year, month, day from julian day number.
• JUL2DAY Convert the inputted Julian day of year to year, month, day.
• KERNEL oriented at angle ANGLE. The IDL procedure CONVOL can be used to do the convolutions.
• LANGLEY the Langley procedure. Additionally, produce Langley scatter plot of direct beam flux vs airmass and show fit.
• LATLON If the current window has map coordinates (i.e., MAP_SET has been used to set up a map projection), LATLON tracks the longitude and latitude of the mouse location and displays them in a separate window.
• LCT ROUTINE: lct PURPOSE: try all predefined color tables USEAGE: lct,index INPUT: index if set index specifies the first color table to try index final color table index
• LEGEND ROUTINE: legend PURPOSE: draws a plot legend USEAGE: legend,labels,pos=pos,linestyle=linestyle,psym=psym,clrbox=clrbox,$ color=color,thick=thick,fg_color=fg_color,bg_color=bg_color,$ box=box,numsym=numsym,ystretch=ystretch,silent=silent,$ center=center,fill=fill,right=right,norm=norm,spos=spos,$
• LEGENDRE ROUTINE: legendre PURPOSE: compute legendre polynomial USEAGE: result=legendre(n,x) INPUT: n order of polynomial x argument of polynomial
• LENSTR ROUTINE: lenstr USEAGE: result=lenstr(str) str a single string or string array. result length of the string(s) in normalized units the number of elements of RESULT matches the number of elements of STRING.
• LESS ROUTINE: less PURPOSE: print interactively selected portions of arrays or vectors USEAGE: less,p1,p2,p3,p4,p5,p6,p7,p8,p9,p10,p11,p12,index=index INPUT: p1,p2,... a set of vector quantities to print. all vectors must
• LOCATE This routine is used by COASTLINE to find the array indices of a given geographical point within irregular latitude and longitude arrays. Given the coordinate arrays alat(i,j) and alon(i,j), LOCATE finds the "floating point" indices x,y such
• LOOPIND ROUTINE: loopind PURPOSE: evaluate a sequence of nested indicies USEAGE: loopind,ii,n1,i1,n2,i2,n3,i3,n4,i4,n5,i5,n6,i6 INPUT: n1 number of elements in first dimension n2 number of elements in second dimension
• LS author: Paul Ricchiazzi jan93 Institute for Computational Earth System Science University of California, Santa Barbara
• MAP_CITIES ROUTINE: map_cities PURPOSE: plot city locations and print city names form cities.dat database USEAGE: map_cities INPUT: none KEYWORD INPUT: file
• MAP_LAMBERT ROUTINE: map_lambert PURPOSE: transformation into lambert azimuthal map projection USEAGE: map_lambert,lat0,lon0,lat,lon,u,v lat0 latitude of tangent point lon0 longitude of tangent point lat array of latitudes
• MEAN ROUTINE: mean AUTHOR: Terry Figel, ESRG, UCSB 2-21-93 CALLING SEQUENCE: mean,var INPUT: var an array PURPOSE: return the mean of var
• MENUW ROUTINE: menuw PURPOSE: create a menu widget and return a selection USEAGE: w=menuw(choices,title=title,group=group,$ font=font,ysize=ysize,done=done) result=menuw(w) while menus(w,ii) do (something that depends on ii)
• MENUWS ROUTINE: menuws PURPOSE: create a multiple value menu widget and return a selections USEAGE: w=menuws(choices,title=title,group=group,$ font=font,ysize=ysize) choices string array containing choices KEYWORD INPUT:
• MIN_CURVE_SURF Interpolate a regular or irregularly gridded set of points with a minimum curvature spline surface.
• MODCT modify the image display color tables so the full range runs from one color index to another.
• MODE Return the mode of an array.
• MODTRNS ROUTINE: modtrns PURPOSE: extract transmission from modtran tape8, display transmission plots USEAGE: modtrns,buf,archive=archive,file=file,xrange=xrange,$ title=title,sort=sort KEYWORD INPUT:
• MON2STR Return a string containing a month's name.
• MOYENVERT Return the an array that is the "vertical" average of a stack of
• MPRANK image superpixel subregions
• MSTDEV Compute the standard deviation and, optionally, the mean of any array.
• MUSLOPE ROUTINE: muslope PURPOSE: compute dot product of surface normal to incomming solar ray USEAGE: result=muslope(sunzen,sunaz,nrmzen,nrmaz) INPUT: sunzen solar zenith angle (degrees) sunaz solar azimuth angle (clockwise from due north, degrees)
• MVE ROUTINE: mve AUTHOR: Terry Figel, ESRG, UCSB 10-21-92 CALLING SEQUENCE: mve,var INPUT: var an array PURPOSE: print out the max min mean and std deviation of var
• NCDF_GET_1FIELD Get a variable and its metadata from a NetCDF file Written 1 April 1993 by William Weibel, UCLA Atmospheric Sciences Source code control Id %W% %G% USEAGE: ncdf_get_1field, file, varname, z, name arguments file string containing the name of the NetCDF file
• NCDF_GET_FIELD ROUTINE: NCDF_GET_FIELD Get a variable and its metadata from a NetCDF file. Calling Sequence ncdf_get_field, File, Varname, Z, Name, C0, C1, C2, ... File A string containing the name of an existing NetCDF file.
• NCDF_INFO ROUTINE: NCDF_INFO PURPOSE: Summarize the information from a NetCDF file USEAGE: NCDF_INFO, File file A string containing the name of an existing NetCDF file. KEYWORD_INPUT: dir if set to one (an integer) the current directory is scanned
• NEWCOV ################################## program calculates the coefficiency of var1 and var2 ################################## ro newcov,var1, var2,cov std1=mstdev(var1,mean1) std2=mstdev(var2,mean2)
• NOT_SET Return the values of array2 that are not in array1. If array2 not defined, use lindgen(max(array1+1))
• N_LINES ROUTINE: n_lines PURPOSE: count number of lines in a file USEAGE: result=numlines(file,nw) INPUT: file file name result number of lines in file
• O2O2CONT ROUTINE: o2o2cont PURPOSE: plot o2*o2 continuum optical depth USEAGE: o2o2cont INPUT: KEYWORD INPUT: DISCUSSION:
• OBAND between y1 and y2 as a function of x. This is useful for indicating an error bounds on an x-y plot.
• PAUSE Momentarily stop execution until a mouse key is pressed. While in the paused state the cursor is changed to what looks like an arrow pointing down on a button. When any of the mouse buttons are pressed the cursor returns to its original form and execution continues.
• PCA Carry out a Principal Components Analysis (Karhunen-Loeve Transform)
• PFILL words into a paragraph that consists of several lines each with a given number of characters (60 character default). This procedure can be use used with LEGEND and CAPTION to produce nicely formated figure captions. The nice thing about PFILL is that it will properly compute the length of lines which contain text escape sequences such as a =
• PHIST plot histogram
• PICKC ROUTINE: pickc PURPOSE: interactive adjustment of a series of discreet color values USEAGE: pickc,colrng,labels=labels,group=group colrng 2 element vector specifying the color index range accessable to pickc (default=[0,!d.n_colors-1]) KEYWORD INPUT:
• PICK_CURSOR routine: pick_cursor useage: pick_cursor inputs: none outputs: none side effects: changes the graphics cursor
• PLACETEXT Put text on a plot using LEGEND.PRO.
• PLANCK ROUTINE: planck USEAGE: result=planck(ww,t [,/microns]) ww wavenumber (cm-1) or wavelength (microns) if /microns set, can be either scalar or vector t temperature (degrees K), can be scalar or vector. result black body spectral intensity, commonly known as the
• PLOT3D_ROT ROUTINE: plot3d_rot PURPOSE: plot a 3-D trajectory and rotate plot interactively USEAGE: plot3d_rot,xx,yy,zz INPUT: xx,yy,zz vector trajectory of path
• PLOTCOMPARE Scatter plot two similar variables, print statistics.
• PLOTPAGE ROUTINE: plotpage PURPOSE: USEAGE: plotpage,x,y,npage=npage INPUT: x variable ploted along x-axis y variable ploted along y-axis,
• PLOTSYM call can create symbols of varying size, fill color, and outline color and thickness. Symbols of arbitrary shape can be created. Note that the symbols may be filled with a different color then the outline color. This can dramatically unclutter the appearance of densely packed scatter plots. See example.
• PLOT_CYCLE set the position of new plots so that they fill the frame in a given order. New plots cause only a single subframe to be overwritten. Old frames are left for comparison.
• PM Shorthand way of setting !p.multi.
• PMOM ROUTINE: pmom PURPOSE: compute legendre moments of scattering phase function USEAGE: pmom,mu,phase,nm,pm INPUT: mu cosine of polar angle, in range -1, 1 phase phase function at each polar angle, normalization is arbitrary
• PNTS_NEAR routine: pnts_near purpose: return index array of points within radius useage: pnts_near,plon,plat,lonrng,latrng,nx,ny,radius,ii,nc plon longitude of point plat latitude of point lonrng longitude range (two element vector)
• POLAR_ORTHO routine polar_ortho alat latitude array alon longitude array outer_lat outer latitude limit xn x coordinate to which (alat,alon) maps (normalized 0-1) yn y coordinate to which (alat,alon) maps (normalized 0-1)
• POLY_XY where poly_xy = SUM [ k(i,j) * x^i * y^j ] the sum extends over i and j
• POLY_XYZ where poly_xyz = SUM [ k(i,j,k) * x^i * y^j * z^k] the sum extends over i,j,k
• POLY_XYZ_FIT dependent variable u to three independent variables x,y and z. The trivariate polynomial function of x,y,z is defined as ufit=SUM [ k(i,j,k) * x^i * y^j * z^k] (summed over i,j and k)
• POLY_XY_FIT dependent variable u to the independent variables x and y. The bivariate polynomial function of x and y is defined as ufit=SUM [ k(i,j) * x^i * y^j ] (summed over i and j)
• PRANK percentile ranking within ARRAY. For example, median_of_array=prank(array,50)
• PRINCAX NAME: princax PURPOSE: principle axis decomposion of a 2d distribution of points USEAGE: princax,xx,yy,ev1,ev2,v1,v2 INPUTS: xx, yy coordinate posititions KEYWORD INPUTS:
• PSD ROUTINE: psd USEAGE: psd,image,wavenum,power,scale=scale,view=view,$ unit=unit,title=title,binpower=binpower,$ xrange=xrange,density=density
• PUTSTR use cursor to position and orient text on a plot Use PUTSTR to interactively position a text label on a plot. The size and orientation of the text label are adjusted by pressing the left or middle mouse buttons. Initially the LMB and MMB control the size of the label. To enable the use of the LMB and MMB to control the label orientation angle, press the RMB and select the ANGLE menu item.
• PWD routine pwd purpose print the current working directory cwd directory name string. if present in argument list directory string is not printed to terminal. author: Paul Ricchiazzi jan93 Institute for Computational Earth System Science
• QUEUE ROUTINE: queue PURPOSE: display print queues USEAGE: queue PROCEDURE: choose print queue from pop up menu AUTHOR: Paul Ricchiazzi 01 Jun 95 Institute for Computational Earth System Science
• RADTEMP ROUTINE: radtemp PURPOSE: compute radiation temperature from a radiance distribution USEAGE: radtemp,w,r,microns=microns INPUT: w wavelength in microns or wavenumber in cm-1 r radiance in w/m2/um/str or w/m2/cm-1/str
• RANDATA and array size
• RANDF routine: randf purpose: generate random time history data with given power spectrum useage: randf,n,slope slope power law slope of power spectrum (default=4) n number of elements in time history. Since an fft is used to compute the random numbers powers of 2 are most efficient.
• RAYLEIGH ROUTINE: rayleigh PURPOSE: compute rayleigh optical depth at a give wavelength USEAGE: result=rayleigh(wl,ps=ps,idatm=idatm) INPUT: wl wavelength in microns KEYWORD INPUT:
• READBUF purpose: read a multi-dimension data buffer from a named ASCII file USEAGE: readbuf,file,buf readbuf,file,buf,tag=tag,ntag=ntag,nskip=nskip,point=point,$ err=err,nc=nc,nl=nl,awk=awk file file name. If file name ends in a .gz or .Z suffix, the file is first uncompressed by running it through zcat.
• READ_TEXT ROUTINE: read_text PURPOSE: read text from a file USEAGE: result=read_text(file,tag) INPUT: file name of input file (string). if only one argument is supplied it is interpreted as the tag value and
• READ_TOMS ROUTINE: read_toms,file,ozone PURPOSE: read toms ascii data files USEAGE: read_toms,ozone,lons,lats INPUT: file Name of the toms archive data file. ozone ozone in dobson units in an global output grid
• REDUNDANT ROUTINE: redundant PURPOSE: returns the indicies of elements array which are non-unique USEAGE: result=redundant(array) INPUT: array a vector array KEYWORD INPUT:
• REGRID a regular grid.
• REGSTAT ROUTINE: regstat PURPOSE: display regional statistics of an image. USEAGE: regstat,im INPUT: im 2-d array KEYWORD INPUT: none
• RELHUM ROUTINE: relhum PURPOSE: compute relative humidity from wet and dry bulb temperature and pressure USEAGE: result=relhum(td,tw,p) INPUT: t ambient (dry bulb) temperature (celsius)
• REPCHR ROUTINE: repchr PURPOSE: produces a string composed of repititions of a given character USEAGE: result=repchr(n,c) n number of repititions c character to repeat print,repchr(20,'-')
• RHOZ ROUTINE: rhoz USEAGE: result=rhoz(p0=p0,t0=t0,z=z,lr=lr) PURPOSE: compute air density at altitude z KEYWORD_INPUTS: p0 surface pressure in mb (default=1013.0 mb) t0 surface temperature in kelvin (default=273.0 K)
• ROOTS where xx is a (possibly non-monotonic) table of values and x is a scalor. ROOTS returns -1 if no roots are found.
• ROWCOL ROUTINE: rowcol PURPOSE: compute the plot frame position of next plot USEAGE: result=rowcol(ix=ix,iy=iy) INPUT: KEYWORD INPUT: ix the x position index starting from 0 on left,
• SATGRID polar orbiting satellites
• SCONVOL with a response function.
• SIND Return the sine of an angle specified in degrees rather than radians.
• SLOPE NAME: slope PURPOSE: compute a two point fitting function, y=f(x) USEAGE: slope,a,b INPUTS: none KEYWORDS: none OUTPUTS:
• SOLVE2 x and y. In The non-linear equations are formally
• SPHASE ROUTINE: sphase,polar,g,type=type PURPOSE: compute sphase greenstein phase function USEAGE: sphase,polar,g INPUT: mu cosine of polar angle (mu=1 in forward direction) g asymmetry factor
• SPRITE interactive display of multi parameter correspondences. Points corresponding to a single independent index variable is hilighted by a small "sprite" symbol on several plot frames simultaneously. The sprite position is controlled by the master index, which can be incremented/decremented via the mouse.
• STEPIND ROUTINE: stepind PURPOSE: step through a sequence of nested indicies USEAGE: result=stepind,ic,n1,i1,n2,i2,n3,i3,n4,i4,n5,i5,n6,i6 INPUT: ic one dimensional index. incremented or decrimated by LMB or MMB, respectively. if the starting value of ic
• STEP_CT NOTE: the rgb color value of the top color scale index is
• STRIP_FN Return a filename stripped of all directory information.
• STRMATCH ROUTINE: strmatch PURPOSE: check for string match to a wild card specification USEAGE: result=strmatch(str,spec) str string spec wild card specification OUTPUT: 1 if STR matches SPEC
• STRWHERE ROUTINE: strwhere PURPOSE: a "where" operator for strings matching a set of string wild cards USEAGE: result=strwhere(starr,wildcard) INPUT: starr an array of strings
• SUNGLINT reflect sunlight to satellite observation point by purely specular reflection.
• SUPERPIX ROUTINE: superpix USEAGE: superpix, a, binsz, abin, sbin superpix, a, binsz, abin, sbib, /align, /compare PURPOSE: compute super pixel average and standard deviation of a scene a image array
• SWATH pass on a predifined ploting grid (usually setup by map_set)
• TABLE ROUTINE: table PURPOSE: print a table of vectors in nicely formatted columns USEAGE: table,p1,p2,p3,p4,p5,p6,p7,p8,p9,p10,p11,p12,f=f INPUT: p1,p2,... a set of vector quantities to print. all vectors must be of the same length
• TAND Return the tangent of an angle specified in degrees rather than radians.
• TDEWP relative humidity. The dew point is the temperature to which air must be cooled at constant pressure and constant mixing ratio to reach 100% saturation with respect to a plane water surface
• TERM_SIZE ROUTINE: term_size PURPOSE: find the number columns and number of lines in the idl terminal USEAGE: term_size,xs,ys INPUT: KEYWORD INPUT: xs number of columns
• TEXTCLOSE procedure to close file for text output as specifed by the (non-standard) system variable !TEXTOUT.
• TEXTOPEN Procedure to open file for text output. The type of output device (disk file or terminal screen) is specified by the TEXTOUT keyword or the (nonstandard) system variable !TEXTOUT.
• TEXT_BOX Name : text_box Purpose : Writes a text message within a box in a graphics window. Description: This procedure writes a short text message within a box-shaped area in a graphics window. The message may be split at word boundaries into several lines, and the character size and orientation may be adjusted for the text to fit within the box.
• THICK ROUTINE: thick PURPOSE: thicken lines and characters on postscript output. USEAGE: thick,thck,cthck INPUT: thck the thickening factor. if not set all graphics system variables related to line thickness are set to 1
• TIMESTAMP the device window
• TOGGLE ROUTINE: toggle USEAGE For opening a postscript file: toggle,color=color,landscape=landscape,portrait=portrait, $ legal=legal,queue=queue,print=print,filename=filename, $ eps=eps,xoffset=xoffset,yoffset=yoffset,xsize=xsize, $ ysize=ysize,_extra=_extra
• TRACE system and the cursor/mouse. TRACE can be used either to obtain the vector of x and y vertices of a path in data coordinates or, when used with TVIM, the array of image indecies of all points along the path or inside the defined
• TRI_SURF This function Interpolates a regularly or irregularly gridded set of points with a C1 smooth quintic surface.
• TVB Use the CURBOX routine to select a region of interest. The sub-array is displayed in another window at full resolution For each new sub-array the selected subscript range is printed to the terminal.
• TVIM ROUTINE: tvim USEAGE: tvim,a tvim,a,scale=scale,range=range,xrange=xrange,yrange=yrange, $ aspect=aspect,title=title,xtitle=xtitle,ytitle=ytitle, $ noaxis=noaxis,interp=interp,colors=colors,c_map=c_map, $ stitle=stitle,rmarg=rmarg,clip=clip,labels=labels, $
• TV_POLAR Display of images defined in polar coordinates (without resorting to IDL's mapping routines).
• UAV_PATH on a moving ship or plane. UAV_PATH provides an easy user interface to 1) select measured quantities to plot and 2) run SPRITE to hilight the correspondences of different data channels as a function of time and position.
• VSCAT DEFINE_REGION procedure to select a region
• W11X8 8.5 x 11 piece of paper in landscape orientation
• W8X11 8.5 x 11 piece of paper
• WHICH given idl procedure name. The directory precedence is set by the system variable !path. The file name may contain any wild card characters understood by the operating system. In the case that a given procedure is found in more than one directory, the first listed pathname is the one compiled by the IDL interpreter in response to a .run statement.
• WINFULL ROUTINE: winfull PURPOSE: create full screen window USEAGE: winfull INPUT: KEYWORD INPUT: DISCUSSION:
• WMX_MSEL title=title, xpos=xpos, ypos=ypos, $ rtcode=rtcode WaveMenu/Widgets: set flags / multiple selection from list START OF DESCRIPTION subroutine (c) IPI, Uni Hannover 02'94, modified 02'94 METHOD: using IDL-Widgets (registered)
• WRITE_IN_BOX Project : SOHO - CDS Name : WRITE_IN_BOX Purpose : Writes a text message within a box in a graphics window. Explanation : This procedure writes a short text message within a box-shaped area in a graphics window. The message may be split at word boundaries into several lines, and the character size and
• WRITE_WIN ROUTINE: write_win PURPOSE: copy image on current window to a gif image file USEAGE: write_win,file file output file name, image will be written in gif or tiff image format KEYWORD INPUT:
• WSELECT ROUTINE: wselect PURPOSE: wset to window selected by a mouse click USEAGE: wselect DISCUSSION: the LMB selects the window and exits WSELECT, the MMB kills the window and remains within the WSELECT program loop. The WSELECT program loop
• XAXIS_MONTH is day of year
• XDATENT ROUTINE: xdatent PURPOSE: widget for text data entry. USEAGE: xdatent,labels,value,ncol=ncol,group=group INPUT: labels string array of labels for data entry field KEYWORD INPUT:
• XGLOBE ROUTINE: XGLOBE USEAGE: XGLOBE PURPOSE: Display a world map and allow user to zoom in on a given region INPUT: none OUTPUT: none DONE quit XGLOBE
• XHELP Display an IDL procedure header using widgets and the widget manager.
• XLESS ROUTINE: xless PURPOSE: create a text widget to scroll through a string array or a file USEAGE: xless,text,file=file,space=space,xsize=xsize,ysize=ysize,$ xpad=xpad,ypad=ypad,title=title,font=font,group=group,$ unmanaged=unmanaged
• XMAKEDRAW ROUTINE: xmakedraw PURPOSE: create a simple draw widget with a done button USEAGE: xmakedraw,group=group,x_window_size=x_window_size,$ y_window_size=y_window_size,widget_label=widget_label,$ make_draw_index=make_draw_index,nowait=nowait INPUT: none required
• XMAP ROUTINE: xmap PURPOSE: Display a world map and allow user to zoom in on a given region INPUT: none OUTPUT: none INTERACTIVE CONTROLS: BUTTON EVENTS WITHIN MAP FRAME:
• XMESSAGE routine: xmessage purpose: create a simple set of widget labels useage: xmessage,labels,charsize=charsize,wbase=wbase,group=group,$ title=title,kill=kill,relabel=relabel,wlabels=wlabels,$ done=done,font=font input:
• XMULTI routine: xmulti purpose: set up margins for horizontally stacked multi frame plot input: p named variable, contains stuff you don't need to know the contents of p are changed after each call Keyword input
• X_AXIS ROUTINE: x_axis PURPOSE: label x axis tick marks with the actual values of the x vector. USEAGE: x_axis,x,y,xticknames=xticknames,xtitle=xtitle, $ charsize=charsize,yspace=yspace,ticklen=ticklen, $ gridstyle=gridstyle,extend=extend
• YMD2JD From Year, Month, and Day compute Julian Day number.
• YMULTI routine: ymulti purpose: set up margins for vertically stacked multi frame plot input: p named variable, contains stuff you don't need to know the contents of p are changed after each call Keyword input
• ZENDAY hours per day and maximum solar zenith as a function of latitude and day of year
• ZENSUN geographic coordinates, date and time.
• ZOOMBAR Emulate the operation of a variable-sized box cursor (also known as a "marquee" selector).