Local IDL Routines

(This page was created by a MODIFICATION of the IDL library routine mk_html_help).

List Last updated: Tue Jul 7 13:06:27 2015.

NOTE: Non-PPPL employees may access these routines by following procedure GEN-034 .

Alphabetical List of Routines

[List of Routines by Category]

ADDDATE - Add days to a date. Tries to return string in same form as input
ADDGPICOMMENT.PRO - add comments to a file for GPI web pages
ADDLABELNODES - Add LABEL sub-nodes to MDSplus signal nodes reading info from a file
ADDMDSTAGS - Add tags to MDSplus nodes
ADDSIGNODES - Add signal nodes and tags to a MDSplus tree for many shots
ADDTREETOTAG - return tags with trees merged in
ADD_TAG - Add a new tag to the structure. NOTE: if you want to add more than one tag at once, use ADD_TAGS
ALPHAMOVIE10 - Plot every 10th frame in time, and overlay 10 d-alpha traces. Have a marching vertical line indicating time in a plot indicating the Strike Point Radius.
AMEDIAN - Works the same as MEDIAN, but the effect tapers off at the edges.
ANIM2CINE - Create an mpeg or avi movie from two .cin files from Phantom Cameras. The data can be color or monochrome
ANIMXYPLOT - Animate X-Y plot of a 2-D array
ARRAYMASK - Return an array mask where values are 1 if within the drawn polygon and 0 if outside.
ARRAY_EQ - Return TRUE if two arrays are equal, else false.
BADPAR - (one line) Validate an input parameter against valid entries.
BAD_PTDATA_ERROR - Return a logical true IF the PTDATA error is serious
BANGPW - Widget to set interactively some !P values. Lists colors by name, if mk_color used; otherwise finds "closest" index to named colors. Allows selection of several custom plotting symbols (see PLOTSYM).
BELL - Ring terminal bell.
BETTERRAINBOW - Loads a rainbow color palette with 6 evenly-spaced (roughly) colors
BETTERTICKLABELS - Tick labels are made a little cleaner. E.g., shorter exponentials, no unnecessary trailing zeroes, accurate numbers when tick values are small differences between large numbers, etc.
BIN2D - Create a density image (2D histogram) from arrays of (x,y) points, or create an image of a function from arrays of ( x, y, f(x,y) ) data. In first case each pixel counts # of (x,y) points falling into a 2D bin (box), thus forming an image of counters. In optional case, each pixel is the average of all f(x,y) data falling into the box. Boxes are determined by dividing the (x,y) range into a uniform grid.
BITMAPBUTTONS - Illustrate use of bitmapbuttons in IDL
BITS - Given a byte or integer, return a vector of 8 or 16 values which are the binary representation of the value.
BLOBBINRANGES - plot bins of one variable vs another from blob database and draws ranges, of say 90%, in Y for each binned point. Uses color filled contours for square bin values. See http://nstx.pppl.gov/nstx/Software/Applications/blobDBdefs.txt for an explanation of variables and units of database variables.
BLOBTRAILS - draw trails of blob trajectories that go through a certain region of the image. Data comes from a database of blob characteristics for a given shot, and perhaps just part of a shot (see populateblobs.pro).
BLOBVYFIT - plot Poloidal velocity (Vy) of blobs from Fast Camera data vs. distance from the separatrix. Bin and smooth things so a curve can be fit through data, with the ultimate goal of categorizing the vertical shear.
BPASS - Implements a real-space bandpass filter which suppress pixel noise and slow-scale image variations while retaining information of a characteristic size.
BPWFEDIT - Read, Edit, & Plot Breakpoint Waveform files used in ppcc system on TFTR
BREAKMDSNAME - break an MDS pathname near the middle, if too long
BREAKSTRING - Break a string up and return a string array
BREAKTEXT - break up (justify) text so lines not longer than a certain length.
BREAK_PATH - Breaks up a path string into its component directories.
BTEST - To test bit N in FIX(X)
CACHECKMONITOR - This function returns a non-zero value if there is a new (unread) monitor for this process variable, otherwise it returns zero. This function is particularly useful when a caGet() operation is expensive in time, e.g. reading large arrays.
CACLEARMONITOR - This procedure clears a monitor on the specified process variable. It cancels the effect of caSetMonitor().
CADEBUG - This procedure turns the EZCA debugging flag on or off. Turning on the debugging flag prints lots of information, which is mainly useful to developers.
CAENDGROUP - This function ends an "asynchronous group". See caStartGroup for more information on asynchronous groups. caEndGroup flushes the queue of caGet and caPut calls and waits for replies from the channel access servers.
CAERROR - This procedure controls error printing and returns error strings.
CAGET - This function reads the value of a Channel Access process variable.
CAGETARRAY - This function reads values for a list of Channel Access process variable. It returns 0 if successful, returns -1 if failed.
CAGETCONTROLLIMITS - This procedure reads the control limits for the specified channel access process variable.
CAGETCOUNTANDTYPE - This function returns the number of elements and data type of a Channel Access process variable.
CAGETENUMSTRINGS - This function returns all of the choice strings associated with a Channel Access "enum" process variable. It is particularly useful for building menus of options.
CAGETERROR - This function get CA return codes for a list of process variable names. Return code can be 0 or -1, 0 for success, -1 for failure.
CAGETGRAPHICLIMITS - This procedure reads the graphic limits for the specified channel access process variable.
CAGETPRECISION - This procedure reads the precision for the specified channel access process variable.
CAGETRETRYCOUNT - This function returns the value of the EZCA retry count parameter. In conjunction with the EZCA Timeout parameter it determines how long EZCA will try to connect to a process variable before giving up.
CAGETSTATUS - This procedure reads the status parameters for a channel access process variable.
CAGETTIMEOUT - This function returns the value of the EZCA Timeout parameter. This value determines the time parameter passed to ca_pend_io() in EZCA. In conjunction with the EZCA RetryCount parameter it determines how long EZCA will try to connect to a process variable before giving up.
CAGETUNITS - This procedure reads the units string for the specified channel access process variable.
CAINIT - This routine sets the channel access timeout used by list array functions defined in ezcaScan library.
CALCBTBP - Calculates toroidal and poloidal magnetic field values (Bt & Bp) at desired R & Z and desired time by reading data from the EFIT (or similar) MDS+ tree. (Bt is also refered to as B-phi.)
CAMAC_HERE - Return 1 if CAMAC on this computer (if environmental variable "camac_server" is non-blank)
CAMONITOR - This function provides Add/Get/Check/Clear monitor features on a single PV or a list of PV names.
CAPENDEVENT - This function causes the Ezca to call channel access ca_pend_event function.
CAPENDIO - This routine sets the timeout used by ca_pend_io in array get/ put used in ezcaScan library.
CAPUT - This procedure writes a new value to a channel access process variable.
CAPUTARRAY - This function writes an array of data to a list of Channel Access process variable. It returns 0 if successful, else retuns -1.
CASCAN - This function provides add/get/zero/clear monitor features on a scan record and a set of PV names.
CASEARCH - This function searches for a list of process variable names. It returns 0 if successful, returns -1 if failed.
CASETMONITOR - This procedure sets a monitor on the specified process variable. This causes a channel access callback to execute whenever the value of that process variable changes. Subsequent calls to caGet() after calling caSetMonitor will read the values provided by the callbacks, rather than reading from the IOC.
CASETRETRYCOUNT - This procedure sets the value of the EZCA RetryCount parameter. In conjunction with the EZCA Timeout parameter it determines how long EZCA will try to connect to a process variable before giving up.
CASETTIMEOUT - This procedure sets the value of the EZCA Timeout parameter. This value determines the time parameter passed to ca_pend_io() in EZCA. In conjunction with the EZCA RetryCount parameter it determines how long EZCA will try to connect to a process variable before giving up.
CAST - Generalized type casting. Converts variables whose type code is out of the range [LOW,HIGH] into this range.
CASTARTGROUP - This procedure starts an "asynchronous group". Within an asynchronous group all calls to caGet and caPut are asynchronous, i.e. they queue a request and return immediately without waiting for a reply from the channel access servers. Calling caEndGroup causes the queue to be flushed and waits for the replies. The use of asynchronous groups can greatly improve the efficiency of channel access. The user must be aware of the restrictions on caGet outlined under the description of that routine.
CATIMESTAMP - This function returns the time stamp of corresponding value for the specified record name.
CATRACE - This procedure turns the EZCA trace flag on or off. Turning on the trace flag prints lots of information which is mainly useful to developers. Setting the trace flag results in less verbose output than setting the debug flag (see caDebug).
CAVERSION - This function returns the string of current version information about ezcaIDL
CHARSIZE2FIT - compute charsize for a string to fit in horizontal # of pixels
CHECKMDSTREE - Check MDS trees, say after a transfer. Produce a file with a list of nodes and checksum of contents of each numerical node or first element of non-numeric nodes.
CHECKSIG - checks for existence of a signal in MDSplus for current shot and optionally declares an event. It can also execute an IDL string when it sees the event. It will then start watching for the next shot.
CH_EXAMPLE - a simple example using the GA Crosshair routines
CH_REGISTER - register window for crosshair routines
CINE2MPEG - Create a movie from a .cin files from Phantom Fast Cameras. Will default to writing jpegs and spawning jmovie to create a QuickTime movie. If /MPEGout keyword set, will write an MPEG. The data can be color or monochrome,
CINEAVE - Produce an average frame from a time ranged from .cin files from Phantom Fast Cameras. This frame is typically used to divide GPI images by to get normalized image.
CINELOAD - Read a frame from a .cin file from a Phantom 7 camera. File is opened only the first time (or when filename is new), and pointers and things are remembered from one call to the next.
CINERATE - Return framing rate from a .cin file from a Phantom 7 camera.
CINETHUMBNAILS - Plot thumbnails of many frames from a .cin file
CINE_SNUM - Return camera serial number from a .cin file from a Phantom camera.
CINE_TIME - Read time from a .cin file from a Phantom 7 camera.
CLEANPLOT - Reset all system variables (!P,!X,!Y,!Z) to their default values
CLEARPLT - This procedure will clear or zero all or a selection of the system plot variables
COLORBAR - The purpose of this routine is to add a color bar to the current graphics window.
COLORBARBD - The purpose of this routine is to add a color bar to the current graphics window. (this is a mod by BD to handle veritcal plot ticknames better)
COLORSEARCH - Return color index (or closest available) from the color name.
COLOR_RESOURCE_EXAMPLE - Example of color buttons on a widget.
COLOR_STATUS_EXAMPLE - Example of color status fields on a widget.
COMBINE_STRUCTS - takes two arrays of structures str1,str2 which have the same number of elements but possibly different tags and makes another structure which has the same number of elements but the tags of both str1,str2 and has their respective tags values copied into it
COMPW - Plot two signals and the difference.
CONVANGLE - convert angle from one scheme to another. For example, some routines have 0 horizontally to the left, with angles increasing in a clockwise direction. and others have zero to the right, with angles increasing in a counter-clockwise direction.
CONVOLVE - Convolution of an image with a Point Spread Function (PSF)
COPY_STRUCT - Copy all fields with matching tag names from one structure to another
CP2JSCOPEFILE - Copy an MDSplus Scope input file to one that will work with jScope
CREATE_LOCUS_TABLE - Create a table in the Locus database following the convention of data columns named xx0, xx1, xx2, etc.
CW_ANIMATE_DUPS - 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. The speed and direction of the display can be adjusted using the widget interface.
CW_BGROUP3_6 - CW_BGROUP3_6 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_BGROUP3_6 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_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_FIELD_BD - 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_PDLIST - 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_PDList 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 name in an unambiguous way.
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 name in an unambiguous way.
DATATYPE - Datatype of variable as a string (3 char or spelled out).
DATE2JD - Convert a date string to Julian Day number.
DATE2YMD - Date text string to the numbers year, month, day.
DB_COLUMNS - list database tables and columns in which the column name contains a string.
DB_LIST - List info from an NSTX Database Table; especially to be displayed in output from a Web Tool database, like http://nstx.pppl.gov/nstx/Software/WebTools/searchefitdb.html. Searches from a database will be MUCH faster than from MDSplus trees.
DECODE_GRAY - Convert a gray-code value to an integer
DECOMPOSEDCOLOR - This function is used to determine, in a device independent way, if the current graphics device is using color decomposition. The function returns a 1 if color decomposition is turned on, and a 0 if it is turned off. When color decomposition is turned on, we say the device is using a true-color display. If color decomposition is turned off, we say the device is using an indexed color display.
DELFROMLIST - delete ith element from a list
DIALOG_INPUT - A modal (blocking) dialog widget to input a line of text. The dialog must be dismissed, by entering text and pressing the Return key, or by clicking on the 'Ok' or 'Cancel' button before execution of the calling program can continue.
DIALOG_MENU - A modal (blocking) dialog widget to display a selectable menu. The dialog must be dismissed by selecting a menu item before execution of the calling program can continue.
DISPLAYFCTIFFS - Animate Fast Camera images with the time overlayed
DOMAINNAME - Return TCP/IP domain name from Unix systems
DRAWCIRCLE - draw a circle centered on [x0, y0]. YOU HAVE TO HAVE YOUR AXES ESTABLISHED BEFORE CALLING THIS. Return out arrays for later drawing on a surface, too. These are in two parts, so you won't have a line down the middle when drawing.
DRAWDIAMOND - draw a diamond in data coordinates
DRAWELLIPSE - draw an ellipse centered on [x0, y0]. YOU HAVE TO HAVE YOUR AXES ESTABLISHED BEFORE CALLING THIS.
DRAWNSTXINSIDES - Provide a drawnstxinsides for IDL routines to be used by others
DRAWRECTANGLE - draw a rectangle in data coordinates
DT_NICENUMBER - Makes nice delta time numbers, by rounding to 3 significant digits Can be used if you want to know if you have a constant timebase.
EDITTABLE - Edit a structure with a table where the second item in the structure is on/off. You can set all items (but the first) on, off, or to a specific value. If there are more rows than will fit on your screen, it will make new columns.
EFITMOVIES - Plot EFIT field lines, Thomson Scattering Density and Temperature and, optionally, Fast Camera images. Instead of Fast Camera, can plot H-alpha (or another) signal vs. time.
EFIT_TIMES - Return EFIT times in MDSplus for a shot
ERROR_MESSAGE -
EVENTSPAWN - When a designated MDSplus event is detected, spawn an IDL procedure, first killing any versions that are running.
EXECONEVENT - Widget to spawn an executable (with shot as argument) when an MDSplus event occurs. An IDL routine can also be spawned with shot as the only argument, or any IDL command string executed.
FACTOR - Find prime factors of a given number.
FANCY_TITLE - write a title at top of screen, with option to use Hershey fonts
FASTCAM_FRAME - a generic routine to get a frame of data from Fast Cameras. You can get camera data from MDSplus at MIT, read localNetCDF, HDF, or CIH files (which follow expected conventions), as well as the Cine files.
FASTCAM_TIMES - a generic routine to get timing array for Fast Cameras. You can get camera data from MDSplus at MIT, read localNetCDF, HDF, or CIH files (which follow expected conventions), as well as the Cine files.
FCDCMOVIES - Plot Fast Camera and Divertor Camera images along with EFIT field lines, and, optionally, Thomson Scattering Density and Temperature. You may also plot H-alpha (or another) signal vs. time.
FCPLAYER - Also displays files from the Phantom or color Miro cameras (.cin files) and optionally save frames as JPEG, PNG or TIFF files. Allows recording of click locations on .cin files from a Phantom 4 or 7 camera (for tracking dust, e.g.). Also trackes "blobs" from images of edge turbulence.
FCTIFFSVCR - animate Fast Camera tiffs with VCR-like controls. from the resulting widget, you may write an Mpeg file
FCVCR - Plot Fast Camera images with a VCR-like interface
FDECOMP - Routine to decompose a file name for any operating system
FEATURE - Finds and measures roughly circular 'features' within an image.
FILE2STRUCT - return a structure where elements are named with column headings, and arrays are the columns
FILEONEVENT - When a designated MDSplus event is detected, write a file containing a shot number, first deleting existing file.
FILESHOTDATE - Print time and date of an NSTX shot, but get data from a file
FILETIME2DBTIME - Return times in filetimes format in database format
FILTER_IMAGE - Identical to MEDIAN or SMOOTH but handle edges and allow iterations.
FINDALLCHAR - Find all appearances of a character in a scalar string
FINDCAMFILES - Find camera files in various directories Environmental/System variable FC_DATA_DIR will be used, if set, to look for files containing the string in 'filename'
FINDDISKS - return a list of disks shown in the df command on Linux
FINDMDSNODES - Search for MDSplus nodes or tags with a name containing a string
FINDMDSTIME - find a time within an MDSplus shot, correspoding to the time of Max Ip, time of Max W-tot, etc. signals come from the EFIT tree when possible.
FINDPEAKS - Find peaks in a data array. To be a peak a local maximum must have a 25% higher range than the first and last quarter of the peak range.
FINDRATZ - find the r of desired Z, but on the outer part of curve, if there is more than one point that would cross Z=desiredZ. Use spline interpolation.
FINDVALIDSHOTS - Search MDS Plus Trees for valid shot numbers with data in a particular node
FIND_COMMON() - : Find which elements are common to the input vectors.
FIND_FONT - Select a Unix hardware font for IDL graphics.
FIRSTSIGNAME - Return the first signal name in a TDI expression. Needed when you want the xaxis from a combination of signals.
FITSRUN - Quickly tell which EFITs and LRDFITs exist for an MDSplus shot
FLUXCOORDS - Return flux coordinates for input R values at a given Z
FOLLOWCONTOUR - Follow a contour line to find where it intersects a desired Y and return the X value. I.e., where the 2D input array has the same value as at specified coordinates. This is used to find the R value at Z=0 with the same Psi value as a specified point on the flux surface. So, it can be used for plotting things in relation to flux surfaces.
FOUNDSUBTREE - determine if sub trees like efit05, lrdfit06, etc. exist
FROMIDLSECONDS - Convert from IDL-syle time (output from SYSTIME(1), to form of '06/14/2004 11:04:52'
FROMIDLTIME - Convert from IDL-syle time (output from SYSTIME(0), to form of '06/14/2004 11:04:52'
FSC_COLOR - The purpose of this function is to obtain drawing colors by name and in a device/decomposition independent way. The color names and values may be read in as a file, or 192 color names and values are supplied with the program. These colors were obtained from the file rgb.txt, found on most X-Window distributions, and from colors in the Brewer color tables (http://colorbrewer2.org/). Representative colors were chosen from across the color spectrum. To see a list of colors available, type: Print, FSC_Color(/Names), Format='(6A18)' If the color names '0', '1', '2', ..., '255' are used, they will correspond to the colors in the current color table in effect at the time the FSC_Color program is called.
FSC_COLORBAR - The purpose of this routine is to add a color bar to the current graphics window.
FULLMDSPATH - Return an MDSplus path for a tag
GAMMA_RAISE - Apply gamma correction to an array, presumably an image.
GAUSSIAN - Compute the 1-d Gaussian function and optionally the derivative
GA_DATA - A GA_Data object defines a dataset Y as a function of X. It can be drawn on a Plot defined by a GA_Plot object.
GA_DATA::ADD_TEXT - Add a text annotation defined by GA_AnnotateText object that will be drawn together with this data object onto the plot object.
GA_DATA::DELETE_TEXT - Deletes a text member from the data object.
GA_DATA::DRAW - Overplots this data set onto a Plot that has been established by a GA_Plot object.
GA_DATA::GETCOLOR - Retrieves the color index associated with this data set.
GA_DATA::GETFLAGAUTOLABEL - Retrieves value of FlagAutoLabel
GA_DATA::GETLABEL - Retrieves the label of this dataset. If not set, use YName. Can be overridden by subclasses to supply automatically generated label. FlagAutoLabel is provided to facilitate this.
GA_DATA::GETLINESTYLE -
GA_DATA::GETLINESTYLENONE - Retrieves linestyle index for 'NONE' (no line).
GA_DATA::GETPLOT - Retrieves the GA_Plot object that contains this data object.
GA_DATA::GETSYMBOL -
GA_DATA::GETSYMBOLSIZE -
GA_DATA::GETXDATA - Retrieves abscissa vector X.
GA_DATA::GETXNAME - Retrieves the name of X vector.
GA_DATA::GETXRANGE - Retrieves the range of X data.
GA_DATA::GETYDATA - Retrieves ordinate vector Y.
GA_DATA::GETYNAME - Retrieves the name of Y vector.
GA_DATA::GETYRANGE - Retrieves the range of Y data.
GA_DATA::INIT - Initializes the GA_Data object.
GA_DATA::SETPROPERTY - Sets the value of a property or group of properties for the GA_Data.
GA_DATA::SET_TEXT_PROPERTY - Sets the parameters associated with a text annotation object.
GA_PLOT - A GA_Plot object draws graphs of its data members. It is a container of GA_Data objects. If it has more than one data object member, the data members are overlayed. A plot object can be thought as a wrapper to IDL's PLOT command, keyword values to the PLOT command are preserved as plot object's or data objects' members. A plot object is plotted on a window created by a GA_Plot_Window object which may contain several plot objects.
GA_PLOT::ADD_DATA - This method allows you to add another data object to the plot object. Properties of the data object may be set with the method's keywords. Extra carries any keywords acceptable by Ga_Data[3]::Init. A new data object will be created and the reference is returned. See also GA_Plot::Add_Data_Object
GA_PLOT::ADD_DATA_OBJECT - This method allows you to add a GA_DATA or GA_DATA3 object to the plot object. The data object reference is returned. See also GA_Plot::Add_Data
GA_PLOT::ADD_TEXT - This method adds a text annotation to a specified location on the plot.
GA_PLOT::AUTO_RANGE - Set data ranges automatically according to data. This is needed for multiple data sets. Set both xrange and yrange by default.
GA_PLOT::DELETE_DATA - This method allows you to delete a data set member from the Plot Object. The data set may be specified by indicating its NAME, by indicating its POSITION (index number), or by the data OBJECT itself. (See the Select_Data method for more details about a data set's NAME and POSITION.)
GA_PLOT::DRAW - This method draws the Plot Object, including all of the data members included in the Plot Object.
GA_PLOT::GETDATAOBJECTS - The method returns the array of data objects stored in this plot object.
GA_PLOT::GETDATASELECTED - Retrieves the selected data object. A data object can be selected by clicking near to the data points with Left-Mouse-Button in 'Select' mode.
GA_PLOT::GETWINDOW - This method returns the GA_Plot_Window object that the plot object belongs to, for EditCallBack purpose.
GA_PLOT::GET_DATA_PROPERTY - This method allows you to retrieve the properties of a data member belonging to the plot. Data member is identified by passing its object reference (which can be obtained with the Select_Data method). If a data member is not specified, the first data memeber is used as a default.
GA_PLOT::GET_PLOT_PROPERTY - This method allows you to obtain the standard Plot properties from the Plot Object. (See the Init Method for a more complete explanation of these Plot properties.)
GA_PLOT::INIT - This method initializes a GA_Plot object. Standard properties are set with positional and keyword parameters. The routine makes GA_DATA objects from the data passed into the method. Use the Add_Data method to add additional data sets and the Delete_Data method to remove data sets from the Plot Object. Data inside the data objects can be modified with the Set_Data_Property method. Think of this initialization routine as a wrapper for the PLOT command. Use keywords appropriate for the PLOT command in making the call.
GA_PLOT::SELECT_DATA - This method retrieves a particular data object associated with this plot object. A data can be selected by name or by index number.
GA_PLOT::SETSLICEMODE - Set mode for data slicing. For a GA_Plot object, the plot can be used as a slicer to slice through other GA_Plot3 objects in the same window. The data in this plot will not be sliced because there is no third dimension. See also GA_Plot3::SetSliceMode
GA_PLOT::SET_DATA_PROPERTY - This method allows you to change the parameters associated with a particular data object. You must specify a particular data set by passing the object reference to the data set. (This can be obtained with the GA_Plot::Select_Data method.) If a data set object is not specified as the data member, the first data set is used by default.
GA_PLOT::SET_PLOT_PROPERTY - This method allows you to set the standard Plot properties. If the DRAW keyword is set, the plot will be drawn after the new properties are set. (See the Init Method for a more complete explanation of these Plot properties.)
GA_PLOT::SET_TEXT_PROPERTY - This method allows you to change the parameters associated with a text annotaion object. The textMember is the index number of the text object. All text members are used by default if no textMember is specified.
GA_PLOTW - Plot widget for "table" of data, or input X & Y arrays.
GA_PLOT_WINDOW - A GA_Plot_Window is a compound widget with a draw window that contains one or several GA_Plot[3] objects. Plots can be added or deleted. The window object handles plot layout, coordinates, preference and properties configurations, mouse events and draws all the plots through their own draw methods.
GA_PLOT_WINDOW::ADD_PLOT - This method adds a plot to the window. A new column of plots will be created if necessary to accomodate the new plot. A plot object is required. If NoDuplicate keyword is set, check if newPlot belongs to the window already. If so, return.
GA_PLOT_WINDOW::CHECKPLOTNUMBERS - Goes through member plots and checks to ensure that they are sequentially numbered. Renumbers them if they are not. Plots having the same number are overlayed and can cause confusing display results. This routine is optional - to be used by the parent application if needed. It returns 0 if no plot has been renumbered, returns 1 otherwise.
GA_PLOT_WINDOW::DELETE_PLOT - This method deletes a plot from the list of plots within the window. Plots are numbered from 1 to N and are in column order in the window. NO EDITCALLBACK is generated by this method! For an EDITCALLBACK use GA_Plot_Window::RemovePlot.
GA_PLOT_WINDOW::DRAW - Draws all the plots in this window by calling the plot objects Draw method.
GA_PLOT_WINDOW::DUMP - Prints out pointers to plot objects and their associated data objects. For debugging purposes.
GA_PLOT_WINDOW::EDITCALLBACK - Perform an IDL procedure call upon certain editing action, CALL_PROCEDURE,ProName,Parent,oData,oPlot,Action ProName is the procedure name specified by keyword EDITCALLBACK when the window object is created (see GA_Plot_Window::Init). This procedure should expect four arguments. Parent The parent widget of the PARENT argument specified in GA_Plot_Window::Init. If the GA_Plot_Window is created through CW_GAWindow, Parent will be the PARENT argument passed to CW_GAWindow. oData A GA_Data object or a null object. oPlot A GA_Plot object or a null object. Action An action string such as 'ADD_DATA','DELETE_DATA', 'DELETE_PLOT','REFERENCE_POINT',etc.
GA_PLOT_WINDOW::GETCURRENTTOOL - Retrieves the name of the current mouse mode. Possible modes are ['Select','Zoom','Edit','Cursor','Slice','Mark','Vector'] plus those defined by MOUSEMODES.
GA_PLOT_WINDOW::GETPLOT - Retrieves a plot object specified by its index number.
GA_PLOT_WINDOW::GETPLOTLIST - Retrieves the names of plots in this window object. A name is specified or a default is given when a plot object is created.
GA_PLOT_WINDOW::INIT - Initializes a GA_Plot_Window object. The window is conceived as a compound widget via CW_GAWindow. When you get the "value" of the compound widget, you are returned the window object. Instead of "setting values" to the compound widget, you call window object methods.
GA_PLOT_WINDOW::INSERT_PLOT - Inserts a new plot at a specified index number. The plot numbers are shifted by 1 (+1) from the inserted plot.
GA_PLOT_WINDOW::REMOVE_PLOT - If the PLOT tag in EDITFLAGS structure is set, this method deletes the plot object specified by the index number. A GA_Plot_Window::EditCallBack is generated.
GA_PLOT_WINDOW::REPLACE_PLOT - This method replaces a current plot in the window with another plot.
GA_PLOT_WINDOW::RESTOREPREFERENCES - Restore user's preferences from file specified by PreferencesFile. This file is always in user's HOME directory.
GA_PLOT_WINDOW::SAVEPREFERENCES - Save the current settings to user's preferences file specified by PreferencesFile. This file is always in user's HOME directory.
GA_PLOT_WINDOW::SETAUTOGRID - Turn on or off the automatic grid layout calculation.
GA_PLOT_WINDOW::SETCHARSIZE -
GA_PLOT_WINDOW::SETCOLORFLAG - Resetting the color table.
GA_PLOT_WINDOW::SETCURRENTTOOL - This method sets the current tool(mouse mode) to be used in the window. 'SELECT' - Seleting a data or a plot for manipulation, copying and deletion, etc. 'ZOOM' - Zoom and reset a plot, switch between multiple and single-plot displays. 'EDIT' - Add, delete or move data points. 'CURSOR' - Mark reference points, switch cursor readout from absolute to relative. 'SLICE' - Change the slices of the 3D data being plotted. 'MARK' - Mark a data point with a special symbol. 'VECTOR' - Change vector magnitute, data point resampling rate, etc.
GA_PLOT_WINDOW::SETMAXGRID - Set the maximum number of columns and rows for determining grid layout of plots automatically.
GA_PLOT_WINDOW::SET_CROSSHAIRS - This method turns cursor crosshair tracking on or off.
GA_PLOT_WINDOW::SET_STATUS_WINDOW - This method assigns a text or label widget ID to be the status window. Cursor tracking reports are sent to the status window.
GA_PLOT_WINDOW::USERSETGRID - Allows manually setting the grid layout of the plots. If howeve, the total number of plots is greater than GRID[0]*GRID[1], the grid is recalculated automatically.
GENNETCDFBLOBS - Write NetCDF files of dummy Blob data for code validation. Files with known blob velocities are generated. This code prints out these average x- and y-velocities, as as writing the averages to a variable in the file (although, as of Nov. 4, 2013, an array was written for those variables and only the first value represents the averages).
GETCMODEFIT - Get efit data from CMOD for separatrix and limiter locations
GETEFIT - Procedure to get efit data from A0 and G0 file or from MDSPLUS. This can be used as a front end to the usual reada and readg. It prints out a message if the efit data does not occur for the desired value of DELTIME. It does not return any data unless time window requirements are met.
GETFILETIME - return creation date and time of a file (not sure atime and ctime are right, for files from a PC)
GETIMAGE - The purpose of this function is to allow the user to open either regular or XDR binary image files of two or three dimensions.
GETMDSLABEL - return a label for an MDSplus signal. If there is a :LABEL sub-node, use that string, else if there is a :COMMENT sub-node, use that, else return the MDSplus signal name.
GETNEXTFILE - get next file in a directory, defaulting to alphabetic search
GETPOS - Get the values for the POSITION keyword after a plot
GETSCOPENAMES - return signal names and plot settings from an MDSplus Scope input file
GETSEP - Get the separatrix (last closed flux surface) R & Z values from EFIT or LRDfit for a particular NSTX or CMOD shot. Interpolate surfaces in time. Can also return R & Z of limiter interior. Also works for CMOD shots (tree opened elsewhere).
GETTOK - Function to retrieve the first part of the string until the character char is encountered.
GETTREES - Return subtree or subnode names from an MDSplus tree
GETWRD - Return the n'th word from a text string.
GET_DELIM - returns file delimiter that is appropriate to VMS, UNIX or Windows
GET_NEBAR - Get Ne Bar (line-averaged plasma density at the midplane) from Multi-point Thomson Scattering data and EFIT gap data.
GET_TEXT_INPUT - Prompt the user for input with a question and return the text string typed by user. For X-windows the input is through a text widget, in the middle of the screen, and the text widget waits until carriage return is entered. Otherwise input is in the terminal window, with a beep to alert user.
GET_WEBPLOTSUM - Creates summary plots vs time with plasma current, D-alpha, injected power and stored energy (W-mhd).
GOOD_IP - Determine if plasma current (Ip) was good for a shot and, optionally declare an event.
GPICONT - plot GPI data (an average of a center strip vs. time) as a color contour with the separatrix overlayed
GPIMOUNTAIN - plot GPI data (an average of a center strip vs. time) as a surface with the separatrix overlayed
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.
GRIDPLOT - Widget for plotting a grid of data from MDSplus or gadat This is an interactive version of ShotLoop. If at GA, assume that access will be through gadat only. When a plot on the grid is clicked on, it is expanded into a separate window.
H5DFROMTEXT - create a H5D file from a text file with columns of data
HIGHESTEFITRUN - find highest efit version run (in the MDSplus tree) Checks up to 5, and contigously after that
HOURS2TIME - Return time string like 23:59:05 from floating point hour value
IDLV4_TO_V5 - Modify an IDL V4.0 (or earlier) procedure such that variables are indexed using square brackets, as allowed (and suggested) within IDL V5.0 and later
IJ2RZ - Convert from fast GPI camera pixels at CMOD or NSTX to R & Z
IMAGEPROC - Demonstrate a few of IDL's image processing features: Fourier filtering, pixel scaling, pixel distribution (histogram), edge enhancement, dilate & erode, convolution, and zooming.
INTERP2D - Perform bilinear 2d interpolation using the IDL intrinsic interpolate procedure
INTERP2DFIT - fit irregularly-spaced x, y, & z points by fitting a 2-D surface using SFIT, and, using the returned coefficients, compute new values at other irregularly-spaced locations.
INTERPEDGE - Interpolate separatrix in time. From EFIT or LRDfit, find R and Z values of last closed flux surface (separatrix) for a particular NSTX or CMOD shot. Can also return R & Z of limiter interior. Also works for CMOD shots (tree opened elsewhere).
INTERPWF - Interpolate MDS signal, or array, to 1 KHz.
INT_DEFINED - see if a value is defined and is an integer
ISARRAY - Tests if the argument is an array.
ISFUNCTION() - Determine whether the IDL program(s) in a file are procedures or functions. Needed because the intrinisc RESOLVE_ROUTINE and ROUTINE_INFO() procedures require the user to know beforehand whether to supply the /IS_FUNCTION or /FUNCTION keywords.
ISNUM - Checks whether the input is a number.
ISNUMBER - Determine if a text string is a valid number.
ISOTIME - Return time in ISO 8601 standard, assuming US East Coast. (handles Daylight Savings time)
JD2DATE - Convert a Julian Day number to a date string.
JD2YMD - Find year, month, day from julian day number.
KEYBRDANIM - Animate frames of plots with keyboard controls. Plot commands can be passed into the routine. By default a vertical dashed red line shows the time. Keyboard controls over animation: 'H': See this Help 'P' or : Toggle Pause 'C': Continue 'F': Faster 'S': Slower 'R' or '>' or : move forward 1 frame 'L' or '<' or : move backward 1 frame 'J' or : Jump forward 10 frames 'B' or : move backward 10 frames 'M': Mouse-click time desired 'Q': to quit
LABELEVERYOTHERTICK - Only label every other major tic mark. The format of the numbers is customized.
LABELFIT - determine character size to make a label fit in a space
LASTCHAR - return last character of a string
LASTMDSSHOT - get the last (current) MDS shot
LEAFNAME - Return leaf name from MDSplus pathname(s)
LEGEND - Create an annotation legend for a plot.
LINESOUT - Write lines out to an X window. Works like xyouts, but uses line #'s (from the top) and /right if you want to right justify text.
LINT - Find the intersection of two lines in the XY plane.
LINTERP - Linearly interpolate tabulated 1-d data from one grid to a new one.
LISTFROMPERL - Called from a Perl Script to list MDSplus data from a Web Page
LISTSHOTS - List shot numbers with signal over/under a certain amount
LIST_PRINTER_UNIX - LIST available printers from lpstat -a
LOADBLOBS - calls many routines used for loading blob tracking info into a database and making plots and output files
LOAD_FC - Load summary Waveforms for Phantom Fast Cameras into MDSplus.
LOAD_NEBAR - Load Ne-bar Waveform into MDSplus.
LOGBOOK_LIST - List info from the NSTX logbook (to a screen or file)
LOGBOOK_LIST_PLUS - List info from the NSTX logbook (to a screen or file)
LOGBOOK_OPTIONS (COPIED FROM LOGBOOK_OPTIONS) - List info from the NSTX logbook (to a screen or file)
LONG64DATE2STR - Return date from a 64-bit longword, like 1112308040, as returned from file_info, in a more conventional format.
LONGDATE2STR - Return date from a longword, like 20060218, in a more conventional format
MAKEN - Make an array of N values, linear between two given limits.
MAKENXY - Make 2-d x and y coordinate arrays of specified dimensions.
MATCH - Routine to match values in two vectors.
MAXSTRUCT - find the maximum of a structure (ignores structures within the input structure)
MDIR - Directory listing of MDSplus data files with wild cards
MDSDAT - "replacement" for gadat.pro. Get MDSplus signal data without having to open a tree (much faster, if a tree is specified)
MDSDATAVSSHOT - Print single values of MDSplus signals vs. shot number. The value can be the max or min, or at a specific time, including time of Max Ip, Max Neutrons, etc. The shot list may be reduced by certain qualifiers, such as to shots where the max of an arbitrary signal is > a given value. Output can be in a format suitable for importing into Kaleidograph, Excel, etc.
MDSDECLAREEVENT - set an MDS event with shot number associated with the event
MDSEDITBRANCH - Read a branch of MDSplus values, allow editing of scalar values in a widget and write back out.
MDSEVENTWAIT - Widget to Wait for an MDSplus event, or the user clicks the CANCEL button.
MDSGETSIG - Get a signal, units and axes values easily from MDSplus
MDSLARGESTNODE - find largest node in a tree
MDSLIST - Print ASCII file containing data for MDSplus signal(s). The "dimension" of one of the signals (typically time) is in the first column, followed by data values at that time. Output may be in the format suitable for importing into Kaleidograph, Excel, etc.
MDSLOADSCALAR - Load MDSplus scalar with one simple call (after opening shot)
MDSLOADSIG - Load MDSplus signals with one simple call (after opening shot) Optionally add node and/or tag to a shot tree.
MDSMKFILE - Write an ascii file containing time and data for MDSplus signal(s). Time is in the first column, followed by data values at that time. Output may be in the format suitable for importing into Kaleidograph, Excel, etc.
MDSNODECHANGES - Print times when the last change was made to an MDSplus node.
MDSSCALARS - Print ASCII file containing values of MDSplus scalars(s) for a list of shots.
MDSSETEVENT - Generates an MDSplus event
MDSSHOTDATE - Print time and date of an NSTX shot.
MDSSIGINTERP - call TDI to interpolate signals, but handle expressions in which multiple signals are included. (assumes all same timebase within a given TDI expression)
MDSTIME2DBTIME - Convert date & time from MDSplus to database format
MDSTIME2VSTIME - Convert date & time from MDSplus to Visual Studio format
MDSTREECHANGES - Print times when the last change was made to an MDSplus tree, and who did it.
MDSUNITS - return units of an MDS tag, or the time, or time units
MDSW - Interactively plot MDS signals with Crosshairs and many options
MDSW_NOCH - Plot one MDS signal simply (without Crosshairs)
MEDSMOOTH - Median smoothing of a vector, including point near it's ends.
MEDSMOOTHEDGE - Median smoothing of an array, including handling edges.
MINMAX - print the min and the max of an array
MKDATEDIR - Make a directory of the form YYYYMMDD (if it doesnt't exist) and move files there if the files were last modified on that date.
MKMANYMOVIES - make animations for the Fast Camera data from a shot list
MK_BITARRAY - Create an array of 1's & 0's corresponding to input bits set (works for negative numbers, too, unlike similar routines)
MK_COLOR - Create color tables with 12 fixed colors at the top. These colors can be referenced by name.
MK_FILENAME - File names with system independent symbolic directories.
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_JPEG - make a bit-map color jpeg file of an IDL window for (viewable) insertion into MS Word, or Powerpoint documents.
MK_MPEG - Write a sequence of images from a 3-D array, or a series of tiff files, as an mpeg movie.
MK_PDMENU - make a structure for a pull down menu for CW_PDMENU routine
MK_PNG - make a bit-map color png file of an IDL window for (viewable) insertion into MS Word, or Powerpoint documents.
MK_SCOPE_GIF - make gif files from scope-like output, using a scope file as input
MK_SHOTLIST - Parse an input string for shots into an array of shots
MK_WTINPUTFILE - Create an input file for Web Plotting Tools, like http://nstx.pppl.gov/nstx/Software/WebTools/mdsplotfileinput.php from an MDSplus Scope or jScope input file.
MONEVENTS - Widget to monitor occurrence of MDSplus events & optional Shot #, if passed with the event declaration. The time of the event can also be displayed.
MONEVENTS_NOXMANAGER - monevents version to run in batch mode. Widget to monitor occurrence of MDSplus events & optional Shot #, if passed with the event declaration. The time of the event can also be displayed.
MONITORJOB - Monitor an IDL job, and restart it if not present
MONTHNAMES - Returns a string array of month names.
MONTHNUMBER - Returns a month number given a month name.
MPCURVEFIT - Perform Levenberg-Marquardt least-squares fit (replaces CURVEFIT)
MPEG_FROM_SCREEN - Example of creating a color Mpeg animation with text overlayed. Works on both 8-bit and 24-bit monitors. Can read from files, but those returning 24-bit data will not have the text overlaying option.
MPFIT - Perform Levenberg-Marquardt least-squares minimization (MINPACK-1)
MPFIT2DFUN - Perform Levenberg-Marquardt least-squares fit to a 2-D IDL function
MPFIT2DPEAK - Fit a gaussian, lorentzian or Moffat model to data
MPFITELLIPSE - Approximate fit to points forming an ellipse
MPFITEXPR - Perform Levenberg-Marquardt least-squares fit to arbitrary expression
MPFITFUN - Perform Levenberg-Marquardt least-squares fit to IDL function
MPFITPEAK - Fit a gaussian, lorentzian or Moffat model to data
MPLOTTITLE - write a plot title with NSTX label and a list of shots on left
MPTSCAM - Animate several plots, including MPTS variables
MPTSOUT - write a table of MPTS data and errors from the edge along with GPI average
MPTSSURFACE - A graphical interface for plotting shaded surfaces of NSTX Multi-point Thomson Scattering data (MPTS) from MDSplus. Summary plots of Ip, D-alpha, Neutral Beam and RF input power, and stored energy (W-mhd from EFIT). Times of NB and RF heating are indicated on the surfaces by darker shading. Different controls are provided to change the viewing angle and other plot parameters. Projection of data maxima vs. radius may be projected on the "back wall". (For critical accuracy of values, especially on the edges, please check with the Thomson diagnosticians personally.)
MSG_BELL - Print a message to the IDL session and ring a bell
MULTIPLOT - Create multiple plots with shared axes.
MVSHOTRANGEDIR - Put files fitting a certain partern into a sub-directory of the form nnnn00s, where nnnn00 represents a shot range, e.g., 114100s whould contain shots 114100-114199.
NDECIMALS - returns the number of non-zero digits after decimal point. ignores insigificant bits (in principle)
NEARESTI - Return index of input array closest to the value of "pt"
NEARESTI_ARRAY - Return indices of big input array closest to the values in the little input array.
NEXTGOODSHOT - find the next shot that has more than a certain Ip.
NICENUMBER - Find a "nice" number close to the given number. Actually, this is for older digitizers, so "rounds" to numbers like 1, 2, 2.5, 5, etc.
NNET.PRO - Neural network classifier. This is a standard 3-layer back-propagation net.
NODENAME - Return nodename on Linux computer
NODESEARCH - Search MDS Plus Trees for a node
NONALPHANUM - find position of first character which are not alphanumeric (0-9, a-z, A-Z & _) if none found, returns strlen(input)
NONNUMBER - find position of first character which is not a number (0-9). if none found, returns -1.
NONVARPOS - find position of characters which are not valid for MDSplus names
NSEARCH - Search MDS Plus Trees for a node
NSTXCORNER - write NSTX in upper left-hand corner of a plot
NSTXLOGO - draw NSTX logo in upper left-hand corner of a plot
NSTXLOGS_GET - Get info on NSTX shots from the ENTRIES table in the NSTXLOGS database
NSTX_XP - return the NSTX XP for an NSTX shot
NUMBERPOS - find position of first character which is a number if none found, returns strlen(input)
NUMLINES - Return the number of lines in a file
NWORDS - Return the number of words in the given text string or string array.
ONALPHA - Tests for running on an alpha computer. You can specify the the desired Alpha computer. Optionally beeps, and prints a message and returns an error if not on the desired Alpha computer.
ONCOMPUTER - Return 1 if on the specified computer. First uses enironmental variable HOST has the computer name.
ONESURF -
OPLOTDASH - Overplot a variety of dashed lines, even if terminal emulator doesn't for different linestyles
OPLOTSEP - Overplot separatrix and limiter onto grid with GPI images already drawn. Works with 2010 NSTX shots.
OS_FAMILY - Return the current operating system as in !VERSION.OS_FAMILY
OVPLOT - Just like oplot, except it calls vcomp to "visually compress" an array for faster delivery of graphs at the expense of CPU time. All data spikes should be retained.
PADSTRINGS - pad column widths so each text field takes up same amount of space. Remove any tabs.
PARCHECK - To check that a procedure has been called with the minimum of allowed number of parameters.
PDSURFACE - This routine provides a graphical interface to the SURFACE and SHADE_SurfRangeACE 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.
PECOMP - Interactively compare PCS and EFIT signals for a shot
PICKCOLORNAME - The purpose of this program is to provide a blocking or modal widget interface for selecting a color "name". The program uses colors familiar to the FSC_COLOR program, and is often used to select a color name for passing to FSC_COLOR.
PICKPLOT - This function allows the user to interactively pick a plot file. It will be plotted in a separate window. Postscript files (with a "ps" extenstion will go to a gv window, and others will be plotted with xv.
PINGPLOT - plot ping times to various computers (from sunfire13, probably).
PLASMAEDGE - From EFIT or LRDfit, find R and Z values of last closed flux surface (separatrix) for a particular NSTX shot and time. Optionally save to a file.Also will plot limiters and last closed flux surface with axes. Can also return R & Z of limiter interior.
PLOT0CHECK - Plots blank axis if no data in !x.range or !y.range
PLOT1SIG - plot 1 NSTX signal for many shots stacked vertically
PLOT3_MPTS - Make 3 Multi-point Thomson Scattering Plots: 2-D plots of electron Temp and Density and a time history.
PLOT7 - plot 7 (or any number) NSTX signals on the same x-axis
PLOTBLOBVYVSBIN - plot a series of vertical velocity traces vs. time from the blob database. Each trace will be from a horizontal range
PLOTCOLORFILL - Plots colorful bar charts
PLOTDASH - Plot a variety of dashed lines, even if terminal emulator doesn't for different linestyles
PLOTHIST - Plot the histogram of an array with the corresponding abcissa.
PLOTNORMAL - plot a normal curve on top of a histogram of data
PLOTNSHOTS - make scope-like plots with overlays from multiple shots.
PLOTNSIGS - make scope-like plots with overlays from multiple signals. this is the version of plotnshots that overlays different signals on the same axes
PLOTSCOPE - make scope-like plots, optionally with overlays from multiple shots.
PLOTSIG1VSSIG2 - plot 1 MDSplus signal vs. another
PLOTSUMMARY - Plot vs. time a summary of a shot (Ip, D-alpha, Pinj) in a small frame
PLOTSUMMARY4 - Plot vs. time a summary of a shot (Ip, D-alpha, Pinj, Wmhd) in a small frame
PLOTSYM - Define useful plotting symbols not in the standard !PSYM definitions.
PLOTTSWALL - This procedure will plot the fitted profiles of electron temperature and density from the NSTX Multi-Pulse Thomson Scattering (MPTS) diagnostic.
POLY_SMOOTH - Reduce noise in 1-D data (e.g. time-series, spectrum) but retain dynamic range of variations in the data by applying a least squares smoothing polynomial filter, also called the Savitzky-Golay smoothing filter. The low-pass filter coefficients are computed by effectively least-squares fitting a polynomial in moving window, centered on each data point, so the new value will be the zero-th coefficient of the polynomial. Approximate first derivates of the data can be computed by using first degree coefficient of each polynomial, and so on. The filter coefficients for a specified polynomial degree and window width are computed independent of any data, and stored in a common block. The filter is then convolved with the data array to result in smoothed data with reduced noise, but retaining higher order variations (better than averaging).
POPULATEBLOBS - Read a file created from fcplayer.pro with columns of blob characteristics vs time. compute frame-to-frame statistics like x & y velocity and duration, based on "reasonableness" factors, like maximum movement per frame allowed. Velocities are recomputed after parent-child relationships determined, so the velocity tracks can be smoothed. (loadblobs.pro can be used for all the steps needed to populate the database.)
PPPL_PRINTERS - return an array of strings of printer descriptions at PPPL
PRIME - Return an array with the specified number of prime numbers.
PRINTSCOPE - print scope-like output, using a scope file as input
PRINT_PATH - prints component directories of an IDL path string.
PROGRESSW - show progress bar until done, or the user clicks the STOP button.
PRONAME - This function retrieves the name of the currently active procedure.
PSF_GAUSSIAN - Create a 1-d, 2-d, or 3-d Gaussian with specified FWHM, center
PSIINTERP - From EFIT or LRDfit, get psi of a flux surface contour at a particular shot and time and R & Z. Then, find the R position of that same psi value at Z=0.
PSWINDOW - This function is used to calculate the size of a PostScript window that has the same aspect ratio (ratio of height to width) as the current display graphics window. It creates the largest possible PostScript output window with the desired aspect ratio. This assures that graphics output looks similar, if not identical, to PostScript output.
PS_FORM - This function displays a form the user can interactively manipulate to configure the PostScript device driver (PS) setup. The function returns a structure of keywords that can be sent directly to the DEVICE command via its _EXTRA keyword
PTR_FREE_RECURSIVELY - This routine when passed a pointer will free up any memory associated with that pointer. This includes structures, which could contain pointers, or other structures which could in turn contain more pointers. It also destroys objects it comes across. It can also cope with null pointers that are found on its travels.
PWD - print the current working directory
QUICKDESPIKE - Quick way (execution-wise) to remove single-element spikes.
READCOL - Read a free-format ASCII data file with columns of data into IDL variables. Lines of data not meeting the specified format (e.g. comments) are ignored. Columns may be separated by commas or spaces. Use READFMT to read a fixed-format ASCII file. Use RDFLOAT for much faster I/O (but less flexibility).
READNETCDFBLOBS - Read NetCDF files of dummy Blob data for code validation. the files can be generated with gennetcdfblobs.
READ_ARRAY - Read a numeric array (1-D) from a text file
READ_FLOATS - Read a list from a text file and return a floating-point array
READ_GENERIC - read an image from a variety of types of files
READ_LIST - Read a list from a text file and return a string array. Will ignore lines beginning with a semicolon, but will will return blank lines.
READ_NUMBERS - Read a numeric array (1-D) from a text file
READ_QUOTED - Reads a file and returns anything between first two quotes.
READ_TABLE - Reads a table file, like from a spreadsheet.
REMCHAR - Remove all appearances of character (char) from string (st)
REMOVE - Contract a vector or up to 7 vectors by removing specified elements
REM_ELEM - return subscripts of input array remaining after elements in a second array are removed
REPCHR - Replace all occurrences of one character with another in a text string.
REPSTR - Replace all occurences of one substring by another.
RESAMPLE - Resample a vector with triangular smoothing.
RESETPLT - This procedure will reset all or a selection of the system plot variables to their initial values
RIGHTYAXISLIMITS - Widget to set some Y Axis values for the right-hand axis in mdsw
RIGHT_ASPECT - Allow contour (or x-y) plots to have the aspect ratio of the data
RMFILESBYDATE - Remove files not modified since a certain date
ROUNDEDAXISLIMITS - Find "nice" axis values, like IDL plot routine does.
RUNTOT - compute a running total of an array by calling an external routine (this is inefficient in normal IDL)
SAMETYPE - make two variables the same numerical type
SAVEBLOBS - Save blob tracks, just like FCplayer, but easier and faster. Usually called from LoadBlobs.pro.
SCREENDUMP - Postscript file from an IDL window, whether 8- or 24-bit graphics
SCREEN_TITLE - write a plot title with shot date and time and NSTX label
SDEV - Returns standard deviation of an array.
SEARCHMDSNODES - Search MDSplus nodes for string contents
SEARCHTEXTNODES - Search MDS Plus Trees for Textual Data
SELECT_FONT - Select a Unix hardware font for IDL graphics.
SEPVSTIME - Get the separtrix (last closed flux surface) R & Z values vs. time. from EFIT or LRDfit for a particular NSTX or CMOD shot. Can also return R & Z of limiter interior.
SETMDSSHOTEVENT - set an MDS event with shot number associated with the event
SETPMULTI - partition the screen into different graphs if 7 or less plot boxes, then 1 column of plots if more than 7 plot boxes, then 2 columns of plots
SETUP_PS - open postscript file and set system variables for postscript device
SETUP_TEK - Set system variables for tektronix device. Use to direct plots to the Tek window in Versaterm, or to XTC.
SETUP_XPC - Use to direct postscript plots to the X-windows Plot Controller (XPC).
SHADE_SURFRANGE - make SHADE_SURF plots with x & y ranges (correctly)
SHOCKVSTIME - Stack plots of a line from the center of .cin file image at various times See http://nstx.pppl.gov/nstx/Software/Help/shockwaves.html for sample images. After plotting, you will be prompted for times for which calculate the speed of the leading edge of the shockwave.
SHOTATTIME - find the NSTX shot number closest to a certain time
SHOTDURATION - Return the Shot Duration in seconds
SHOTSOFFILES - Return MDSplus shots (based on creation time) of files
SHOW3M - Show a 2D array three ways in a display that combines SURFACE, CONTOUR, and an image (color/gray scale pixels).
SHOWBITS - Given a byte or integer, return a vector of 8 or 16 values which are the binary representation of the value.
SIGALERT - Send email alerts when MDSplus signals are not acquired, or have undesirable values.This routine can be run in your IDL session, or it can be put into the "Auto-reload Facility" of NSTX-U.
SIGN - Gives the sign of X, i.e. 1 for positive, -1 for negative, 0 for 0.
SIGX - Compute horizontal extent of blob along center axis, from edge to edge, given theta, and the two radii. Equation from Jim Myra
SIGY - Compute vertical extent of blob from edge to edge along center axis given theta, and the two radii. The units of the result will be the same as the units of radius1 & radius2. Equation from Jim Myra
SIMP - Does Simpson numerical integration on an array of y values.
SIZE_STRUCT - Obtain the size in bytes of an IDL structure definition.
SMOOTH2 - Do multiple smoothing. Gives near Gaussian smoothing.
SMOOTHEDGE - smooth a 2-D array using /edge_truncate, but then smooth the remaining rows and columns within width/2 of the edge even more.
SMOOTHTRUECOLOR - smooth a true color array 1 component at a time.
SPAWNPRINT - Spawn command on VMS or Unix to print a Postscript file
SPEC_DIR - Provide a complete file specification by appending a default disk or directory if necessary.
SQLFIXSPECIALCHARS - Encapsulate special characters so they can work in SQL text insertions The special characters are '%', '^', '$', '*', '@', '#', '(', '!', ')', '?'
STACKPLOT - An example of X-window widgets for plotting some GA data
STRARRAYSAME - Returns TRUE if two strings, or string arrays, are identical, else FALSE
STRCONCAT - Concatenate a string array into single string, or a matrix of strings into a string array.
STREP - Edit a string by position. Precede, Follow, Replace, Delete.
STRESS - String edit by sub-string. Precede, Follow, Delete, Replace.
STRETCHSTEPS - stretch parts of the color tables into steps.
STRMATCH - check for string match to a wild card specification
STRNUMBER - Function to determine if a string is a valid numeric value.
STRPARSE - Parses the string LINE using the characters in DELIM as delimiters. Puts individual pieces into consecutive locations in LIST.
STRUCEDIT - Widget to edit a structure of scalars from an IDL save file. The names of the input fields are the names of the structure elements.
STRWHERE - a "where" operator for strings matching a set of string wild cards
SURFRANGE - make SURF plots with x & y ranges (correctly)
SURF_CONTOUR - The purpose of this program is to demonstrate how to create a shaded surface and coutour plot in the same object graphics window. The contour plot should be able to be translated independently of the surface.
SYB_ENTRY - : Display/modify/create entries in the NSTX logbook database.
TABINV - To find the effective index of a function value in an ordered vector.
TAGRANKOF - Return a list of MDSplus signals with a certain rank (that contain data)
TAGSEARCH - Search MDS Plus Trees for a tag
TAG_EXIST - To test whether a tag name exists in a structure.
TDIS - Search MDS Plus Trees for TDI DATA
TEMIDPLANESEP - Find the electron temperature at the midplane separatrix by interpolating from NSTX MPTS data
TEMPLATE - Provide a template for IDL routines to be used by others
TESTCMD - test batch execution
TEXTLINES - Form lines of text for outputing (say, in a table form). If formats are not input, then guess about good formatting for variables of different types.
TH_IMAGE_CONT - Plot contours of Images with both contour lines and colors
TIME2SEC - Return seconds since midnight, if no date given. Otherwise, since Jan. 1, 1970.
TIMESOFSHOTS - return dates and times, like 12:26PM, of NSTX shot
TOIDLTIME - Convert a date string to IDL time (output from SYSTIME(1), i.e., seconds since 1/1/1970
TOTSTRUCT - find the total of numerical values in a structure (handles structures within the input structure)
TREE_EXISTS - Return a true if an MDSplus tree exists for a given shot number
TRIMTAGNAMES - Trim tree info from an MDSplus tag name
TRISMOOTH - Triangular smoothing of a vector, including points near the ends.
TRUNS_GET - List info (in a database) on NSTX TRANSP runs (to a screen or file)
TVIMAGE - This purpose of TVIMAGE is to enable the TV command in IDL to be a completely device-independent and color-decomposition- state independent command. On 24-bit displays color decomposition is always turned off for 8-bit images and on for 24-bit images. The color decomposition state is restored for those versions of IDL that support it (> 5.2). Moreover, TVIMAGE adds features that TV lacks. For example, images can be positioned in windows using the POSITION keyword like other IDL graphics commands. TVIMAGE also supports the !P.MULTI system variable, unlike the TV command. TVIMAGE was written to work especially well in resizeable graphics windows. Note that if you wish to preserve the aspect ratio of images in resizeable windows, you should set the KEEP_ASPECT_RATIO keyword, described below. TVIMAGE works equally well on the display, in the PostScript device, and in the Printer and Z-Graphics Buffer devices. The TRUE keyword is set automatically to the correct value for 24-bit images, so you don't need to specify it when using TVIMAGE.
TVIMAGE_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. This function is similar to "REBIN" in that it can resize a one, two, or three dimensional array. "REBIN", however, requires that the new array size must be an integer multiple of the original size. CONGRID will resize an array to any arbitrary size (REBIN is somewhat faster, however). REBIN averages multiple points when shrinking an array, while CONGRID just resamples the array.
TVRD_24 - This function reads a 24-bit image from a 24-bit or 8-bit display device, returning a pixel-interleaved byte array of type BYTARR(3, xsize, ysize), where xsize and ysize are the dimensions of the current graphics device.
TV_24 - This procedure displays a 24-bit image on the current graphics device, constructing a custom colour table if the device supports less than 257 colours.
TWOSCOMPLEMENT - Taking the Two's Complement of an integer
TWOSURF -
TYPE - Finds the type class of a variable.
UNSETUP_PS - close a postscript file (opened by setup_ps) and re-set system variables for previous device.
UNSETUP_TEK - undo system variables from setup_tek call.
UNSETUP_XPC - Close plots file opened with setup_xpc, and send to the X-windows Plot Controller (XPC) by figuring out next file in the sequence it is looking for.
UPDATENSTXSTATUS - Update the NSTX Status Web page
USESIGMATH - parse an MDSplus TDI string, substituting Brian Nelson's Signal Math TDI routines for +,-,* and /, so timebases get adjusted, if necessary.
USINGXWINDOWS - Prompt user for switching Plot device to X.
VAXIS - shell around AXIS procedure that sees if number of minor y tick marks need to be reduced, and if the number of y tick labels need to be cut in half.
VCOMP - "visually compress" (resample) an array for faster plotting of lines. All data spikes should be retained. Will return y points for each x -- the min & max values. IF nFinal GE N_ELEMENTS(inData)*2 will just return inputs
VECTORSURF - Shows a fancy way to plot irregulary spaced data from x,y & z vectors.
VGDS_TITLE - write a plot title with shot date and time and NSTX label
VIEWTEXT - View a string, or string array, of text in a scrollable text widget.
VPLOT - Just like plot, except it calls vcomp to "visually compress" an array for faster delivery of graphs at the expense of CPU time. All data spikes should be retained.
VT100 - Define the TEK and VT100 commands for use in IDL. Especially useful for MAC users who use Versaterm or users who otherwise want to do Tektronix plots while connected to their UNIX platform of choice.
WATCHEVENTS - Widget to monitor occurrence of MDSplus events. If all events do not happen before next occurance of first event, send e-mail.
WEBDISPLAY - Display web pages from IDL for Help, or other purposes.
WEBPLOTSUM - Plot vs. time a summary of a shot in a small frame Ip, D-alpha, stored energy, NB & RF power are plotted.
WEEKDAY - Compute weekday given year, month, day.
WFMDSSHOTEVENT - Wait for an MDSplus event, with shot number coming in
WHERE_ARR - Return the subscripts where a given set of values equal the values in the input array. It is basically an expansion of IDL where in which the condition to match can be an array.
WHICH - Like Unix which, prints the path of an IDL routine.
WHICHCOMPUTER - Return name of Linux computer you are running on. First uses enironmental variable HOST, then uname -n
WHITEOUT - white-out a portion of the color table -- defaults to the 5 lowest locs.
WIDGET_BOTTOM - Move a widget to the bottom of the screen or base widget.
WITHRANKOF - Return a list of MDSplus signals with a certain rank (that contain data)
WORDARRAY - Convert text string or string array to a 1-d array of words.
WRITECAMAVG - For camera files that exist for a particular shot, check for \CAMERAS::TOP.FC_n.RAWDATA:FRAMES_MAX and \CAMERAS::TOP.FC_n.RAWDATA:FRAMES_AVG (tags \PH7_n_FMAX and \PH7_n_FAVG) and write them if need be.
WRITELOG - Provide a writeLog for IDL routines to be used by others
WRITE_GENERIC - write an image to the appropriate type of file, based on file extension
WRITE_IN_BOX - Writes a text message within a box in a graphics window.
WRITE_MPEG - Write a sequence of images as an mpeg movie
WRITE_TEXT - Write data to a text file
XANIMJPEG - animate jpegs (or other image files) in a VCR-like widget, which can make an MPEG Movie.
XAXISW - Widget to set some X Axis values via the system variable !X
XCDEDIT - A table editor modified from XVAREDIT for ppcc c.d file.
XCOLORS - The purpose of this routine is to interactively change color tables in a manner similar to XLOADCT. No common blocks are used so multiple copies of XCOLORS can be on the display at the same time (if each has a different TITLE). XCOLORS has the ability to notify a widget event handler, an object method, or an IDL procedure if and when a new color table has been loaded. Brewer color tables can also be accessed from this program, if the file fsc_brewer.tbl can be found somewhere in your IDL path.
XEASYANIM - animate 3-D array and optionally make MPEG Movie
XFONT_4 - XFONT_4 is a modal widget for selecting and viewing an X Windows font.
XIA - Display an animated sequence of images using X-windows Pixmaps. The speed and direction of the display can be adjusted using the widget interface.
XPC - This function allows a user to interactively pick a postscript file from a list that can be scrolled. The file will be plotted in a separate gv window.
XSECTIONW - Widget to display an image and x-y plots of cross-sections. Color palettes may be loaded, adjusted and saved. Images can be saved as 'jpg','tif','tif','bmp','jpeg,'png', 'ppm', 'pgm', or 'gif'
XVAREDIT - This routine provides an editor for any IDL variable.
XY2RMRSEP - transform pixel locations (say, from a Fast 2-D Camera image) to distance from the Separatrix and distance along field line parallel to flux lines
XYANIM - Animate a series of X-Y plots. Makes an animation in a XINTERANIMATE window. An MPEG file can then be saved, or the movie can be played with VCR-like controls
X_COMPLAIN - Pops up a one line complaint.
YAXISW - Widget to set some Y Axis values via the system variable !Y
YMD2DATE - Convert from year, month, day numbers to date string.
YMD2JD - From Year, Month, and Day compute Julian Day number.
YRMONTHDAY - Return a string of YYYYMMDD from a date string.
ZAXISW - Widget to set some Z Axis values via the system variable !Y

Routine Descriptions

ADDDATE

[Next Routine] [List of Routines]

 NAME:
       addDate
 PURPOSE:
       Add days to a date. Tries to return string in same form as input
 CATEGORY:
	Dates
 CALLING SEQUENCE:
       newDate = addDate(date, ndays)
 INPUTS:
       date = date string, e.g., '6/17/1951', '1951/6/17', or 19510617    
         17 Jun, 1951     Jun 17 1951   1951 Jun 17
         17/Jun/85   17-Jun-1951   85-Jun-17   17 June, 1951.
	nDays - number of days to add (negative number OK)
 KEYWORD PARAMETERS:
	JULIAN - if set, return as Julian day
	LONGYEAR - if set, return year as 4-digits 
 OUTPUTS:
       newDate = Returned date string
 EXAMPLES:
	IDL> print, addDate('6/17/1951', 13)
	06/30/1951

	IDL> print, addDate('June 17, 1951', 13)
	June 30, 1951

	IDL> print, addDate('6/17/51', 365)
	06/16/52				

	IDL> print, addDate('6-17-1951', -30)
	05-18-1951

	IDL> print, addDate('17-Jun-1951', -30)
	18-May-1951

	IDL> print, addDate('20110520', -30)
	20110420

	IDL> print, adddate(systime(),-2)
	28 Jun 11

 COMMON BLOCKS:
 NOTES:
 MODIFICATION HISTORY:
	20-May-2011 fix for longdates
	19-Feb-2010 add LONGYEAR keyword so 4-digit year returned
	17-Aug-2009 Written by Bill Davis

ADDGPICOMMENT.PRO

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       addGPIcomment.pro

 PURPOSE:
       add comments to a file for GPI web pages

 CATEGORY:
       GPI, Web, NSTX

 CALLING SEQUENCE:
       IDL> addGPIcomment, headline=headline, Description=Description, username=username,  $
                           shot=shot, PagePassword='something',

 INPUT KEYWORDS:
   Required:
	username - Linux username of person making entry
	PagePassword - this is required
	shot - NSTX shot # for which comment applies
	headline - a one-line Summary of status
   Optional:
	Description - more detailed comment, can be up to 20 lines
	outFile - web page, DEFAULT='/w/nstx.pppl.gov/htdocs/nstx/Software/nstxstatus.html'
	maxLength - max length of status field
	logfile - name of log file. 
		  DEFAULT='/local/nstxops/web/log/addGPIcomment.log'
	debug - if set prints debugging info
	verbose - if set prints lots of info
	status - if odd, successful
   
 OUTPUTS:
       appends to a text file, comments.txt, to a web-accessible directory.

 METHOD:
	Gets data for fields (like Description) to be updated from addGPIcomment.html
	(via idlMDSPlotServer2550.pl) and appends to the output file.

 COMMON BLOCKS:
       NONE

 EXAMPLE:
       IDL> addGPIcomment, shot=999999, headline='This is a test',  $
		            username='bdavis', PagePassword='Masa', /debug
       IDL> addGPIcomment, shot=999999, headline='This is a big test',  $
		            username='bdavis', PagePassword='Masa', $
	       description=strconcat(replicate('blah', 200), delim=' '), /debug
 MODIFICATION HISTORY:
	15-Oct-2013  Written by Bill Davis, PPPL, for Stewart Zweben

ADDLABELNODES

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       addLabelNodes
 PURPOSE:
       Add LABEL sub-nodes to MDSplus signal nodes reading info from a file
 CATEGORY:
       MDSplus, TCL 
 CALLING SEQUENCE:
       addLabelNodes, shot1, shot2, filename=filename
 INPUTS:
	shot1 = starting shot number to process (defaults to last shot)
	shot2 = last shot number to process (optional)
 KEYWORDS:
	filename - name of file with info - REQUIRED, 
		   see, e.g., BDAVIS$:[CVS.MISC.WF]tauslabel.dat
	   the file must contain 4 columns, separated by white space.  
	   the first column is the tagname (without \), the last column is 
	   the Label text enclosed in double quotes. The middle columns
	   can be any single word or character (file format from another
	   application).
	tree - name of tree -- defaults to 'WF'
 COMMON BLOCKS:
       NONE
 NOTES:
       YOU NEED PRIVILEGES to write to the MDSplus tree.
 LIMITATIONS:
 MODIFICATION HISTORY:
	25-Jan-01 Written by Bill Davis.

ADDMDSTAGS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       addmdstags
 PURPOSE:
       Add tags to MDSplus nodes
 PROCEDURE:
 CATEGORY:
       MDSplus, Summary 
 CALLING SEQUENCE:
       addmdstags, shot=shot, nodes=nodes, tags=tags
 INPUTS:
 KEYWORDS:
	shot - shot number to process
	nodes - MDSplus node names to which tag will added (all in same tree)
	tags - to add
	VERBOSE  - if set, more info is printed
	test  - doesn't write to MDSplus
 EXAMPLE:
       nodes = ['\PASSIVESPEC::TOP.IR.IMG0.RAWDATA.IR_408:TIMES', $
		 '\PASSIVESPEC::TOP.IR.IMG1.RAWDATA.IR_408:TIMES', $
		 '\PASSIVESPEC::TOP.IR.IMG2.RAWDATA.IR_408:TIMES' ]
	tags = ['img0_408_times', 'img1_408_times', 'img2_408_times' ]
	addmdstags, shot=128000, nodes=nodes, tags=tags, /verb, /test
   for i=shot1,shot1+499 do addmdstags, shot=i, nodes=nodes, tags=tags, /verb
 NOTES:
       YOU NEED PRIVILEGES to write to the MDSplus tree.
 LIMITATIONS:
	Divide by zeroes, etc. will cause a message like:
	    % Program caused arithmetic error: Floating illegal operand
 MODIFICATION HISTORY:
	27-Mar-2008 Written by Bill Davis.

ADDSIGNODES

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       addsignodes
 PURPOSE:
       Add signal nodes and tags to a MDSplus tree for many shots
 PROCEDURE:
 CATEGORY:
       MDSplus
 CALLING SEQUENCE:
       addsignodes, shot1, shot2, tags=[tag1,tag2,tag3,...]
 INPUTS:
	shot1 = starting shot number to process
	shot2 = last shot number to process
 KEYWORDS:
	tags - tags to add (if defined in the model tree, you
	       will not need to specify the corresponding nodes).
	nodes = if tags are not defined in the model tree, these are necessary
	tree - MDSplus tree
	usage - for MDSTCL node creation. Default='signal'
	VERBOSE  - if set, more info is printed
	test  - doesn't write to MDSplus
 NOTES:
       YOU NEED PRIVILEGES to write to the MDSplus tree.
 LOGIC:
	finds node names for tags. Then, if node names are not different
	than the "tag" names, does not add tags.
 LIMITATIONS:
	all signals must be in the same tree
 MODIFICATION HISTORY:
	11-Apr-07 changed for Linux (add output= to mdstcl)
	13-Jun-02 Written by Bill Davis.

ADDTREETOTAG

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       addTreeToTag
 PURPOSE:
       return tags with trees merged in
 CATEGORY:
       MDSplus, SCOPE
 CALLING SEQUENCE:
	names = addTreeToTag( tags, trees )
 INPUTS:
   tags - array of tags, e.g., '\ip1' (if tree already there, will not change)
   trees - array of trees (same dimension as tags)
 RETURNED:
	names - tag names with tree in them, e.g., '\engineering::ip1'
 KEYWORDS:
 COMMON BLOCKS:
       none
 EXAMPLE:
 	IDL> print, addTreeToTag( ['\ip1+\ip2'], ['engineering'] )
	\engineering::ip1+\engineering::ip2
 	IDL> print, addTreeToTag( ['\engineering::ip1.blah+\ip2'], ['engineering'] )      
	\engineering::ip1.blah+\engineering::ip2

 LIMITATIONS:
 MODIFICATION HISTORY:
	30-Apr-01 Written by Bill Davis

ADD_TAG

[Previous Routine] [Next Routine] [List of Routines]


 NAME:
    ADD_TAG
       
 PURPOSE:
    Add a new tag to the structure. NOTE: if you want to add more
    than one tag at once, use ADD_TAGS

 CATEGORY:
    Programming
 
 CALLING SEQUENCE:
    add_tag, oldstruct, tagname, tagValue, newstruct, structyp=structyp

 INPUTS: 
    oldstruct: The original structure (or array of structures)
    tagname: string containing the new tag name
    tagValue: the initial value of the new tag, e.g. fltarr(5)
           or [3,5,6], or 0L, etc.

 KEYWORD PARAMETERS:
   structyp: a string with the name of the new structure.
     if already defined an error is printed.

 OUTPUTS: 
    newstruct: The structure with the new tag it it.

 OPTIONAL OUTPUT
    NONE

 CALLED ROUTINES:
    COMBINE_STRUCTS
 

 REVISION HISTORY:
    25-OCT-2000, Judith Racusin.

ALPHAMOVIE10

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       alphamovie10
 PURPOSE:
       Plot every 10th frame in time, and overlay
       10 d-alpha traces. Have a marching vertical line indicating time 
	in a plot indicating the Strike Point Radius.

 CATEGORY:
       Animation, NSTX

 CALLING SEQUENCE:
	IDL> d=alphamovie10( 138000, tStart=tStart, tEnd=tEnd )

 INPUTS:
       shot = NSTX shot number 
 KEYWORD PARAMETERS:
    Inputs:
	tStart - 
	tEnd - 
	rMin -  minimum time to display (DEFAULT: 25 )
	rMax -  minimum time to display (DEFAULT: 85 )
	inc - how many D-alpha traces to put on a plot
	efit - 
	xsize - horizontal size of X window (DEFAULT: 600 )
	ysize - vertical size of X window (DEFAULT: 450 )
	xpos - initial X position of lower left of X window in pixels
	ypos - initial Y position of lower left of X window in pixels
	charsize - size of characters on plot (Default: 1.5)
	verbose - if set, will print many informational messages
	debug - if set, will stop before returning
 OUTPUTS:
       MPEGS can be saved from the IDL Animation Widget interface
 EXAMPLE:
	IDL> d=alphamovie10( 138000, /verb )

 NOTES:
       This routine uses X-memory, so too many frames can cause X errors.
	Try reducing the number of frames or xsize and ysize.
 MODIFICATION HISTORY:
	19-Jul-2010 put into xinteranimate by Bill Davis
	20-Apr-2010 written by Josh Kallman. cam4_fy10 written by Vlad.

AMEDIAN

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       AMEDIAN
 PURPOSE:
       Works the same as MEDIAN, but the effect tapers off at the edges.
 CATEGORY:
       Smoothing, Math
 CALLING SEQUENCE:
       Result = AMEDIAN( ARRAY, WIDTH )
 INPUT PARAMETERS:
       ARRAY   = One or two-dimensional array to be median filtered.
       WIDTH   = Width of the median filter box.
 OPTIONAL KEYWORD PARAMETERS:
       None.
 COMMON BLOCKS:
       None.
 SIDE EFFECTS:
       None.
 RESTRICTIONS:
       ARRAY must be one or two-dimensional.
 PROCEDURE:
       A larger array is constructed with the border filled with the reflected
       edges of the original array.  Then MEDIAN is applied to this larger
       array, and the area corresponding to the original array is returned as
       the result of the function.
 MODIFICATION HISTORY:
	26-Oct-2010 added edge keyword
	15-Jul-2008 for True Color images (dimensioned [3,xsize,ysize]), 
		    smooth over each color.
   	12-Jun-01 Made work for 1 dimension of 2 being small. [BD]
   	21-Feb-01 Just return array if width < or = 1. [BD]
       WRITTEN by William Thompson, February 1993.

ANIM2CINE

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
    anim2cine

 PURPOSE:
    Create an mpeg or avi movie from two .cin files from Phantom Cameras.
    The data can be color or monochrome

 CATEGORY:
    animation

 CALLING SEQUENCE:
    anim2cine, CineFile1, CineFile2, movieFile=movieFile, t1=t1, t2=t2

 INPUTS:
	CineFile1 - cine file
	CineFile2 - (optional)
	 - 
 OPTIONAL KEYWORD PARAMETERS:
	movieFile - name of output MPEG or QuickTime file (will default to a nice name), or 
	prefix - what would precede _shot_t1_t2 (in msec) in the output filename
	t1 - start time of animation in seconds
	t2 - end time of animation in seconds
	VIEW - if set, just displays images, and does not make an mpeg
   	ndups - if given means repeat every image 'ndups' times
   	despeckle - if set call despeckle routine (slow, but less "intrusive" 
		    than median)
	nSmooth - number input to median smoothing routine for camera data
	sigSmooth - number input to median smoothing routine for signal data
	topPixels -
	botPixels - 
	charsize - character size for plots. Default=2
	ctb - color table for non-color image 
	label1 - label on plot for CineFile1 (default='Monochrome')
	label2 -  label on plot for CineFile2 (default='Color')
	gamma1 - gamma setting for camera 1
	gamma2 - gamma setting for camera 2
	saturation1 - saturation setting for camera 1, if color 
	saturation2 - saturation setting for camera 2, if color 
	min1 - minimum value for bytescaling camera 1
	min2 - minimum value for bytescaling camera 2
	max1 - maximum value for bytescaling camera 1
	max2 - maximum value for bytescaling camera 2
	region1 - crop region to display for camera 1    
	region2 - crop region to display for camera 2     
	byteScale - if set, will scale 
	sigName - if set, will not show Fast Camera images, but this
		  signal vs. time (defaults to \passivespec::BAYC_DALF_HAIFA)
	sigT1 - starting time of signal vs. time plot
	sigT2 - ending time of signal vs. time plot
	sigTitle - if set, will be displayed above sigName plot,
		   else tries to get label from MDSplus
	verbose - if set will print out info as it works
 OUTPUTS: 
	an MPEG file named by movieFile keyword

 EXAMPLE:
    
    anim2cine,camera1="Phantom710-9206", camera2="Phantom73-6663", shot=138767, $
		 sig1='\wf::ip',sig2='\wf::nel', t1=.405, t2=.406,  $
		 gamma1=.37,  min1=20, max1=1442, $
		 gamma2=.8, sat2=.3, max2=1440, rot2=1                               ,/debug

    anim2cine,camera1="Phantom710-9206", camera2="Miro2-7988", shot=138767, $
		 sig1='\wf::ip',sig2='\wf::nel', t1=.405, t2=.406,  $
		 gamma1=.37,  min1=20, max1=1442, $
		 gamma2=.3, sat2=.3, max2=255                                 ,/debug

    f1=findcamfiles('nstx_1_135258.cin')
    f2=findcamfiles('Miro_135258.cin')
    anim2cine,f1,f2,t1=.17,t2=.53, inc=10, mag1=2, mag2=3,  $
	       region1=[.08,.05,1,1], region2=[.1,.0, 1.0,.9], $
	       sig1='\operations::mi_h908_01:input_03*(-1.6)', sig2='\wf::prf', $
	       Units1='mTor', /QUICKTIME, sigLabel1='Antenna Power', /debug

    anim2cine, camera1='Phantom710-9206', camera2='Miro2-7988',  $
	        shot=140000, t1=0.2, t2=0.3, sigT1=0.0, sigT2=1.0, $
		sig1='\wf::ip', sig2='\wf::pnb',  nSmooth=5,  /verbose  , /debug

    anim2cine, 'NSTX_130387.cin', $
		'MIRO_130387.cin', $
		t1=0.1, t2=1.4, sig1='\wf::ip', sigTitle='Plasma Current', /verbose                      

    anim2cine, shot=130370, t1=0.5, t2=0.58, /verbose, /view    , /debug

    f1=findcamfiles('nstx_1_135254.cin')
    f2=findcamfiles('Miro_135254.cin')
    anim2cine,f1,f2,t1=.180,t2=.580, inc=10, $
              movieFile='NSTX_135254_180-580ms.mpg', mag1=2, mag2=3    , /debug
    	  
    f1='/p/nstxcam-archive/Phantom71-5040/2009/nstx_1_135254.cin'
    f2='/p/nstxcam-archive/Miro2-7988/2009/Miro_135254.cin'
    anim2cine,f1,f2,t1=.180,t2=.580, inc=10, $
		region1=[.08,.05,1,1], region2=[.1,.0, 1.0,.9], $
              movieFile='NSTX_135254_180-580ms.mpg', mag1=2, mag2=3    , /debug

    f1=findcamfiles('nstx_1_136159.cin')	; fastest one
    f2=findcamfiles('Miro_136159.cin')
    anim2cine, f1,f2,  mag2=2,  $
		label1='Full', label2='Dropper View', $
		gamma1=0.096,  min1=65,  max1=4095, $
		gamma2=1.188, min2=1114, max2=11075                 , /debug

   mv files to /w/nstx.pppl.gov/htdocs/nstx/Software/Diagnostics/FC2008
   (or whatever year) for web viewing at
   http://nstx.pppl.gov/nstx/Software/Diagnostics/

 MODIFICATION HISTORY:
	08-Dec-2011 added flip1 and flip2 keywords (also made work with just 1 file)
	31-Aug-2010 lots of changes to allow to work off web tool nstxmovie.html
	01-Jul-2010 added region1 and region2 keywords and allow different 
		    magnifications for different cameras
	08-Oct-2009 updates for 2009 cameras. Extract shot # from filenames, 
			if not input
	12-Nov-2008 mods because cineload now assuming frame 0 is beginning of data
	16-Jul-2008 Use Z-buffer, even when viewing, for smoother displays
	15-Jul-2008 Written by Bill Davis

ANIMXYPLOT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       animxyplot
 PURPOSE:
       Animate X-Y plot of a 2-D array
 CATEGORY:
       Animation
 CALLING SEQUENCE:
       IDL> animxyplot, data2d, x, time [, ....]
 INPUTS:
       data2d - 2 d array (1st dimension like x, 2nd like time)
	x - array for x-axis of x-yplot
	time
 KEYWORD PARAMETERS:
	(can have any keywords used in PLOT command -- will be passed on)
 	mpeg - if set, will create an mpeg of animation
	filename - name of mpeg file (default =  'plotanimation.mpg')
	rep - # number of times to repeat frames (to slow down mpeg) default=0
	t1 - time to start animation (indexes into time array) (default=start)
	t2 - time to end animation (default=end)
	xtitle -    
	ytitle -    
	xsize - xsize of window in pixels
	ysize - ysize of window in pixels 
	flip - if set, will flip mpeg image    
	timeTitle - appended to indication of time on plot (def='Sec.')
	pause - # of seconds to pause between plotted frames when creating
	verbose - if set, will print many informational messages
	debug - if set, debug output will be printed
 OUTPUTS:
       NONE; just the mpeg file, if specified
 EXAMPLE:
	nframes = 20
	nPts = 1000
	data2d = fltarr(npts, nframes)
	time = findgen(nFrames)/1000 +0.2
	x =findgen(npts)/npts*150 + 50
	for i=0,nframes-1 do data2d[0,i]=sin(x*5/max(x)+i/10.)*exp(1.-x/100-i/10.)
	animxyplot, data2d, x, time, xtitle='Radii', ytitle='Value', /mpeg
 NOTES:
 MODIFICATION HISTORY:
       18-Jan-2008 Written by Bill Davis, PPPL

ARRAYMASK

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	arrayMask

 PURPOSE:
 	Return an array mask where values are 1 if within the drawn polygon
 	and 0 if outside. 

 CATEGORY:
       Utility
 CALLING SEQUENCE:
       IDL> mask=arrayMask( fullx, fully, x, y )
 INPUTS:
	fullx - full X array of data 
	fully - full y array of data
	x - x coordinates of polygon to enclose
	y - y coordinates of polygon to enclose

 OUTPUTS:
       mask - array dimensioned same as fullX and fullY containing 1's and 0's.

 EXAMPLE:
	IDL> fullx = findgen(65)
	IDL> fully = findgen(65)
	IDL> x = [10,10,20,20]
	IDL> y = [10,30,30,10]
	IDL> mask=arrayMask( fullx, fully, x, y )

 WRITTEN 03-Dec-2009 by Bill Davis

ARRAY_EQ

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	ARRAY_EQ
 PURPOSE:
  	Return TRUE if two arrays are equal, else false.
 CATEGORY:
       Programming
 CALLING SEQUENCE: 
	logical=ARRAY_EQ(array1,array2)

 INPUTS:   
	bigArray - an array of numbers to look in
  	littleArray - an array to look for matches in bigArray
 OUTPUTS:
	logical - 0/1

 COMMON BLOCKS:
 NOTES:
 MODIFICATION HISTORY:
 	17-May-99 WMD Written

BADPAR

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
     badpar
 PURPOSE: (one line)
     Validate an input parameter against valid entries.
 DESCRIPTION:

     This is a general parameter checking function for validating input
     quantities in other procedures and functions.  This routine will
     generate an error message indicating what is wrong with the item.

     Example of use:

     pro foo,array
     if badpar(array,[4,5],2,CALLER='foo') then return
        .
        . code for foo .
        .
     end


     This would cause an immediate return to the routine that called foo
     with an error message if the input was not either floating or double
     and 2 dimensional.

     As of IDL v3.0, these are the recognized type codes (see 1-218 in
        reference guide).

        Type
        Code     Data Type
        ----    -----------------------------
          0      Undefined
          1      Byte
          2      Integer
          3      Longword integer
          4      Floating point
          5      Double-precision floating
          6      Complex floating
          7      String
          8      Structure

 CATEGORY:
  Utility
 CALLING SEQUENCE:
     val = badpar(param,goodtype,goodrank)
 INPUTS:
     param    - IDL variable to validate.
     goodtype - Scalar or vector of type codes that are valid.
     goodrank - Scalar or vector of valid ranks.
 OPTIONAL INPUT PARAMETERS:
 KEYWORD PARAMETERS:
     CALLER   - String identifying the calling routine.
     DEFAULT  - Value to return in param if undefined and undefined allowed.
     DIMEN    - Dimensions of variable.
     NPTS     - Total number of elements in variable.
     RANK     - Rank of variable.
     TYPE     - Type of variable.
 OUTPUTS:
     Return value is true if the parameter is bad.  False if good.
 COMMON BLOCKS:
 SIDE EFFECTS:
	using the font keywords makes resizing very slow and inaccurate
 RESTRICTIONS:
 PROCEDURE:
 MODIFICATION HISTORY:
	03-Feb-03 Added FIT, FILE, and WID keywords. Made font work [BD]
     3/24/93 - Written by Marc W. Buie, Lowell Observatory.
     4/27/93 - MWB, added TYPE and DEFAULT keywords.

BAD_PTDATA_ERROR

[Previous Routine] [Next Routine] [List of Routines]

 
 NAME:
       BAD_PTDATA_ERROR
 PURPOSE:
       Return a logical true IF  the PTDATA error is serious
 CATEGORY:
       GA, error processing
 CALLING SEQUENCE:
       logical = Bad_PTDATA_Error(ptdata_ierr)
 INPUTS:
       ptdata_ierr - error return from PTDATA calls
 KEYWORD PARAMETERS:
 OUTPUTS:
 RETURNED:	logical indication of a serious error 
		(per IDL definition, e.g., 0 IF  false)
 COMMON BLOCKS:
 MODIFICATION HISTORY:
               1-Apr-97 WMD Written

BANGPW

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       bangPW
 PURPOSE:
       Widget to set interactively some !P values. Lists colors by name, 
	if mk_color used; otherwise finds "closest" index to named colors. 
	Allows selection of several custom plotting symbols (see PLOTSYM).
 CATEGORY:
       Graphics, Widgets
 CALLING SEQUENCE:
       IDL> bangPW
 INPUTS:
 KEYWORD PARAMETERS:
     Optional Keywords:
	  UPDATECALLBACK - a routine to call after struct system variable is set
	  GROUP_LEADER - This widget is destroyed if it's GL is destroyed
 OUTPUTS:
       The system variable !P is changed               	
 COMMON BLOCKS:
       NONE
 EXAMPLE:
	IDL> bangPW, UPDATECALLBACK='myReplotter'
 NOTES:
	If an application overrides !P.* parameters, or specifies them on
	the plot command, changing settings with this widget will not override.
	!P.SYMSIZE not controlled, because it seems to have no effect.
 MODIFICATION HISTORY:
	29-Apr-08 check for routine being compiled (vs. needing to be found)
		  added a "Refresh" button which, if a proper plotting routine
		  is provided, will replot with any changed settings.
	17-Aug-01 Allow lines with symbols [BD]
	30-Oct-00 Written by Bill Davis, PPPL

BELL

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       BELL
 PURPOSE:
       Ring terminal bell.
 CATEGORY:
	Programming, Sound, Errors
 CALLING SEQUENCE:
       bell, [n]
 INPUTS:
       n = number of rings (def=1).  in
 KEYWORD PARAMETERS:
 OUTPUTS:
 COMMON BLOCKS:
 NOTES:
 MODIFICATION HISTORY:
       R. Sterner, 20 Oct, 1989.

 Copyright (C) 1989, Johns Hopkins University/Applied Physics Laboratory
 This software may be used, copied, or redistributed as long as it is not
 sold and this copyright notice is reproduced on each copy made.  This
 routine is provided as is without any express or implied warranties
 whatsoever.  Other limitations apply as described in the file disclaimer.txt.

BETTERRAINBOW

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       betterrainbow
 PURPOSE:
       Loads a rainbow color palette with 6 evenly-spaced (roughly) colors
 CATEGORY:
      Colors,  Graphics
 CALLING SEQUENCE:
       IDL> betterrainbow
 INPUTS:
       NONE  
 KEYWORD PARAMETERS:
    Optional Keywords:
	BAR - if set, will draw a color bar on plot
	nColors - # of colors to load (Defaults to !D.TABLE_SIZE)
	lessRed - if set, rainbow will have a smaller red region
	WhiteBottom - if set, there will be a white region at the bottom
	topColor - can be an index or 'white' or 'black'
	botColor - can be an index or 'white' or 'black'
	linePlots - if set, top color will be black and bottom color will be white
	noYellow - if set, don't have yellow (because doesn't show up well on white)
 OUTPUTS:
       NONE (color table changed)
 EXAMPLE:
	IDL> betterrainbow, botColor='white', /bar
	IDL> 

 LIMITATIONS:
	always starts at the bottom of color palette.
 MODIFICATION HISTORY:
	13-Aug-2012 mucked with white bottom
	04-Nov-2011 smoothed out corners in green between 180 & 240, so discontinuity not
		    seen in organge
	26-Aug-2011 added smooth parameter, default it to 50. Round off purple to
		    blue transition.
	18-Jun-2008 added NoYellow keyword
	02-Aug-2007 fix bug for /lineplot and ncolors<256; 
		    if /linePlots keyword set, reset !p.color & !p.background
	30-Apr-2007 added linePlots keyword
	26-May-2006 added ncolors and whiteBottom keywords
	14-Feb-2005 add topColor and botColor keywords
       15-Jul-2002 Written by Bill Davis, PPPL

BETTERTICKLABELS

[Previous Routine] [Next Routine] [List of Routines]

  NAME:
 	betterticklabels

  PURPOSE:
 	Tick labels are made a little cleaner. E.g., shorter exponentials,
	no unnecessary trailing zeroes, accurate numbers when tick values
	are small differences between large numbers, etc.

 CATEGORY:
	Plotting, Graphics

  EXAMPLE:
	IDL> plot, y, ytickformat='betterticklabels'

  EXAMPLE A - Make a dummy plot call so can determine Tick Max:
	IDL> COMMON betterticklabels_common, yticklabels
	IDL> plot, y, ytick_get=yticklabels, ytickname=replicate('      ',30)
	IDL> AXIS, YAXIS=1, YRANGE=!y.crange, ytickformat='betterticklabels'
	IDL> dum = TEMPORARY(yticklabels)	; so doesn't affect later calls

  HISTORY:
	03-Mar-2008 slight mod to handle floating point comparison
       03-Aug-2006 fixed for values less than 2.e-6
	15-Apr-04 be able to return xtick values and x tic labels (NOT DEBUGGED)
	15-Oct-01 shift y axis labels if !p.font=0 (helps with some 3-D plots)
	11-Jan-01 shift y-axis labels if on TEK and !p.font=0 
	09-Oct-00 Written by Bill Davis

BIN2D

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       Bin2D
 PURPOSE:
       Create a density image (2D histogram) from arrays of (x,y) points,
       or create an image of a function from arrays of ( x, y, f(x,y) ) data.
       In first case each pixel counts # of (x,y) points falling into
       a 2D bin (box), thus forming an image of counters. In optional case,
       each pixel is the average of all f(x,y) data falling into the box.
       Boxes are determined by dividing the (x,y) range into a uniform grid.
 CATEGORY:
	Image Processing
 CALLING EXAMPLES:
       imh = Bin2D( x, y, NPIX=64, XRAN=[0,20], YRAN=[-5,5] )
       imz = Bin2D( x, y, FXY=z, NPIX=[200,100] )
 INPUTS:
       X = array (any dimension) of x values.
       Y = array of y values, should correspond to x array.
               optionally, x can be of the form [[x],[y]]
               containing both x and y coordinates as rows of matrix,
               and then argument y should not be specified.
 KEYWORDS:
       XRAN and YRAN : specify the x,y range to be mapped into the image.
                       Common Bin2D, xminc,xmaxc, yminc,ymaxc
                       can also specify the x,y range if keywords are not used,
                       otherwise the defaults = min-max ranges of x and y.
       NPIXELS = 1 or 2 element integer array specifying size of result,
                       (single value means square image), default = [64,64].
      /NOCLIP means do not bother checking if (x,y) are within range (faster).
       TYPE_VAR = type code specifying the IDL variable type of result,
               (1=byte, 2=short, 3=Long, 4=float,... default=2, short integer).
 KEYWORDS (optional):
       IMAGE_DENSITY = an existing image of counters (2D histogram)
                       to which the result is added (overrides NPIX=).
       FXY = array giving z = f(x,y) for the purpose of binning into an image
               however, bins with no (x,y) data points are left = zero.
               (NOTE: must specify XRAN and YRAN, or set /NOCLIP).
   if /BOTH is set and FXY=z is given, then the binned image of z=f(x,y) is
               returned by function, and an image of (x,y) density is
               returned via the keyword IMAGE_DENSITY.
 OUTPUTS:
       Result of function is an image of the density of (x,y) points, or an
       image of scalar field function if z values are given at (x,y) points.
 PROCEDURE:
       Binning is performed by finding number of (x,y) duplicates
       at each pixel,  using the IDL sort and where functions.
 HISTORY:
       written Frank Varosi, U.of MD., 1988.
               F.V. 1990, modif. for IDL-V2.

BITMAPBUTTONS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       bitmapbuttons
 PURPOSE:
       Illustrate use of bitmapbuttons in IDL
 CATEGORY:
       GUI, buttons
 CALLING SEQUENCE:
       IDL> bitmapbuttons
    Then click on buttons and watch them change.
 COMMON BLOCKS:
       none
 NOTES:
	Requires IDL 5.2 or later.
 LIMITATIONS:
	This may not be the easiest way to manage button states
 MODIFICATION HISTORY:
	27-Jan-00 [BD]

BITS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       bits
 PURPOSE:
       Given a byte or integer, return a vector of 8 or 16 values
       which are the binary representation of the value.
 CATEGORY:
       bits, hardware
 INPUT:
       invalue - The byte or integer value to check
 OUTPUT:
       bitarr  - The 8-element array with values set
                 if the bit is set
 EXAMPLE:
	IDL> BITS, invalue, BITARR
 HISTORY:
       Written 1988 by M.Morrison
       13-Nov-92 (MDM) - Modified to allow integer*2 values
                         and to allow an array of values.
        7-Apr-94 (MDM) - Allow integer*4 values
       15-Aug-94 (MDM) - Corrected error from 7-Apr-94 mod which
                         did not allow an array of inputs

BLOBBINRANGES

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
 	blobbinranges

 PURPOSE:
	plot bins of one variable vs another from blob database and draws
       ranges, of say 90%, in Y for each binned point. Uses color filled
	contours for square bin values.
       See http://nstx.pppl.gov/nstx/Software/Applications/blobDBdefs.txt
	for an explanation of variables and units of database variables.

 CATEGORY:
       Blobs

 CALLING SEQUENCE:
	IDL> blobBinRanges, filename

  INPUTS:
  ------
	filename - file saved from DbAccess

  KEYWORDS:
  --------
	xVar - Column in DbAccess for independent variable (default='topNorm')
	yVar - Column in DbAccess for dependent variable (default='xVel')
		Note: velocities are in Km/sec. Most other things are in pixels.
	x1 - starting pixel in horizontal direction to consider
	x2 - ending pixel in horizontal direction to consider
	t1 - starting pixel in vertical direction to consider     
	t2 - ending pixel in vertical direction to consider        
	percent - % of data points to draw bars over (Default=90, but 95% might be better)
	binSize - length of bin (on X axis)
	nBins - if set, will set binsize so this # of bins cover range of X data
	minHt - min value of topNorm
	maxHt - max value of topNorm
	saveFile - if=1, will save a JPEG file
	plotFile - file name to save JPEG to
	position - bounding box in normalized coords (def=[.1,.1,.95, .9])
	xrange - the x limits of the plot (set !x.style=1 before running for exact)
	yrange - the y limits of the plot (set !y.style=1 before running for exact)
	explain - include in the legend an explanation of bars and numbers
	ctb - color table for color contours (default=3, hot metal)
	interp - if set, will interpolate colors indicating blobs per bin

  EXAMPLES:
  --------
    IDL> blobBinRanges, '/u/bdavis/cvs/database/DBoutSH141741.txt', $
	     x1=10, x2=50, charsize=1.5,  $    
    	     xtitle='Normalized Blob Brightness',  $
	     ytitle='Radial Velocity (Km/s)',  $  
    	     title='Shot 141741; 212-216 msec', $    
    	     percent=90, yrange=[-2,4], xrange=[1,7], /contours, /rainbow		  
  
    IDL> blobBinRanges, '/u/bdavis/cvs/database/DBoutSH139286.txt', $
	     x1=10, x2=50, charsize=1.5,  $    
    	     xtitle='Normalized Blob Brightness',  $
	     ytitle='Radial Velocity (Km/s)',  $  
    	     title='Shot 139286; 312-316 msec', $    
    	     percent=90, yrange=[-2,4], xrange=[1,7], /contours, /rainbow		  
  
    IDL> blobBinRanges, '/u/bdavis/cvs/idl_cvs/DBoutSH142000.txt', /debug	  

    IDL> blobBinRanges, '/u/bdavis/cvs/idl_cvs/DBoutSH142000.txt', $
	     x1=40, charsize=1.5,  $    
    	     xtitle='Normalized Blob Brightness',  $
	     ytitle='Radial Velocity (Km/s)',  $  
    	     title='Shot 142000; 240-270 msec', legend='Outside Separatrix', $    
    	     percent=90, yrange=[-2,4], xrange=[1,7], /contours, /rainbow		  
 

    IDL> blobBinRanges, '/u/mko/testfile_142000.txt', x1=40, charsize=1.5,  $    
    	     xtitle='Normalized Blob Brightness',  $
	     ytitle='Radial Velocity (Km/s)',  $  
    	     title='Shot 142000; 240-270 msec', legend='Outside Separatrix', $    
    	     percent=90, yrange=[-2,4], xrange=[1,7], /contours, /rainbow		  
	
  MODIFICATION HISTORY:
  --------------------
	29-Oct-2013 change order of columns read to fit (new?) DbAccess files.
  	WRITTEN 26-Jul-2012 by Bill Davis

BLOBTRAILS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
        blobtrails

 PURPOSE:
        draw trails of blob trajectories that go through a certain region of the image. 
        Data comes from a database of blob characteristics for a given shot, and perhaps
        just part of a shot (see populateblobs.pro).
      
 CATEGORY:
       Blobs

 CALLING SEQUENCE:
       IDL> blobtrails, table=table, xpt=xpt, ypt=ypt, box=box, minht=minht

 INPUTS:
 -------
      database - SQL database (server maintained by Tom Carroll) for blobs, DEF='BLOBS'
      table - table name in database of blobs for a period within a shot, or
      shot - will assume table is named 'SH'+shot

      xpt - horizontal center of region from which trajectories start
      ypt - vertical center of region from which trajectories start
      boxradius - # of pixels around [xpt, ypt] to allow for start of trajectories
      minHt - min height of blob in normalized image. (when blob passes through box) 
      lifeRequired -  lifetime required in seconds (after passing through box) , or
      needed - number of frames needed (after passing through box) to bother with
      t1 - (optional) 1st time to consider (seconds)
      t2 - (optional) last time to consider (seconds)
      timeOffSet - amount needed to be added to camera time to get to shot time
      rainbow - if set, will use "betterrainbow" pallette, rather than hot metal.
      nSmooth - smoothing to be applied before track is plotted (default=3)
      maxJump - max # of pixel to change per frame to be considered same blob
                 (DEF=10)
      msec - if set, display times in millisec
      ellipse - if set, draw ellipses where fit was made
      symWidth - if <=0 then draw ellipses in realistic shapes
      scale - if realistic blob sizes drawn, scale their size by this factor
      xplot1 - starting x pixel for plot
      xplot2 - ending x pixel for plot
      yplot1 - starting y pixel for plot
      yplot2 - ending y pixel for plot
      verbose - if set, lots of information output listed
      debug - if set, will output even more and may stop at some spots
          "rise" was the difference from the max of a blob (after normalizing frame) 
              and the lowest closed contour line that enclosed it. 

 EXAMPLES:
      IDL> blobtrails, 32,32, box=2, /rainbow, minht=1.1, /list, /debug

      IDL> blobtrails, 25,25, box=2, /rainbow, shot=138234, ny=80, /list     , /debug

      IDL> maxJump=5
      IDL> blobtrails, table='SH138234',xpt='32',ypt='32',boxRadius='2',minHt='2', $
                       maxJump=maxJump, needed='3',t1='0',t2='20', ctb='-1', ListTimes='on', $
                       eFileType='None',psfilename='blobtrails',emailPsAddress='', /deb

      IDL> blobtrails, table='SH1091216028', x1=39, x2=41, y1=2,y2=62, psym=4, minHt='1.5', $
                       maxJump=10, needed='3',t1='0',t2='20', ctb='-1', ListTimes='on',   $
                       xplot1=30, xplot2=60,  /msec,  chimax=5, nSmooth=3, $
                       eFileType='None',psfilename='blobtrails',emailPsAddress='', /deb

         blobtrails, table='SH138234',xpt='20',ypt='20',boxRadius='3', minHt='2', $
                   maxJump=maxJump, needed='3',ctb='-1',  $
                    t1=530, t2=550, $
                   xplot1=10, xplot2=50, yplot1=10, yplot2=80, charsize=1.5, /ellip          , /deb

         blobtrails, table='SH138234',x1=15, x2=30, y1=20, y2=22,  minHt='2.5', $
                   maxJump=maxJump, needed='3',ctb='-1',  $
                    t1=530, t2=550, $
                   xplot1=15, xplot2=50, yplot1=10, yplot2=80, charsize=1.5, /ellip          , /deb

         blobtrails, 20, 20, boxRadius=3, shot=138234,  $
                     minHt=2.2, t1=530, t2=550, xSize=500, ySize=600, $
                     /ListTimes, charsize=1.8, psym=4, symSize=2,$
                     xplot1=10, xplot2=40, yplot1=0, yplot2=30

   to get a track of just one blob:
         blobtrails, 8, 40, boxRadius=4, shot=138234,  $
                     minHt=2.2, t1=534, t2=535, xSize=500, ySize=600, $
                     /ListTimes, charsize=1.6, psym=4, symSize=2,$
                     xplot1=-10, xplot2=40   ;;;, yplot1=0, yplot2=30

   to make plots for Stewart's 2014 paper:
   IDL> !p.font=0
   IDL> setup_ps, 'bt_140395_1pt5.ps', printer='postscript', /color
   IDL> blobtrails, shot=140395, t1=549.25, t2=550.75, minHt=1.5,  $
		     x1box='0',x2box='63', y1box='0',y2box='79', $
	             limiter='on', charsize=1.8, symbol='none', $
	       	     yplot1='', yplot2='', $
	             efitVersion='EFIT02',  $
	       	     /noYellow, /rainbow,  /first, symwidth=3
   IDL> unsetup_ps 

   IDL> setup_ps, 'bt_141746.ps', printer='postscript', /color
   IDL> blobtrails, shot=141746, t1=213.5 ,t2=214.5, minHt=1.5,  $
		     x1box='0',x2box='63', y1box='0',y2box='79', $
	             limiter='on', charsize=1.8, symbol='none', $
	       	     yplot1='', yplot2='', $
	             efitVersion='EFIT02',  $
	       	     /noYellow, /rainbow, /first, symwidth=3
   IDL> unsetup_ps 
 
   to make plots for Stewart's 2014 paper, but with times printed:
   IDL> blobtrails, shot=140395, t1=549,t2=551, minHt=1.5,  $
		     x1box='0',x2box='63', y1box='0',y2box='79', $
	             limiter='on', charsize=charsize, symbol='none', $
	       	     yplot1='', yplot2='', $
	             efitVersion='EFIT02',  $
	       	     noYellow=noYellow, rainbow=rainbow,  $
	       	     titleChrSz=titleChrSz, /first, symwidth=3, $
		     /ListTimes, Xplot1=-40, Xplot2=50
  
   to make plot for Stewart's 2014 paper, but with just one blob:
   IDL> blobtrails, shot=140395, t1=550.92 ,t2=550.96, minHt=1.5,  $
		     x1box='0',x2box='63', y1box='0',y2box='79', $
	             limiter='on', charsize=1.5, $
	       	     yplot1='', yplot2='', first=0, $
	             efitVersion='EFIT02',  $
	       	     noYellow=noYellow, rainbow=rainbow,  $
	       	     /ellipse, symwidth=3, $
		     /ListTimes, Xplot1=0, Xplot2=50, nskip=3
  
   IDL> blobtrails, shot=141746, t1=213.192 ,t2=213.195, minHt=1.5,  $
		     x1box='0',x2box='63', y1box='0',y2box='79', $
	             limiter='on', charsize=1.5, $
	       	     yplot1='', yplot2='', first=0, $
	             efitVersion='EFIT02',  $
	       	     noYellow=noYellow, rainbow=rainbow,  $
	       	     /ellipse, symwidth=3, /ListTimes, $
		     Xplot1=-20, Xplot2=50, nskip=3
  
 MODIFICATION HISTORY:
	29-Jul-2014 add /degrees to call to drawellipse, since the tilts in 
		    the database are degrees (zero left, 90 straight up, 
		    180 to right). Also added nskip factor for when drawing
		    all locations for a single track
       16-Jul-2014 add noYellow keyword
	01-Oct-2012 colors for single tracks was broken; fixed.
		    Now, both blob positions and separatrix (and limiter) are plotted
		    physical coordinates when plotting in cm. Previously, and still when
		    plotting vs. pixels, the "rhomboid" shape of the fiber bundle is
		    not accounted for.
	28-Sep-2012 when axesInCm set, use actual R & Z values for blob positions, and 
		    plot separtrix from actual R & Zs.
	13-Sep-2012 added EveryOther, suppress, noTitle keywords
  	18-Jul-2012 adjust for plot area not all the pixels
	26-Mar-2012 option to draw separatrix
       22-Mar-2012 Use HM values for ellipse shapes (have an option for size, too)
       01-Dec-2011 fixed duplication of first and last blob indices
       17-Jun-2011 fixed for Database time in msec
       08-Mar-2011 added wholeLife field to database, so "needed" makes more sense
                    (the blob has to have persisted for that many frames to be considered)
       WRITTEN 2-Feb-2011 by Bill Davis for Stewart Zweben

BLOBVYFIT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
 	blobvyfit 

 PURPOSE:
	plot Poloidal velocity (Vy) of blobs from Fast Camera data
	vs. distance from the separatrix. Bin and smooth things so
	a curve can be fit through data, with the ultimate goal
	of categorizing the vertical shear.

 CATEGORY:
	GPI

 CALLING SEQUENCE:
	blobvyfit, shot,  BinSize=binsize, barFraction=barFrac,  $
	         title=title, Overlay=Overlay, $
                 WindowTitle=WindowTitle, GROUP_LEADER=group_leader, $
		 XSIZE=xsize_in, YSIZE=ysize_in, xtitle=xtitle, ytitle=ytitle, $
		 _extra=_extra
 INPUTS:
	shot - NSTX shot number

 OUTPUTS:
	plot in graphics widget

 KEYWORDS:
    barFraction - fraction of interval over which bar is drawn (0-1) 
		   (default=0.5)
    BinSize -  The size of each bin of the histogram,  scalar (not necessarily
             integral).  If not present (or zero), the bin size is set to 1.
    Overlay - if set, overlay a curve 
    ShotList - list of shots to cycle through

 EXAMPLE:
	IDL> blobvyfit, 138234

	   ; to be able to make JPEGS for all shots, with fixed limits:
	IDL> blobvyfit, 138234, plotLimitsFile='PlotLims.txt'

 MODIFICATION HISTORY:
	17-Feb-2014 Written by Bill Davis

BPASS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
		bpass
 PURPOSE:
		Implements a real-space bandpass filter which suppress 
		pixel noise and slow-scale image variations while 
		retaining information of a characteristic size.

 CATEGORY:
		Image Processing
 CALLING SEQUENCE:
		res = dgfilter( image, lnoise, lobject )
 INPUTS:
		image:	The two-dimensional array to be filtered.
		lnoise: Characteristic lengthscale of noise in pixels.
			Additive noise averaged over this length should
			vanish. MAy assume any positive floating value.
		lobject: A length in pixels somewhat larger than a typical
			object. Must be an odd valued integer.
 OUTPUTS:
		res:	filtered image.
 PROCEDURE:
		simple 'wavelet' convolution yields spatial bandpass filtering.
 NOTES:
 MODIFICATION HISTORY:
   19-May-2009 Limit filter width so convol doesn't exceed array dimensions [BD]
		Written by David G. Grier, The University of Chicago, 2/93.
		Greatly revised version DGG 5/95.
		Added /field keyword JCC 12/95.
		Revised & added 'stack','voxel' capability JCC 5/97.

	This code 'bpass.pro' is copyright 1997, John C. Crocker and 
	David G. Grier.  It should be considered 'freeware'- and may be
	distributed freely in its original form when properly attributed.

BPWFEDIT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	BPWFEDIT

 PURPOSE:
	Read, Edit, & Plot Breakpoint Waveform files used in ppcc system on TFTR
 CATEGORY:
       TFTR, Waveforms, GUI Editing

 REVISION HISTORY:
	21-Aug-98 Written by Bill Davis

BREAKMDSNAME

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       BreakMDSname

 PURPOSE:
       break an MDS pathname near the middle, if too long

 CATEGORY:
	MDSplus, Strings

 CALLING SEQUENCE:
        newLines = BreakMDSname( line )

 INPUTS:
       line - string containing an MDSplus tag or node name      in

 KEYWORD PARAMETERS:
	MAXLENGTH  - max line length (default 72)  OPTIONAL

 OUTPUTS:
	newlines - string array of MDSplus name broken near middle

 EXAMPLE:
    IDL> line = '\ENGINEERING::OPERATIONS.PC_OH_BR_1_CUR_1'
    IDL> newLines = BreakMDSname( line, MAXLENGTH=25 )

 COMMON BLOCKS:
 NOTES:

 MODIFICATION HISTORY:
	01-Apr-99 Written earlier by Bill Davis

BREAKSTRING

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       BreakString
 PURPOSE:
      Break a string up and return a string array
 CATEGORY:
       Strings
 CALLING SEQUENCE:
       IDL> str_array = BreakString(longString)
 INPUTS:
       longString = a string of words 
 KEYWORD PARAMETERS:
       Optional Keywords:
	  MAXLENGTH - Maximum length of array elements of output (else=72)
	  DELIMITER - delimiter, else ' ' 
		(see WORDARRAY for multispace delmiters')
	  COMPRESS    - if set, squeeze out extra imbedded blanks
 OUTPUTS:
       str_array = returned array of strings             	out
 COMMON BLOCKS:
       NONE
 EXAMPLE:
    IDL> line = '\ENGINEERING::OPERATIONS.PC_OH_BR_1_CUR_1'
    IDL> newLines = BreakString( line, MAXLENGTH=25, DELIM=':' )
 NOTES:
	Can be used as a replacement for obsolete str_sep routine
 MODIFICATION HISTORY:
	31-Jan-02 bug fix and speed improvement 
       1-Apr-99 Written by Bill Davis, PPPL

BREAKTEXT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       breaktext
 PURPOSE:
       break up (justify) text so lines not longer than a certain length.
 CATEGORY:
       strings
 CALLING SEQUENCE:
       IDL> newText = breakText( text )
 INPUTS:
	text - string array or scalar
 KEYWORD PARAMETERS:
	maxLength - number of characters per line (DEFAULT=72)
	delim - what to break lines with (default is a line feed)
 OUTPUTS:
       string array returned
 EXAMPLE:
    text = ['This is the first line  this is the second', ' ',  $
	     '123456789 123456789 123456789 123456789 123456789 ']
    wrapped = breaktext( text, delim='  ', maxlength=25 )
    
    text = strconcat(replicate('blah ', 200)
    wrapped = breaktext( text, delim=' ', maxlength=73 )
 NOTE:
  
 MODIFICATION HISTORY:
	14-Aug-2008  Written by Bill Davis, PPPL

BREAK_PATH

[Previous Routine] [Next Routine] [List of Routines]

 NAME: 
    BREAK_PATH

 PURPOSE: 
     Breaks up a path string into its component directories.

 CATEGORY:
       MDSplus, Strings
 CALLING SEQUENCE: 
     Result = BREAK_PATH( PATHS [ /NoCurrent])

 INPUTS: 
     PATHS   = A string containing one or more directory paths.  The
               individual paths are separated by commas, although in UNIX, 
               colons can also be used.  In other words, PATHS has the same 
               format as !PATH, except that commas can be used as a separator 
               regardless of operating system.

               A leading $ can be used in any path to signal that what follows 
               is an environmental variable, but the $ is not necessary.  (In 
               VMS the $ can either be part of the path, or can signal logical
               names for compatibility with Unix.)  Environmental variables
               can themselves contain multiple paths.

 OUTPUT: 
      The result of the function is a string array of directories.
      Unless the NOCURRENT keyword is set, the first element of the array is 
      always the null string, representing the current directory.  All the 
      other directories will end in the correct separator character for the 
      current operating system.

 OPTIONAL INPUT KEYWORD:
      /NOCURRENT = If set, then the current directory (represented by
               the null string) will not automatically be prepended to the
               output.

 PROCEDURE CALLS:
      Functions:  DATATYPE(), breakstring()

 REVISION HISTORY:
       Version 1, William Thompson, GSFC, 6 May 1993.
               Added IDL for Windows compatibility.
       Version 2, William Thompson, GSFC, 16 May 1995
               Added keyword NOCURRENT
       Version 3, William Thompson, GSFC, 29 August 1995
               Modified to use OS_FAMILY
       Version 4, Zarro, GSFC, 4 August 1997
               Added trim to input
       Converted to IDL V5.0   W. Landsman 25-Nov-1997

BTEST

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
    BTEST       

 PURPOSE:
    To test bit N in FIX(X)

 CATEGORY:
    Bits, Hardware

 CALLING SEQUENCE:
    YesNo = btest( X, N )

 PARAMETERS:  
    Inputs:
    	X      (REQ) (I) (0 1) (I  F)
           	X is the variable to be tested
   
    	N      (REQ) (I) (0) (I)
           	The bit of X to be tested
     Returned:
    	YESNO  (REQ) (O) (0 1) (I)
           	The result of the test. 1(true) if bit N is set, 0(false)
           	otherwise.

 EXAMPLES:

        YESNO = btest( !X.STYLE, 4 )
        IF YESNO THEN PRINT,'X-axis suppressed' $
                 ELSE PRINT,'Draw X-axis'

        To find points in NEWSIPS which are outside calibrated region:
        YESNO = btest( ABS(NU),1 )             ; look for nu flag = -2
        IND = WHERE (YESNO EQ 0)            ; keep points where yesno = 0
        PLOT,W(IND),F(IND)                  ; plot calibrated points
        
 NOTES:

     Note that negative integers are stored in twos complement form.
     Therefore, the left-most bits are ON rather than OFF as they are for 
     positive numbers. Input the absolute value of X is negative numbers 
     to avoid this problem. 

     This procedure can be used to check the values of complex
     IDL system variables such as ![XYZ].STYLE.

 PROCEDURE:

     Checks whether (FIX(X) OR (NOT 2^N)) = -1 to set the output
     flag YESNO.

 MODIFICATION HISTORY:
	26-Oct-99 Convert from btest to make a function (like FORTRAN)
     Mar  6 1983 RJP GSFC initial program
     Aug 24 1987 RWT GSFC add PARCHECK
     Mar  7 1988 CAG GSFC all VAX RDAF-style prolog
     Jul 13 1990 RWT GSFC Sun mods: use examples pertinent to SUN IDL
                 and add listing of procedure call statement
     Jun 19 1991 PJL GSFC cleaned up; tested on SUN and VAX; updated prolog
     Mar  8 1993 RWT GSFC modify to allow X & YESNO to be vectors and 
                 add documentation about negative numbers.

CACHECKMONITOR

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caCheckMonitor

 PURPOSE:
	This function returns a non-zero value if there is a new (unread)
       monitor for this process variable, otherwise it returns zero.
       This function is particularly useful when a caGet() operation is
       expensive in time, e.g. reading large arrays.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	state = caCheckMonitor(pvname)

 INPUTS:
	pvname: The name of the process variable on which to check the monitor.

 OUTPUTS:
       The function return value is zero if no new monitor value is available,
       and non-zero if a new monitor value is available.

 PROCEDURE:
	This routine uses ezcaNewMonitorValue(). The "type" parameter required
       by ezcaNewMonitorValue() is the native EZCA data type as determined
       by caGetCountAndType().

 EXAMPLES:
       IDL> state = caCheckMonitor('test_ao1',event)

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CACLEARMONITOR

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caClearMonitor

 PURPOSE:
	This procedure clears a monitor on the specified process variable.
       It cancels the effect of caSetMonitor().

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	status = caClearMonitor(pvname)

 INPUTS:
	pvname: The name of the process variable on which to clear the monitor.

 OUTPUTS:
       The function return value of caClearMonitor is a status value.  The
       status is 0 if the routine was successful (i.e. the process variable
       exists) and non-zero if the routine failed.

 PROCEDURE:
	This routine uses ezcaClearMonitor(). The "type" parameter required
       by ezcaClearMonitor is the native EZCA data type as determined
       by caGetCountAndType().

 EXAMPLES:
       IDL> status = caClearMonitor('test_ao1')

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CADEBUG

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caDebug

 PURPOSE:
	This procedure turns the EZCA debugging flag on or off. Turning on
       the debugging flag prints lots of information, which is mainly
       useful to developers.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	caDebug, state

 INPUTS:
	state:  state=1 turns debugging on, state=0 turns debugging off.

 OUTPUTS:
       None

 PROCEDURE:
	This routine uses ezcaDebugOn() and ezcaDebugOff().

 EXAMPLES:
       IDL> caDebug, 1     ; Turn on debugging
       setting Debug
       IDL> status = caGet('test_ao1', value)
       ca_pend_event(0.000010)
       --start end-of-prologue() report
       ****** Start State:
       AutoErrorMessage T InGroup F Debug T Trace F ErrorLocation LastOnly ListPrint
       LastOnly TimeoutSeconds 0.050000
       Workp : 9cf970 trashme F (nxt 0)
       Channel_avail_hdr 0 :
       ...
       ...
       IDL> caDebug, 0 ; Turn off debugging

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAENDGROUP

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caEndGroup

 PURPOSE:
	This function ends an "asynchronous group". See caStartGroup for more
       information on asynchronous groups.
       caEndGroup flushes the queue of caGet and caPut calls and waits for
       replies from the channel access servers.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	stat = caEndGroup(status)

 INPUTS:
	None.

 OUTPUTS:
       The function return value is 0 if the operation was successful,
       otherwise it is the first encountered non-successful return code.
       The optional status parameter can be used to return the status code
       of each operation in the group.

 OPTIONAL OUTPUT PARAMETERS:
       status: If this optional parameter is present then it returns a
               array of status information, one for each channel access
               call in the group.

 COMMON BLOCKS:
       EZCA_COMMON contains a flag (ingroup) which indicates if we
       are currently in an asynchronous group. This routine clears that flag.

 PROCEDURE:
	If the status parameter is present then this routine uses
       ezcaEndGroupWithReport().  If the parameter is not present then
       the routine calls ezcaEndGroup().

 RESTRICTIONS:
       When the status parameter is present, and ezcaEndGroupWithReport() is
       called, there is no way to know in advance how many status values
       will be returned.  This routine passes a status array with 1024
       elements, and then truncates it to the actual length.  The maximum
       number of status values which can be retrieved is thus 1024. No errors
       will occur if an asynchronous group has more than 1024 calls, but
       only the first 1024 status values can be obtained.
       This is probably sufficient for most applications!

 EXAMPLES:
       IDL> caStartGroup
       IDL> status = caget('test_ao1.SCAN', scan)
       IDL> status = caget('test_mca1.ERTM', ertm)
       IDL> ; Print out values - they will be zero.
       IDL> help, scan, ertm
       IDL> status = caEndGroup()
       IDL> ; Print out values after executing caEndGroup, they are non-zero
       IDL> help, scan, ertm
       Output:
           SCAN            INT       =        0
           ERTM            FLOAT     =      0.000000
           SCAN            INT       =        6
           ERTM            FLOAT     =       7.10000

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAERROR

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caError

 PURPOSE:
	This procedure controls error printing and returns error strings.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	caError, err_string, /ON, /OFF, /PRINT, prefix=prefix

 INPUTS:
       None

 KEYWORD PARAMETERS:
       /ON
           Setting this switch turns on automatic error message printing
           on stdout.  Automatic printing is initially enabled.

       /OFF
           Setting this switch turns off automatic error message printing
           on stdout.

       /PRINT
           Setting this switch prints the last error message on stdout.

       prefix=prefix
           The prefix keyword can be used to pass a string which is prefixed
           to error messages printed with /PRINT or fetched via the optional
           output parameter.

 OPTIONAL OUTPUT PARAMETERS:
	err_string:
           If this parameter is present then it will contain the text of the
           last error message.

 COMMON BLOCKS:
       EZCA_COMMON contains a flag (ingroup) which indicates if we
       are currently in an asynchronous group. This routine tests that flag.

 PROCEDURE:
	This routine uses ezcaPerror(), ezcaAutoErrorMessageOn(),
       ezcaAutoErrorMessageOff(), and ezcaGetErrorString()

 EXAMPLE:
       IDL> ; Define a prefix and turn on error messages
       IDL> caError, prefix='My program', /ON
       IDL> ; Fetch the last error message
       IDL> caError, err_string

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAGET

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGet

 PURPOSE:
	This function reads the value of a Channel Access process variable.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	Status = caGet(pvname, value, /string, max=n)

 INPUTS:
	pvname:	The name of the process variable for which the value is to
               be returned.

 KEYWORD PARAMETERS:
	STRING:	Set this flag to force caGet to return a string, rather than
               a number.  This flag is particularly useful when the native
               channel access data type is ENUM (3), since the string is
               more descriptive than the number.

	MAX:    This keyword parameter is used to limit the number of
               values returned by caGet. caGet normally returns the native
               element count for a process variable. Setting MAX to a
               number less than this will cause caGet to return only the
               first MAX values in the array.

 OUTPUTS:
	value:  The value of the process variable. By default, caGet returns
               "value" with the native data type and number of elements
               of the process variable. It determines this information by
               calling caGetCountAndType().  Note that if caGet is called
               after calling caStartGroup but before calling caEndGroup then
               the IDL variable "value" is created, but will not actually
               contain the data until caEndGroup is called.

       The function return value of caGet is a status value.  The
       status is 0 if the routine was successful (i.e. the process variable
       exists) and non-zero if the routine failed.  If caGet is called from
       within an asynchronous group then the status return only indicates
       whether the operation was successfully queued.

 COMMON BLOCKS:
       EZCA_COMMON contains a flag (ingroup) which indicates if we
       are currently in an asynchronous group. This routine tests that flag.

 SIDE EFFECTS:
	This routine will causes a channel access search to take place if
       this is the first time this process variable has been referenced. It
       performs a ca_get, unless called as part of an asynchronous group.

 RESTRICTIONS:
       There are two important restrictions which must be kept in mind when
       calling caGet from inside a "group", i.e. after calling caStartGroup
       and before calling caEndGroup.

       1) The IDL "value" variable (i.e. the second parameter
       passed to caGet) must not be "re-used" or deleted before the call to
       caEndGroup. The reason for this is that EZCA has been passed the
       address of this variable as the location in which the data is to be
       copied when caEndGroup is called. Thus, this location must still
       point to a valid memory location when caEndGroup is called.
       If the "value" variable is re-used then IDL's behavior is
       unpredictable, and bus errors/access violations could occur.

       2) When using caGet to read strings, the data type returned will be
       a byte array, rather than a string.  The reason has to do with the
       manner in which IDL passes strings, which requires that EZCA actually
       be passed pointers to byte arrays. When caGet is called outside of a
       group it automatically converts the byte array to a string before
       returning the value. However when caGet is called inside of a group
       it cannot perform this conversion, since it cannot be done until after
       the data is read, which does not occur until caEndGroup is called.
       Thus, it is the user's responsibility to convert the data from a byte
       array to a string after calling caEndGroup. This is done very simply
       with the string() function. For more information see the example below.

 PROCEDURE:
	This routine uses ezcaGet().

 EXAMPLES:
       IDL> ; The following is an example of a single caGet
       IDL> status = caGet('test_mca1.VAL', value)

       IDL> ; The following is an example of a valid grouped operation
       IDL> ; It also shows how to handle strings.
       IDL> caStartGroup
       IDL> status = caGet('test_mca1.VAL', mca_value)
       IDL> status = caGet('test_vme1.DESC', vme_desc) ; This is a string PV
       IDL> status = caEndGroup()
       IDL> vme_desc = string(vme_desc)    ; Convert from byte array to string

       IDL> ; The following is an example of an INVALID grouped operation
       IDL> caStartGroup
       IDL> status = caGet('test_mca1.VAL', mca_value)
       IDL> status = caGet('test_vme1.VAL', vme_value)
       IDL> mca_value=0
       IDL> ; We have redefined mca_value, so the previous location is
       IDL> ; undefined. NO NOT DO THIS!
       IDL> status = caEndGroup()

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAGETARRAY

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       caGetArray

 PURPOSE:
       This function reads values for a list of Channel Access process
       variable. It returns 0 if successful, returns -1 if failed.

 CATEGORY:
       EPICS Channel Access Interface

 CALLING SEQUENCE:
       Status = caGetArray(names,pdata,max=no,type=i,/TYPE,/EVENT)

 INPUTS:
       names:	The variable for a list of channel access PV names for which
               the array of data is to be returned.

 KEYWORD PARAMETERS:
      MAX:    Default to 1 for a list of PV names. If more than one values
              to be returned for a list of array type PV names, this keyword
              must be specified. If the `no' specified is greater than the
              native count, zeros will be padded in the output array.

              If only one PV name is input, then caGetArray returns
              the native element count for the process variable. Setting
              MAX to a number less than the native count this will cause
              caGetArray to return only the first MAX values for the PV.

      TYPE:   This keyword specifies the IDL data type to be returned by
              the output array. If not specified, it defaults to 5, i.e.
              double precision type of data will be returned by the
              output array.

                1 - byte      2 - short       3 - long      4 - float
                5 - double    7 - string

     /TYPE    Instead of type=i a user can use the IDL data type keyword
              directly, the data type keyword supercedes the type=i
              specification. Valid types given below

                            /double
                            /float
                            /string
                            /long
                            /short
                            /byte

    /EVENT    If specified use the ca_array_get_callback otherwise use
              the ca_array_get

 OUTPUTS:
     pdata:  The output variable,  pdata(max,noNames), returns the data
             array for the requested list of PV names. The `max' is the no
             of values specified by the keyword MAX, the `noNames' is the
             number of PV names in the input variable names.

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       This routine will causes a channel access search to take place if
       this is the first time this process variable has been referenced.

 RESTRICTIONS:
       Only one type of data can be requested for a list of PV names.

 PROCEDURE:
	This routine uses Ezca_getArray() from the ezcaScan library.

 EXAMPLES:
       Three examples are given below.
       The first caGetArray call returns only the first value for each PV
       name, the second and third caGetArray call both returns 10 float
       values for each PV name

       IDL> names=['chademowf7','chademowf8']
       IDL> st = caGetArray(names,pdata)
       IDL> st = caGetArray(names,pdata,max=10,/float)
       IDL> st = caGetArray(names,pdata,max=10,type=4)

 MODIFICATION HISTORY:
       Written by:	Ben-chin Cha      Dec, 1995
      04-11-96     bkc    If array get failed, only the pvnames not found are
                          reported
      04-22-96     bkc    Replace caError by caGetError

CAGETCONTROLLIMITS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGetControlLimits

 PURPOSE:
	This procedure reads the control limits for the specified channel
       access process variable.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	status = caGetControlLimits(pvname, low, high)

 INPUTS:
	pvname: The name of the process variable from which to read the
               control limits.

 OUTPUTS:
       low:    The low control limit (double).

       high:   The high control limit (double).

       The function return value of caGetControlLimits is a status value.  The
       status is 0 if the routine was successful (i.e. the process variable
       exists) and non-zero if the routine failed.

 PROCEDURE:
	This routine uses ezcaGetControlLimits().

 EXAMPLE:
       IDL> status = caGetControlLimits('test_ao1', low, high)

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAGETCOUNTANDTYPE

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGetCountAndType

 PURPOSE:
	This function returns the number of elements and data type of a
       Channel Access process variable.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	Status = caGetCountAndType(pvname, count, type)

 INPUTS:
	pvname:	The name of the process variable for which information is to
               be returned.

 OUTPUTS:
	count:  The number of elements in the process variable. This is 1 for
               scalar process variables and more than 1 for arrays.

       type:   This is a 3 element array containing information about the data
               type of the process variable.
               type(0) = Channel access data type as defined in "cadef.h"
               type(1) = EZCA data type as defined in "ezca.h"
               type(2) = IDL/PV-WAVE data type as defined in size()
               These data types are as follows:

               Name    Channel Access      EZCA        IDL/PVWAVE
               String      0                 1             7
               Short       1                 2             2
               Float       2                 4             4
               Enum        3                 2 (short)     2 (short)
               Byte        4                 0             1
               Long        5                 3             3
               Double      6                 5             5

   The function return value of caGetCountAndType is a status value.  The
   status is 0 if the routine was successful (i.e. the process variable exists)
   and non-zero if the routine failed.

 SIDE EFFECTS:
	This routine will cause a Channel Access search to take place if this is
       the first time this process variable has been referenced.

 RESTRICTIONS:
       The channel access data type enum is mapped to EZCA and IDL short
       data types.  However, application programs can use this routine to
       determine if the native channel access data type is enum, and then
       use caGet(pvname, value, /string) to read the string equivalent of the
       process variable. Programs can also use
       caGetEnumStrings(pvname, strings) to read the strings for the all of
       the possible values of an enum process variable.

 PROCEDURE:
	This routine uses ezcaPvToChid() and then ca_element_count() and
       ca_field_type().
       Note that this routine always returns its values "immediately", even
       if it is called between a caStartGroup and caEndGroup.

 EXAMPLE:
       IDL> status = caGetCountAndType('test_mca1.VAL', count, type)
       IDL> print, status
       0                       ; Status = success
       IDL> print, count
       2048                    ; Array with 2048 elements
       IDL> print, type
           5       3       3   ; Long data type
 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAGETENUMSTRINGS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGetEnumStrings

 PURPOSE:
	This function returns all of the choice strings associated with a
       Channel Access "enum" process variable. It is particularly useful
       for building menus of options.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	Status = caGetEnumStrings(pvname, strings)

 INPUTS:
	pvname:	The name of the process variable for which the enum strings
               are to be returned. The native channel access data type of
               this process variable must be enum (3).

 OUTPUTS:
	strings: A string array containing the strings for each possible
               value of the enum variable.

       The function return value of caGetEnumStrings is a status value.  The
       status is 0 if the routine was successful (i.e. the process variable
       exists and is of type enum) and non-zero if the routine failed.

 SIDE EFFECTS:
	This routine causes a channel access read. It does not use the
       grouping mechanism of EZCA, i.e. it always executes immediately.

 RESTRICTIONS:
       There must be less than 16 enum strings and they must each be less
       than 26 characters.

 PROCEDURE:
	This routine uses ezcaPvToChid and then ca_get() with a request type
       of DBR_GR_ENUM.  The functionality required by this routine is not
       presently provided directly in EZCA, although it should probably be
       added.

 EXAMPLES:
       IDL> status = caGetEnumStrings('test_mca1.SCAN', strings)
       IDL> for i=0, n_elements(strings)-1 do print, strings(i)
       Passive
       Event
       I/O Intr
       10 second
       5 second
       2 second
       1 second
       .5 second
       .2 second
       .1 second

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAGETERROR

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGetError

 PURPOSE:
       This function get CA return codes for a list of process variable names.
       Return code can be 0 or -1, 0 for success, -1 for failure.

 CATEGORY:
       EPICS Channel Access Interface

 CALLING SEQUENCE:
       Status = caGetError(Pvname,Err)

 INPUTS:
      Pvname: The variable for a list of process variables for which the
              channel access return code to be checked.

 KEYWORD PARAMETERS:
       None.

 OUTPUTS:
       Err:  The corresponding return code(s) for the Pvname(s) are returned.
             Returns array of 0 or 1. 0 indicates success, 1 indicates failed.

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       This routine will causes a channel access search to take place if
       this is the first time pvnames has been referenced.

 RESTRICTIONS:
       None.

 PROCEDURE:
       This routine uses Ezca_get_error_array() from the ezcaScan library.

 EXAMPLES:
       IDL> print,caGetError('chademoai1')
       IDL> x = ['chademoai1','chademoai2']
       IDL> status = caGetError(x)

 MODIFICATION HISTORY:
       Written by:	Ben-chin Cha      Dec, 1995

CAGETGRAPHICLIMITS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGetGraphicLimits

 PURPOSE:
	This procedure reads the graphic limits for the specified channel
       access process variable.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	status = caGetGraphicLimits(pvname, low, high)

 INPUTS:
	pvname: The name of the process variable from which to read the
               graphic limits.

 OUTPUTS:
       low:    The low graphic limit (double).

       high:   The high graphic limit (double).

       The function return value of caGetGraphicLimits is a status value.  The
       status is 0 if the routine was successful (i.e. the process variable
       exists) and non-zero if the routine failed.

 PROCEDURE:
	This routine uses ezcaGetGraphicLimits().

 EXAMPLE:
       IDL> status = caGetGraphicLimits('test_ao1', low, high)

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAGETPRECISION

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGetPrecision

 PURPOSE:
	This procedure reads the precision for the specified channel
       access process variable.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	status = caGetPrecision(pvname, precision)

 INPUTS:
	pvname: The name of the process variable from which to read the
               precision.

 OUTPUTS:
       precision:  The precision (short).

       The function return value of caGetPrecision is a status value.  The
       status is 0 if the routine was successful (i.e. the process variable
       exists) and non-zero if the routine failed.

 PROCEDURE:
	This routine uses ezcaGetPrecision().

 EXAMPLE:
       IDL> status = caGetPrecision('test_ao1', precision)

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAGETRETRYCOUNT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGetRetryCount

 PURPOSE:
	This function returns the value of the EZCA retry count parameter.
       In conjunction with the EZCA Timeout parameter it determines how
       long EZCA will try to connect to a process variable before giving up.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	RetryCount = caGetRetryCount()

 INPUTS:
	None.

 OUTPUTS:
       The function return value of caGetRetryCount is the integer
       value of the EZCA RetryCount parameter.

 PROCEDURE:
	This routine uses ezcaGetRetryCount().

 EXAMPLES:
       IDL> print, caGetRetryCount()
       599

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAGETSTATUS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGetStatus

 PURPOSE:
	This procedure reads the status parameters for a channel access
       process variable.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	status = caGetStatus(pvname, timestamp, status, severity)

 INPUTS:
	pvname: The name of the process variable from which to read the
               status parameters.

 OUTPUTS:
       timestamp: The timestamp of the last time the record was processed
               lonarr(2).

       status: The status flag (int).

       severity: The severity flag (int).

       The function return value of caGetStatus is a status value.  The
       status is 0 if the routine was successful (i.e. the process variable
       exists) and non-zero if the routine failed.

 PROCEDURE:
	This routine uses ezcaGetStatus().

 EXAMPLE:
       IDL> status = caGetStatus('test_ao1', timestamp, status, severity)

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAGETTIMEOUT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGetTimeout

 PURPOSE:
	This function returns the value of the EZCA Timeout parameter. This
       value determines the time parameter passed to ca_pend_io() in EZCA.
       In conjunction with the EZCA RetryCount parameter it determines how
       long EZCA will try to connect to a process variable before giving up.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	timeout = caGetTimeout()

 INPUTS:
	None.

 OUTPUTS:
       The function return value of caGetTimeout is the floating point
       value of the EZCA Timeout parameter, in seconds.

 PROCEDURE:
	This routine uses ezcaGetTimeout().

 EXAMPLES:
       IDL> print, caGetTimeout()
       0.0500000

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAGETUNITS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caGetUnits

 PURPOSE:
	This procedure reads the units string for the specified channel
       access process variable.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	status = caGetUnits(pvname, units)

 INPUTS:
	pvname: The name of the process variable from which to read the units.

 OUTPUTS:
       units:  The units (string).

       The function return value of caGetUnits is a status value.  The
       status is 0 if the routine was successful (i.e. the process variable
       exists) and non-zero if the routine failed.

 COMMON BLOCKS:
       EZCA_COMMON contains a flag (ingroup) which indicates if we
       are currently in an asynchronous group. This routine tests that flag.

 PROCEDURE:
	This routine uses ezcaGetUnits().

 EXAMPLE:
       IDL> status = caGetUnits('test_ao1', units)

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAINIT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caInit

 PURPOSE:
	This routine sets the channel access timeout used by list array
       functions defined in ezcaScan library.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	caInit [,flag] [,help=help]

 INPUTS:
	flag:	Optional flag, if set to -1  ezcaScan library default timeout
               settings will be used.

 KEYWORD PARAMETERS:
     HELP:  If ,/HELP is set, on-line help will be displayed.

 OUTPUTS:
       None.

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       This routine set the channel access timeout values used in the
       ezcaScan library.  This routine set the timeout to 3 seconds for
       lists of process variables, and sets the timeout for
       ca_pend_event to 0.001 second.

       If a value of -1 is specified for the flag, the default value
       of 10 seconds for lists of process variables will be used.

 RESTRICTIONS:
       None.

 PROCEDURE:
	This routine uses Ezca_init() from the ezcaScan library.

 EXAMPLES:
       IDL> caInit

 MODIFICATION HISTORY:
 	Written by:	Ben-chin Cha     Dec, 1995

CALCBTBP

[Previous Routine] [Next Routine] [List of Routines]

  NAME:
	calcbtbp

  PURPOSE:
	Calculates toroidal and poloidal magnetic field values (Bt & Bp)
	at desired R & Z and desired time by reading data from the EFIT
	(or similar) MDS+ tree. (Bt is also refered to as B-phi.)

  CATEGORY:
       EFIT, LRDFIT

  CALLING SEQUENCE:
	calcbtbp, shot, index, time, Rwant, Zwant, tree=tree, $
                 BpWant=Bp, BtWant=Bt		; returned
  INPUTS:
	shot - NSTX shot number
	index - number of the run, 1,2,... etc. 
	time - time wanted in seconds
	Rwant - Major radius in meters at which Bt & Bp wanted 
	Zwant - Height in meters at which Bt & Bp wanted 

  RETURNED:
    keywords:
	BpWant - Poloidal magnetic field at desired R & Z at desired time
	BtWant - Toroidal magnetic field at desired R & Z at desired time

  EXAMPLE:
      IDL> .r /u/jmenard/idl/efit/math_routines_jem.pro
      IDL> .r efit_routines_jem.pro
      IDL> calcbtbp, 139444, 4, .27, 1.44, 0., BP=Bp, Bt=Bt
	(will see lots of errors for LRDfits)

      IDL> mdsopen,'LRDFIT04', 139444
      IDL> BTAXP = mdsgetsig( '\BTAXP', xaxis=fittime )
      IDL> print, BTAXP( nearesti( fitTime, 0.27 ) )

  NOTES:
	To see what fits are available, you could:
	   IDL> print, fitsrun(shot)
       or
	   IDL> print, bestFitAvail(shot)
  MODIFICATION HISTORY:
  	WRITTEN 19-Jan-2012 by Bill Davis with Stefan Gerhardt's help
		see /u/sgerhard/NSTX/idl/lib/MSERoutines.pro
	Uses many routines from Jon Menard.

CAMAC_HERE

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       CAMAC_here
 PURPOSE:
       Return 1 if CAMAC on this computer
	(if environmental variable "camac_server" is non-blank)
 CATEGORY:
       CAMAC
 CALLING SEQUENCE:
       IDL> OK = CAMAC_here()
 INPUTS:
       none required  
 KEYWORD PARAMETERS:
	var - Environmental variable to check to determine if CAMAC available.
		(defaults to 'camac_server')
	HLP - When set, help information is printed.
	verbose - if set, will print many informational messages
	debug - if set, debug output will be printed
 OUTPUTS:
       OK = 1 if environmental variable "camac_server" is non-blank
 EXAMPLE:
 NOTES:
       When the routine is called with the
	keyword hlp set, help information is printed.
 MODIFICATION HISTORY:
       08-Jan-2009 Written by Bill Davis, PPPL

CAMONITOR

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       caMonitor

 PURPOSE:
       This function provides Add/Get/Check/Clear monitor features on a
       single PV or a list of PV names.

 CATEGORY:
       EPICS Channel Access Interface

 CALLING SEQUENCE:
       Status = caMonitor(name, vals, num, overflow, op_keyword,type_keyword, max=no)

 INPUTS:
       name:	The variable for a PV or a list of PV names.

 KEYWORD PARAMETERS:
     ADD:      Set /ADD to add CA monitor for the specified name.
               Return 0 for success, -1 for failure.

     CLEAR:    Set /CLEAAR to clear CA monitor for the specified name.
               Return 0 for success, -1 for failure.

     CHECK:    Set /CHECK to check for new event for the specified name.
               Return 0 for success, -1 for failure.
               The ouput variable 'vals' contains the return event flags.
                 0 - flags no new event detected
                 1 - flags new event detected

     GET:      Set /GET to get monitor values back for the specified name.
               Different type of monitor returns different vals array.
               If non queue type monitor set, the vals array returns a
               single value for each PV in the name variable.
               If the kewword /QUEUE is specified, in addition of vals,
               both num and overflow variables are also returned.

     QUEUE:	Set /QUEUE flag to queue the value change event for the
               monitored single channel until the user gets them.

     MAXQUEUE: The MAXQUEUE=no must be specified if /QUEUE is specified.

     MODE:     This flag indicates what type of monitor queue is desired.
               The MODE=i where i can be 1/2/3, it defaults to 1. The
               MODE=1 or 2 monitor fills the QUEUE buff until it is fulled.
               If MODE=1, the /GET will clear the QUEUE buff.
               IF MODE=2, the /GET will not clear the QUEUE buff.
               The MODE=3 uses the circulat buffer, it keeps the most
               current MAXQUEUE values in the queue buffer.

               Default Vals returned in double precision form.
     /INT      Return Vals converted to integer
     /LONG     Return Vals converted to long integer
     /BYTE     Return Vals converted to byte type 
     /FLOAT    Return Vals converted to float type 
     /STRING   Return Vals converted to string type

 OUTPUTS:
     vals:     Returns the array of data if either keyword /GET or /CHECK
               is specified

     num:      Returns the real number of data in the vals array for the
               /QUEUE mode

     overflow: Returns the buffer full indicator for the /QUEUE mode
               0 - vals queue buff is not full
               1 - vals queue buff is full

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       This routine will causes a channel access search to take place if
       this is the first time this process variable has been referenced.

 RESTRICTIONS:
       All the PVs are monitored as double values in this function
       unless the PV is a DBR_STRING type then monitored as string type.
       For getting the monitored queue array, only a single PV name can
       be specified.  For non queue type monitor, only the first value
       for a PV can be returned by this function.  Use caGet to get
       array type of values back.

 PROCEDURE:
	This routine uses Ezca_monitorArrayAdd(), Ezca_monitorArrayGet(),
       Ezca_monitorArrayCheck(), Ezca_monitorArrayClear(), Ezca_queueAdd(),
       Ezca_queueGet(),Ezca_queueZero(), and Ezca_queueClear()
       from the ezcaScan library.

 EXAMPLES:
    Single value monitor

       IDL> print,caMonitor('chademoai1',/add)
       IDL> print,caMonitor('chademoai1',vals,/get)
       IDL> print,caMonitor('chademoai1',/clear)

    Use queue array monitor with maxqueue=100

       IDL> print, caMonitor('chademoai1',/add,/queue,maxqueue=100)
       IDL> print, caMonitor('chademoai1',vals,num,overflow,/get,/queue,maxqueue=100)
       IDL> print, caMonitor('chademoai1',/clear,/queue)

 MODIFICATION HISTORY:
       Written by:	Ben-chin Cha      Dec, 1995
       04-12-96    bkc   Modified on line help syntax
       04-07-99    bkc   Return monitor values specification:
                         /byte,/int,/long,/float,/string

CAPENDEVENT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caPendEvent

 PURPOSE:
	This function causes the Ezca to call channel access ca_pend_event
       function.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	caPendEvent [,time=0.001] [,help=help]

 INPUTS:
       None.

 KEYWORD PARAMETERS:
       TIME:  This keyword parameter is used to reset the timeout in seconds
              used by ca_pend_event in ezcaScan library.

       HELP:  If ,/HELP is set, on-line help will be displayed.

 OUTPUTS:
       None.

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       This routine sets the timeout for event monitor routines used in
       ezcaScan library and calls the ca_pend_event.

 RESTRICTIONS:
	Positive time must be used.

 PROCEDURE:
	This routine uses Ezca_setPendTime() from the ezcaScan library.

 EXAMPLES:
       IDL> caPendEvent, time=0.0001

 MODIFICATION HISTORY:
 	Written by:	Ben-chin Cha      Dec, 1995

CAPENDIO

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caPendIO

 PURPOSE:
	This routine sets the timeout used by ca_pend_io in array get/
       put used in ezcaScan library.

 CATEGORY:
       EPICS Channel Access Interface

 CALLING SEQUENCE:
       caPendIO, time=time, list_time=list_time

 INPUTS:
       None.

 KEYWORD PARAMETERS:
	TIME:   Use the TIME=time keyword to set the timeout waiting for
               channel access I/O for single process variable name.

	LIST_TIME: Use the LIST_TIME=list_time keyword to set the timeout
               waiting for channel access I/O for a list of PV names.

       HELP:   If ,/HELP is specified, on line help will be displayed.

 OUTPUTS:
       None.

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       These times will be used in array get/put from then on in all
       ca_pend_io calls in ezcaScan library.

 RESTRICTIONS:
       Positive real times should be used in those keywords.

 PROCEDURE:
	This routine uses Ezca_setPendTime() from the ezcaScan library.

 EXAMPLES:
       IDL> caPendIO, time=0.1, list_time=3.
       IDL> caPendIO, /help

 MODIFICATION HISTORY:
 	Written by:	Ben-chin Cha      Dec, 1995

CAPUT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caPut

 PURPOSE:
	This procedure writes a new value to a channel access process variable.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	status = caPut(pvname, value)

 INPUTS:
	pvname:	The name of the process variable for which the new value
               is to be written

       value:  The new value to be written. In general this can be a scalar
               or array of any data type.  There are of course restrictions
               in that certain strings cannot be written to certain process
               variables, and some process variables cannot be passed arrays.

 KEYWORD PARAMETERS:
	WAIT:	Set this flag to force caPut to wait for a channel access
               callback.  The default is not to wait for a callback, using the
               ezca function ezcaPutOldCa.  The WAIT keyword results in a
               call to ezcaPut, which uses channel access callbacks.

 OUTPUTS:
       The function return value of caPut is a status value.  The
       status is 0 if the routine was successful (i.e. the process variable
       exists and a valid value was written) and non-zero if the routine
       failed.

 PROCEDURE:
	This routine uses ezcaPut(). The "nelem" and "type" parameters passed
       to ezcaPut are determined from the IDL data type and number of elements
       of the "value" parameter passed to caPut(). Strings are converted to
       to byte arrays before being passed.

 RESTRICTIONS:
       None.   caPut can be called inside a group, i.e. after calling
               caStartGroup and before calling caEndGroup.  The "value"
               variable passed to caPut can be immediately re-used when
               inside a group, since EZCA copies it to a private location.

 EXAMPLES:
       IDL> ; Put a linear ramp (findgen()) to a waveform process variable.
       IDL> status = caPut('my_waveform.VAL', findgen(100))

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995
       Sept. 16, 1998  Mark Rivers  Added WAIT keyword, made non-callback
                                    version of caput the default

CAPUTARRAY

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       caPutArray

 PURPOSE:
       This function writes an array of data to a list of Channel Access
       process variable. It returns 0 if successful, else retuns -1.

 CATEGORY:
       EPICS Channel Access Interface

 CALLING SEQUENCE:
       Status = caPutArray(pvname, pdata, /event)

 INPUTS:
       pvname:	The variable specifies a list of process variables for
               which the input array of data is to be written to IOC.
       pdata:  Input data array. The data array must be consistant with
               the number of PV names defined in the pvname.

 KEYWORD PARAMETERS:
      EVENT:   If specified use the ca_array_put_callback otherwise
               use the ca_array_put.

 OUTPUTS:
      None.

 COMMON BLOCKS:
      None.

 SIDE EFFECTS:
       This routine will causes a channel access search to take place if
       this is the first time this process variable has been referenced.

 RESTRICTIONS:
       Thus, it is the user's responsibility to make sure the adequate
       pdata is provided for the pvname.

 PROCEDURE:
	This routine uses Ezca_putArray() from the ezcaScan library.

 EXAMPLES:
       In the following example write a string value '11' to two PV
       names: chademomask1.VAL  and chademoai2.VAL

       IDL> x = ['chademomask1', 'chademoai2']
       IDL> y = make_array(1, 2, /string)
       IDL> y(0) = '11'
       IDL> y(1) = '11'
       IDL> status = caPutArray(x,y)

       In the following example write values [1,2,3] to two waveform records
       names: chademowf2  and chademowf5

       IDL> x = ['chademowf2','chademowf5']
       IDL> y = make_array(3, 2)
       IDL> y(0,0) = [1,2,3]
       IDL> y(0,1) = [1,2,3]
       IDL> print,caPutArray(x,y)
       IDL> print,caGetArray(x,pd,max=10)
       IDL> print,pd

 MODIFICATION HISTORY:
       Written by:	Ben-chin Cha      Dec, 1995

CASCAN

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       caScan

 PURPOSE:
       This function provides add/get/zero/clear monitor features on a
       scan record and a set of PV names.

 CATEGORY:
       EPICS Channel Access Interface

 CALLING SEQUENCE:
       Status = caScan(name,pvnames,nonames,npts,vals,op_keyword,max=no)

 INPUTS:
       name:   The name of the process variable which has control of
               triggering scan, e.g. the scan record name.
       pvnames: A list of detector process variables for which the values
                are to be monitored by the trigger name.

 KEYWORD PARAMETERS:
      ADD:     Set this flag /ADD  to add a complete set of monitor for
               name and pvnames.
               Return 0 if successful, -1 if failed, 1 if old monitor
               already existed. If succeeds, the output variable npts
               is set to the number of data to be detected, and the
               nonames is set to the number of PVs in pvnames.

      CLEAR:   Set this flag /CLEAR to clear the monitor set by add.
               Return 0 if successful, -1 if failed.

      GET:     Set this flag /GET to get scan array of monitor values back.
               Return -1 if failed, return 1 if scan is properly set up but
               not triggered yet, return >1 if real data detected.
               If succeeds, the npts is set to the number of data so far
               detected.

      ZERO:    Set this flag /ZERO to zero the allocated space.
               Return 0 for success, -1 for failure.

      MAX:     Specifies the max number of monitor values to be returned.
               If the trigger name is not a scan record, the max=no must
               be provided for this function.

 OUTPUTS:
     nonames:  This variable returns the number of PVs in pvnames.
     npts:     This variable returns the current number of data points
               detected by the scan record.
     vals:     This detector data array buff, vals(nonames,max), stores
               the detected data so far captured.

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       This routine will causes a channel access search to take place if
       this is the first time this process variable has been referenced.

 RESTRICTIONS:
       None.

 PROCEDURE:
       This routine uses Ezca_scanAddMonitor(), Ezca_scanClearMonitor(),
       Ezca_scanGetMonitor(), and Ezca_scanZeroMonitor() from the Ezca
       library.

 EXAMPLES:
      For scan record type triggered scan

       IDL> print,caScan('name',pvnames,/add)
       IDL> print,caScan('name',pvnames,nonames,npts,vals,/get)
       IDL> print,caScan('name',pvnames,/zero)
       IDL> print,caScan('name',pvnames,/clear)

      For non-Scan record type triggered scan

       IDL> print,caScan('name',pvnames,/add,max=100)
       IDL> print,caScan('name',pvnames,nonames,npts,vals,/get,max=100)
       IDL> print,caScan('name',pvnames,/zero,max=100)
       IDL> print,caScan('name',pvnames,/clear,max=100)

 MODIFICATION HISTORY:
       Written by:	Ben-chin Cha      Dec, 1995

CASEARCH

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caSearch

 PURPOSE:
       This function searches for a list of process variable names.
       It returns 0 if successful, returns -1 if failed.

 CATEGORY:
       EPICS Channel Access Interface

 CALLING SEQUENCE:
       Status = caSearch(pvname)

 INPUTS:
      pvname: The variable for a list of process variables for which the
              channel access search to be done.

 KEYWORD PARAMETERS:
       None.

 OUTPUTS:
       None.

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       This routine will causes a channel access search to take place if
       this is the first time pvnames has been referenced.

 RESTRICTIONS:
       None.

 PROCEDURE:
       This routine uses Ezca_search_list() from the ezcaScan library.

 EXAMPLES:
       IDL> print,caSearch('chademoai1')
       IDL> x = ['chademoai1','chademoai2']
       IDL> status = caSearch(x)

 MODIFICATION HISTORY:
       Written by:	Ben-chin Cha      Dec, 1995
      04-11-96   bkc   Fix typo error names to name

CASETMONITOR

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caSetMonitor

 PURPOSE:
	This procedure sets a monitor on the specified process variable.
       This causes a channel access callback to execute whenever the value
       of that process variable changes.  Subsequent calls to caGet() after
       calling caSetMonitor will read the values provided by the callbacks,
       rather than reading from the IOC.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	status = caSetMonitor(pvname)

 INPUTS:
	pvname: The name of the process variable on which to set the monitor.

 OUTPUTS:
       The function return value of caSetMonitor is a status value.  The
       status is 0 if the routine was successful (i.e. the process variable
       exists) and non-zero if the routine failed.

 PROCEDURE:
	This routine uses ezcaSetMonitor(). The "type" parameter required
       by ezcaSetMonitor is the native EZCA data type as determined
       by caGetCountAndType().

 EXAMPLES:
       IDL> status = caSetMonitor('test_ao1')
       IDL> status = caGet('test_ao1', value)

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CASETRETRYCOUNT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caSetRetryCount

 PURPOSE:
	This procedure sets the value of the EZCA RetryCount parameter.
       In conjunction with the EZCA Timeout parameter it determines how
       long EZCA will try to connect to a process variable before giving up.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	caSetRetryCount, retrycount

 INPUTS:
	RetryCount: The integer retry count.

 OUTPUTS:
       None

 PROCEDURE:
	This routine uses ezcaSetRetryCount().

 EXAMPLES:
       IDL> caSetRetryCount, 100

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CASETTIMEOUT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caSetTimeout

 PURPOSE:
	This procedure sets the value of the EZCA Timeout parameter. This
       value determines the time parameter passed to ca_pend_io() in EZCA.
       In conjunction with the EZCA RetryCount parameter it determines how
       long EZCA will try to connect to a process variable before giving up.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	caSetTimeout, timeout

 INPUTS:
	Timeout:  The timeout value in seconds (floating point).

 OUTPUTS:
       None

 PROCEDURE:
	This routine uses ezcaSetTimeout().

 EXAMPLES:
       IDL> caSetTimeout, .001

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAST

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       CAST
 PURPOSE:
       Generalized type casting.  Converts variables whose type code is out 
       of the range [LOW,HIGH] into this range.
 CATEGORY:
       Programming, type conversion
 CALLING SEQUENCE:
       Result = CAST( X, [LOW [,HIGH]])
 INPUTS:
    X
       Numerical, arbitrary, or a character representation of a number(s).
    LOW
       Number representing a type code, range (1:9).  If greater than 9, it is
       set to 9.  If less then 1, or not given, it is set to 1.
 OPTIONAL INPUT PARAMETERS:
    HIGH
       Type code, same as LOW.  Default value is 9.  If provided and less then
       LOW, it is set to LOW.
 KEYWORD PARAMETERS:
    /FIX
       Switch.  If set, the output is filtered through FPU_FIX, eliminating
       floating underflow errors.
 OUTPUTS:
       If the type of X is < LOW, CAST returns X converted to type LOW.
       If the type of X is > HIGH, CAST returns X converted to type HIGH.
       Otherwise CAST returns X.
 OPTIONAL OUTPUT PARAMETERS:
       None.
 COMMON BLOCKS:
       None.
 SIDE EFFECTS:
       None.
 RESTRICTIONS:
       1)  An attempt to convert a string which is NOT a character 
           representation of a number into a numeric type will yield error.
       2)  X cannot be a structure or pointer, but can be a structure element.
       3)  The value 8 for either LOW or HIGH is not allowed (since it 
           corresponds to structure type).  Value of 10 and above is ignored.
 PROCEDURE:
       Identifies the type of X, and if out of the range given by [LOW,HIGH]
       calls the proper conversion routine using the system routine 
       CALL_FUNCTION.  Also uses FPU_FIX and ISNUM from MIDL.
 MODIFICATION HISTORY:
       Created 25-DEC-1991 by Mati Meron.
       Modified 15-JUN-1995 by Mati Meron to accept the new DOUBLECOMPLEX type.
       Modified 25-SEP-1998 by Mati Meron.  Underflow filtering added.

CASTARTGROUP

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caStartGroup

 PURPOSE:
	This procedure starts an "asynchronous group".  Within an asynchronous
       group all calls to caGet and caPut are asynchronous, i.e. they queue
       a request and return immediately without waiting for a reply from
       the channel access servers. Calling caEndGroup causes the queue to be
       flushed and waits for the replies. The use of asynchronous
       groups can greatly improve the efficiency of channel access. The user
       must be aware of the restrictions on caGet outlined under the
       description of that routine.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	caStartGroup

 INPUTS:
	None.

 OUTPUTS:
       None

 COMMON BLOCKS:
       EZCA_COMMON contains a flag (ingroup) which indicates if we
       are currently in an asynchronous group. This routine sets that flag.

 PROCEDURE:
	This routine uses ezcaStartGroup().

 EXAMPLES:
       IDL> caStartGroup
       IDL> status = caget('test_ao1.SCAN', scan)
       IDL> status = caget('test_mca1.ERTM', ertm)
       IDL> ; Print out values - they will be zero.
       IDL> help, scan, ertm
       IDL> status = caEndGroup()
       IDL> ; Print out values after executing caEndGroup, they are non-zero
       IDL> help, scan, ertm
       Output:
           SCAN            INT       =        0
           ERTM            FLOAT     =      0.000000
           SCAN            INT       =        6
           ERTM            FLOAT     =       7.10000

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CATIMESTAMP

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caTimeStamp

 PURPOSE:
       This function returns the time stamp of corresponding value for
       the specified record name.

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	string = caTimeStamp(pvname)

 INPUTS:
       pvname:	The name of the process variable for which the timestamp is to
               be returned.

 KEYWORD PARAMETERS:
       None.

 OUTPUTS:
	string:  The function returns the time stamp string for the requested
                PV name.

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
	This routine will causes a channel access search to take place if
       this is the first time this process variable has been referenced.

 RESTRICTIONS:
       Only single PV name is allowed in input.

 PROCEDURE:
	This routine uses Ezca_timeStamp() from the ezcaScan library.

 EXAMPLES:
       IDL> print,caTimeStamp('chademoai1')

 MODIFICATION HISTORY:
 	Written by:	Ben-chin Cha      Dec, 1995

CATRACE

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	caTrace

 PURPOSE:
	This procedure turns the EZCA trace flag on or off. Turning on
       the trace flag prints lots of information which is mainly useful
       to developers.  Setting the trace flag results in less
       verbose output than setting the debug flag (see caDebug).

 CATEGORY:
	EPICS Channel Access Interface

 CALLING SEQUENCE:
	caTrace, state

 INPUTS:
	state:  state=1 turns trace on, state=0 turns trace off.

 OUTPUTS:
       None

 PROCEDURE:
	This routine uses ezcaTraceOn() and ezcaTraceOff().

 EXAMPLES:
       IDL> caTrace, 1     ;Turn on trace
       setting Trace
       IDL> status = caGet('test_ao1', value)
       ca_pend_event(0.000010)
       find_channel() found >test_ao1<
       get_channel(): was able to find_channel()
       ca_pend_event(0.000010)
       ...
       ...
       IDL> caTrace, 0     ; Turn off trace

 MODIFICATION HISTORY:
 	Written by:	Mark Rivers
	June 28, 1995

CAVERSION

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       caVersion

 PURPOSE:
       This function returns the string of current version information
       about ezcaIDL

 CATEGORY:
       EPICS Channel Access Interface

 CALLING SEQUENCE:
       string = caVersion()

 INPUTS:
       None.

 OUTPUTS:
       Return the string which gives the version information about
       ezcaIDL, ezca, Ezca, and EPICS base verion number.

 PROCEDURE:
	This routine uses Ezca_version() from the ezcaScan library.

 EXAMPLE:
       IDL> print, caVersion()

 MODIFICATION HISTORY:
       Written by:     Ben-chin Cha   Dec, 1995

CHARSIZE2FIT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       charSize2Fit

 PURPOSE:
       compute charsize for a string to fit in horizontal # of pixels

 CATEGORY:
       strings

 CALLING SEQUENCE:
       IDL> charsize= charsize2fit( charstr, pixels)

 INPUTS:
       charstr - character string to plot
	pixels - # of horizontal pixels character string must fit into
	
 KEYWORD PARAMETERS:
	nchars - overrides charstr size

 OUTPUTS:
       charsize - character size that can be used in call to xyouts

 EXAMPLE:
	IDL> pixels = 100
 	IDL> window,/fr, xsize=pixels, ysize=100
	IDL> charstr='Hi to all you folks out there'
	IDL> xyouts, 0,.5, charStr, charsize=charsize2fit( charstr, pixels )

  25-Jul-2012 added nchars keyword
  WRITTEN 06-Jul-2012 by Bill Davis

CHECKMDSTREE

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
        checkMDStree
 PURPOSE:
      Check MDS trees, say after a transfer. Produce a file with a 
	list of nodes and checksum of contents of each numerical node or first 
	element of non-numeric nodes.
 CATEGORY:
       MDSplus, Searching
 CALLING SEQUENCE:
       IDL> checkMDStree, tree=tree, shot=shot, outFile=outFile
 INPUTS:
	tree - MDSplus tree. 
	shot - MDSplus shot to search. 
 KEYWORD PARAMETERS:
    Input (Optional):
	server - MDSplus server. Default is the default server for the tree.
	outFile - defaults to tree_nnnnnn_server_list.txt
	remove - if set, removes the tree::top when listing the node name
    Returned (Optional):
	status - status from mdsopen call
 OUTPUTS:
    (Optional):
	outFile - 
	outDir - output dir (DEF='')
 EXAMPLE:
	IDL> checkMDStree, tree='particles', shot=130000, server='lark:8501', /verb

	IDL> checkMDStree, tree='usxr', shot=142000, server='skylark:8501', /verb
 NOTES:
 MODIFICATION HISTORY:
	24-Feb-2011 include any port info into default output filename
	01-Oct-2008 add checksum for Alphanumerics, too.
	29-Aug-2008 Written by Bill Davis, PPPL

CHECKSIG

[Previous Routine] [Next Routine] [List of Routines]

  NAME:
	checkSig

  PURPOSE:
	checks for existence of a signal in MDSplus for current shot and
	optionally declares an event. It can also execute an IDL string when
	it sees  the event. It will then start watching for the next shot.

  CATEGORY:
	MDSplus, Events

  CALLING SEQUENCE:
       IDL> checksig, tree=tree, sig=sig, event=event

  INPUTS:
  KEYWORD PARAMETERS:
    Inputs:
	tree - MDSplus tree (DEFAULT=engineering)
	sig - MDSplus signal to look for in current shot
	event - MDSplus event to declare (DEFAULT=$USER_test)
	logfile - where to write log messages
	pause - seconds to pause between checks (default=10 sec)
	test - if set, will not set event, only print messages
	realVerbose - if set will tell you too much stuff
	verbose - if set, will print many informational messages
	debug - if set, debug output will be printed
  OUTPUTS:
	none, just printing

  EXAMPLE:
	IDL> checksig, tree='engineering', sig='\fdia', event='bdtest'

	IDL> checksig, tree='engineering', sig='\fdia', /test,/verb, pause=10

	IDL> checksig, sig='\cameras::ph7_1_count',  $
		exec='cinethumbnails, "*nstx_2_*'+strtrim(lastshot(),2)+'*.cin"'
	IDL> checksig, sig='\efit02::r',  $
	     exec='cinethumbnails,findLastFile("/p/nstxcam/Miro2-7988/2010/*.cin")'

  15-Apr-2010 alternately can call an IDL routine [BD]
  13-Apr-2010 increased default pauses [BD]
  WRITTEN by Bill Davis, 01-Apr-2010

CH_EXAMPLE

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       CH_Example
 PURPOSE:
       a simple example using the GA Crosshair routines
 CATEGORY:
       GUI Graphics, Example
 CALLING SEQUENCE:
       CH_Example
 COMMON BLOCKS:
       ch_example
 NOTES:
       Your display may have to be set to 256 colors to see the crosshairs.
 MODIFICATION HISTORY:
       Written by Bill Davis, 8/29/97

       GA Crosshair routines originally written by John Ferron. 
       Now maintained by T. Terpstra

CH_REGISTER

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
  	ch_register
 PURPOSE:
	register window for crosshair routines

 CATEGORY:
	GUI Graphics, Cursor Cross-hairs

 EXAMPLE:
	See ch_example.pro

 MODIFIED:
	29-Nov-07 Don't handle if window names not found in ch_set [BD]
	30-Oct-00 Override !P.PSYM & !P.LINESTYLE for cros-hairs  [BD]
	04-Dec-99 Make mask bit 6, so it's red when used with MK_COLOR  [BD]
	29-Mar-99 Added newX, newY & newP keywords to CH_SET for changing
		  plotting parameters  [BD]
	26-Jan-99 Taken from GA   [BD]
		  Combining all ch_ files here, since this must be called 1st.

CINE2MPEG

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
    cine2mpeg

 PURPOSE:
    Create a movie from a .cin files from Phantom Fast Cameras.
    Will default to writing jpegs and spawning jmovie to create a
    QuickTime movie. If /MPEGout keyword set, will write an MPEG.
    The data can be color or monochrome,

 CATEGORY:
    animation

 CALLING SEQUENCE:
      cine2mpeg, CineFile1, outFile=outfile, t1=t1, t2=t2, ndups=ndups
   or
      cine2mpeg, shot=shot, t1=t1, t2=t2, /verbose

 INPUTS:
	CineFile1 - a cine filename

	shot - if used instead of filename, it will search appropriate directories.

 OPTIONAL KEYWORD PARAMETERS:
	outFile - name of output MPEG file (will default to a nice name), or 
	prefix - what would precede _shot_t1_t2 (in msec) in the output filename
	t1 - start time of animation in msec
	t2 - end time of animation in msec
	MPEGout - if set will create an MPEG movie
	FramesOut - if=0, will not create QuickTime movie
	VIEW - if set, just displays images, and does not make an mpeg
   	ndups - if given means repeat every image 'ndups' times
   	despeckle - if set call despeckle routine (slow, but less "intrusive" 
		    than median)
	badValue - if data is this or above, replace with median of surrounding pixels
	nSmooth - number input to median smoothing routine
	gamma - gamma correction. (Default=1, which is no correction). 
		0.5 probably better for Miro
	saturation - As in HSV color representation, for color camera. 
		Default is 0.3.
	topPixels -
	botPixels - 
	AveT1 - start time of range for Average Frame in msec
	AveT2 - end time oof range for Average Frame in msec
	manifold - if set, will draw line for manifold positon
	charsize - character size for labels. Default=1.5
	ctb - color table for non-color image 
	label - label on plot 
	horizontal_flip - if set, flip images horizontally
	vertical_flip - if set, flip images vertically
	byteScale - if set, will scale 
	minVal - if this and byteScale set, will use this as minimum value
	maxVal - if this and byteScale set, will use this as maximum value
	inc - default 1o 1; use every "inc"th frame
	noCaption - do not put text on or above image
	Rotate - integer from 0-3, passed to IDL ROTATE function
	verbose - if set will print out info here and there
 OUTPUTS: 
	an MPEG file named by outFile keyword

 NOTES:
	*** you have to be careful with MAXVAL. If too big, all frames will be black
 EXAMPLE:

    cine2mpeg, '/p/nstxcam-archive/Miro2-7988/2008/MIRO_130389.cin', $
		t1=0.02, t2=0.0300, /verbose                                 , /debug

    cine2mpeg, shot=130277, t1=0.100, t2=0.200, /verbose, /view    , /debug

    cine2mpeg, GETENV("NSTXUSR")+'/phantom4/GDNex10usFps27000DC110maP1.98torr-1.cin', $
		outfile='Ne110us.mpg', t1=.0007, t2=0.0017, ndups=4, mag=3

	minHt and maxChi2 are the most useful to adjust:
   blobCriteria = { minHt : 1.2,  $
		     maxChi2 : 3.,  $
		     maxFrames : 1,  $
		     maxJump : 10,  $
		     minArea : 9,  $
		     minLifetime : 3,	$
		     maxAreaChange : 100,  $
		     minRise : 0.02  $
		   }
  cine2mpeg,'/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_138234.cin',$
           aveT1=0.530, aveT2=0.550,  t1=0.532, t2= 0.5326, /blobs, $
            blobCriteria=blobCriteria, $
           colorTable=3, min=256, /surface, /RotCC, /arrow		     , /view,/debug

  cine2mpeg,'/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_138234.cin',$
           aveT1=0.530, aveT2=0.550,  t1=0.530, t2= 0.5302, /blobs, $
           colorTable=3, minWidth=256, /surface, /horiz, /RotCC, /arrow     , /view,/debug

     ; to test drawing plasma EDGE and limiter shadow:
  cine2mpeg,'/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_138234.cin',$
           aveT1=0.530, aveT2=0.550,  t1=0.530, t2= 0.5301,  $
           colorTable=3, minWidth=256, /horiz, /RotCC, /arrow, /EDGE  	     , /view,/debug

   mv files to /w/nstx.pppl.gov/htdocs/nstx/Software/Diagnostics/Miro/GlobalMPEGs 
	for web viewing at
       http://nstx.pppl.gov/nstx/Software/Diagnostics/Miro/GlobalMPEGs

     for Stewart's FY15 GPI paper:

   IDL> cinethumbnails, /edge,  $
	    nSmooth=3, Rotation=1, /horiz, xSize=668*10./8+80, ySize=652*.666, $
	    '/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_140395.cin',       $
	    /rainbow, border=3, /ellip, nWanted=10, nrows=2, howFar=.1, /norm, $
	    bytescale=0, aveT1=.5505, aveT2=.5515, minVal=0.405, maxVal=2.159, $
	    /colorbar, t1=.550929, t2=.551029, label=0,/verbose

  cine2mpeg,'/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_140395.cin',  $
           aveT1=550.5, aveT2=551.5,  t1=550.929, t2=550.95, $	;;;t2= 551.019,  $
           /ellip, /horiz, /rotccw, howFar=0.1, $
           ctb=3, minWidth=256	   ;;;,  /view


 MODIFICATION HISTORY:
	09-Apr-2015 added ellipses keyword for Stewart Zweben GPI paper
	04-Feb-2015 using cgImage and cgSnapshot instead of TV and TVRD so color
		    JPEGS easy.
	12-Mar-2014 added Fit keyword for separatrix calculation
	15-Oct-2013 BIG CHANGE: Bytescale with minVal & maxVal, unless showMax
			defined
	08-Oct-2013 added manifold-showing option. New limiter position
	06-Mar-2013 black out top and bottom after drawing separatrix
	05-Mar-2013 if bytescale set, don't use maxVal and minVal to scale image
       25-Oct-2012 added showNumbers, xvals, and yvals, for suppressing blob #s and
		    having surface axes in cm.
	27-Mar-2012 use fastcam_times and fastcam_frame so can support HDF files from simulation
	12-mar-2012 moved smoothing out of cine2mpeg, and let be done in findblobs,
		    like other apps doing. Have time inputs in msec. Default to Gaussian smoothing
	24-Feb-2012 added gaussian smoothing option
	23-Feb-2012 many adjustments for showing CMOD data, especially when window size
		    not optimal.
	31-Aug-2011 added Surface option for better Blob tracking
	07-Apr-2011 added NoCaption keyword for NOVA work.
	10-Aug-2010 added option to make .mov files from Eliots Java code that uses 
		    jpegs
	09-Jun-2010 made do loops start with LONG so can handle > 32K frames
	27-Aug-2009 added /horizontal_flip and /vertical_flip
 	22-Jul-2009 if not MIRO, and maxVal not specified, scale each frame to it's max.
		    added NORMALIZE keyword (default) to read through all frames
		    and get the max value for use in BYTSCL.
	24-Jun-2009 added showMin and showMax keywords.
	12-Nov-2008 mods because cineload now assuming frame 0 is beginning of data
	18-Sep-2008 mods to magnify keyword
	05-Aug-2008 Written by Bill Davis

CINEAVE

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
	cineave

 PURPOSE:
       Produce an average frame from a time ranged from .cin files from 
       Phantom  Fast Cameras. This frame is typically used to divide GPI
       images  by to get normalized image.

 CATEGORY:
	animation

 CALLING SEQUENCE:
      
	IDL> a=cineave( CineFile, aveT1=aveT1_in, aveT2=aveT2_in, aveInt=aveInt )

 INPUTS:
	CineFile - a cine filename

  	aveT1 - start time for averaging (seconds)
  	aveT2 - end time for averaging

	nsmooth - # of points for median smoothing on individual frames
   	despeckle - if set call despeckle routine (slow, but less "intrusive" 
		    than median)
	badValue - if data is this or above, replace with median of surrounding pixels
	inc - default 1o 1; use every "inc"th frame
	FrameOffset - if set, subtract this (like a baseline) from all pixels
	FrameAveMin - if set, make close-to-zero pixels this number, 
		      so when dividing into data, as in normalizing, result is near zero

  OUTPUTS:
	maxInt - the maximum intensity anywhere in the frame vs. time
	aveInt - the average intensity anywhere in the frame vs. time
	maxVal - maximum value over interval
	minVal - minimum value over interval
	maxNorm - max value of normalized images over that the same time range
	times - times used to create this average frame
	status - odd if OK

 EAXMPLES:

  filename='/p/gpi/szweben/Phantom_Data/2009_Phantom_data/1091216/shot_1091216029.cin'

 or filename='/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_142000.cin'

	IDL> t0=systime(1) & a=cineave( filename, aveInt=aveInt ) & print, systime(1)-t0

  Without finding AveInt, took 6.5 sec for nstx_1_142000.cin. 
  When finding average, 33.6 seconds .

 MODIFICATION HISTORY:
  05-Mar-2014 added keywords fr1 & fr2 for files with whacky times
  05-Sep-2012 added keywords FrameOffset and FrameAveMin
  04-Sep-2012 fixed bug where was dividing by n-1 rather than n.
  27-Mar-2012 use fastcam_times and fastcam_frame so can support HDF files from simulation
  01-Sep-2011 added nsmooth, inc, despeckle & badvalue keywords
  27-Jul-2011 made max intensity at a pixel be the 99.9% pixel value so bad pixels
		don't form max (as Ricky Macqueda did)
  25-Jul-2011 added keyword maxInt to return maximum intensity vs. time
  22-Jul-2011 default aveT1 and aveT2 to entire file and option to return
	       average intensity vs. time [BD]
  18-Jan-2011 added minAll and maxAll keywords
  WRITTEN Jan-2011 by Bill Davis for Stewart Zweben

CINELOAD

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       cineload
 PURPOSE:
       Read a frame from a .cin file from a Phantom 7 camera.
	File is opened only the first time (or when filename is new), and
	pointers and things are remembered from one call to the next.
 CATEGORY:
       Image Processing
 CALLING SEQUENCE:
       IDL> image = cineload( filename, frame )
 INPUTS:
   	filename - a .cin file
   	frame - absolute frame number in file desired. 0 is always the first
 OUTPUTS
	image - a [n,y] or [3,n,y] image
    optional:
	fps - frames per second
	exposure - exposore time
 KEYWORD PARAMETERS (optional):
    input:
	init - first call for this filename
	verbose - print out lots of info
	debug - will stop within routine if error detected.
    output:
	bitcount - 
	outMsg - 
	status - if odd, then OK
 EXAMPLE:
	IDL> filename = '/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_139475.cin'
	IDL> cine_time, filename, times
	IDL> img = cineload(filename, 0)	; get the first frame

 NOTES:
 MODIFICATION HISTORY:
   27-Feb-2013 error message, and assume FirstFrame=0, if frame outside
		range in file. This is necessary for some apps when the
		first frame in the file is not 0.
   03-Jan-2013 fixed exposure output
   22-Jun-2010 don't return image as UINT if only 8 bits
   02-Apr-2010 flip Miro files if gt 137000, according to Lane
   01-Jul-2009 merged "memory feature" of cine_time.pro with this
   12-Nov-2008 Hide firstFrame ne 0 within this routine, so calling program 
		can ask for first frame.
   10-Nov-2008 don't force frame=0 when /INIT [BD]
   02-Jul-2008 added capability for MIRO color cameras [BD]
   19-Apr-2007 added keyword INIT in case frames don't start at 1 [BD]

   IDL> img = CINELOAD(GETENV("NSTXUSR")+'/miro/MIRO_130363.cin', 100, /debug)
   IDL> img = CINELOAD(GETENV("NSTXUSR")+'/phantom4/NSTX_130363.cin', 100, /debug)

 WRITTEN by Ricky Maqueda, Bill Davis & Werner Boeglin

CINERATE

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       cinerate
 PURPOSE:
       Return framing rate from a .cin file from a Phantom 7 camera.
 CATEGORY:
       Image Processing
 CALLING SEQUENCE:
       IDL> rate= cinerate( filename )
 RETURNED:
	rate - frames per second
 INPUTS:
   	filename - a .cin file
 KEYWORD PARAMETERS:
   OUTPUT:
	serialNum - serial number of camera
	warning - if set to 0, will not pop dialog up for messages
 EXAMPLE:
	IDL> cine_time,'/p/camdata/dust/nstx121048.cin', time

 NOTES:
 MODIFICATION HISTORY:
   Written by Bill Davis 17-Jul

CINETHUMBNAILS

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       cineThumbNails
 PURPOSE:
       Plot thumbnails of many frames from a .cin file
 CATEGORY:
       Fast Cameras
 CALLING SEQUENCE:
       IDL> cinethumbnails, shot
 INPUTS:
       shot - optional alternate to filename; if more than one cine file found
	       you will get a dialog box (if no shot or filename entered, will be prompted)  
 KEYWORD PARAMETERS:
   Inputs:
      (Optional)
	filename - optional name of cine file (fastest when this used)
	t1 - start time of thumbnails (sec.)
	t2 - end time of thumbnails (sec.)
	nWanted - # of thumbnails (defaults to 108)
	edge - if set, will show plasma edge on picture (separatrix) (NOT WORKING)
       fit - type of fit for separatrix plot
	deltaT - time between thumbnails
	minVal - min value to use in byte scaling (default=0)
	maxVal - max value to use in byte scaling (default depends on camera type)
		>>> if = 0, each frame will be byte scaled.
	bytescale - if set, bytescale frames
	gamma - gamma to apply to image (Default=0.55)
	ctb - color table for non-color image 
	saturation - (Default=0.3)
	xsize - horizontal size of plot window (defaults to 640, but will let you manually expand)
	ysize - vertical size of plot window (defaults to 512, but will let you manually expand)
	label - if=0 will not label each frame with time in msec
	title - if=0 will not print file name at top right of frame   
	horizontal_flip - if set, flip images horizontally
	vertical_flip - if set, flip images vertically
       RotCCW - rotate image Counter-ClockWise
	RotCW - rotate image ClockWise
	nRows - # of rows of thumbnails
	top2bottom - if=0, time will go from bottom to top
	border - # of pixels between images (default=1)
	verbose - if set, will print many informational messages
	debug - if set, debug output will be printed
    Outputs:
	(none)
 OUTPUTS:
       just plots to graphic window
 EXAMPLES:
     !P.FONT=0
     setup_ps, 'Thumbs_138117.ps', printer = 'postscript color'
  cinethumbnails,  /horiz, /rotccw, ctb=3,  $
	'/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_138117.cin', $
	minVal=20, maxVal=230, nWanted=40, /edge, $
	t1=0.242,t2=0.248, xsize=900, ysize=580, nsmooth=3, thick=3
     unsetup_ps
  cinethumbnails,  /horiz, /rotccw, ctb=3,  $
	'/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_139050.cin', $
	t1=0.399,t2=0.455, xsize=900, ysize=580,/debug
   IDL> i = 0
   IDL> i = i+1
   IDL> cinethumbnails, '/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_138120.cin', $
		t1=0.219+i*0.001, t2=0.219+(i+1)*0.001, /horizontal_flip, /RotCCW, ctb=3, $
		xsize=1024, ysize=780
   IDL> mk_jpeg,'~/sh138120_'+strtrim(219+i,2)+'ms.jpg'

   IDL> cinethumbnails, '/p/nstxcam/Miro2-7988/2010/nstx_2_137600.cin'
   		    (expand window manually)

   IDL> cinethumbnails, 137726, xsize=1600,ysize=1000, t1=.03, t2=.31, nwanted=45
   		    (select the Miro file)

   IDL> cinethumbnails,'/p/nstxcam/Phantom73-6663/2010/nstx_3_137726.cin',maxval=0, $
   		       t1=.100,t2=.274      ; (will byte scale each frame)

   IDL> cinethumbnails,'/p/nstxcam/Phantom710-9206/2010/nstx_1_137726.cin',maxval=2000, $
   			t1=.246,t2=.267,nw=23
  	  ; to test separtrix drawing
   IDL> cinethumbnails, '/p/nstxcam/Phantom710-9205/2010/nstx_5_139444.cin', $
   			 t1=.255,t2=.285, /horizontal_flip, /RotCCW, ctb=3, $
   			 nwanted=20, /bytescale, /edge
  	  ; or from CMOD:
   IDL> cinethumbnails,  $
	   '/p/gpi/szweben/Phantom_Data/2009_Phantom_data/1091216/shot_1091216028.cin', $
   	   t1=.0,t2=.02, /horizontal_flip, ctb=3, nwanted=20, /bytescale, /edge

   IDL> cinethumbnails, 'nstx_5_137582.cin', t1=.32, t2=.37, $
		nSmooth=3, Rotation=1, /horiz, xSize=1300, ySize=900, /edge
		

   IDL> cinethumbnails, '/p/nstxcam/Phantom73-8032/2010/nstx_4_137702.cin'

     for Stewart's FY15 GPI paper:
   IDL> cinethumbnails, t1=.550929, t2=.551029, label=0, /edge,  $
	    nSmooth=3, Rotation=1, /horiz, xSize=668, ySize=652*.666,  $
	    '/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_140395.cin', $
	    /rainbow, border=3, /ellip, nWanted=8, nrows=2, howFar=.2, /verb

   IDL> !P.FONT=0
   IDL> setup_ps, 'thumbs_140395.ps', printer='postscript', /color
   IDL> cinethumbnails, t1=.550929, t2=.551029, label=0, /edge,  $
	    nSmooth=3, Rotation=1, /horiz, xSize=668*10./8, ySize=652*.666,  $
	    '/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_140395.cin', $
           aveT1=.5505, aveT2=.5515, showCon=1, nlevs=600, $
	    /rainbow, border=3, /ellip, nWanted=10, nrows=2, howFar=.1, /verb
   IDL> unsetup_up

   IDL> mk_jpeg, 'mythumbs.jpg'    ; make a jpeg file of whatever is plotted
   IDL> cinethumbnails, t1=.550929, t2=.551029, label=0, /edge,  $
	    nSmooth=3, Rotation=1, /horiz, xSize=668*10./8+80, ySize=652*.666, $
	    '/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_140395.cin',       $
	    /rainbow, border=3, /ellip, nWanted=10, nrows=2, howFar=.1, /norm, $
	    bytescale=0, aveT1=.5505, aveT2=.5515, minVal=0.405, maxVal=2.159, $
	    /colorbar

   IDL> cinethumbnails, /edge,  $
	    nSmooth=3, Rotation=1, /horiz, xSize=668*10./8+80, ySize=652*.666, $
	    '/p/nstxcam-archive/Phantom710-9205/2010/nstx_5_140395.cin',       $
	    /rainbow, border=3, /ellip, nWanted=10, nrows=2, howFar=.1, /norm, $
	    bytescale=0, aveT1=.5505, aveT2=.5515, minVal=0.405, maxVal=2.159, $
	    /colorbar, t1=.550929, t2=.551029, label=0,/verbose
 NOTES:
	see http://nstx.pppl.gov/nstx/Software/Applications/cinethumbnails.html
	for examples
 MODIFICATION HISTORY:
   30-Jul-2014 handle white at bottom of color table
   14-Oct-2013 added FIT keyword for separatrix plot
   07-Mar-2013 added keywords top2bot (now default), nrows, and border (def=1)
   26-Feb-2013 mods to work from a web page. Added medsmooth keyword.
   12-Dec-2011 put flip and rotate in for doing blob work. Also adding option to show
		separatrix and limiter shadow
   14-Dec-2010 made to work with monochrome files (not True Color)
   Written by Bill Davis, 12-Apr-2010

CINE_SNUM

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       cine_snum
 PURPOSE:
       Return camera serial number from a .cin file from a Phantom camera.
 CATEGORY:
       Image Processing
 CALLING SEQUENCE:
       IDL> serialNumber = cine_snum( filename )
 INPUTS:
 KEYWORD PARAMETERS:
   INPUT:
   	filename - a .cin file
   OUTPUT:
	serialNumber - serial number of camera
 EXAMPLE:
	IDL> print, cine_snum('/p/nstxcam/Miro2-7988/2010/nstx_2_137839.cin')

 MODIFICATION HISTORY:
   Written May-2010 by Bill Davis
           from program written by Ricky Maqueda.

CINE_TIME

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       cine_time
 PURPOSE:
       Read time from a .cin file from a Phantom 7 camera.
 CATEGORY:
       Image Processing
 CALLING SEQUENCE:
       IDL> cine_time, filename, times[, frames, xsize=xsize, ysize=ysize]
 INPUTS:
 KEYWORD PARAMETERS:
   INPUT:
   	filename - a .cin file
	positive - if set, will not return negative image numbers
   OUTPUT:
	times - array of times in seconds of frames
   	frames - array of frame numbers
	firstImage - first image number
	imageSize - image size in bytes
	xsize - horizontal size of an image
	ysize - vertical size of an image
	serialNum - serial number of camera
	warning - if set to 0, will not pop dialog up for messages
 EXAMPLE:
	IDL> cine_time,'/p/camdata/dust/nstx121048.cin', time

 NOTES:
 MODIFICATION HISTORY:
   04-Mar-2014 keyword POSITIVE to correct for negative frame numbers
   16-Jan-2014 fixed exposure output
   19-Aug-2012 fixed dt being 2usec, 3usec, 2usec, etc. for Phantoms with 400,000 rate
   16-Aug-2010 added warning keyword, so doesn't pop dialog box on wall if error
   22-Jun-2010 don't make image UINT if only 8 bits
   05-May-2010 added keyword serialNum
   02-Apr-2010 flip Miro files if gt 137000, according to Lane
   01-Jul-2009 merged "memory feature" of cineload.pro with this
   17-Jul-2008 return FirstImage (first frame)
   17-Jun-2008 check for existence of file 
   27-Apr-2007 commented out time-correction code which was giving -NaN for
		$NSTXUSR/phantom4/flipped_123648.cin (exposure time was changed)
   Written by Bill Davis, for Lane Roquemore, 31-May-2006
           from program written by Ricky Maqueda.

CLEANPLOT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:
       CLEANPLOT
 PURPOSE:
       Reset all system variables (!P,!X,!Y,!Z) to their default values
 CATEGORY:             
	Plotting
 EXPLANATION:
       Reset all system variables (!P,!X,!Y,!Z) which are set by the user 
       and which affect plotting to their default values.

 CALLING SEQUENCE:
       Cleanplot

 INPUTS:       
       None

 OUTPUTS:      
       None

 SIDE EFFECTS: 
       The system variables that concern plotting are reset
       to their default values.  A message is output for each
       variable changed.   The CRANGE, S, WINDOW, and REGION fields of the
       !X, !Y, and !Z system variables are not checked since these are 
       set by the graphics device and not by the user.    

 PROCEDURE:
       This does NOT reset the plotting device.
       This does not change any system variables that don't control plotting.

 RESTRICTIONS:
       If user default values for !P, !X, !Y and !Z are different from
       the defaults adopted below, user should change P_old etc accordingly

 MODIFICATION HISTORY:
       Written IDL Version 2.3.0  W. Landsman & K. Venkatakrishna May '92
       Handle new system variables in V3.0.0     W. Landsman   Dec 92
       Assume user has at least V3.0.0           W. Landsman   August 95
       V5.0 has 60 instead of 30 TICKV values    W. Landsman   Sep. 97
       Change !D.N_COLORS to !D.TABLE_SIZE for 24 bit displays
               W. Landsman  April 1998

CLEARPLT

[Previous Routine] [Next Routine] [List of Routines]

 NAME:                 
	CLEARPLT

 PURPOSE:              
	This procedure will clear or zero all or a selection
       of the system plot variables

 CATEGORY:             
	Plotting

 CALLING SEQUENCE:     
			clearplt,/all           ;clear the !p, !x, !y, !z
                       clearplt,/x,/z          ;clear the !x and !z variables
                       clearplt,/x             ;only clear the !x variable
                       clearplt,/x,/invert     ;clear all except the !x

 INPUTS:
       KEYWORDS:
               x,y,z,p = clear the appropriate variable
               all     = clear all, this is equivalent to /x,/y,/z,/p
               invert  = invert the logic. Clear all unselected variables.
                         Therefore "clearplt,/all,/invert" does nothing.

 OUTPUTS:      none

 COMMON BLOCKS:
       none.
 SIDE EFFECTS:
               The sytem plot variables are changed.

 MODIFICATION HISTORY:
	20-Apr-99 [BD] more things cleared for !P
       Written by: Trevor Harris, Physics Dept., University of Adelaide,
               July, 1990.

COLORBAR

[Previous Routine] [Next Routine] [List of Routines]

NAME:
COLORBAR

PURPOSE:

The purpose of this routine is to add a color bar to the current
graphics window.

AUTHOR:

FANNING SOFTWARE CONSULTING
David Fanning, Ph.D.
1645 Sheely Drive
Fort Collins, CO 80526 USA
Phone: 970-221-0438
E-mail: davidf@dfanning.com
Coyote's Guide to IDL Programming: http://www.dfanning.com/

CATEGORY:

Graphics, Widgets.

CALLING SEQUENCE:

COLORBAR

INPUTS:

None.

KEYWORD PARAMETERS:

ANNOTATECOLOR: The name of the "annotation color" to use. The names are those for
FSC_COLOR, and using the keyword implies that FSC_COLOR is also in
your !PATH. If this keyword is used, the annotation color is loaded
*after* the color bar is displayed. The color will be represented
as theColor = FSC_COLOR(ANNOTATECOLOR, COLOR). This keyword is provide
to maintain backward compatibility, but also to solve the problem of
and extra line in the color bar when this kind of syntax is used in
conjunction with the indexed (DEVICE, DECOMPOSED=0) model is used:

LoadCT, 33
TVImage, image
Colorbar, Color=FSC_Color('firebrick')

The proper syntax for device-independent color is like this:

LoadCT, 33
TVImage, image
Colorbar, AnnotateColor='firebrick', Color=255

BOTTOM: The lowest color index of the colors to be loaded in
the bar.

CHARSIZE: The character size of the color bar annotations. Default is !P.Charsize.

COLOR: The color index of the bar outline and characters. Default
is !P.Color..

DIVISIONS: The number of divisions to divide the bar into. There will
be (divisions + 1) annotations. The default is 6.

FONT: Sets the font of the annotation. Hershey: -1, Hardware:0, True-Type: 1.

FORMAT: The format of the bar annotations. Default is '(I0)'.

INVERTCOLORS: Setting this keyword inverts the colors in the color bar.

MAXRANGE: The maximum data value for the bar annotation. Default is
NCOLORS.

MINRANGE: The minimum data value for the bar annotation. Default is 0.

MINOR: The number of minor tick divisions. Default is 2.

NCOLORS: This is the number of colors in the color bar.

NODISPLAY: COLORBAR uses FSC_COLOR to specify some of it colors. Normally,
FSC_COLOR loads "system" colors as part of its palette of colors.
In order to do so, it has to create an IDL widget, which in turn
has to make a connection to the windowing system. If your program
is being run without a window connection, then this program will
fail. If you can live without the system colors (and most people
don't even know they are there, to tell you the truth), then setting
this keyword will keep them from being loaded, and you can run
COLORBAR without a display.

POSITION: A four-element array of normalized coordinates in the same
form as the POSITION keyword on a plot. Default is
[0.88, 0.10, 0.95, 0.90] for a vertical bar and
[0.10, 0.88, 0.90, 0.95] for a horizontal bar.

RANGE: A two-element vector of the form [min, max]. Provides an
alternative way of setting the MINRANGE and MAXRANGE keywords.

REVERSE: Setting this keyword reverses the colors in the colorbar.

RIGHT: This puts the labels on the right-hand side of a vertical
color bar. It applies only to vertical color bars.

TICKNAMES: A string array of names or values for the tick marks.

TITLE: This is title for the color bar. The default is to have
no title.

TOP: This puts the labels on top of the bar rather than under it.
The keyword only applies if a horizontal color bar is rendered.

VERTICAL: Setting this keyword give a vertical color bar. The default
is a horizontal color bar.
MATCH: If set will match color bar to extent of plot.

COMMON BLOCKS:

None.

SIDE EFFECTS:

Color bar is drawn in the current graphics window.

RESTRICTIONS:

The number of colors available on the graphics display device (not the
PostScript device) is used unless the NCOLORS keyword is used.

Requires the FSC_COLOR program from the Coyote Library:

http://www.dfanning.com/programs/fsc_color.pro

EXAMPLES:

To display a horizontal color bar above a contour plot, type:

LOADCT, 5, NCOLORS=100
CONTOUR, DIST(31,41), POSITION=[0.15, 0.15, 0.95, 0.75], $
C_COLORS=INDGEN(25)*4, NLEVELS=25
COLORBAR, NCOLORS=100, POSITION=[0.15, 0.8, 0.95, 0.90]

To display a vertical color bar in the lower right of a contour plot, type:

IDL> device, decompose=0
IDL> loadct, 3
IDL> contour, dist(100), /fill, nlevels=100, zstyle=1
IDL> colorbar, pos=[.92,.1,.95,.4], /vert, title='Kev'

MODIFICATION HISTORY:

Written by: David W. Fanning, 10 JUNE 96.
10/27/96: Added the ability to send output to PostScript. DWF
11/4/96: Substantially rewritten to go to screen or PostScript
file without having to know much about the PostScript device
or even what the current graphics device is. DWF
1/27/97: Added the RIGHT and TOP keywords. Also modified the
way the TITLE keyword works. DWF
7/15/97: Fixed a problem some machines have with plots that have
no valid data range in them. DWF
12/5/98: Fixed a problem in how the colorbar image is created that
seemed to tickle a bug in some versions of IDL. DWF.
1/12/99: Fixed a problem caused by RSI fixing a bug in IDL 5.2. Sigh... DWF.
3/30/99: Modified a few of the defaults. DWF.
3/30/99: Used NORMAL rather than DEVICE coords for positioning bar. DWF.
3/30/99: Added the RANGE keyword. DWF.
3/30/99: Added FONT keyword. DWF
5/6/99: Many modifications to defaults. DWF.
5/6/99: Removed PSCOLOR keyword. DWF.
5/6/99: Improved error handling on position coordinates. DWF.
5/6/99. Added MINOR keyword. DWF.
5/6/99: Set Device, Decomposed=0 if necessary. DWF.
2/9/99: Fixed a problem caused by setting BOTTOM keyword, but not NCOLORS. DWF.
8/17/99. Fixed a problem with ambiguous MIN and MINOR keywords. DWF
8/25/99. I think I *finally* got the BOTTOM/NCOLORS thing sorted out. :-( DWF.
10/10/99. Modified the program so that current plot and map coordinates are
saved and restored after the colorbar is drawn. DWF.
3/18/00. Moved a block of code to prevent a problem with color decomposition. DWF.
4/28/00. Made !P.Font default value for FONT keyword. DWF.
9/26/00. Made the code more general for scalable pixel devices. DWF.
1/16/01. Added INVERTCOLORS keyword. DWF.
5/11/04. Added TICKNAME keyword. DWF.
9/29/05. Added REVERSE keywords, which does the *exact* same thing as
INVERTCOLORS, but I can never remember the latter keyword name. DWF.
1/2/07. Added ANNOTATECOLOR keyword. DWF.
4/14/07. Changed the default FORMAT to I0. DWF.
5/1/07. Unexpected consequence of default format change is colorbar annotations
no longer match contour plot levels. Changed to explicit formating of
colorbar axis labels before PLOT command. DWF.
5/25/07. Previous change has unanticipated effect on color bars using
logarithmic scaling, which is not really supported, but I have an
article on my web page describing how to do it: http://www.dfanning.com/graphics_tips/logcb.html.
Thus, I've fixed the program to accommodate log scaling, while still not OFFICIALLY
supporting it. DWF.
10/3/07. Method used to calculate TICKNAMES produces incorrect values in certain cases when
the min and max range values are integers. Now force range values to be floats. DWF.
10/17/07. Accidentaly use of INTERP keyword in CONGRID results in wrong bar values for
low NCOLORS numbers when INVERTCOLORS or REVERSE keyword is used. Removed INTERP keyword. DWF.
11/10/07. Finished fixing program to accommodate log scaling in ALL possible permutations. DWF.
8 Feb 2008. Added CRONJOB keyword and decided to use month names when I write the date. DWF.
8 Feb 2008. Renamed CRONJOB to NODISPLAY to better reflect its purpose. DWF.
21 May 2008. Changed the default CHARSIZE to !P.CHARSIZE from 1.0. DWF.
30 Oct 2008. Fixed a problem with the FONT keyword not being recognized in certain
configurations.
13-Dec-2010 Default range to !Z.CRANGE (set when contour was last called) [BD]
19-Jul-2011 Added Match keyword to make vertical colorbar match in height to plot
window. Also, default to having number on outside of colorbar when
vertical and on the right. [BD]
23-Sep-2013 show every other tic value when numbers large [BD]

COLORBARBD

[Previous Routine] [Next Routine] [List of Routines]

NAME:
COLORBARbd

PURPOSE:

The purpose of this routine is to add a color bar to the current
graphics window. (this is a mod by BD to handle veritcal plot ticknames better)