Harris 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

• ADJCT Interactively adjusts color tables using mouse input.
• AMULTI reasonable display of "number" plots. Tries to force 4 columns.
• AMULTI2 reasonable display of "number" plots. Tries to force 2 columns.
• CAT_FILE (be they on the current host or on another host, be they normal, compressed or in a zoo file)
• CLEAN_PHASE function will add or subtract PERIOD in order to make the phases more logical in sequence Uses first element as reference
• CLEAR (if they are not part of a widget), redraw TEK screens, close PostScript files etc.. It will also attempt to close and free all LUNs.
• CLEARPLT ofthe system plot variables
• CLEAR_WIDGETS NAME: CLEAR_WIDGETS PURPOSE: This procedure will DESTROY ALL widgets CATEGORY: Utility CALLING SEQUENCE: clear_widgets clear_widgets, base_id INPUTS:
• CLOSEST Find the element of ARRAY that is the closest in value to VALUE
• COHERENCY NAME: COHERENCY PURPOSE: determine the statistical COHERENCY between two time series CATEGORY: Time-series/Spectral analysis CALLING SEQUENCE: COHERENCY, ts1,ts2, DF=df
• COPYRIGHT plot (but outside plot region). Generally only useful for PostScript plots as the plotted page is smaller than the physical page therefore text outside the plot region can still be seen. Not so useful for window dumps unless the user has reduced the plot region by setting !P.REGION.
• CURVEFIT Non-linear least squares fit to a function of an arbitrary number of parameters. Function may be any non-linear function where the partial derivatives are known or can be approximated.
• DATE_LABEL The JHUAPL routine "timeaxis" generally does a better job, with more flexible labelling format. DATE_LABEL works best for time ranges from a few days to several years.
• DATE_SEL To allow interactive selection from a series of dates
• DAYMONTH This subroutine returns a 3 char mnemonic for month (lower case), the day in the month, the number of days in the month, and the month number, when given a year number and day of the year NB: Leap years ARE taken into accoount
• DEFINECT NAME: definect PURPOSE: defines a colour table with given number of colours CATEGORY: Display CALLING SEQUENCE: definect, ncolours, /load definect, ncolours, /load, ct=ct definect, ncolours, red=r, blue=b, green=g
• DEF_CIRCLE either hollow or filled. Use !p.sym=8 to use it
• DEMOD Shifts wanted frequency down to base-band. Then applies a low-pass filter
• DISP3 Show a 2d array three ways in a display that combines SHADE_SURF, CONTOUR, and an IMAGE.
• DIST2 to its radius from the centre. CATEGORY: Signal Processing.
• DIST3 function proportional to its radius from the centre. CATEGORY: Signal Processing.
• DIST4 function proportional to its radius from the centre. This is then stepped steps times CATEGORY: Signal Processing.
• ELLIPSOID NAME: ELLIPSOID PURPOSE: create an ellipsoidal gaussian volume density function CATEGORY: Signal Processing. CALLING SEQUENCE: result = ELLIPSOID(n) result = ELLIPSOID(n,aspect=aspect)
• ENCAPS Part of the PSETUP Suite of procedures that provide easy and versatile customisation of the plotted page for PostScript (plus other functionality)
• EVERY_2ND_XTICK every 2nd tick
• FFT_XCORR NAME: fft_xcorr PURPOSE: Perform a cross-correlation using an FFT CATEGORY: Time-Series/Spectral analysis CALLING SEQUENCE: fft_xcorr, tdata1, tdata2, NORMAL_FACTOR=nf INPUTS: tdata1,tdata2 = (Complex) vectors containing the time series
• FILTER NAME: filter PURPOSE: perform digital filtering in the frequency domain via FFT CATEGORY: Time-series/Spectral analysis CALLING SEQUENCE: result = filter(time_series, /TIME, $
• FMOFT an orthogonal basis set based on the sine function.
• FUNCTION DECILE This function will compute the 10,50 and 90 %iles from the given input vector unless the second parameter is supplied, in which case those values will be used.
• FUNCT[1] EVALUATE THE SUM OF A GAUSSIAN AND A CONSTANT AND OPTIONALLY RETURN THE VALUE OF IT'S PARTIAL DERIVATIVES. NORMALLY, THIS FUNCTION IS USED BY CURVEFIT TO FIT THE SUM OF A SPECTRAL LINE AND A VARYING BACKGROUND TO ACTUAL DATA.
• FUNCT[2] EVALUATE THE SUM OF A x*GAUSSIAN AND A CONSTANT AND OPTIONALLY RETURN THE VALUE OF IT'S PARTIAL DERIVATIVES. NORMALLY, THIS FUNCTION IS USED BY CURVEFIT TO FIT TO ACTUAL DATA.
• GAUSSFIT Fit y=f(x) where: F(x) = a0*exp(-z^2) + a3 and z=(x-a1)/a2 a0 = height of exp, a1 = center of exp, a2 = 1/e width, a3 = constant term Estimate the parameters a0,a1,a2,a3 and then call curvefit.
• GAUSSIAN_FIT Fits a gaussian using a least square polynomial fit (poly_fit) to the log of the data.
• GETPERIOD_SCL when the main scaling is linear in frequency.
• GET_TIMES To allow interactive selection from a series of dates
• HISTO_2D produces an histogram from arbitrary x,y data
• LEAPYR Very useful for finding number of days in a year. eg. NUM_DAYS_IN_YR = 365 + leapyr(year)
• MTHNUMDAY This subroutine calculates the day number of the start of the month, the number of days in the month, and a 3 char mnemonic for month (lower case), when given a year number and the month number if the month number is invalid then stday=-1
• OPLOTGAPPY a procedure to oplot the sections of the x,y arrays that contain values that are less than ymax and or xmax
• OPLOTGAPPY_1 a procedure to oplot the sections of the x,y arrays that contain values that are less than ymax and or xmax
• PLACETITLES information line onto page. Useful for multiple plots to label the entire set of figures. Also useful for single page plots which already have labelling on the top and bottom, for example when there are multiple scales such as frequency at the bottom and period at the top. This routine is most useful for postscript files as the titles are placed near the borders of the plot region (!p.region). This may cause the titles (and always causes the infoline) to be partially off of the window in X-window applications.
• PLOTERR Plot data points with accompanying error bars.
• PLOTUTES_MENU NAME: plotutes_menu PURPOSE: provides a simple menu of often used plot utilities CATEGORY: plot utility CALLING SEQUENCE: plotutes_menu plotutes_menu,ps,IMAGE=image OPTIONAL PARAMETERS:
• PLOT_CIRCLE NAME: plot_circle PURPOSE: plots a circle on the current plot device CATEGORY: plot utility CALLING SEQUENCE: plot_circle, size, /FILL, COLOR=c, THICK=t, /OVERPLOT INPUTS: size = radius of circle in data units KEYWORDS:
• POLAR_HIST produces a 2D histogram from polar data
• PSCOLOUR Part of the PSETUP Suite of procedures that provide easy and versatile customisation of the plotted page for PostScript (plus other functionality)
• PSETUP customisation of the plotted page for PostScript (plus other functionality)
• PSFILE (sets plot device to PS) Part of the PSETUP Suite of procedures that provide easy and versatile customisation of the plotted page for PostScript (plus other functionality)
• PSRES Part of the PSETUP Suite of procedures that provide easy and versatile customisation of the plotted page for PostScript (plus other functionality)
• RCLEAR (if they are not part of a widget), redraw TEK screens, close PostScript files etc.. It will also attempt to close and free all LUNs. The user is then returned to the top level
• RESAMPLE order to resample. Any resampled points which are too large (1.5*YLIMIT) are set to the mean. These points are labelled by the BADPTS keyword
• RESETPLT of the system plot variables to their initial values
• RESET_SIZE Part of the PSETUP Suite of procedures that provide easy and versatile customisation of the plotted page for PostScript (plus other functionality)
• RND This function will round the given value up/down/in or out using the second parameter as the modulo (default is 1)
• SAVE_SYS[1] variables. Since these routines use a stack system they should always be used in pairs to ensure correct restoration. RESTORE_SYS pops the last set of variables off the stack
• SAVE_SYS[2] variables. Since these routines use a stack system they should always be used in pairs to ensure correct restoration. SAVE_SYS pops the last set of variables off the stack
• SCREENS device regardless of the device type. Thus a procedure can call this routine and begin to plot without having to worry about whether it is displaying to a windowed or plot device. Currently only handles X, Sun, PS, HP, NULL and TEK devices properly.
• SEASON given input date outputs season in code
• SECTIM this function returns the date and time in the format ydhms, given the elapsed seconds since the start of 1965
• SECTIME this function gives the date in the format dmyhms given the time in seconds from 1/1/1965, uses the routine sectim then converts the time format from ydhms to dmyhms
• SET_SIZE Part of the PSETUP Suite of procedures that provide easy and versatile customisation of the plotted page for PostScript (plus other functionality)
• SHOWVOLUME Based on the example in the RSI IDL manual. Uses SURFACE, SHADE_VOLUME, POLYSHADE and TVSCL to produce a surface in 3-D coords.
• SHOW_SIZE Part of the PSETUP Suite of procedures that provide easy and versatile customisation of the plotted page for PostScript (plus other functionality)
• SIDES positioned at the top, bottom, left or right of the page for the current set of displays.
• SIGFIG This function will return the number of significant figures in the value "range"
• STDEV Compute the standard deviation and optionally the mean of any array.
• STEP_DIST function proportional to its radius from the centre. This is then stepped steps times CATEGORY: Signal Processing.
• STRESS String edit by sub-string. Precede, Follow, Delete, Replace.
• TH_CHOICE a number of choices
• TH_HISTOGRAM The in-built histogram routine in IDL does not produce consistent binning given an arbitrary binsize and/or max/min keywords. In other words, if you randomly choose your binsize and try to predict the number of histogram bins resulting you'll (or rather, it will!) get it wrong every now and then. New histogram routine follows. B.Vandepeer 24-Feb-1995 Atmos. Physics Group, University of Adelaide
• TH_IMAGE_CONT ******************** HIGH FREQUENCY RADAR DIVISION, SRL ********************** *************************** Ionospheric Effects ****************************** 1 TH_IMAGE_CONT Overlays an image and a contour plot and optionally adds a scale bar. Based on the IDL USERLIB routine IMAGE_CONT. This routine supersedes the USERLIB one, having far more functionality, yet capable of EXACTLY
• TH_NEAREST This function will find the nearest multiple or fraction of VALUE that is just under or just over LIMIT. Particularly useful for REBINning.
• TH_SMOOTH replicates the end elements in the window to get right size, hence will smooth the entire array, including the end points.
• TH_WMENU[1] Like wmenu but allows non-mouse menus. Uses widgets if available.
• TH_WMENU[2] Like wmenu but allows non-mouse menus. Uses widgets if available.
• TH_WSCREENS If the device does not have widgets, then the result is the same as calling SCREENS
• TICKLIMIT than 30, the limit set by IDL. If the number of tickvals is larger than 30 then every second tick is chosen, and the number checked again. The end values are retained though.
• TIMEFMTCONV this subroutine converts from the time format of YDHMS to DMYHMS
• TIMESEC this function gives the time in seconds from 1/1/1965 given the date in the format dmyhms. Reverse function of SECTIME Uses the routine TIMSEC once the date format has been converted
• TIMFMTCONV this subroutine converts from the time format of DMYHMS to YDHMS
• TIMSEC this function returns the elapsed seconds since the start of 1965 given date and time in the format ydhms Reverse function of SECTIM
• TOTALREG Perform a general total least squares fit with optional error estimates
• UNIX2VMS under VMS we must place all references to directories inside square brackets and separate with "." rather than simply separating everything with /
• WCLEAR window (if it is not part of a widget) or redraw a TEK screen
• WHITEBG black foreground lines by defining the the !p.background index to white (255,255,255) and the !p.color index to black (0,0,0). Nb: both the !p.background and !p.color are set by this routine
• WMEAN NAME: WMEAN PURPOSE: trivial function to produce the weighted mean of a set of data CATEGORY: Mathematical utilities CALLING SEQUENCE: result = wmean( data, weights, sd=sd) COMMON BLOCKS:
• XCORR NAME: XCORR PURPOSE: Perform cross-correlation without using FFT CATEGORY: Time-Series/Spectral analysis CALLING SEQUENCE: xcorr, tdata1, tdata2, normal_factor=nf, maxval=maxval INPUTS: tdata1,tdata2 = (Complex) vectors containing the time series
• XEXFIT Fit y=f(x) where: F(x) = a0*z*exp(-z^2) + a3 and z=(x-a1)/a2 a0 = height of exp, a1 = center of exp, a2 = 1/e width, a3 = constant term Estimate the parameters a0,a1,a2,a3 and then call curvefit.
• XY2PSYM10 setting but return the actual data values used to do this. Thus filled histograms can be made using
• XYREBIN optionally suppressing outliers for a better image