The Dadisp™ Worksheet Function Reference Manual
Total Page:16
File Type:pdf, Size:1020Kb
The DADiSP™ Worksheet Data Analysis and Display Software Function Reference Manual July, 2003 Copyright © 2003 DSP Development Corporation ii The DADiSP Licensing Agreement It is important to read and understand the DADiSP Licensee Agreement prior to opening the disk envelope. By opening this envelope, you indicate your acceptance of the following terms and conditions: • The Licensee has non-exclusive rights for use of the supplied software. • The supplied programs may not be copied except as described by the Installation Procedure listed in Chapter 1 of the DADiSP Worksheet Manual. • The Licensee may not disclose or resell any part of the program or documentation to unlicensed parties. Disclaimer of Warranties and Liability The information contained in this document is believed to be reliable and accurate. However, DSP Development Corporation assumes no responsibility whatsoever for errors, omissions, or inaccuracies. DSP DEVELOPMENT CORPORATION DISCLAIMS ANY AND ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING THE WARRANTY OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE INFORMATION CONTAINED IN THIS MANUAL AND THE SOFTWARE DESCRIBED THEREIN. The buyer or user assumes all risks as to the quality and performance of this product. DSP development shall not be liable for any damages, including special or consequential damages arising out of the use of such information and software even if DSP Development Corporation has been notified in advance of the possibility of such damage. About This Manual This manual contains detailed descriptions of each command and function available at the Worksheet level. Once you have read The DADiSP Worksheet User Manual and are familiar with the DADiSP environment, you should rely on this manual for most of your day-to-day work. The listing of Worksheet functions, which appears starting on the next page, is organized by the type of operation that each function or command performs. The main body of the manual consists of an alphabetical listing of function definitions. iii iv DADiSP Worksheet Function Categories 3D and 4D Graphics CONTOUR Display matrix as a contour plot CONTOURSET Specify display attributes of contour plot DENSITY Display matrix as a density plot GETPALETTE Return a series of the color indices used in palette HATCHCOLOR Set the color of 3D cross-hatching IGRID Grid XYZ data using the inverse distance method MAPPALETTE Set color palette for density plot MOUSEROTATE Rotate a 3-D plot with the mouse PLOT3D Plot table in true 3-D perspective ROTATE3D Rotate a 3-D plot SETPALETTE Define ordered list of shading colors SETPLOTMETHOD Set plotting method SETSHADING Select the range of shading colors SETXPAL Set RGB value for color index SGRID Grid XYZ data using spline interpolation SHADEWITH Shade 3-D objects with another object SPIN Spin a 3D plot WATERFALL Display table as a 3-D waterfall plot WFSET Change attributes of waterfall plot XYZ Create a 3D XYZ plot ActiveX CREATEOBJECT Return a handle to an ActiveX server object GETOBJECT Return a handle to a running ActiveX server object MSWORD Write a string to MS Word using ActiveX MSWORD2 Insert a metafile of a Worksheet into MS Word using ActiveX RELEASE Release an ActiveX server object WS2HTML Convert Worksheet to HTML using MS Word and ActiveX XLCLEAR Clear ActiveX connection to Excel XLGET Return a range of values from Excel via ActiveX Automation XLINIT Start an ActiveX connection to Excel XLPUT Transfer a range of values to Excel via ActiveX Automation v Annotation COMMENT Set comment for the first series in a window DFLOOD Change the color of the area containing specified points DLNABS Draw a line at specified coordinates DPTABS Draw a point at specified coordinates LABEL Label the window with text LEGCUR Insert a legend for all the series in a window LEGEND Set the attributes and location for a standard legend LINEANN Annotate graph with lines at specified coordinates LINECOPY Copy line annotation LINECUR Freehand line drawing cursor in window LINEDEL Delete line annotation LINEDRAW Draw a polyline between specified coordinates. LINEMOVE Move line annotation NFORMAT Format a list of numbers SETCOMMENT Set the comment for any window, overlays and overplots SFORMAT Format a list of strings TEXT Draw a left-justified block of text at a given point TEXTANN Annotate graph with text at specified coordinates TEXTCUR Freehand text annotation cursor in window TEXTDEL Delete text annotation TEXTEDIT Edit text annotation TEXTMOVE Move text annotation Binary Series && || ! Logical Operators < <= > >= == != Conditional operators AND && Logical AND DELETE Eliminate points based on condition EQUAL Determine if two expressions are equal FLIPFLOP Combine binary series inputs GREATER Determine if one expression is greater than another GREATEREQUAL Determine if one expression is greater than or equal to another ISNAN Return 1 for each element that is a NA value LESSER Determine if one expression is less than another LESSEREQUAL Determine if one expression is less than or equal to another NOT ! Logical NOT NOTEQUAL Determine if two expressions are not equal OR || Logical OR REPLACE Replace values in a series based on a logical condition XOR Logical XOR vi Colors COLORBAR Display the current colormap COOL Generate a colormap of shades of blue COPPER Generate a copper colormap DFLOOD Change the color of the area containing specified points GETCOLORMAP Return the colormap for density and shaded plots GETCRANGE Get color shading range GETGCOLOR Get global color parameter GETGRIDCOLOR Get color of the grids GETPALETTE Return a series of the color indices used in palette GETRBG Return the separate RGB components of an image GRAY Generate a black & white colormap GRIDCOLOR Set grid color HATCHCOLOR Set the color of 3D cross-hatching HOT Generate a colormap of black, red, yellow, white MAPPALETTE Sets color palette for density plot RAINBOW Generate a colormap of the visible color spectrum RESETMAP Reset the colormaps of all Windows containing an image SAVECMAP Save and automatically restores the Worksheet colormap SERCOLOR Specify series color only SETCOLOR Set series color SETCOLORMAP Set the colormap for density and shaded plots SETCRANGE Set color shading to a specific range SETGCOLOR Set global color parameter SETPALETTE Define ordered list of shading colors SETPMAP Convert palette color to colormap values SETSHADING Select the range of shading colors SETXPAL Set RGB value for color index SHOWCMAP Display the current colormap as a density plot STRCOLOR Return the Color Name for specified Color Index WINCOLOR Specify background window and series color Complex Conversions ANGLE Extract Angular portion CARTESIAN Convert to Cartesian CONJUGATE Generate Complex Conjugate IMAGINARY Calculate real component of imaginary series MAGNITUDE Return magnitude component of series MAKECARTESIAN Combine two input expressions into complex Cartesian (Real/Imaginary) form vii MAKEPOLAR Combine two input expressions into complex Polar (Magnitude/Phase) form PHASE Calculate the phase angle of a Complex expression POLAR Convert to Polar REAL Extract Real part Control Flow BREAK Terminate the immediately enclosing FOR or WHILE loop CONTINUE Terminate the execution of statements in a FOR or WHILE loop FOR Provide FOR-loop iterative statements GOTO Allow branching to labeled statements in SPL functions IF Evaluate if true LOOP Execute simple FOR-Loop iterative statements WAITKEY Pause execution of an SPL function WHILE Evaluate while expression is true Cursor Functions COLNMOVE Move the column cursor by a specified number of points COLNPUT Reset the column cursor position COLPOS Return the item or column number of the last cursor position CURMOVE Move the cursor position by a specified offset in x-axis units CURNMOVE Move the cursor position by a specified number of points CURNPUT Reset the cursor position CURPOS Return last position of point cursor CURPOS2 Return position of second cursor CURPUT Reset the cursor position at the specified x-axis location CURSORON Turn cross hair cursors on ITEMNPUT Reset the item cursor position ITEMPOS Return the item number of the last position of the crosshair cursor MAGNIFY Enable the cursor to select a region in a window to magnify MOVE Move cursor by time NMOVE Move cursor n points NPUT Move cursor to nth point PUT Put cursor on time in series viii Curve Fitting EXPFIT Fit y(x) = A * exp(B*x) using linearization INTERP2 Perform two-dimensional linear interpolation LFIT Fit a line to a series using the end points LINREG Fit a line to series LINREG2 Regress two series LSINFIT Least Squares method for fitting sine curves of known frequency PFIT Least Squares Polynomial fitting with error statistics POLYFIT Return polynomial coefficients POLYGRAPH Graph polynomial fit POWFIT Fit y(x) = A * x^B using linearization SINFIT Fit y(x) = A + B * sin(C*x + D) using the FFT SINTREND Fit y(x) = A + B*x + C * sin(D*x + E) using the FFT SPLINE Cubic spline interpretation SPLINE2 Perform two-dimensional cubic spline fitting Data Input/Output Functions EXPORTFILE Export a DADiSP series to a data file EXPORTWORKSHEET Save the current Worksheet to an external Worksheet file (.dwk) IMPORTFILE Import a data file IMPORTWORKSHEET Load an external Worksheet file (.dwk) INPORT Retrieve 1, 2, or 4 bytes from a port MULTIREADB Read a multi-channel Binary data file into a Worksheet OUTPORT Output 1, 2, or 4 bytes to a port READA Read an ASCII file into a Worksheet READB Read a Binary data file into a Worksheet READBMP Read a Microsoft