GAUSSplotTM Professional Graphics

Aptech Systems, Inc. — Mathematical and Statistical System Information in this document is subject to change without notice and does not represent a commitment on the part of Aptech Systems, Inc. The software described in this document is furnished under a license agreement or nondisclosure agreement. The software may be used or copied only in accordance with the terms of the agreement. The purchaser may make one copy of the software for backup purposes. No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose other than the purchaser’s personal use without the written permission of Aptech Systems, Inc.

Copyright 2005-2006 by Aptech Systems, Inc., Maple Valley, WA. All Rights Reserved.

ENCSA Hierarchical Data Format (HDF) Software Library and Utilities Copyright (C) 1988-1998 The Board of Trustees of the University of Illinois. All rights reserved. Contributors include National Center for Supercomputing Applications (NCSA) at the University of Illinois, Fortner Software (Windows and Mac), Unidata Program Center (netCDF), The Independent JPEG Group (JPEG), Jean-loup Gailly and Mark Adler (gzip). Bmptopnm, Copyright (C) 1992 David W. Sanderson. Dlcompat Copyright (C) 2002 Jorge Acereda, additions and modifications by Peter O’Gorman. Ppmtopict Copyright (C) 1990 Ken Yap.

GAUSSplot, GAUSS and GAUSS Engine are trademarks of Aptech Systems, Inc.

Tecplot RS, Tecplot, Preplot, Framer and Amtec are registered trademarks or trade- marks of Amtec Engineering, Inc.

Encapsulated PostScript, FrameMaker, PageMaker, PostScript, Premier–Adobe Sys- tems, Incorporated. Ghostscript–Aladdin Enterprises. Linotronic, Helvetica, Times– Allied Corporation. LaserWriter, Mac OS X–Apple Computers, Incorporated. Au- toCAD, DXF–Autodesk, Incorporated. Chears–ChevronTexaco Corporation. Com- Computer Corporation. Elan License Manager is a trademark of Elan Computer Group, Incorporated. Alpha, DEC, Digital, LaserJet, HP-GL, HP-GL/2, PaintJet– Hewlett-Packard Company. X-Designer–Imperial Software Technology. Builder Xcessory– Integrated Computer Solutions, Incorporated. IBM, RS6000, PC/DOS–International Business Machines Corporation. Bookman–ITC Corporation. VIP–Landmark Graph- ics Corporation. X Windows–Massachusetts Institute of Technology. MGI VideoWave– MGI Software Corporation. ActiveX, Excel, MS-DOS, , Visual Basic, Vi- sual C++, Visual J++, Visual Studio, Windows, Windows Metafile–Microsoft Cor- poration. HDF, NCSA–National Center for Supercomputing Applications. , OPEN LOOK–Novell, Incorporated. Motif–Open Software Foundation, Incorporated. Gridgen–Pointwise, Incorporated. Eclipse, FrontSim–Schlumberger, Limited. IRIS, IRIX, OpenGL–Silicon Graphics, Incorporated. Open Windows, Solaris, Sun, –Sun MicroSystems, Incorporated. All other product names mentioned herein are trademarks or registered trademarks of their respective owners.

Part Number: 005712 Version 8.0 Documentation Revision: 860 July 20, 2007

Contents

Contents

1 Overview

1.1 Getting Started ...... 1-3 1.1.1 Setup and Initialization ...... 1-3 1.1.2 Creating Data ...... 1-4 1.1.3 Setting Plot Options ...... 1-5 1.1.4 Plotting the Graph ...... 1-6 1.2 What Next ...... 1-7 1.2.1 Customizing Your Graph ...... 1-7 1.2.2 GP Tools ...... 1-8 1.3 Data Files ...... 1-8 1.3.1 Structure of a Data ...... 1-8 1.3.2 Data File Creation Commands ...... 1-9 1.3.3 Inputting Data ...... 1-11 1.4 Basic Structure of a Graph ...... 1-18 1.4.1 Workspace ...... 1-18 1.4.2 Frame ...... 1-18 1.5 Plot Types ...... 1-19 1.5.1 Basic Plot Types ...... 1-19 1.5.2 Line Plots ...... 1-19 1.5.3 Field Plots ...... 1-19 1.5.4 GAUSSplot Plot Types ...... 1-22 1.6 Categorization of Commands ...... 1-31 1.7 Working With Structure Pointers ...... 1-33 1.8 Structure Files ...... 1-34 1.9 Error Handling ...... 1-35 1.10 Examples ...... 1-35 1.10.1 Line Plots ...... 1-35 1.10.2 Field Plots ...... 1-41 1.10.3 Graphs Containing Different Plot Types ...... 1-44

v GAUSSplot 8.0

2 Command Overview

2.1 Commands ...... 2-1 2.1.1 Setup and Initialization ...... 2-1 2.1.2 Creating Data Files ...... 2-2 2.1.3 Specifying Data and Macro Files ...... 2-3 2.1.4 Adding Frames to a Graph ...... 2-3 2.1.5 Setting Line Map Options ...... 2-4 2.1.6 Setting Field Zone Options ...... 2-9 2.1.7 Setting Axes Options ...... 2-15 2.1.8 Sizing and Positioning the Graph ...... 2-23 2.1.9 Animation ...... 2-24 2.1.10 Setting Frame Options ...... 2-24 2.1.11 Adding Text ...... 2-25 2.1.12 Adding Arrows ...... 2-26 2.1.13 Adding Line Segments ...... 2-26 2.1.14 Adding Other Geometries ...... 2-27 2.1.15 Printing and Exporting ...... 2-27 2.1.16 Plotting the Graph ...... 2-29 2.1.17 Miscellaneous Commands ...... 2-30 2.2 Global Variables ...... 2-31 2.2.1 GAUSSplot Colors ...... 2-31 2.2.2 GAUSSplot Fonts ...... 2-32 2.2.3 GAUSSplot Line Patterns ...... 2-33 2.2.4 GAUSSplot Symbols ...... 2-33 2.2.5 GAUSSplot Error Messages ...... 2-34 2.2.6 GAUSSplot Debugging ...... 2-35

3 Command Reference

A Character Table

vi Contents

B Obsoleted Commands

Index

vii

Overview 1-1 1 erent types of plots. ff Overview is generated by these lines of code: 1.1 ’s ease of use, let us begin by demonstrating how to create a simple XY is simple enough to allow users to create a graph with only a few lines of code, yet GAUSSplot // Set uplibrary library gaussplot; and#include include gp.sdf file with structure definitions // Create gpPlotControl// structure values andstruct set gpPlotControl members gp; togp default = gpXYLinePlotCreate; // Generate data x = seqa(0.2,.2,15); Line plot. The graph in Figure To illustrate GAUSSplot Users can add text, legends, arrowsoutput and and symbols view to options. a graph, as well as configure a wide variety of flexible enough to allow for the creation of elaborate graphs incorporating di GAUSSplot 8.0

Frame 001  12 Sep 2006  gp06ac010F52F84506e17c0030d

-0.4

-0.6

-0.8 V2

-1

-1.2

0.5 1 1.5 2 2.5 3 V1

Figure 1.1: Simple XY Plot

1-2 Overview 1-3 Overview , with the GAUSSplot , which can be found in the : installation directory. For more examples, subdirectory. xylineplot1.e GAUSS GAUSSplot gaussplot/examples subdirectory of your or your Setup and initialization Creating data and writing the data file Setting various plot options Plotting the graph library gaussplot; #include gp.sdf struct gpPlotControl gp; y = log(x/5); // Write dataret to = data gpMakeXYLinePlot(&gp,x,y,""); file and create graph 1.10 1. 2. 3. 4. These must all be present in any program that creates a graph using This example is a slightly simplified version of The setup and initialization process must include the following calls: There are four steps to creating a graph with 1.1.1 Setup and Initialization gaussplot/examples see Section 1.1 Getting Started exception of the second step if the necessary data file already exists. GAUSSplot 8.0

as well as a call to the appropriate gpPlotTypePlotCreate command for the type of graph that is to be created. For instance, if you wanted to create a 3D Cartesian graph, you would add the following line to the above:

gp = gp3DCartesianPlotCreate;

See Section 1.5.4 for a list of all of the plot types that are supported in GAUSSplot and Section 2.1.1 for the available gpPlotTypePlotCreate commands.

1.1.2 Creating Data

If the necessary data file does not already exist, then the next step is to create data. If you are going to use gpPlot to plot the graph (see Section 1.1.4), then you must also write the data file at this point in your program. However, if you use one of the gpMakePlotTypePlot commands to plot the graph, then it will write the data to a data file for you, and you need only to generate that data.

The following code creates data for a data file with one zone, containing three variables, and writes the data file:

struct gpData gdat;

// Generate data for 3D Cartesian frame a = seqa(0,pi/12,25)’; r = seqa(6,-0.25,25); x = r.*cos(a); y = r.*sin(a); z = rev(1.5*r).*ones(25,25);

// Put data into an array a = aconcat(x,y,3); a = aconcat(a,z,3);

// List variable names string vnames = { "X", "Y", "Z" };

1-4 Overview for in 1-5 Overview gpPlot gpSetAxisMap with a frame number to initialize your plot before calling . command to add additional 1.3 for line plots or with a frame number of 2. commands to initialize your plot gpSetLineMaps . Most of these commands are optional. gpPlotCreate Frame gpSetDataFile 1.5.4 PlotType PlotCreate gpAdd gpSetLineMapZone gpSetLineMapZone or commands to add frames before plotting the graph. PlotType or commands. Therefore, you may add additional frames gp program that you need to add frames for a multiple frame graph Frame PlotType PlotCreate GAUSSplot gpSetLineMaps gpSetLineMaps for an explanation of frames). If you use gpAdd PlotType contains many plot option commands, which allow you to specify the number of line will use defaults for all options that have not been explicitly set. However, if you use 1.4 // Set datagdat in = gpData gpInitPlotData(vnames); ret structure = gpAddZone(&gdat,"Zone One",a); // Write dataret file = gpWritePlotData(&gdat,"mydata.plt"); gp to plot your graph, then it is necessary to call It is at this stage in a order to specify which data file(s) are to be used for the graph. (see Section Following the above code, we mightplot call with the one following frame, commands containing to one configure field our zone: 3D Cartesian GAUSSplot maps or field zones thatexplanation are of displayed line in maps a and plot field and zones, how see they are Section to be displayed. For an 1.1.3 Setting Plot Options GAUSSplot field plots with a frameshould number be argument that added is in higher order.of than For 3 example, one. you before Frames should calling added not in call this manner gpPlot implicitly by calling For an explanation of zones and data file structure, see Section control structure, then your graphuse does the not various contain any frames by default. Therefore, youAlternatively, need if to you use one ofcontrol the structure, then your graph(though contains allowable) one to frame use by the default. appropriate frames In because this the case, plot it type isone for not of all necessary the frames in the graph has already been determined by the call to GAUSSplot 8.0

framenum = 1; fieldzonenum = 1; activate = 1; = 70; xpos = 41; ypos = 91; positionunit = 1;

// Specify the data file to use ret = gpSetDataFile(&gp,framenum,"mydata.plt");

// Activate the shade layer and set the shade color ret = gpShowShadeLayer(&gp,framenum,activate); ret = gpSetShadeColor(&gp,framenum,fieldzonenum,"red");

// Activate the transparency effect and set the percentage of // transparency ret = gpUseTransparencyEffect(&gp,framenum,activate); ret = gpSetTransparency(&gp,framenum,fieldzonenum,transparency);

// Make the axes sized independently of one another ret = gpMakeAxesIndependent(&gp,framenum);

// Add text for a title ret = gpAddTextObject(&gp,framenum,"text1",xpos,ypos, positionunit,"3D Surface Plot");

1.1.4 Plotting the Graph

Once all of the desired plot options have been set, you may plot the graph:

ret = gpPlot(&gp);

For simple graphs with only one frame, containing one or more line maps or one field zone, you may use the appropriate gpMakePlotTypePlot command to write the data to a data file and plot

1-6 Overview 1-7 Overview in your “Record” from → GUI buttons and structure and write it ) to point you to the 2 and are ready to try a gpSetMacroFile to create the graph. GAUSSplot (Chapter . gpPlotControl . GAUSSplot  program (use O GAUSSplot GAUSS ‘File’ menu. The layout file may then be re-opened  gpOpenLayoutFile GAUSSplot program in graphical user interface (GUI), select “Macro” GAUSSplot program to ensure this). chapter, then complete the following steps to finish customizing your for details on using these commands. GAUSSplot 3 macro file, which is then run in erent data by a call to GAUSSplot ff  O the ‘File’ menu. GAUSSplot menu options. Select the “Stop Recording” button onselect the “OK” ‘Macro when Record’ you dialog are box, asked if and you then are sure that you want to stop recording. In the ‘Write Macro File’file dialog that box, you choose are a creating. filefile name Be that and sure is location that created for you by the are your macro not using the same name as the macro Make any desired changes to your graph using the Run your In the 5. 3. 4. 1. 2. GAUSSplot  commands that you need to customizein various the options. C If yougraph: cannot find what you are looking for the graph. See Chapter The graph plotting commands takeout the to information a in the After the graph has beenselecting plotted, ‘Save the Layout’ information from for the thewith graph the may same be or saved as di a layout file by Once you have learned how to create basic graphs using 1.2.1 Customizing Your Graph 1.2 What Next complex, highly customized graph, see the C GAUSSplot 8.0

6. Now go back to your GAUSSplot program and call gpAddMacroFile with the name of your newly created macro file right before the call to plot the graph. Then when you run your program again, the changes that you made with the GUI will be be done for you automatically.

See the T R U’ M in the file tpum. for more information on using the graphical user interface.

1.2.2 GP Tools

GP TOOLS is a free package containing additional procedures that may be used with GAUSSplot. The package includes quick and dirty procedures for producing simple graphs as well as procedures that make use of GAUSSplot’s graphing capabilities in specific applications.

GP TOOLS may be downloaded from the gptools directory on Aptech’s ftp site. The directory contains a .zip file for use on Windows, a .tar.gz file for use on UNIX and Linux and a .pdf with installation instructions and documentation for each of the procedures in the package.

1.3 Data Files

1.3.1 Structure of a Data File

A GAUSSplot graph is created from data in a GAUSSplot format binary data file, which is indicated by a .plt extension. A .plt data file is organized into zones (blocks of data). The number of variables and the variable names are set once at the top of the data file and apply to each zone in the file. Thus, if a .plt data file contains three variables (X, Y, and Z), each zone in the file must contain three variables named X, Y, and Z.

Within a zone, each variable must be the same size (i.e., each variable must contain the same number of rows and the same number of columns). However, the number of elements contained in a variable may vary from zone to zone. For example, the following describes a valid data file format:

1-8 Overview 1-9 Overview gpData gpData structure for a data variables that are each K gpData structure using user-specified data files. These routines allow you to .plt gpData Zone 3 Zone 1 Zone 2 Z 15 15 Z 100 50 Z 50 30 XY 15 15 15 15 XY 100 100 50 50 XY 50 50 30 30 data file using the data contained in a Variable Rows Cols Variable Rows Cols Variable Rows Cols .plt structure, add data to it, and write the data contained in the structure 1. × file that will contain onlyN one zone with Creates and initializes a variable names. Adds all of the variables forstructure. one zone of theCreates, data initializes, file and to adds the data to a Writes a structure. gpData contains a set of routines for creating file: .plt gpWritePlotData gpAddZone gpSetPlotData gpInitPlotData GAUSSplot 1.3.2 Data File Creation Commands create and initialize a to a GAUSSplot 8.0

The following example illustrates how you may use the data file creation commands to create a data file with two zones, containing three 2-dimensional variables;

library gaussplot; #include gp.sdf

// Generate data l = 20; pil = pi/(l-1); x = seqa(-10,2.5,l)’*pil; y = seqa(-10,2.5,l)*pil;

// Create 3 variables that are 20x20 for zone 1 xz1 = x.*ones(l,l); yz1 = y.*ones(l,l); zz1 = sin(x).*cos(x-y);

// Create 3 variables that are 11x6 for zone 2 xz2 = xz1[5:15,5:10]; yz2 = yz1[5:15,5:10]; zz2 = cos(xz1)-sin(yz1)+1;

// Copy the data for zone 1 into a 3x20x20 array az1 = aconcat(xz1,yz1,3); az1 = aconcat(az1,zz1,3);

// Copy the data for zone 2 into a 3x11x6 array az2 = aconcat(xz2,yz2,3); az2 = aconcat(az2,zz2,3);

// Initialize gpData structure, add data, and write data file struct gpData gdat; string vnames = { "X", "Y", "Z" }; gdat = gpInitPlotData(vnames); ret = gpAddZone(&gdat,"Zone 1",az1); ret = gpAddZone(&gdat,"Zone 2",az2); ret = gpWritePlotData(&gdat,"mydata.plt");

1-10 Overview 1-11 K × Overview 1. For example, 1])). × , 1 + and could be represented i may be either an N [ y , must be used to add the data to 1.2 1] , 1 1]) with the points immediately + , i i [ [ y gpAddZone x , gpAddZone 1] , i [ x 1]) and ( , 1 − i [ y , 1] , 1 ) would be laid out as in Figure y − 1) array containing K variables that are N , i × x [ to add data stored in vectors or matrices to a data structure for Bar, x N × inputs the data as a matrix or an array. variables for a line plot as follows: y and x gpAddZone gpSetPlotData // Create gpDatastruct structure gpData gdat; // Create datax - = 2 ones(8,1); y variables = that seqa(8,-1,8); arestring 8x1 vnames = { "X",// "Y" Set }; datagdat in = gpData gpInitPlotData(vnames); ret structure = gpAddZone(&gdat,"Zone 1",x˜y); // Write dataret file = gpWritePlotData(&gdat,"lineplot.plt"); by a series of line segments connecting each point ( For Bar, XY Line and Polar Line plots, the data input into Data for Bar, XY Line and Polar Line Plots The resulting set of data points ( a data structure. matrix or a 3-dimensional (K suppose you created XY Line, and Polar Line plots. For all other plot types, You may use 1.3.3 Inputting Data preceding and following (i.e., ( GAUSSplot 8.0

(x[1,1],y[1,1])

(x[2,1],y[2,1])

(x[3,1],y[3,1])

(x[4,1],y[4,1])

(x[5,1],y[5,1])

(x[6,1],y[6,1])

(x[7,1],y[7,1])

(x[8,1],y[8,1])

Figure 1.2: Line Plot Point Arrangement

1-12 Overview 1-13 1])). + j , i Overview [ , by a series y should be a , 1.3 1] = + a j may be either a , i [ x gpAddZone , where 1.3 ]), and ( j P. To illustrate this, suppose you for a 2D Cartesian plot: gpAddZone , × y 1 + i and [ y x , ] j , 1 ]) with its neighboring points (i.e., j + , i i [ [ x y 4 variables , ] × j , i 1]), ( [ x − j , i [ ) would be laid out as in Figure y y , , x 1] − j , i P) array containing K 3-dimensional variables (to plot a volume). [ x × P) array containing K variables that are N P) array containing K 2-dimensional variables (to plot a surface) or a N × × × ]), ( j N N L , . The set of data points can be represented, as is shown in Figure × × × 1 ) 3 − , i y [ // Create gpDatastruct structure gpData gdat; // Create datax - = 2 seqa(1,1,4)’.*ones(4,1); y variables = that seqa(4,-1,4).*ones(1,4); are 4x4 // Copy thea data = into aconcat(x,y,3); string an vnames array = that { is "X", 2x4x4 // "Y" Set }; datagdat in = gpData gpInitPlotData(vnames); ret structure = gpAddZone(&gdat,"Zone 1",a); // Write dataret file = gpWritePlotData(&gdat,"surfaceplot.plt"); , y x , ] j , 1 − i [ x aconcat( of line segments connecting each point( ( The resulting set of data points ( For 2D Cartesian and 2D Contour plots, the data array that is input into Data for 2D Cartesian and 2D Contour Plots 3-dimensional (K used the following commands to create the 4 For 3D Cartesian and 3D Contour plots, the data array input into Data for 3D Cartesian and 3D Contour Plots 3-dimensional (K 4-dimensional (K GAUSSplot 8.0

(a[1,1,1],a[2,1,1]) (a[1,1,2],a[2,1,2]) (a[1,1,3],a[2,1,3]) (a[1,1,4],a[2,1,4])

(a[1,2,1],a[2,2,1]) (a[1,2,2],a[2,2,2]) (a[1,2,3],a[2,2,3]) (a[1,2,4],a[2,2,4])

(a[1,3,1],a[2,3,1]) (a[1,3,2],a[2,3,2]) (a[1,3,3],a[2,3,3]) (a[1,3,4],a[2,3,4])

Figure 1.3: 2D Cartesian Plot Point Arrangement (a[1,4,1],a[2,4,1]) (a[1,4,2],a[2,4,2]) (a[1,4,3],a[2,4,3]) (a[1,4,4],a[2,4,4])

A 3D Cartesian plot created with 3 variables (corresponding to the X, Y and Z axes) that are N×P would be laid out just like the 2D Cartesian plot in Figure 1.3 except that each point would have X, Y and Z coordinates (i.e., each point would be defined as (x[i, j], y[i, j], z[i, j])).

For an example of a 3D Cartesian plot with 3 variables that are L×N×P, suppose you used the following commands to create the 2×3×4 variables x, y and z for a 3D Cartesian plot:

// Create gpData structure struct gpData gdat;

// Create data - 3 variables that are 2x3x4 x = seqa(1,1,4)’.*ones(3,1); x = aconcat(x,x,3); y = seqa(3,-1,3).*ones(1,4); y = aconcat(y,y,3); z = ones(3,4); z = aconcat(z,2*z,3);

1-14 Overview ])). j 1-15 , i , 1 + Overview k [ z , ] j , i , ]), and 1 concatenated in the j ]) with its neighboring j z , + 1 , and could be represented i k [ , + y k and i , [ 1.4 , ] y z j k , , [ ] , ]), x j z i j , , , , ] i 1 j 1 , , k + − [ 1 k y i [ , , + ] x k contains i j [ , , z a k i , [ , ] y j k , [ , ] x j 1 ]) and ( j , − , 1 i , where i , , + 1 k i 1.1 [ , − y k , [ k ] [ x j z , , ] 1 ) would be laid out as in Figure j z , − 1]), ( 1])) as well as with the corresponding points in its neighboring , i i y , , − + , 1 k j j x [ − , , x i i k , , [ k k y [ [ , z z ] , , j are defined in Table , 1] 1] i , − + 1.4 1 j j , , − i i , , k [ k k [ [ x y y , , // Copy thea data = into aconcat(x,y,4); a an = array aconcat(a,z,4); thatstring is vnames 3x2x3x4 = { "X",// "Y", Set "Z" data }; gdat in = gpData gpInitPlotData(vnames); ret structure = gpAddZone(&gdat,"Zone 1",a); // Write dataret file = gpWritePlotData(&gdat,"volumeplot.plt"); 1] 1] − + j j , , i i , , k k [ [ x x by a series of line segments connecting each point ( fourth dimension in that order. The resulting set of data points ( points in the same plane (i.e., ( ( The points in Figure plane(s) (i.e., ( ( GAUSSplot 8.0

P16

P15

P14 P20

P13 P19

P18 P4 P24

P17 P3 P23 P2 P22 P8 P1 P21 P7

P6 P12

P5 P11

P10

P9

Figure 1.4: 3D Cartesian Plot Point Arrangement

1-16 Overview 1-17 Overview 1.4 1]) 2]) 3]) 4]) 1]) 2]) 3]) 4]) 1]) 2]) 3]) 4]) 1]) 2]) 3]) 4]) 1]) 2]) 3]) 4]) 1]) 2]) 3]) 4]) , , , , , , , , , , , , , , , , , , , , , , , , 1 1 1 1 2 2 2 2 3 3 3 3 1 1 1 1 2 2 2 2 3 3 3 3 , , , , , , , , , , , , , , , , , , , , , , , , 1 1 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 2 2 , , , , , , , , , , , , , , , , , , , , , , , , [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 [3 a a a a a a a a a a a a a a a a a a a a a a a a , , , , , , , , , , , , , , , , , , , , , , , , 1] 2] 3] 4] 1] 2] 3] 4] 1] 2] 3] 4] 1] 2] 3] 4] 1] 2] 3] 4] 1] 2] 3] 4] , , , , , , , , , , , , , , , , , , , , , , , , 1 1 1 1 2 2 2 2 3 3 3 3 1 1 1 1 2 2 2 2 3 3 3 3 , , , , , , , , , , , , , , , , , , , , , , , , 1 1 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 2 2 , , , , , , , , , , , , , , , , , , , , , , , , [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 [2 a a a a a a a a a a a a a a a a a a a a a a a a , , , , , , , , , , , , , , , , , , , , , , , , 1] 2] 3] 4] 1] 2] 3] 4] 1] 2] 3] 4] 1] 2] 3] 4] 1] 2] 3] 4] 1] 2] 3] 4] , , , , , , , , , , , , , , , , , , , , , , , , Array Correspondence for Figure 1 1 1 1 2 2 2 2 3 3 3 3 1 1 1 1 2 2 2 2 3 3 3 3 / , , , , , , , , , , , , , , , , , , , , , , , , 1 1 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 2 2 , , , , , , , , , , , , , , , , , , , , , , , , [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 [1 a a a a a a a a a a a a a a a a a a a a a a a a Point Definition P1 ( P2 ( P3 ( P4 ( P5 ( P6 ( P7 ( P8 ( P9 ( P10 ( P11 ( P12 ( P13 ( P14 ( P15 ( P16 ( P17 ( P18 ( P19 ( P20 ( P21 ( P22 ( P23 ( P24 ( Table 1.1: Graph Point GAUSSplot 8.0

Frame 001  13 Sep 2006  frames1

-0.2

-0.4

-0.6

-0.8 Y1, Y2, Y3

-1

-1.2

1 2 3 4 X

Figure 1.5: Frames

1.4 Basic Structure of a Graph

1.4.1 Workspace

In GAUSSplot, a graph is created in a workspace. The workspace is the page that the graph is drawn on. All elements of the graph are contained in the workspace.

1.4.2 Frame

The most basic unit within a workspace is a frame. A graph can contain multiple frames, and each frame contains a set of axes (although the user may choose not to show them) and the plotting of one or more sets of data points. See Figure 1.5.

1-18 Overview 1-19 Overview . . Each frame 1.6 GAUSSplot 1 variable is associated with the X or Theta-axis × P) variable associated with the Y-axis, and, for 3D Cartesian plots, one × N × P in the case of 3D Cartesian volume plots) variable associated with the × N P (or L P) variable associated with the Z-axis. Together these variables specify a locus of × Polar Line 2D Cartesian 3D Cartesian XY Line × × N 1 variable is associated with the Y or R-axis. Together these two variables specify a • • • • × × P (or L × P (or L × Both 2D Cartesian and 3Done Cartesian N plots are field plots, that is, for both types of plots, there is 1.5.3 Field Plots XY Line and Polar Lineis, plots for both both graph XY linear Line sets and of Polar points Line (and plots, are one thus N termed line plots), that An XY or Polar LineFor plot each may line contain map, multiple you line mustone maps, specify variable which to one are be variable each to associated controlled be withmore separately. associated the of with Y the the or following layers: X R-axis. or lines, Each Theta-axis symbols, line and and map (for may XY be Line represented plots), by bars one and or error bars. X-axis, one N 1.5.2 Line Plots and one N N There are four basic plot types in the underlying graphics engine used by linear set of points. This linear set of points is referred to as a line map. See Figure 1.5.1 Basic Plot Types 1.5 Plot Types must be associated with one and only one of these basic plot types. The basic plot types are: GAUSSplot 8.0

Frame 001  13 Sep 2006  gp1c564024c0404506134300337

1 line maps

0

f(x) -1

-2

-3

0.5 1 1.5 2 2.5 3 x

Figure 1.6: Line Maps

1-20 Overview 1-21 Overview

Z . 0 1 2 3 4 5 Y 1.7 data file contains Z -8 .plt X

-6 X -4 -2 erent zones in the data file. Thus a field plot will ff 0 0 Figure 1.7: Field Zones -2 contains an explanation of zones. See Figure -4 1.3.1

cartesianplot2 Y  -6 field zones -8 13 Sep 2006  Frame 001 contain as many field zones as there are zones in the associated data file. For example, if a user A field plot may contain multiple fields or field zones if the associated points in 2D or 3Drepresented space by that one constitute or a more fieldvector, of (i.e., scatter, the a shade, following surface and layers: or boundary. a mesh volume), connecting which neighboring may points, be contour, more than one zone. Section For each 2D and 3D CartesianX-axis, plot, one you variable to must be specify associatedassociated one with with variable to the the be Y-axis, Z-axis. and, associated This foran with specification 3D axis the of plots, map. the one Axis variables variable to maps tozones be are be in mapped set a to for frame each the use axis entire the is plot, same called not axis for map, a but particular di field zone. All of the field GAUSSplot 8.0

wanted to create a 3D Cartesian plot with the following data file:

Zone 1 Variable Rows Cols V1 50 10 V2 50 10 V3 50 10

Zone 2 Variable Rows Cols V1 20 5 V2 20 5 V3 20 5

then he would have two field zones in his plot. In other words, supposing he associated V1 with the X-axis, V2 with the Y-axis and V3 with the Z-axis, then he would have two completely separate sets of data points defined by (V1,V2,V3), the first containing 500 data points, and the second containing 100 data points. Display options, such as which layers are activated (e.g. mesh, contour, etc.), are controlled separately for each field zone.

1.5.4 GAUSSplot Plot Types

In addition to the four basic plot types, GAUSSplot supports other plot types that are built from the basic plot types using various view options. Since each of these additional plot types are derived from one of the basic plot types, it is that basic plot type which must be associated with the frame containing the plot. For example, one of the additional plot types is a Bar plot, which is an XY Line plot in which the line maps are displayed as bars. A frame that contains a Bar plot will be associated with the XY Line plot type.

Plot types that are derived from the same basic plot type may be displayed together in the same frame because they differ only in the view options used to display the data or the method by which the data is presented.. For example, you may create a Bar plot with three line maps (i.e. three sets of data points) and then change one of the line maps to be displayed as a line instead of bars, which would result in a frame that contained both Bar and XY Line plots. However, you may not

1-22 Overview 1-23 to Overview . field plots gpBoxPlotCreate percentile method to generate the graph. For example, the given frequency counts : Bar, Box, Hist, HistF, HistP, LogX, LogY, plot types, including the basic plot types from erent basic plot types together in a frame. For example, gpMakeBoxPlot line plots ff GAUSSplot erently than other plot types. Bar plot XY Line plot Line maps displayed as bars Hist plot XY Line plot Displays a frequency histogram for the data Box plot XY Line plot Displays data using the box graph Plot Type Basic Plot Type View Options HistP plot XY Line plot Displays a percentage histogram for the data HistF plot XY Line plot Displays a frequency histogram for the data, LogX plotLogY plot XY Line plot XY Line plot Uses log scaling for the X-axis Uses log scaling for the Y-axis ff LogLog plot XY Line plot Uses log scaling for the X and Y axes XY Line plot XY Line plot Line maps displayed as lines Polar Line plot Polar Line plot Line maps displayed as lines 2D Contour plot 2D Cartesian plot3D Contour plot Field 3D zones Cartesian displayed plot with contour flood Field zones displayed with contour flood 2D Cartesian plot 2D Cartesian plot3D Cartesian plot 3D Cartesian plot Field zones displayed as mesh Field zones displayed as mesh To create a graph with one frame containing a box plot, you may use Box Plots Because Box, Hist, HistF, and HistPslightly plots di all require a manipulation of the data, they are handled initialize your plot control structure, and 2D Cartesian, 2D Contour, 3D Cartesian, and 3D contour plots are all The following plot types are considered LogLog, Polar Line, XY Line. show plot types that are derived from di Following is a complete list of the you may not have a Bar plot and a 2D Cartesian plot in the same frame. which they are derived and the view or data presentation options that are associated with each: GAUSSplot 8.0

following code:

library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpBoxPlotCreate;

rndseed 12345; nboxes = 5; npoints = 7; x=seqa(1,1,nboxes)’; y=rndn(npoints,nboxes);

ret = gpMakeBoxPlot(&gp,x,y);

produces the graph in Figure 1.8

To create a graph with multiple frames, each containing a box plot, you may use gpBoxPlotCreate to initialize your plot control structure, gpAddBoxFrame to add frames to your graph, and gpPlot to generate the graph. Unlike with other plot types, when you initialize a plot control structure with gpBoxPlotCreate, you must use gpAddBoxFrame to add EACH frame, including the first. The reason for this is that gpAddBoxFrame takes your data as an argument and generates the boxes for the frame.

Note that you will still need to use gpWritePlotData to write your data file, and gpSetDataFile to set the data file in your plot control structure.

For example, you could use the following code to generate the graph in Figure 1.9 with two frames, each containing box plots:

library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpBoxPlotCreate;

1-24 Overview 1-25 Overview Figure 1.8: Simple Box Plot gp0dc401060F084506debb00167  12 Sep 2006  Frame 001 GAUSSplot 8.0

// Create random data rndseed 14738; nboxes = 10; npoints = 20; x=reshape(seqa(1,1,nboxes)’,npoints,nboxes); y=rndn(npoints,nboxes);

// Write data file struct gpData gdat; gdat = gpSetPlotData(x˜y,""); call gpWritePlotData(&gdat,"gpbox.plt");

// Set data and macro files gpSetMacroFile(&gp,"gpbox.mcr"); call gpSetDataFile(&gp,0,"gpbox.plt");

// Set up frame 1 call gpAddBoxFrame(&gp,x,y); call gpMoveFrame(&gp,1,1,0.25,9,3.925);

// Set up frame 2 call gpSetBoxMinMaxMethod(&gp,2,2); call gpAddBoxFrame(&gp,x,y); call gpShowSymbolLayer(&gp,2,1); call gpSetSymbolSize(&gp,2,seqa(1,1,nboxes),1); call gpSetBoxColor(&gp,2,seqa(1,1,nboxes),"red"); call gpSetSymbolColor(&gp,2,seqa(1,1,nboxes),"cyan"); call gpMoveFrame(&gp,2,1,4.325,9,3.925);

// Plot the graph call gpPlot(&gp);

To create a graph with multiple frames, containing different types of plots, use gpPlotCreate to initialize the plot control structure, gpAddPlotTypeFrame to plot the graph.

1-26 Overview 1-27 Overview gpbox gpbox   14 Nov 2006 14 Nov 2006   Figure 1.9: Multiple-Frame Box Plot Frame 002 Frame 001 GAUSSplot 8.0

Histograms

To create a graph with one frame containing a Hist plot, you may use gpBoxPlotCreate to initialize your plot control structure, and gpMakeHistPlot to generate the graph. For example, the following code:

library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpHistPlotCreate;

rndseed 454356; x = round(rndn(4000,1)*100);

{ b, m, freq, ret } = gpmakehistplot(&gp,x,50);

produces the graph in Figure 1.10

To create a graph with multiple frames, containing one or more hist plots, you may use gpHistPlotCreate to initialize your plot control structure, gpAddHistFrame as well as the other gpAddPlotTypeFrame commands to add frames to your graph. and gpPlot to generate the graph. However, you must also call gpCreateHistData before writing your data file to manipulate your data for the hist plot.

The commands available for generating various types of histograms are as follows:

Hist plots HistF plots HistP plots gpHistPlotCreate gpHistFPlotCreate gpHistPPlotCreate gpCreateHistData gpCreateHistPData gpAddHistFrame gpAddHistFFrame gpAddHistPFrame gpMakeHistPlot gpMakeHistFPlot gpMakeHistPPlot

For example, you could use the following code to generate the graph in Figure 1.11 with two frames, the first containing a hist plot, and the second a histp plot:

1-28 Overview 1-29 Overview 300 200 100 0 Midpoint -100 Figure 1.10: Simple Hist Plot gp06ac00F85C404506e0dc0032c -200  -300 12 Sep 2006

0

 50 200 150 100 Frequency # Frame 001 GAUSSplot 8.0

library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpPlotCreate;

// Create random data rndseed 454356; x = round(rndn(4000,1)*100); { v1, m1, freq1 } = gpCreateHistData(x,50); { v2, m2, freq2, freq2p } = gpCreateHistPData(x,50);

// Set data in gpdata structure struct gpData gdat; gdat = gpInitPlotData("X"$|"Y"); call gpAddZone(&gdat,"",aconcat(m1,freq1,3)); call gpAddZone(&gdat,"",aconcat(m2,freq2p,3));

// Write data file ret = gpWritePlotData(&gdat,"xylineplot.plt"); if (ret); print gpGetErrorMessage(ret); endif;

// Set data file call gpSetDataFile(&gp,0,"xylineplot.plt");

// Set up frame 1 call gpAddHistFrame(&gp); call gpSetLineMapZone(&gp,1,1,1); call gpMoveFrame(&gp,1,0.25,0.25,5.175,7.85);

// Set up frame 2 call gpAddHistPFrame(&gp); call gpSetLineMapZone(&gp,2,1,2); call gpSetBarColor(&gp,2,1,"blue","blue"); call gpMoveFrame(&gp,2,5.525,0.25,5.175,7.85);

1-30 Overview 1-31 Overview structure. 200 , commands may be 1.4 gpPlotControl 0 structure and initializing its xylineplot Midpoint  HistP Plot / -200 12 Sep 2006 

5 4 3 2 1 0 Frequency % Frame 002 gpPlotControl Figure 1.11: Multiple-Frame Hist graph is created from the information contained in a contains commands for creating a // Plot thecall graph gpPlot(&gp); GAUSSplot Following the basic structure of a graph that was outlined in Section GAUSSplot members to default values for amaps particular for plot field type, plots, specifying setting line various output maps and for view line options, plots and and plotting axis the graph. A 1.6 Categorization of Commands GAUSSplot 8.0 categorized into five different groups, depending on what unit of the graph they operate on. The five categories are as follows:

Commands that operate on an entire graph:

Example Command Purpose gpBarPlotCreate Creates a gpPlotControl structure and initializes its members to default values for a bar plot. gpPlot Plots a graph using information contained in a gpPlotControl structure.

Commands that operate on a frame:

Example Command Purpose gpAddTextObject Adds a text object to a specified location in a frame. gpMoveFrame Moves the frame to a specified location in the workspace. gpSetXAxisTitle Sets the title of the X-axis in a frame.

Commands that operate on a line map (for line plots):

Example Command Purpose gpSetBarColor Sets the line color and fill color for the bars in a line map. gpSetLineMaps Sets the variables that are to be associated with each axis for one or more line maps.

Commands that operate on a field zone (for field plots):

Example Command Purpose gpSetMeshColor Sets the color of the mesh in a field zone. gpSetScatterSize Sets the size of the symbols for the scatter layer in a field zone.

For 2D and 3D Contour plots, all contour options are set within a contour group. Each field zone for which the contour layer is activated must be tied to a particular contour group. Up to four contour groups may be used in any one frame, and one contour group may be used to set options for multiple field zones in a frame. Thus the final category consists of:

1-32 Overview 1-33 Overview structure, which you gpPlotControl or one of the plot type specific gpPlotControl gpPlotCreate graph is stored in a Adds a legend to display theused values in associated the with contour each plot. color Sets the variable to be used for contour plotting. GAUSSplot commands. For example: symbol table. You may input a pointer to a structure into a command by GAUSS using default values for an XY Line plot. commands are implemented using structure pointers, which hold the address of a call gpSetLineColor(&gp,1,1,"blue"); gp = gpXYLinePlotCreate; struct gpPlotControl gp; PlotCreate gp PlotType Example CommandgpAddContourLegend Purpose gpSetContourVariable placing an ‘&’ in frontstructure. of the For structure example: name, indicating that you are passing in the address of that Or you may create awith structure the pointer following and lines set of it code: to point at the plot control structure created above GAUSSplot initializes structure in the To initialize a plot control structure, you may call gp Commands that operate on a contour group (for 2D and 3D Contour plots): All of the information for a 1.7 Working With Structure Pointers must create and initialize atstructure the with beginning of the your following line: program. You can create a GAUSSplot 8.0

struct gpPlotControl *pgp; pgp = &gp;

In the first line, placing an asterisk (‘*’) in front of pgp tells GAUSS to make pgp a pointer to a plot control structure. The second line sets pgp to the address of gp, making it a pointer to gp. If you create a structure pointer this way, then you may input it into a GAUSSplot command like this:

call gpSetLineColor(pgp,1,1,"blue");

The GAUSSplot data file creation commands are also implemented using structure pointers; however, they operate on gpData structures, rather than plot control structures. See Section 1.3.2 for an example of using structure pointers in these commands.

Structure pointers are not yet fully implemented in GAUSS. Enough functionality exists to support the GAUSSplot API. However, you may run into problems if you try to use them in ways that are not documented here.

1.8 Structure Files

When you write a data file with gpWritePlotData, or a data file is created automatically with one of the gpMakePlotTypePlot commands, then the information in the gpData structure containing the data is saved to a file. This file has the same name as the associated data file, except with an .fsr extension instead of a .plt extension.

This structure file is accessed by gpAddFieldZoneLegendFrame as well as by GAUSSplot commands that allow you to specify variables using variable names. These commands open the .fsr file to obtain needed information or to convert the input variable names to indices of the variables into the data file. If you want to add a field zone legend or specify variables using variable names in GAUSSplot commands, then you need to keep the .fsr structure file together with your .plt data file at all times.

Call gpCleanUp after running your program to delete the structure and data files.

1-34 Overview 1-35 Overview subdirectory . See the GAUSSplot gaussplot/examples in the xylineplot1.e to set the level of error handling in your program. for line-by-line explanation of some of the examples. to retrieve the associated error messages. installation directory.  C supports three levels of error handling: // Set up library and include file with structure definitions to 1 in your program to display debugging information.  GAUSS gpSetErrorLevel 1 Return2 error codes if errors Log are3 error encountered messages (default). and return Log error error codes message if and errors stop are program encountered. run if an error is encountered. This example can be found in the file This example creates a graph with one frame containing an XY Line plot with only one line map. Example 1 1.10.1 Line Plots Here are some complete example programs that create graphs in 1.10 Examples If all of the commandsappear in when your you program run return your with_gp_debug program a or success is code, displayed but your with graph errors, either then does set not the global variable GAUSS of your If you use the errorgpGetErrorMessage handling default and your program encounters errors, you may call Call GAUSSplot 1.9 Error Handling GAUSSplot 8.0

library gaussplot; #include gp.sdf

// Create gpPlotControl structure and set members to default // values struct gpPlotControl gp; gp = gpXYLinePlotCreate;

// Generate data x = seqa(0.2,.2,15); y = log(x/5);

// Set the names of macro and data files to create gpSetMacroFile(&gp,"xylineplot1.mcr"); ret = gpSetDataFile(&gp,0,"xylineplot1.plt");

// Create graph ret = gpMakeXYLinePlot(&gp,x,y,"");

Example 2

This example creates a graph with one frame containing an XY Line plot. The vector in x is plotted against each of the three columns in y, making three separate line maps. Each line map is displayed in a different color. The axes titles are set and a line legend added before the graph is plotted.

This example can be found in the file xylineplot2.e in the gaussplot/examples subdirectory of your GAUSS installation directory.

// Set up library and include file with structure definitions library gaussplot; #include gp.sdf

// Create gpPlotControl structure and set members to default // values

1-36 Overview 1-37 . Instead Overview erent XY Line plot. Since ff gpAddXYLineFrame . creates five line maps (which will be must be used to plot the graph. For a graph with gpSetLineMaps gpSetLineMaps gpPlot , there is no need to add frames using will create the specified frame if it does not already exist and then struct gpPlotControl gp; gp = gpXYLinePlotCreate; // Generate data x = seqa(0.2,.2,15); y = log(x/5)˜ln(x/5)˜exp(x/5); // Set axesret titles = gpSetXAxisTitle(&gp,1,1,"x"); ret = gpSetYAxisTitle(&gp,1,1,"f(x)"); // Add lineret legend = gpAddLineLegend(&gp,1); ret = gpMoveLineLegend(&gp,1,85,40); // Set thegpSetMacroFile(&gp,"xylineplot2.mcr"); names ofret macro = and gpSetDataFile(&gp,0,"xylineplot2.plt"); data files to// create Create graph ret = gpMakeXYLinePlot(&gp,x,y,""); gpSetLineMaps gpXYLinePlotCreate This example creates a graph with three frames, each containing a di Example 3 Since the graph contains multiple frames, the plot type for thecall entire to graph is set tothe XY frames Line are plot created at implicitly the in beginning the of calls the to program withA the call to specify which variables are to bethe associated frame. with In the this X example,displayed and the as Y first five axes call distinct for to lines) one insecond or the frame, more first and line frame, the maps the third in second call call creates creates four three line line maps maps in in the the third frame. GAUSSplot 8.0

only one frame containing an XY Line plot, you may use gpMakeXYLinePlot to write the data file and plot the graph.

This example can be found in the file xylineplot3.e in the gaussplot/examples subdirectory of your GAUSS installation directory.

// Set up library and include file with structure definitions library gaussplot; #include gp.sdf

// Create gpPlotControl structure and set members to default // values struct gpPlotControl gp; gp = gpXYLinePlotCreate;

// Create gpData structure struct gpData gdat;

// Generate data // X-axis variable x = seqa(.2,.2,20);

// Y-axis variables y = log(x[.,1]/5); y2 = ln(x[.,1]/5); y3 = exp(x[.,1]/5); x = x˜y; x = x˜y*0.8; x = x˜y*0.6; x = x˜y*0.4; x = x˜y*0.2; x = x˜y2; x = x˜y2*0.6; x = x˜y2*0.2; x = x˜y3; x = x˜y3*0.8; x = x˜y3*0.6;

1-38 Overview 1-39 Overview "X1" "Y5" }; "Y12" }; "Y8", "Y9", "Y10", "Y11", "Y12" }; print gpGetErrorMessage(ret); // Set datagdat in = gpData gpSetPlotData(x,vnames); structure // Write dataret file = gpWritePlotData(&gdat,"xylineplot3.plt"); if (ret); endif; // Set error// level encountered tocall 2 gpSetErrorLevel(&gp,2); - print error messages// if Specify errors names// are for opened macrogpSetMacroFile(&gp,"xylineplot3.mcr"); file to becall created gpSetDataFile(&gp,0,"xylineplot3.plt"); and data file// to Specify be linestring maps linemaps1 for = all { three "X1" frames call "Y1", gpSetLineMaps(&gp,1,linemaps1); "X1" "Y2",string "X1" linemaps2 "Y3", =call "X1" { gpSetLineMaps(&gp,2,linemaps2); "Y4", "X1"string "Y6", linemaps3 "X1" = "Y7", { "X1" "X1" "Y8"call "Y9", }; gpSetLineMaps(&gp,3,linemaps3); "X1" "Y10", "X1" "Y11",// "X1" Show symbolcall layer gpShowSymbolLayer(&gp,1|2|3,1); andcall change gpSetSymbolSkip(&gp,1,1|3|5,2,2); symbol options x = x˜y3*0.4; // List variablestring names vnames = { "X1", "Y1", "Y2", "Y3", "Y4", "Y5", "Y6", "Y7", GAUSSplot 8.0

call gpSetSymbolSkip(&gp,1,2|4,3,2); call gpSetSymbolSkip(&gp,2,seqa(1,1,3),15,3); call gpSetSymbolSkip(&gp,3,seqa(1,1,4),2,2); call gpSetSymbolSize(&gp,1,seqa(1,1,5),2); call gpSetSymbolSize(&gp,2,seqa(1,1,3),3); call gpSetSymbolSize(&gp,3,seqa(1,1,4),2); call gpSetSymbolShape(&gp,1,2,"circle"); call gpSetSymbolShape(&gp,1,3,"rtri"); call gpSetSymbolShape(&gp,1,4,"diamond"); call gpSetSymbolShape(&gp,1,5,"ltri"); call gpSetSymbolShape(&gp,2,2,"circle"); call gpSetSymbolShape(&gp,2,3,"rtri"); call gpSetSymbolShapeASCII(&gp,3,1,1,"$"); call gpSetSymbolShapeASCII(&gp,3,2,3,"r"); call gpSetSymbolShapeASCII(&gp,3,3,2,"p"); call gpSetSymbolShapeASCII(&gp,3,4,2,"x"); call gpSetSymbolColor(&gp,1,5,"purple"); call gpSetSymbolLineThickness(&gp,2,1,0.8); call gpSetSymbolFillMode(&gp,2,2,2,""); call gpSetSymbolFillMode(&gp,2,3,4,"CUSTOM34");

// Change line options call gpSetLineColor(&gp,1,5,"purple"); call gpSetLineThickness(&gp,3,1|4,0.8); call gpSetLinePattern(&gp,3,1|2,"dashdot"); call gpSetLinePatternLength(&gp,3,1,6);

// Resize and move frames to show all three in window call gpMoveFrame(&gp,1,1,0.25,4.425,3.925); call gpMoveFrame(&gp,2,5.575,0.25,4.425,3.925); call gpMoveFrame(&gp,3,1,4.325,9,3.925);

// Specify titles of axes call gpSetXAxisTitle(&gp,1,1,"X AXIS"); call gpSetYAxisTitle(&gp,1,1,"Y AXIS"); call gpSetXAxisTitle(&gp,2,1,"X AXIS"); call gpSetYAxisTitle(&gp,2,1,"Y AXIS");

1-40 Overview 1-41 Overview is used to write the data to a gaussplot/examples in the "using math/Greek characters as symbols"); gpMake3DContourPlot to plot the graph. contourplot1.e gpPlot and then call call gpSetXAxisTitle(&gp,3,1,"X"); call gpSetYAxisTitle(&gp,3,1,"F(X)"); // Add titlescall for gpAddTextObject(&gp,1,"title1",44,89,1,"log(x/5)"); eachcall frame gpAddTextObject(&gp,2,"title2",44,89,1,"ln(x/5)"); call gpAddTextObject(&gp,3,"title3",46,89,1,"exp(x/5)"); // Add textcall box gpAddTextObject(&gp,3,"text1",32,56,1, in frame 3 call gpSetTextObjectFont(&gp,3,"text1","times",13,2); call gpSetTextObjectColor(&gp,3,"text1","custom41"); call gpSetTextObjectBoxType(&gp,3,"text1",2); call gpSetTextObjectBoxColor(&gp,3,"text1","custom41",""); call gpSetTextObjectMargin(&gp,3,"text1",40); call gpRotateTextObject(&gp,3,"text1",15); // Show eachgpShowDrawing(&gp,2); frame onecall at gpFramePause(&gp,1|2,0.1); a time and pause// between Create each graph call frame gpPlot(&gp); This example creates a graph withonly one one frame, frame, containing containing a one 3D field Contour zone, plot. Since the graph has Example 1 1.10.2 Field Plots data file and plot thegpWritePlotData graph. For a more complicated graph, you must first writeThis the example data can file be using found in the file GAUSSplot 8.0 subdirectory of your GAUSS installation directory.

// Set up library and include file with structure definitions library gaussplot; #include gp.sdf

// Create gpPlotControl structure and set members to default // values struct gpPlotControl gp; gp = gp3DContourPlotCreate;

// Generate data xl = 51; yl = 51; pix = pi/(xl-1); piy = pi/(yl-1); x = seqa(-88,2.5,xl)’*pix; y = seqa(-88,2.5,yl)*piy; z = sin(x).*cos(x-y); cv = cos(x).*sin(x-y); x = x.*ones(51,51); y = y.*ones(51,51);

// List variable names string vnames = { "X", "Y", "Z", "CV" };

// Specify names for macro file to be created and data file to be // opened gpSetMacroFile(&gp,"contourplot1.mcr"); ret = gpSetDataFile(&gp,0,"contourplot1.plt");

// Add title for frame ret = gpAddTextObject(&gp,1,"",43,93,1,"3D Contour Plot");

// Create contour plot ret = gpMake3DContourPlot(&gp,x,y,z,cv,vnames);

1-42 Overview 1-43 Overview subdirectory gaussplot/examples in the volumeplot1.e z = aconcat(z,2*r[i].*ones(4,21),3); installation directory. // Set uplibrary library gaussplot; and#include include gp.sdf file with structure definitions // Create gpPlotControl// structure values andstruct set gpPlotControl members gp; togp default = gp3DCartesianPlotCreate; // Generate data a = seqa(0,pi/10,21)’; r = seqa(.25,0.75,4); x = r.*cos(a); x = areshape(x,5|4|21); y = r.*sin(a); y = areshape(y,5|4|21); r = r|(r[rows(r)]+0.75); z = areshape(2*r[1].*ones(4,21),4|21); for i(2,5,1); endfor; // Show onlyret shade = layer gpShowMeshLayer(&gp,1,0); ret and = use gpShowBoundaryLayer(&gp,1,0); translucency ret = gpShowShadeLayer(&gp,1,1); ret = gpSetShadeColor(&gp,1,1,"blue"); GAUSS This example can be found in the file This example creates a graph withcylindrical solid, one which frame, is containing created a by 3D using Cartesian 3-dimensional plot. variables. The plot is a Example 2 of your GAUSSplot 8.0

ret = gpUseTranslucencyEffect(&gp,1,1); ret = gpSetTranslucency(&gp,1,1,30);

// Specify names for macro and data files to be created gpSetMacroFile(&gp,"volumeplot1.mcr"); ret = gpSetDataFile(&gp,0,"volumeplot1.plt");

// Plot the graph ret = gpMake3DCartesianPlot(&gp,x,y,z,"");

1.10.3 Graphs Containing Different Plot Types

This example creates a graph with three frames: a large frame containing a 2D Contour plot with a contour legend, an inset frame containing a 3D Cartesian plot and an inset frame containing an XY Line plot. Since the generic gpPlotCreate command is used to initialize the plot control structure, there is no plot type set for the entire graph. This allows for the creation of multiple frames, each containing different plot types. In this example, the frames are created with gpAdd2DContourFrame, gpAdd3DCartesianFrame, and gpAddXYLineFrame.

This example can be found in the file plot1.e in the gaussplot/examples subdirectory of your GAUSS installation directory.

// Set up library and include file with structure definitions library gaussplot; #include gp.sdf

// Create gpPlotControl structure and set members to default values struct gpPlotControl gp; gp = gpPlotCreate;

// Create gpData structure struct gpData gdat;

// Generate data xl = 51;

1-44 Overview 1-45 Overview yl = 51; pix = pi/(xl-1); piy = pi/(yl-1); x = seqa(-88,2.5,xl)’*pix; y = seqa(-88,2.5,yl)*piy; // Z-axis variable z = sin(x).*cos(x-y);z2 // = For zeros(20,1);z3 contour // = and For zeros(60,1); cartesian xy // plots line For plot // xy X line and plot x Y-axis = variables x.*ones(51,51); x2 = seqa(0.2,0.2,20); x3 = seqa(0.05,0.05,60); y = y.*ones(51,51); y2 = log(x2[.,1]); y3 = ln(x3[.,1]); // Put dataa into = an aconcat(x,y,3); a array = aconcat(a,z,3); a2 = aconcat(x2,y2,3); a2 = aconcat(a2,z2,3); a3 = aconcat(x3,y3,3); a3 = aconcat(a3,z3,3); // List variablestring names vnames = { "X",// "Y", Set "Z" data }; gdat in = gpData gpInitPlotData(vnames); ret structure = gpAddZone(&gdat,"Zoneret One",a); = gpAddZone(&gdat,"Zoneret Two",a2); = gpAddZone(&gdat,"Zone Three",a3); // Write data file GAUSSplot 8.0

ret = gpWritePlotData(&gdat,"plot1.plt");

// Specify names for macro file to be created and data file to be // opened gpSetMacroFile(&gp,"plot1.mcr"); ret = gpSetDataFile(&gp,0,"plot1.plt");

// Add a 2D Contour frame, a 3D Cartesian frame, and an XY Line // frame gpAdd2DContourFrame(&gp); gpAdd3DCartesianFrame(&gp); gpAddXYLineFrame(&gp);

// Use only field zone one for contour and cartesian plots // And use field zones two and three for XY line plot ret = gpSetActiveFieldZones(&gp,1,1); ret = gpSetActiveFieldZones(&gp,2,1); ret = gpSetLineMapZone(&gp,3,1,2); ret = gpSetLineMapZone(&gp,3,2,3);

// Change color distribution to continuous for contour frame ret = gpSetContourColorDistribution(&gp,1,1,2);

// Set line map options ret = gpSetLineColor(&gp,3,2,"custom33"); ret = gpShowSymbolLayer(&gp,3,1); ret = gpSetSymbolSkip(&gp,3,1,2,2); ret = gpSetSymbolSkip(&gp,3,2,5,2); ret = gpSetSymbolSize(&gp,3,1|2,2); ret = gpSetSymbolShape(&gp,3,1,"square"); ret = gpSetSymbolShape(&gp,3,2,"diamond"); ret = gpSetSymbolColor(&gp,3,2,"custom33"); ret = gpSetSymbolFillMode(&gp,3,1|2,2,"");

// Resize and move frames to show all three in window ret = gpMoveFrame(&gp,1,0.25,0.25,10.5,8); ret = gpMoveFrame(&gp,2,2,4.6,3.5,2.5);

1-46 Overview 1-47 Overview installation directory for more GAUSS (chrs(ones(1,21)*32)$+"2D Contour Plot")$| "with 3D Cartesian and XY Line Plot Insets"); subdirectory of your // Add contourret legend = for gpAddContourLegend(&gp,1,1); ret contour = group gpMoveContourLegend(&gp,1,1,85,49); 1 ret = gpSetContourLegendBoxStyle(&gp,1,1,2,0.2,1,2); ret = gpSetContourLegendSkip(&gp,1,1,2); ret = gpSetContourLegendMargin(&gp,1,1,5); // Do not// show And border doret or not = axes show gpShowXAxis(&gp,2,0,0); inret border frame = or 2 gpShowYAxis(&gp,2,0,0); backgroundret in = frame gpShowZAxis(&gp,2,0); ret 3 = gpSetFrameStyle(&gp,2,0,0,1); ret = gpSetFrameStyle(&gp,3,0,0,0); // Create contourret plot = gpPlot(&gp); ret = gpMoveFrame(&gp,3,5.75,1.25,3.5,2.5); // Make X// and And Y makeret axes axes = independent XYZ gpMakeAxesIndependent(&gp,1); ofret dependent one = in another gpMakeAxesXYZDependent(&gp,2,1,0.5); frame in 2 frame// 1 Add titleret for = frame gpAddTextObject(&gp,1,"",32,91,1, 1 gaussplot/examples See the examples.

Command Overview 2-1 . 2 GAUSSplot Creates a plot control structuremembers and to initializes default its values for a 2D Cartesian plot. Creates a plot control structuremembers and to initializes default its values for a 2D Contour plot. Creates a plot control structuremembers and to initializes default its values for a 3D Cartesian plot. Creates a plot control structuremembers and to initializes default its values for a 3D Contour plot. Command Overview gp3DContourPlotCreate gp2DContourPlotCreate gp3DCartesianPlotCreate gp2DCartesianPlotCreate 2.1.1 Setup and Initialization Following is a complete list of the commands and global variables contained in 2.1 Commands GAUSSplot 8.0

gpBarPlotCreate Creates a plot control structure and initializes its members to default values for a Bar plot.

gpBoxPlotCreate Creates a plot control structure and initializes its members to default values for a Box plot.

gpHistPlotCreate Creates a plot control structure and initializes its members to default values for a Hist plot.

gpHistFPlotCreate Creates a plot control structure and initializes its members to default values for a HistF plot.

gpHistPPlotCreate Creates a plot control structure and initializes its members to default values for a HistP plot.

gpLogLogPlotCreate Creates a plot control structure and initializes its members to default values for a LogLog plot.

gpLogXPlotCreate Creates a plot control structure and initializes its members to default values for a LogX plot.

gpLogYPlotCreate Creates a plot control structure and initializes its members to default values for a LogY plot.

gpPlotCreate Creates a plot control structure and initializes its members to generic default values for a graph with frames containing different plot types.

gpPolarLinePlotCreate Creates a plot control structure and initializes its members to default values for a Polar Line plot.

gpXYLinePlotCreate Creates a plot control structure and initializes its members to default values for an XY Line plot.

2.1.2 Creating Data Files

gpAddZone Adds all of the variables for one zone of the data file to the data structure.

2-2 Command Overview 2-3 K Command Overview 1. × data file using the data contained in a .plt Add a Box plot frame. Add a 2D Cartesian plot frame. Add a 2D Contour plot frame. Add a 3D Cartesian plot frame. Add a 3D Contour plot frame. Add a Bar plot frame. variables that are N Writes a Specifies the data file(s) to use. Specifies the name of the macro file to write. Generates vectors of category breakpoints, category midpoints, frequency counts, and frequency percentages for a HistP plot (percentage histogram). Creates and initializes a datauser-specified structure variable using names. Sets the title of a data set. Creates, initializes and adds dataa to data a file data that structure will for contain only one zone with data structure. Generates vectors of category breakpoints, category midpoints, and frequency counts for a(frequency histogram). Hist plot gpAddBarFrame gpAddBoxFrame gpAdd2DCartesianFrame gpAdd2DContourFrame gpAdd3DCartesianFrame gpAdd3DContourFrame gpSetMacroFile gpSetDataFile gpSetPlotData gpWritePlotData gpCreateHistData gpInitPlotData gpSetDataSetTitle gpCreateHistPData 2.1.4 Adding Frames to a Graph 2.1.3 Specifying Data and Macro Files GAUSSplot 8.0

gpAddHistFrame Add a Hist plot frame.

gpAddHistFFrame Add a HistF plot frame.

gpAddHistPFrame Add a HistP plot frame.

gpAddLogLogFrame Add a LogLog plot frame.

gpAddLogXFrame Add a LogX plot frame.

gpAddLogYFrame Add a LogY plot frame.

gpAddPolarLineFrame Add a Polar Line plot frame.

gpAddXYLineFrame Add an XY Line plot frame.

2.1.5 Setting Line Map Options

Line Map Specification

gpSetLineMapAxes Sets the X and Y axes to be used for the specified line map(s).

gpSetLineMapNames Sets names for all of the line maps in a frame.

gpSetLineMaps Sets all of the line maps for a frame.

gpSetLineMapZone Sets the zone in the data file to be used for the specified line map(s).

Line Layer Options

gpSetLineColor Sets the color of the line(s) in the specified line map(s).

gpSetLinePattern Sets the pattern of the line(s) in the specified line map(s).

2-4 Command Overview 2-5 Command Overview Specifies a weight variable for onecurve fits. or more Sets options for one orfits. more general curve Sets the file(s) to whichand curve fit data details are written. Sets the dependent variable for onecurve or fits. more Sets the number of points onthe the specified curve(s) line in map(s). Sets the order of the polynomialbe function used to for one or more curve fits. Sets the range of thefor independent the variable curve(s) in the specified line map(s). Sets the derivative at the beginningending and points of one or more spline fits. Sets the curve fit type ofspecified the line line(s) map(s). in the Sets the thickness of themap(s). line(s) in the specified line Activates or deactivates the line layerframe(s). in the specified Activates or deactivates the line layerline for map(s). the specified Sets the length of thespecified pattern line of map(s). the line(s) in the gpSetGeneralCurveFitOptions gpSetCurveFitType gpSetCurveFitWeightVariable gpSetCurveFitPolynomialOrder gpSetCurveFitRange gpSetCurveFitSplineClamp gpSetCurveFitDependentVariable gpSetCurveFitPoints gpSetCurveFitDataFile gpSetLinePatternLength gpShowLineLayer gpShowLineMapLineLayer gpSetLineThickness Curve Fit Options GAUSSplot 8.0

Symbol Layer Options

gpSetSymbolColor Sets the color of the symbols in the specified line map(s).

gpSetSymbolFillMode Sets the fill mode of the symbols in the specified line map(s).

gpSetSymbolLineThickness Sets the line thickness of the symbols in the specified line map(s).

gpSetSymbolShape Sets the shape of the symbols in the specified line map(s).

gpSetSymbolShapeASCII Sets the shape of the symbols in the specified line map(s) to an ASCII character.

gpSetSymbolSize Sets the size of the symbols in the specified line map(s).

gpSetSymbolSkip Sets the an option to show symbols at only a subset of the data points in the specified line map(s).

gpShowLineMapSymbolLayer Activates or deactivates the symbol layer for the specified line map(s).

gpShowSymbolLayer Activates or deactivates the symbol layer in the specified frame(s).

Bar Layer Options

gpSetBarColor Sets the color of the bars in the specified line map(s).

gpSetBarLineThickness Sets the thickness of the bar outlines in the specified line map(s).

gpSetBarOrientation Sets the orientation of the bars in the specified line map(s).

gpSetBarWidth Sets the width of the bars in the specified line map(s).

2-6 Command Overview 2-7 Command Overview Sets the color of thespecified error line bars map(s). in the Sets the line thickness ofthe the specified error line bars map(s). in Sets the length of thebars crossbar in for the the specified error line map(s). Sets an option to show errorsubset bars of at the only data a pointsline in map(s). the specified Sets the type of thespecified error line bars map(s). in the Sets the variable to be usedbars for in the the error specified line map(s). Activates or deactivates the error barin layer the specified frame(s). Activates or deactivates the error barfor layer the specified line map(s). Sets the color of thespecified percentile line box map(s). symbol for the Activates or deactivates the bar layerline for map(s). the specified Activates or deactivates the bar layerframe(s). in the specified gpSetBoxColor gpShowLineMapErrorBarLayer gpSetErrorBarVariable gpShowErrorBarLayer gpSetErrorBarSkip gpSetErrorBarType gpSetErrorBarLineThickness gpSetErrorBarSize gpShowBarLayer gpSetErrorBarColor gpShowLineMapBarLayer Percentile Box Symbol Options for Box plots Error Bar Layer Options GAUSSplot 8.0

gpSetBoxMinMaxMethod Sets the method by which the maximum and minimum values for the percentile box symbols in the specified frame are calculated.

gpSetBoxWidth Sets the width of the percentile box symbols for the line maps in the specified frame.

Adding Line Legends

gpAddLineLegend Adds a line legend to a frame.

gpMoveLineLegend Moves a line legend to a specified location in the frame.

gpSetLineLegendBoxColor Sets the colors of the outline and background of the box surrounding a line legend.

gpSetLineLegendBoxStyle Sets the style of the box surrounding a line legend.

gpSetLineLegendBoxThickness Sets the thickness of the outline of the box surrounding a line legend.

gpSetLineLegendBoxType Sets the type of the box surrounding a line legend.

gpSetLineLegendFont Sets the font used in a line legend.

gpSetLineLegendLineSpacing Sets the spacing between the lines of text in a line legend.

gpSetLineLegendMargin Sets the size of the margin between the line legend text and the surrounding box.

2-8 Command Overview 2-9 Command Overview Activates or deactivates the mesh layerthe for specified field zones(s). Activates or deactivates the mesh layerthe in specified frame(s). Sets the color of thefield mesh zone(s). in the specified Sets the mesh line patternfield in zone(s). the specified Sets the length of thethe mesh specified line field pattern zone(s). in Sets the line thickness ofspecified the field mesh zone(s). in the Sets the type of thefield mesh zone(s). in the specified Specifies which field zones are to be displayed. Sets the variable to be associatedframe. with each axis in a Sets names for all of the field zones in a frame. gpShowMeshLayer gpSetMeshType gpShowFieldZoneMeshLayer gpSetMeshLinePatternLength gpSetMeshLineThickness gpSetMeshColor gpSetMeshLinePattern gpSetActiveFieldZones gpSetAxisMap gpSetFieldZoneNames Mesh Layer Options Field Zone Specification 2.1.6 Setting Field Zone Options GAUSSplot 8.0

Contour Layer Options

gpAddContourLegend Adds a contour legend for the specified contour group(s).

gpMoveContourLegend Moves a contour legend to a specified location in the frame.

gpSetContourColorDistribution Sets the color map distribution of contour flooding for the specified contour group(s).

gpSetContourFloodGroup Sets the contour group to be used for contour flooding in the specified field zone(s).

gpSetContourLegendBoxColor Sets the colors of the outline and background of the box surrounding a contour legend.

gpSetContourLegendBoxStyle Sets the style of the box surrounding a contour legend.

gpSetContourLegendBoxThickness Sets the thickness of the outline of the box surrounding a contour legend.

gpSetContourLegendBoxType Sets the type of the box surrounding a contour legend.

gpSetContourLegendHeaderFont Sets the font used for the header text in a contour legend.

gpSetContourLegendLabelFont Sets the font used for the labels in a contour legend.

gpSetContourLegendLineSpacing Sets the spacing between the lines of text in a contour legend.

gpSetContourLegendMargin Sets the size of the margin between the contour legend text and the surrounding box.

2-10 Command Overview 2-11 Command Overview Sets the line pattern ofspecified the field vectors in zone(s). the Sets the length of thethe vector line specified pattern field in zone(s). Sets the contour group tocontour be lines used in for the specified field zone(s). Sets the contour variable for thecontour specified group(s). Activates or deactivates the contour layer in the specified frame(s). Activates or deactivates contour lines and flooding in the specified field zones(s). Projects the vectors in the vectorthe layer 3D onto field zone surface. Sets the arrow head type forthe the specified vectors field in zone(s). Sets the color of thefield vectors in zone(s). the specified Sets the orientation of a contour legend. Sets an option to show onlycontour a levels in subset a of contour the legend. Sets view options for a contour legend. Sets the color of thespecified contour field lines zone(s). in the gpSetVectorLinePatternLength gpSetVectorColor gpSetVectorLinePattern gpMakeVectorsTangent gpSetVectorArrowHeadType gpShowFieldZoneContourLayer gpSetContourVariable gpShowContourLayer gpSetContourLineColor gpSetContourLineGroup gpSetContourLegendSkip gpSetContourLegendView gpSetContourLegendOrientation Vector Layer Options GAUSSplot 8.0

gpSetVectorLineThickness Sets the line thickness of the vectors in the specified field zone(s).

gpSetVectorType Sets the type of the vectors in the specified field zone(s).

gpSetVectorVariables Sets the variables to use as the vector components for the vectors in the specified field zone(s).

gpShowFieldZoneVectorLayer Activates or deactivates the vector layer for the specified field zones(s).

gpShowVectorLayer Activates or deactivates the vector layer in the specified frame(s).

Scatter Layer Options

gpSetScatterColor Sets the color of the scatter symbols in the specified field zone(s).

gpSetScatterFillMode Sets the fill mode of the scatter symbols in the specified field zone(s).

gpSetScatterLineThickness Sets the line thickness of the scatter symbols in the specified field zone(s).

gpSetScatterShape Sets the shape of the scatter symbols in the specified field zone(s).

gpSetScatterShapeASCII Sets the shape of the scatter symbols in the specified field zone(s) to an ASCII character.

gpSetScatterSize Sets the size of the scatter symbols in the specified field zone(s).

gpShowFieldZoneScatterLayer Activates or deactivates the scatter layer for the specified field zones(s).

2-12 Command Overview 2-13 ect to use in the Command Overview ff Sets the lighting e specified field zone(s). Activates or deactivates contour lighting for the specified field zone(s). Activates or deactivates the shade layerthe for specified field zones(s). Activates or deactivates the shade layerthe in specified frame. Sets the color of thespecified boundary field line zone(s). in the Sets the thickness of thethe boundary specified line field in zone(s). Activates or deactivates the boundary layer in the specified frame(s). Activates or deactivates the boundary layer for the specified field zones(s). Activates or deactivates the scatter layerthe in specified frame(s). Sets the color of thespecified shading field in zone(s). the gpUseFieldZoneContourLighting gpSetLightingEffect gpShowBoundaryLayer gpShowFieldZoneBoundaryLayer gpSetBoundaryColor gpSetBoundaryThickness gpShowShadeLayer gpSetShadeColor gpShowFieldZoneShadeLayer gpShowScatterLayer Boundary Layer Options Lighting Effect Options Shade Layer Options GAUSSplot 8.0

gpUseFieldZoneShadeLighting Activates or deactivates shade lighting for the specified field zone(s).

gpUseLightingEffect Activates or deactivates the lighting effect in the specified frame(s).

Translucency Effect Options

gpSetTranslucency Sets the percentage of translucency in the specified field zone(s).

gpUseFieldZoneTranslucency Activates or deactivates the translucency effect for the specified field zone(s).

gpUseTranslucencyEffect Activates or deactivates the translucency effect in the specified frame(s).

Adding Field Zone Legends

gpAddFieldZoneLegendFrame Adds a field zone legend frame as an inset in the specified frame.

gpMoveFieldZoneLegend Moves a field zone legend frame to a specified location in the parent frame.

gpSetFieldZoneLegendBoxColor Sets the colors of the outline and background of the box surrounding a field zone legend.

gpSetFieldZoneLegendBoxStyle Sets the style of the box surrounding a field zone legend.

gpSetFieldZoneLegendBoxThickness Sets the thickness of the outline of the box surrounding a field zone legend.

gpSetFieldZoneLegendBoxType Sets the type of the box surrounding a field zone legend.

2-14 Command Overview 2-15 Command Overview Specifies whether or not thefilled. grid area is Sets a title for a field zone legend. Sets the font of thelegend. title in a field zone Sets size of margin between thefield top zone of legend text the and thesurrounding top box. of the Sets the font used in a field zoneSets legend. the spacing between the linesa of field text zone in legend. Sets size of margin between thethe bottom field of zone legend text andthe the surrounding bottom box. of Specifies which surfaces are toCartesian be (or displayed 3D for Contour) a volume 3D plot. Sets the range of I-planesplane to surface display plotting. in I, IJ, IK or IJK Sets the range of J-planesplane to surface display plotting. in J, JK, IJ or IJK Sets the range of K-planesIJK to plane display surface in plotting. K, IK, JK or gpFillGridArea gpSetKPlaneRange gpSetSurfacesToPlot gpSetIPlaneRange gpSetJPlaneRange gpSetFieldZoneLegendUpperMargin gpSetFieldZoneLegendTitle gpSetFieldZoneLegendTitleFont gpSetFieldZoneLegendLineSpacing gpSetFieldZoneLegendLowerMargin gpSetFieldZoneLegendFont X,Y,Z Axes Options 2.1.7 Setting Axes Options Surface Plotting Options For Volume Plots GAUSSplot 8.0

gpMakeAxesIndependent Allows the axes to be sized independently.

gpMakeAxesXYDependent Makes the X and Y axes dependent on each other, so they may not be sized independently.

gpMakeAxesXYZDependent Makes the X, Y and Z axes dependent on one another, so they may not be sized independently.

gpPositionGrid Positions the grid in the frame.

gpPositionXAxis Positions an X-axis.

gpPositionYAxis Positions a Y-axis.

gpSetGridAreaFillColor Sets the fill color for the grid area in a frame.

gpSetLineMapAxes Sets the X and Y axes to be used for the specified line map(s).

gpSetXAxisColor Sets the color of an X-axis.

gpSetXAxisGridLineColor Sets the color of the X-axis major gridlines.

gpSetXAxisGridLineThickness Sets the thickness of the X-axis major gridlines.

gpSetXAxisGridPattern Sets the pattern of the X-axis major gridlines.

gpSetXAxisGridPatternLength Sets the length of the X-axis major gridline pattern.

gpSetXAxisLabelColor Sets the color of X-axis tick labels.

gpSetXAxisLabelFont Sets the type and size of the font used for X-axis tick labels.

gpSetXAxisLabelOffset Sets the offset of X-axis tick labels from the axis line.

2-16 Command Overview 2-17 Command Overview set of an X-axis title from the ff Sets the color of the Y-axis major gridlines. Sets the thickness of thegridlines. Y-axis major Sets the pattern of thegridlines. Y-axis major Sets the length of thepattern. X-axis minor gridline Sets the range of an X-axis. Sets the thickness of an X-axis line. Sets the distance between majorand tick the marks number of minorX-axis. tick marks on an Sets the title for an X-axis. Sets the color of an X-axis title. Sets the type and sizean of X-axis the title. font used for Sets the o axis line. Sets the color of a Y-axis. Sets an option to show onlyX-axis a tick subset labels. of Sets the color of the X-axis minor gridlines. Sets the thickness of thegridlines. X-axis minor Sets the pattern of thegridlines. X-axis minor gpSetYAxisGridPattern gpSetYAxisColor gpSetYAxisGridLineColor gpSetYAxisGridLineThickness gpSetXAxisTitleFont gpSetXAxisTitleOffset gpSetXAxisTicks gpSetXAxisTitle gpSetXAxisTitleColor gpSetXAxisRange gpSetXAxisThickness gpSetXAxisMinorGridPattern gpSetXAxisMinorGridPatternLength gpSetXAxisMinorGridLineColor gpSetXAxisMinorGridLineThickness gpSetXAxisLabelSkip GAUSSplot 8.0

gpSetYAxisGridPatternLength Sets the length of the Y-axis major gridline pattern.

gpSetYAxisLabelColor Sets the color of Y-axis tick labels.

gpSetYAxisLabelFont Sets the type and size of the font used for Y-axis tick labels.

gpSetYAxisLabelOffset Sets the offset of Y-axis tick labels from the axis line.

gpSetYAxisLabelSkip Sets an option to show only a subset of Y-axis tick labels.

gpSetYAxisMinorGridLineColor Sets the color of the Y-axis minor gridlines.

gpSetYAxisMinorGridLineThickness Sets the thickness of the Y-axis minor gridlines.

gpSetYAxisMinorGridPattern Sets the pattern of the Y-axis minor gridlines.

gpSetYAxisMinorGridPatternLength Sets the length of the Y-axis minor gridline pattern.

gpSetYAxisRange Sets the range of a Y-axis.

gpSetYAxisThickness Sets the thickness of a Y-axis line.

gpSetYAxisTicks Sets the distance between major tick marks and the number of minor tick marks on a Y-axis.

gpSetYAxisTitle Sets the title for a Y-axis.

gpSetYAxisTitleColor Sets the color of a Y-axis title.

gpSetYAxisTitleFont Sets the type and size of the font used for a Y-axis title.

gpSetYAxisTitleOffset Sets the offset of a Y-axis title from the axis line.

2-18 Command Overview 2-19 Command Overview set of the Z-axis tick labels from ff the axis line. Sets the range of the Z-axis. Sets the thickness of the Z-axis line. Sets the distance between majorand tick the marks number of minorZ-axis. tick marks on the Sets the length of thepattern. Z-axis major gridline Sets the color of the Z-axis tick labels. Sets the type and sizethe of Z-axis the tick font labels. used for Sets the o Sets an option to show onlyZ-axis a tick subset labels. of the Sets the color of the Z-axis minor gridlines. Sets the thickness of thegridlines. Z-axis minor Sets the pattern of thegridlines. Z-axis minor Sets the length of thepattern. Z-axis minor gridline Sets the color of the Z-axis. Sets the color of the Z-axis major gridlines. Sets the thickness of thegridlines. Z-axis major Sets the pattern of thegridlines. Z-axis major gpSetZAxisTicks gpSetZAxisMinorGridPatternLength gpSetZAxisRange gpSetZAxisThickness gpSetZAxisMinorGridLineThickness gpSetZAxisMinorGridPattern gpSetZAxisLabelSkip gpSetZAxisMinorGridLineColor gpSetZAxisLabelColor gpSetZAxisLabelFont gpSetZAxisLabelOffset gpSetZAxisGridPattern gpSetZAxisGridPatternLength gpSetZAxisGridLineColor gpSetZAxisGridLineThickness gpSetZAxisColor GAUSSplot 8.0

gpSetZAxisTitle Sets the title for the Z-axis.

gpSetZAxisTitleColor Sets the color of the Z-axis title.

gpSetZAxisTitleFont Sets the type and size of the font used for the Z-axis title.

gpSetZAxisTitleOffset Sets the offset of the Z-axis title from the axis line.

gpShow3DOrientationAxis Activates or deactivates display of the 3-D orientation axis in a frame.

gpShowXAxis Activates or deactivates display of an X-axis in a frame.

gpShowXAxisGridLines Activates or deactivates display of X-axis major gridlines in a frame.

gpShowXAxisLabels Activates or deactivates display of X-axis tick labels in a frame.

gpShowXAxisMinorGridLines Activates or deactivates display of X-axis minor gridlines in a frame.

gpShowXAxisTicks Activates or deactivates display of X-axis tick marks in a frame.

gpShowYAxis Activates or deactivates display of a Y-axis in a frame.

gpShowYAxisGridLines Activates or deactivates display of Y-axis major gridlines in a frame.

gpShowYAxisLabels Activates or deactivates display of Y-axis tick labels in a frame.

gpShowYAxisMinorGridLines Activates or deactivates display of Y-axis minor gridlines in a frame.

gpShowYAxisTicks Activates or deactivates display of Y-axis tick marks in a frame.

2-20 Command Overview 2-21 Command Overview Activates or deactivates display of Z-axis minor gridlines in a frame. Activates or deactivates display of Z-axis tick marks in a frame. Activates or deactivates light source shading in the grid area. Activates or deactivates log scaling onX-axis. an Activates or deactivates log scaling onY-axis. a Activates or deactivates display of the Z-axis in a frame. Activates or deactivates display of Z-axis major gridlines in a frame. Activates or deactivates display of Z-axis tick labels in a frame. set of the R-axis tick labels from the axis ff line. Sets the fill color for the grid areaSets in the a titles frame. for the polar axes. Sets the color of the R-axis. Sets the color of the R-axis tick labels. Sets the type and sizetick of labels. the font used for the R-axis Sets the o Specifies whether or not the grid area is filled. gpSetRAxisLabelOffset gpSetPolarAxesTitles gpSetRAxisColor gpSetRAxisLabelColor gpSetRAxisLabelFont gpFillGridArea gpSetGridAreaFillColor gpUseYAxisLogScaling gpUseGridAreaLighting gpUseXAxisLogScaling gpShowZAxisLabels gpShowZAxisMinorGridLines gpShowZAxisTicks gpShowZAxisGridLines gpShowZAxis Polar Axes Options GAUSSplot 8.0

gpSetRAxisLabelSkip Sets an option to show only a subset of the R-axis tick labels.

gpSetRAxisRange Sets the range of the R-axis.

gpSetRAxisThickness Sets the thickness of the R-axis line.

gpSetRAxisTicks Sets the distance between major tick marks and the number of minor tick marks on the R-axis.

gpSetRAxisTitle Sets the title for the R-axis.

gpSetRAxisTitleColor Sets the color of the R-axis title.

gpSetRAxisTitleFont Sets the type and size of the font used for the R-axis title.

gpSetRAxisTitleOffset Sets the offset of the R-axis title from the axis line.

gpSetThetaAxisColor Sets the color of the Theta-axis.

gpSetThetaAxisLabelColor Sets the color of the Theta-axis tick labels.

gpSetThetaAxisLabelFont Sets the type and size of the font used for the Theta-axis tick labels.

gpSetThetaAxisLabelOffset Sets the offset of the Theta-axis tick labels from the axis line.

gpSetThetaAxisLabelSkip Sets an option to show only a subset of the Theta-axis tick labels.

gpSetThetaAxisRange Sets the range of the Theta-axis.

gpSetThetaAxisThickness Sets the thickness of the Theta-axis line.

gpSetThetaAxisTicks Sets the distance between major tick marks and the number of minor tick marks on the Theta-axis.

gpSetThetaAxisTitle Sets the title for the Theta-axis.

gpSetThetaAxisTitleColor Sets the color of the Theta-axis title.

2-22 Command Overview 2-23 or vertically. / Command Overview set of the Theta-axis title from the axis line. ff Sets the o Translates a plot horizontally and Activates 3D perspective in a framethe so plot that is the dependent shape on of angle. the specified field of view Resizes a plot. Controls how a plot is sized to the frame. Rotates a plot about the X, Y and ZRotates axes. a plot about the X-axis. Rotates a plot about the Y-axis. Rotates a plot about the Z-axis. Sets the distance between thepoint viewer and of the a center plot. Sets the position of the viewer in 3D grid coordinates. Specifies whether theta should beor measured radians. in degrees Sets the theta range of a complete circle. Specifies which polar axes are toframe. be displayed in a Sets the type and size oftitle. the font used for the Theta-axis gpSetPlotFit gpSetTranslation gpSetMagnification gpSet3DViewerPosition gpUse3DPerspective gpRotateXAxis gpRotateYAxis gpRotateZAxis gpSet3DViewDistance gpRotateAxes gpSetThetaAxisTitleFont gpSetThetaPeriod gpShowPolarAxes gpSetThetaAxisTitleOffset gpSetThetaMode 2.1.8 Sizing and Positioning the Graph 3D Perspective and Rotation GAUSSplot 8.0

2.1.9 Animation

gpAnimate3DRotation Animates the rotation of a plot about the X,Y and Z axes.

gpAnimateFieldZones Cycles through the specified field zones one at a time to produce animation.

gpAnimateLineMaps Cycles through the specified line maps one at a time to produce animation.

gpAnimateXAxisRotation Animates the rotation of a plot about the X-axis.

gpAnimateYAxisRotation Animates the rotation of a plot about the Y-axis.

gpAnimateZAxisRotation Animates the rotation of a plot about the Z-axis.

2.1.10 Setting Frame Options

gpMoveFrame Moves a frame to a specified location.

gpSetFrameBackgroundColor Sets the background color for a frame.

gpSetFrameHeaderColor Sets the header color for a frame.

gpSetFrameHeaderText Sets the text to be displayed in all frame headers.

gpSetFrameName Sets the name for a frame.

gpSetFrameStyle Sets style options for a frame.

gpSetTileMargins Sets the margins between the frames and the edges of the paper for the gpTile command.

gpTile Tiles frames in the workspace.

2-24 Command Overview 2-25 Command Overview Sets the spacing between the linesa of text text object. in Sets the size of thein margin between a the text object text and the surrounding box. Sets the default font toobjects. be used for text Sets the anchor location of a text object. Sets the colors of thebackground outline of and the box surroundingobject. a text Sets the style of theobject. box surrounding a text Sets the thickness of thesurrounding outline a of text the object. box Sets the type of theobject. box surrounding a text Sets the color of the text in a text object. the type and size ofobject. the font used in a text Adds a text object to a frame. Adds a text object to aposition frame in at 3D a grid specified coordinates. Rotates a text object from the horizontal. gpSetTextObjectMargin gpSetTextObjectFont gpSetTextObjectLineSpacing gpSetTextObjectBoxType gpSetTextObjectColor gpSetTextObjectBoxStyle gpSetTextObjectBoxThickness gpSetTextObjectAnchorLocation gpSetTextObjectBoxColor gpRotateTextObject gpSetDefaultTextFont gpAddTextObject gpAddTextObject3D 2.1.11 Adding Text GAUSSplot 8.0

2.1.12 Adding Arrows

gpAddArrow Adds an arrow to a frame. gpSetArrowColor Sets the color of an arrow. gpSetArrowHeadAngle Sets the angle that one side of an arrow head makes with the arrow line segment. gpSetArrowHeadAttachment Specifies to which end of an arrow the arrow head is attached. gpSetArrowHeadSize Sets the size of an arrow. gpSetArrowHeadStyle Sets the style of the head of an arrow. gpSetArrowHeadType Sets the type of arrow head to use for an arrow. gpSetArrowLinePattern Sets the pattern of the arrow line segment. gpSetArrowLinePatternLength Sets the length of the arrow line segment pattern. gpSetArrowLineThickness Sets the line thickness of the arrow line segment.

2.1.13 Adding Line Segments

gpAddLineSegment Adds a line segment to a frame. gpAddLineSegment3D Adds a line segment to a frame at a specified position in 3D grid coordinates. gpSetLineSegmentColor Sets the color of a line segment. gpSetLineSegmentPattern Sets the pattern of the line segment. gpSetLineSegmentPatternLength Sets the length of the line segment pattern. gpSetLineSegmentThickness Sets the thickness of the line segment.

2-26 Command Overview 2-27 Command Overview 2 format graphics file. / Specifies whether or not ais geometry filled. object Sets the color of a geometry object. Sets the fill color of a geometry object. Sets the line pattern of the geometry object. Sets the length of thepattern. geometry object line Sets the line thickness ofobject. the geometry Sets the number of sidescircular approximating or a elliptical geometry object. Adds a circular geometry to a frame. Adds an elliptical geometry to a frame. Adds a rectangular geometry to a frame. Adds a square geometry to a frame. Exports a graph to an HP-GL Exports a graph to agraphics Windows file. (BMP) format Exports a graph to anformat Encapsulated graphics PostScript file. (EPS) Exports a graph to an HP-GL format graphics file. gpExportHPGL gpExportHPGL2 gpExportBMP gpExportEPS gpSetGeometryNumSides gpSetGeometryLinePatternLength gpSetGeometryLineThickness gpSetGeometryColor gpSetGeometryFillColor gpSetGeometryLinePattern gpAddRectangle gpAddSquare gpFillGeometry gpAddCircle gpAddEllipse 2.1.15 Printing and Exporting 2.1.14 Adding Other Geometries GAUSSplot 8.0

gpExportJPEG Exports a graph to a Joint Photographic Experts Group (JPEG) format graphics file.

gpExportPNG Exports a graph to a Portable Network Graphics (PNG) file.

gpExportPS Exports a graph to a PostScript (PS) format graphics file.

gpExportRAS Exports a graph to a Sun Raster (RAS) format graphics file.

gpExportTIFF Exports a graph to a Tagged Image File Format (TIFF) graphics file.

gpExportWMF Exports a graph to a Windows Meta File (WMF) format graphics file.

gpExportXWD Exports a graph to an X-Windows Format () graphics file.

gpPrint Prints a graph.

gpPrintToFile Specifies a print output file name or deactivates printing to a file.

gpSetExportImageWidth Specifies the width of the exported image in pixels.

gpSetExportJPEGQuality Sets the quality of the output JPEG graphics file.

gpSetPaperOrientation Sets the orientation of the page on which the graph is displayed.

gpSetPaperSize Sets the size of the page on which the graph is displayed.

gpSetPrintFormat Sets the print output format for printing on UNIX or Linux.

gpSetPrintPalette Sets the print/export palette to monochrome or color.

2-28 Command Overview 2-29 Command Overview Writes a data file andcontaining draws a a graph HistP with plot one (percentage frame histogram). Writes a data file andcontaining draws a a graph LogLog with plot. one frame Writes a data file andcontaining draws a a graph LogX with plot. one frame Writes a data file andcontaining draws a a graph LogY with plot. one frame Writes a data file andcontaining draws a a graph Polar with Line one plot. frame Writes a data file andcontaining draws a a graph Box with plot one (box frame graph percentile plot). Writes a data file andcontaining draws a a graph Hist with plot one (frequency histogram). frame Writes a data file andcontaining draws a a graph HistF with plot one (frequency histogram),vector frame of given a frequency counts. Writes a data file andcontaining draws a a graph 2D with Cartesian one plot. frame Writes a data file andcontaining draws a a graph 2D with Contour one plot. frame Writes a data file andcontaining draws a a graph 3D with Cartesian one plot. frame Writes a data file andcontaining draws a a graph 3D with Contour one plot. frame Writes a data file andcontaining draws a a graph Bar with plot. one frame gpMakePolarLinePlot gpMakeLogXPlot gpMakeLogYPlot gpMakeHistPPlot gpMakeLogLogPlot gpMakeHistPlot gpMakeHistFPlot gpMakeBarPlot gpMakeBoxPlot gpMake2DContourPlot gpMake3DCartesianPlot gpMake3DContourPlot gpMake2DCartesianPlot 2.1.16 Plotting the Graph GAUSSplot 8.0

gpMakeXYLinePlot Writes a data file and draws a graph with one frame containing an XY Line plot.

gpPlot Draws a graph.

2.1.17 Miscellaneous Commands

gpAddMacroFile Adds one or more macro files to a plot control structure, to be run at the end of the macro file created with the structure data.

gpCleanUp Deletes the data, macro and structure files associated with a graph.

gpFramePause Pauses drawing for a specified number of seconds after drawing for a frame is completed.

gpGetErrorMessage Returns the error message associated with a particular error code.

gpOpenLayoutFile Opens a layout file in GAUSSplot.

gpRedefineColor Sets the RGB values for a color in the color palette.

gpRunMacroFile Runs a macro file in GAUSSplot.

gpSetErrorLevel Sets the level of error handling in your program.

gpSetPaperOrientation Sets the orientation of the page on which the graph is displayed.

gpSetPaperSize Sets the size of the page on which the graph is displayed.

gpSetWorkspaceView Sets workspace view options.

gpShowDrawing Specifies whether or not drawing is shown.

gpWait Specifies whether GAUSSplot will return to GAUSS immediately or wait until the GAUSSplot window has been closed.

2-30 Command Overview 2-31 1 global × Command Overview 1 Black2 White3 Red4 Yellow5 35 Green6 Custom27 36 Cyan7 Custom28 38 37 Blue8 Custom30 Custom29 Purple9 39 Custom1 Custom31 40 Custom32 41 42 43 Custom33 Custom34 Custom35 10 Custom211 Custom312 Custom413 44 Custom514 Custom36 45 Custom615 Custom37 46 Custom716 Custom38 47 Custom817 Custom39 48 Custom918 Custom40 49 Custom1019 Custom41 50 Custom1120 Custom42 51 52 Custom1221 Custom43 Custom44 53 Custom1322 Custom45 54 Custom1423 Custom46 55 Custom15 Custom47 56 Custom48 57 Custom49 Index Color Index Color , which is defined as follows: color palette contains 68 colors. The color names are stored in the 68 uses global variables to contain all of the available options for certain command input _gp_colors GAUSSplot The 2.2.1 GAUSSplot Colors arguments. These options may bewhich referenced they by are name contained. or by index into the global variable in GAUSSplot 2.2 Global Variables vector GAUSSplot 8.0

Index Color Index Color 24 Custom16 58 Custom50 25 Custom17 59 Custom51 26 Custom18 60 Custom52 27 Custom19 61 Custom53 28 Custom20 62 Custom54 29 Custom21 63 Custom55 30 Custom22 64 Custom56 31 Custom23 65 Multi 32 Custom24 66 Multi2 33 Custom25 67 Multi3 34 Custom26 68 Multi4

Any of the solid colors (_gp_colors[1:64]) may be redefined using user-specified RGB values by calling gpRedefineColor.

Colors ‘Multi’, ‘Multi2’, ‘Multi3’, and ‘Multi4’ (_gp_colors[65:68]) may be used only for mesh, contour lines, vectors, and scatter symbols. They use the contour variable for the corresponding contour group (1 - 4) to determine the color displayed at each point. The default contour variable for all contour groups is the last variable in the data file. To specify a different contour variable, call gpSetContourVariable.

2.2.2 GAUSSplot Fonts

GAUSSplot includes nine fonts, which can be used for any text included in a graph. The font names are stored in the 11×1 global vector _gp_fonts, which is defined as follows:

2-32 Command Overview 2-33 . Command Overview and GAUSSplot 1 global vector × gpShowSymbolLayer 1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot 1 Courier 2 CourierBold 3 Helv4 (helvetica) HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef Index Line Pattern Index Font erent kinds of line patterns which can be used for any lines, mesh, ff , which is defined as follows: for a table that lists all of the available characters in , there are six di A includes eleven preset symbol shapes to represent data points in a graph when the GAUSSplot GAUSSplot either the symbol or scatter layer is turned on (see 2.2.4 GAUSSplot Symbols In 2.2.3 GAUSSplot Line Patterns arrows, etc. in a graph._gp_line_patterns The line pattern names are stored in the 6 See Appendix GAUSSplot 8.0 gpShowScatterLayer). The symbol names are stored in the 11×1 global vector _gp_symbols, which is defined as follows:

Index Symbol Shape 1 Square 2 Del (delta) 3 Grad (gradient) 4 RTri (right triangle) 5 LTri (left triangle) 6 Diamond 7 Circle 8 Point 9 Cube 10 Sphere 11 Octahedron

Only _gp_symbols[1:7] may be used in Bar, XY Line and Polar Line plots.

2.2.5 GAUSSplot Error Messages

All of the error messages used by GAUSSplot are stored in the global variable _gp_error_messages, which is defined as follows:

Index Error Message 1 Frame index out of range 2 Line Map index out of range 3 Cannot access variable names in structure file - Use variable indices 4 Invalid plot type 5 Invalid variable names 6 Invalid argument 7 Plot type not set

2-34 Command Overview 2-35 Command Overview is set to a scalar 1 in your _gp_debug if stderr 8 Could9 not delete all associated Arguments files not conformable 10 Cannot11 open file for write Cannot12 write to file: out Number of13 of disk variable space names does not Contour14 match Group number index out of of variables range Index15 out of range Invalid16 object name Data17 array must have 3 or No18 4 data dimensions file specified Variables do19 not match Invalid20 curve fit type Variables must21 be 2 or 3-dimensional Cannot22 open structure file Frame23 does not contain a Field field24 zone zone legend legend does not contain Argument25 out a of title range Wrong26 object type Too many frames, use gpPlot to plot the graph Index Error Message prints debugging information to program. By default, it is set to 0. GAUSSplot 2.2.6 GAUSSplot Debugging

Command Reference 3-1 or 3 sets the plot type of the entire gpMake2DCartesianPlot gp2DCartesianPlotCreate . structure and initializes its members to default gpPlotCreate gp2DCartesianPlotCreate to plot a graph using either gp Command Reference plot control structure with itsCartesian members plot. set to default values for a 2D gpPlotControl . Calling erent types, use ff = gp2DCartesianPlotCreate; gpPlot graph to 2D Cartesian. To createof a di graph with multiple frames that contain plots gaussplot gp gp You may use Creates a values for a 2D Cartesian plot. FORMAT OUTPUT LIBRARY PURPOSE REMARKS gp2DContourPlotCreate

A plot control structure initialized with gp2DCartesianPlotCreate contains one frame by default.

EXAMPLE library gaussplot; #include gp.sdf

// Generate data x = seqa(1,5,20); y = seqa(10,2,20).*log(x’); x = x’.*ones(20,20); string vnames = { "V1", "V2" };

struct gpPlotControl gp; gp = gp2DCartesianPlotCreate; ret = gpMake2DCartesianPlot(&gp,x,y,vnames);

This example illustrates how you may create a 2D Cartesian plot with one field zone, using defaults for all style and display options. The first variable (V1) will be associated with the X-axis, and the second variable (V2) with the Y-axis.

SOURCE gpcartesianplot.src

SEE ALSO gpMake2DCartesianPlot, gpPlot

gp2DContourPlotCreate

PURPOSE Creates a gpPlotControl structure and initializes its members to default values for a 2D Contour plot.

LIBRARY gaussplot

FORMAT gp = gp2DContourPlotCreate;

OUTPUT gp plot control structure with its members set to default values for a 2D

3-2 GAUSS C R Command Reference 3-3 ) will V1 or contains ) with the Y-axis, and the V2 gp3DCartesianPlotCreate sets the plot type of the entire gpMake2DContourPlot gp2DContourPlotCreate . gpPlot , gpPlotCreate ) will be the contour variable. gp2DContourPlotCreate to plot a graph using either V3 gp Contour plot. . Calling  erent types, use R ff library gaussplot; #include gp.sdf // Generate data p = pi; x = seqa(0,p/4,15)’; y = seqa(0,p/4,15); cv = cos(x).*sin(x-y); x = x.*ones(15,15); y = y.*ones(15,15); string vnames = { "V1",struct "V2", gpPlotControl "V3" gp; }; gp = gp2DContourPlotCreate; ret = gpMake2DContourPlot(&gp,x,y,cv,vnames); gpcontourplot.src gpMake2DContourPlot one frame by default. You may use graph to 2D Contour. To createof a di graph with multiple frames that contain plots This example illustrates how you mayzone, create using a defaults 2D for Contour all plot style with and one display field options. The first variable ( gpPlot A plot control structure initialized with be associated with the X-axis,third the variable second ( variable (  C  SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gp3DCartesianPlotCreate

gp3DCartesianPlotCreate

PURPOSE Creates a plot control structure and initializes its members to default values for a 3D Cartesian plot.

LIBRARY gaussplot

FORMAT gp = gp3DCartesianPlotCreate;

OUTPUT gp plot control structure with its members set to default values for a 3D Cartesian plot.

REMARKS You may use gp to plot a graph using either gpMake3DCartesianPlot or gpPlot. Calling gp3DCartesianPlotCreate sets the plot type of the entire graph to 3D Cartesian. To create a graph with multiple frames that contain plots of different types, use gpPlotCreate.

A plot control structure initialized with gp3DCartesianPlotCreate contains one frame by default.

EXAMPLE library gaussplot; #include gp.sdf

// Generate data p = pi; x = seqa(0,p/4,15)’; y = seqa(0,p/4,15);

z = cos(x).*sin(x-y); x = x.*ones(15,15); y = y.*ones(15,15); string vnames = { "V1", "V2", "V3" };

struct gpPlotControl gp;

3-4 GAUSS C R Command Reference 3-5 ) will V1 or contains ) with the Y-axis, and the V2 gp3DContourPlotCreate sets the plot type of the entire gp3DContourPlotCreate gpMake3DContourPlot gp3DContourPlotCreate . gpPlot , gpPlotCreate ) with the Z-axis. gp3DContourPlotCreate to plot a graph using either V3 gp plot control structure with itsContour members plot. set to default values for a 3D . Calling  erent types, use R ff = gp3DContourPlotCreate; library gaussplot; gp = gp3DCartesianPlotCreate; ret = gpMake3DCartesianPlot(&gp,x,y,z,vnames); Creates a plot control structurea and 3D initializes Contour its plot. members to default values for gaussplot gp gp You may use one frame by default. gpcartesianplot.src gpMake3DCartesianPlot graph to 3D Contour. To createof a di graph with multiple frames that contain plots This example illustrates how you mayzone, create using a defaults 3D for Cartesian all plot style with and one display field options. The first variable ( gpPlot A plot control structure initialized with be associated with the X-axis,third the variable second ( variable (  C  FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpAdd2DCartesianFrame

#include gp.sdf

// Generate data p = pi; x = seqa(0,p/4,15)’; y = seqa(0,p/4,15);

z = cos(x).*sin(x-y); cv = sin(x).*cos(x-y); x = x.*ones(15,15); y = y.*ones(15,15); string vnames = { "V1", "V2", "V3", "V4" };

struct gpPlotControl gp; gp = gp3DContourPlotCreate; ret = gpMake3DContourPlot(&gp,x,y,z,cv,vnames);

This example illustrates how you may create a 3D Contour plot with one field zone, using defaults for all style and display options. The first variable (V1) will be associated with the X-axis, the second variable (V2) with the Y-axis, the third variable (V3) with the Z-axis, and the fourth variable (V4) will be the contour variable.

SOURCE gpcontourplot.src

SEE ALSO gpMake3DContourPlot, gpPlot

gpAdd2DCartesianFrame

PURPOSE Adds a 2D Cartesian plot frame to a gpPlotControl structure creted with gpPlotCreate or gp2DCartesianPlotCreate.

LIBRARY gaussplot

3-6 GAUSS C R Command Reference 3-7 erent variables for the ff gpAdd2DCartesianFrame to use di creates a frame with one field zone and ); gpSetAxisMap pgp to draw the graph. gpAdd2DCartesianFrame pointer to a plot control structure.  R gpPlot library gaussplot; #include gp.sdf struct gpPlotControl gp; gp = gpPlotCreate; ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAdd2DCartesianFrame(&gp); gpAdd3DContourFrame(&gp); framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); framenum = 2; xpos = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp); axes. Frames are numbered in the order in which they areUse added, beginning with one. associates the first variable in thevariable with data the file Y-axis. with Use the X-axis and the second gpAdd2DCartesianFrame( pgp By default,  C  INPUT FORMAT EXAMPLE REMARKS GAUSS gpAdd2DContourFrame

The preceding example creates a graph with two frames. The first contains a 2D Cartesian plot, and the second a 3D Contour plot. The frames are moved and resized so that the second frame is an inset drawn in the lower left-hand corner of the first frame. This example assumes that mydata.plt already exists and contains at least three variables.

SOURCE gpcartesianplot.src

SEE ALSO gpPlotCreate, gp2DCartesianPlotCreate, gpPlot

gpAdd2DContourFrame

PURPOSE Adds a 2D Contour plot frame to a gpPlotControl structure created with gpPlotCreate or gp2DContourPlotCreate.

LIBRARY gaussplot

FORMAT gpAdd2DContourFrame(pgp);

INPUT pgp pointer to a plot control structure.

REMARKS By default, gpAdd2DContourFrame creates a frame with one field zone and associates the first variable in the data file with the X-axis, the second variable with the Y-axis, and uses the last variable as the contour variable. Use gpSetAxisMap to use different variables for the axes, and gpSetContourVariable to change the contour variable.

Frames are numbered in the order in which they are added, beginning with one.

Use gpPlot to draw the graph.

EXAMPLE library gaussplot; #include gp.sdf

3-8 GAUSS C R Command Reference 3-9 already exists and gpAdd3DCartesianFrame gpPlot mydata.plt , gpAdd3DCartesianFrame gp2DContourPlotCreate ,  R struct gpPlotControl gp; gp = gpPlotCreate; ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAdd2DContourFrame(&gp); gpAdd3DContourFrame(&gp); framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); framenum = 2; xpos = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp); gpcontourplot.src gpPlotCreate The above example creates a graphContour with plot, two and frames. the second Theresized a first so 3D contains that Contour a the plot. 2D second Theof frame frames the is are first an moved frame. inset and drawn Thiscontains in example at the assumes least lower that left-hand three corner variables.  C  SOURCE SEE ALSO GAUSS gpAdd3DCartesianFrame

PURPOSE Adds a 3D Cartesian plot frame to a gpPlotControl structure created with gpPlotCreate or gp3DCartesianPlotCreate.

LIBRARY gaussplot

FORMAT gpAdd3DCartesianFrame(pgp);

INPUT pgp pointer to a plot control structure.

REMARKS By default, gpAdd3DCartesianFrame creates a frame with one field zone and associates the first variable in the data file with the X-axis, the second variable with the Y-axis, and the third variable with the Z-axis. Use gpSetAxisMap to use different variables for the axes.

Frames are numbered in the order in which they are added, beginning with one.

Use gpPlot to draw the graph.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpPlotCreate;

ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAdd2DContourFrame(&gp); gpAdd3DCartesianFrame(&gp);

framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height);

framenum = 2; xpos = 2;

3-10 GAUSS C R Command Reference 3-11 already exists and structure created with erent variables for the axes ff gpPlot gpAdd3DContourFrame , . mydata.plt gpAdd3DContourFrame to use di creates a frame with one field zone and gpPlotControl to change the contour variable. ); pgp gpSetAxisMap gp3DContourPlotCreate gp3DCartesianPlotCreate or , gpAdd3DContourFrame pointer to a plot control structure.  R gpSetContourVariable ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp); and Frames are numbered in the order in which they are added, beginning with one. gpAdd3DContourFrame( pgp By default, associates the first variable in thewith data the file Y-axis, the with third the variablethe X-axis, with contour the the variable. second Z-axis, variable Use and uses the last variable as gpPlotCreate Adds a 3D Contour plotgpPlotCreate frame to a gaussplot gpcartesianplot.src The above example creates a graphContour with plot, two and frames. the second Theresized a first so 3D contains that Cartesian a the plot. 2D second Theof frame frames the is are first an moved frame. inset and drawn Thiscontains in example at the assumes least lower that left-hand three corner variables.  C  INPUT FORMAT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpAddArrow

Use gpPlot to draw the graph.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpPlotCreate;

ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAdd2DContourFrame(&gp); gpAdd3DContourFrame(&gp);

framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height);

framenum = 2; xpos = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp);

The above example creates a graph with two frames. The first contains a 2D Contour plot, and the second a 3D Contour plot. The frames are moved and resized so that the second frame is an inset drawn in the lower left-hand corner of the first frame. This example assumes that mydata.plt already exists and contains at least three variables.

SOURCE gpcontourplot.src

SEE ALSO gpPlotCreate, gp3DContourPlotCreate, gpPlot

3-12 GAUSS C R Command Reference . , 3-13 coord yend , xend gpAddArrow , gpAddArrow ystart , xstart , name ) in the coordinates specified with , yend , 0) is lower left corner of frame. , xend framenum , pgp starting and ending position inand 2D Y grid plot coordinates, coordinates. i.e., X starting and ending position inwhere frame (0 coordinates, 0-100, 2 scalar, return code, 0 if successful, otherwise an error code. scalar, frame number. string, name for the arrow object. scalar, horizontal position at which the arrowscalar, begins. vertical position at which the arrowscalar, begins. horizontal position at which the arrowscalar, ends. vertical position at which the arrowscalar, ends. position coordinate system, one of the1 following: pointer to a plot control structure. ) to the point ( ystart  , ); R = gpAddArrow( xstart framenum = 2; xstart = 4; xend = 6.5; ret Specifying a name for theother arrow object commands allows that you set to arrow reference options.( the The object arrow in will be drawn from the point framenum name xstart ystart xend yend coord pgp Adds an arrow to a specified frame. gaussplot ret coord  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpAddBarFrame

ystart = 6; yend = 6.75; coord = 2; ret = gpAddArrow(&gp,framenum,"arrow1",xstart,ystart,xend, yend,coord); ret = gpSetArrowColor(&gp,framenum,"arrow1","blue");

This example adds an arrow to frame two, drawing the arrow from the point (4, 6) to the point (6.5, 6.75) in grid coordinates. It then sets the color of the arrow to blue.

SOURCE gparrow.src

SEE ALSO gpSetArrowColor, gpSetArrowLineThickness, gpSetArrowHeadStyle

gpAddBarFrame

PURPOSE Adds a Bar plot frame to a gpPlotControl structure created with gpPlotCreate or gpBarPlotCreate.

LIBRARY gaussplot

FORMAT gpAddBarFrame(pgp);

INPUT pgp pointer to a plot control structure.

REMARKS By default, gpAddBarFrame creates a frame with one line map, associating the first variable in the data file with the X-axis, and the second variable with the Y-axis. Use gpSetLineMaps to use different variables or to specify multiple line maps.

Frames are numbered in the order in which they are added, beginning with one.

Use gpPlot to draw the graph.

3-14 GAUSS C R Command Reference 3-15 gpAddBoxFrame already exists and contains at gpPlot , mydata.plt gpBarPlotCreate ,  R library gaussplot; #include gp.sdf struct gpPlotControl gp; gp = gpPlotCreate; ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAddBarFrame(&gp); gpAddXYLineFrame(&gp); framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); framenum = 2; xpos = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp); gpbarplot.src gpPlotCreate The above example creates a graphplot, with and two the frames. second an Thethe XY first second Line contains frame plot. a is Bar The an framesframe. inset are drawn This moved in and example the assumes resized lower that so left-handleast that corner two of variables. the first  C  SOURCE EXAMPLE SEE ALSO GAUSS gpAddBoxFrame

gpAddBoxFrame

PURPOSE Adds an Box plot frame to a gpPlotControl structure created with gpPlotCreate or gpBoxPlotCreate.

LIBRARY gaussplot

FORMAT gpAddBoxFrame(pgp, grp, y);

INPUT pgp pointer to a plot control structure. grp 1×P vector or N×P matrix, containing the group numbers corresponding to each column of y data. y N×P matrix. Each column represents the set of y values for an individual percentile box symbol.

REMARKS If grp is N×P, each row of grp should be identical.

gpAddBoxFrame computes percentiles on the data in y and adds box symbols to represent those percentiles to the new frame. However, you will still need to write grp (or reshape(grp,N,P) if grp is 1×P) and y to a .plt data file before plotting your graph.

By default, gpAddBoxFrame creates a frame with P line maps, associating the first P variables in the data file with the X-axis, and the next P variables with the Y-axis. Use gpSetLineMaps to use different variables or to specify different line maps.

Frames are numbered in the order in which they are added, beginning with one.

Use gpPlot to draw the graph.

EXAMPLE library gaussplot; #include gp.sdf

3-16 GAUSS C R Command Reference 3-17 gpAddBoxFrame  R // Initialize plotstruct control gpPlotControl structure gp; gp = gpBoxPlotCreate; gpSetErrorLevel(&gp,2); // Create data rndseed 12345; nboxes = 5; npoints = 7; x=reshape(seqa(1,1,nboxes)’,npoints,nboxes); y=rndn(npoints,nboxes); // Write datastruct file gpData gdat; gdat = gpSetPlotData(x˜y,""); call gpWritePlotData(&gdat,"gpbox.plt"); // Set datagpSetMacroFile(&gp,"gpbox.mcr"); and macrocall files gpSetDataFile(&gp,0,"gpbox.plt"); // Set upcall frame gpAddBoxFrame(&gp,x,y); 1 call gpMoveFrame(&gp,1,1,0.25,9,3.925); // Set upcall frame gpSetBoxMinMaxMethod(&gp,2,2); 2 call gpAddBoxFrame(&gp,x,y); call gpShowSymbolLayer(&gp,2,1); call gpSetSymbolSize(&gp,2,seqa(1,1,nboxes),1); call gpMoveFrame(&gp,2,1,4.325,9,3.925); // Plot thecall graph gpPlot(&gp); The above example creates a graphThe with second two frame frames, displays both symbols containing at Box each plots. data point as well as the percentile  C  GAUSS gpAddCircle

box symbols.

SOURCE gpxylineplot.src

SEE ALSO gpPlotCreate, gpBoxPlotCreate, gpPlot

gpAddCircle

PURPOSE Adds a circular geometry object to the specified frame.

LIBRARY gaussplot

FORMAT ret = gpAddCircle(pgp, framenum, name, xstart, ystart, xradius, coord);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name for the line segment object. xstart scalar, horizontal position of the center of the circle. ystart scalar, vertical position of the center of the circle. xradius scalar, length of the radius of the circle in X plot coordinates or horizontal frame coordinates. coord scalar, position coordinate system, one of the following: 1 starting position, width, and height in frame coordinates, 0-100, where (0, 0) is lower left corner of frame. 2 starting position, width and height in 2D grid coordinates, i.e., X and Y plot coordinates.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Specifying a name for the circular geometry object allows you to reference the object in other commands that set options for the object. The following

3-18 GAUSS C R Command Reference 3-19 gpAddCircle in conjunction with after adding a circle to change the number of sides coord); gpSetGeometryNumSides to create a regular polygon with N sides.  R framenum = 2; xstart = 1; ystart = 4; xradius = 1; coord = 2; framenum = 1; xstart = 3; ystart = 0; xradius = 2; coord = 2; ret = gpAddCircle(&gp,framenum,"circ1",xstart,ystart,xradius, ret = gpSetGeometryColor(&gp,framenum,"circ1","purple"); gpSetGeometryColor gpSetGeometryLineThickness gpSetGeometryNumSides gpSetGeometryLinePattern gpSetGeometryLinePatternLength gpFillGeometry gpSetGeometryFillColor gpAddCircle This example adds a circle with(3,0). radius It of then 2 sets to the frame color one, of centered the on circle the to point purple. By default, a circular geometrygpSetGeometryNumSides object is estimated by 72that sides. the You may circle call is estimated by. You may also use commands may be used tothat set have options been for added circles to and your other graph: types of geometries  C  EXAMPLE GAUSS gpAddContourLegend

numsides = 6; ret = gpAddCircle(&gp,framenum,"hex1",xstart,ystart,xradius, coord); ret = gpSetGeometryNumSides(&gp,framenum,"hex1",numsides);

This example adds a hexagon with radius of 1 to frame two, centered on the point (1,4).

SOURCE gpgeometry.src

SEE ALSO gpAddEllipse, gpSetGeometryColor, gpSetGeometryLineThickness

gpAddContourLegend

PURPOSE Adds a contour legend for the specified contour group(s).

LIBRARY gaussplot

FORMAT ret = gpAddContourLegend(pgp, framenum, contourgroupnum);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. contourgroupnum scalar or N×1 vector, contour group number(s).

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS All contour options are set within a contour group. Each field zone that is displayed as a contour plot must be associated with a particular contour group, which controls the contour options.

Contour plots can be displayed with contour lines and/or contour flooding. If both lines and flooding are used in a field zone, they may be associated with

3-20 GAUSS C R Command Reference 3-21 , xhaxis , gpAddEllipse , gpAddEllipse ystart , xstart , name , framenum , gpSetContourLegendBoxStyle , pgp pointer to a plot control structure. scalar, frame number. string, name for the line segment object. scalar, horizontal position of the center ofscalar, the vertical ellipse. position of the center ofscalar, the length ellipse. of the horizontal axiscoordinates of or the horizontal ellipse frame in coordinates. X plot scalar, length of the vertical axiscoordinates of or the horizontal ellipse frame in coordinates. X plot ); coord  , R = gpAddEllipse( erent contour groups. By default a contour plot is displayed with contour ff framenum = 1; contourgroupnum = 1; ret = gpAddContourLegend(&gp,framenum,contourgroupnum); yvaxis Adds an elliptical geometry object to the specified frame. gaussplot ret pgp framenum name xstart ystart xhaxis yvaxis gpcontourplot.src gpMoveContourLegend di flooding only, using contour group one to control all options. gpSetContourLegendOrientation  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpAddEllipse

coord scalar, position coordinate system, one of the following: 1 starting position, width, and height in frame coordinates, 0-100, where (0, 0) is lower left corner of frame. 2 starting position, width and height in 2D grid coordinates, i.e., X and Y plot coordinates.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Specifying a name for the elliptical geometry object allows you to reference the object in other commands that set options for the object. The following commands may be used to set options for ellipses and other types of geometries that have been added to your graph:

gpSetGeometryColor gpSetGeometryLineThickness gpSetGeometryLinePattern gpSetGeometryLinePatternLength gpFillGeometry gpSetGeometryFillColor gpSetGeometryNumSides

By default, an elliptical geometry object is estimated by 72 sides. You may call gpSetGeometryNumSides after adding an ellipse to change the number of sides that the ellipse is estimated by.

You may also use gpSetGeometryNumSides in conjunction with gpAddEllipse to create a non-regular polygon with N sides.

EXAMPLE framenum = 1; xstart = 1; ystart = 2; xhaxis = 2.25; yvaxis = 1.5; coord = 2;

3-22 GAUSS C R Command Reference 3-23 gpSetGeometryLineThickness gpAddFieldZoneLegendFrame , gpAddFieldZoneLegendFrame xhaxis,yvaxis,coord); xhaxis,yvaxis,coord); gpSetGeometryColor ,  R framenum = 2; xstart = 2; ystart = 3; xhaxis = 1; yvaxis = 1.5; coord = 2; numsides = 8; ret = gpAddEllipse(&gp,framenum,"oct1",xstart,ystart, ret = gpAddEllipse(&gp,framenum,"ell1",xstart,ystart, ret = gpSetGeometryColor(&gp,framenum,"ell1","blue"); ret = gpSetGeometryNumSides(&gp,framenum,"oct1",numsides); gaussplot gpAddCircle Adds a field zone legend frame as an inset in the specified frame. gpgeometry.src This example adds an ellipse with1.5 a to horizontal frame axis one, of centered 2.25to on and blue. the a point vertical (1,2). axis It of then sets the color of the ellipse This example adds a non-regular octogonvertical with axis a of horizontal 1.5 axis to of frame 1 two, centered and on a the point (2,3).  C  LIBRARY SOURCE PURPOSE SEE ALSO GAUSS gpAddFieldZoneLegendFrame

FORMAT ret = gpAddFieldZoneLegendFrame(pgp, framenum);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A field zone legend identifies each field zone in the specified frame. If the contour layer is the only layer activated in a field zone, then that field zone is not included in the legend. Call gpAddContourLegend to add a contour legend to the frame.

You must use the GAUSSplot API to add and set options for field zone legends. They are not available from the GUI.

A field zone legend is contained in its own frame, which is positioned as an inset in the parent frame (the parent frame is the frame specified by framenum). When the graph is plotted in the GAUSSplot GUI, the legend may be the active frame. If this is the case, then you will need to select the parent frame with the mouse (or select ‘Push Current Frame Back’ from the ‘Frame’ menu) before you may make changes to the parent frame. When you select the parent frame, the legend will be pushed back behind it. Select ‘Push Current Frame Back’ from the ‘Frame’ menu with the parent frame selected to make the legend reappear.

Because information about the data file is needed to create the field zone legend, you must keep the associated structure file together with your data file if you wish to use field zone legends. gpAddFieldZoneLegendFrame accesses the structure file to obtain the needed information about the data file. See Section 1.8 for more information on structure files.

The field zone names are used to identify the field zones in the legend. Field zone names come from the names of the corresponding zones in the data file. If you write the data file yourself, you may specify zone names with gpAddZone. Otherwise, default names (“Zone 1”, “Zone 2”,..., “Zone N”) are used. Call gpSetFieldZoneNames to rename the field zones in the frame before adding a legend.

3-24 GAUSS C R Command Reference 3-25 gpAddHistFrame gpAddHistFrame , gpMake3DCartesianPlot . structure created with erent variables or to specify multiple ff . gpPlot gpSetFieldZoneLegendLineSpacing , to use di creates a frame with one line map, associating gpPlotControl gpMoveFieldZoneLegend , ); pgp gpHistPlotCreate or gpSetLineMaps gpAddHistFrame pointer to a plot control structure.  R framenum = 1; ret = gpAddFieldZoneLegendFrame(&gp,framenum); line maps. the first variable in the datathe file Y-axis. Use with the X-axis, and the second variable with gaussplot gpAddHistFrame( pgp A Hist plot is a frequency histogram. By default, gpSetFieldZoneNames gpSetFieldZoneLegendBoxStyle Adds a Hist plot framegpPlotCreate to a does not support field zone legends. gpfieldzone.src If one or more ofscatter the symbols field (i.e., zones the in scatter the‘cube’, layer specified ‘sphere’ is frame or activated are and ‘octahedron’), represented the then by scatter 2Dwill 3D shape representations be is of used the set in scatter to the symbols field zone legend. This command applies only tofield 2D zone and legends 3D must Cartesian be plots. plotted Graphs with containing  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpAddHistFrame

Call gpCreateHistData to generate from your data the vectors of category midpoints and frequency counts that are needed to plot the graph, and write the second and third returns from gpCreateHistData to your GAUSSplot data file.

Frames are numbered in the order in which they are added, beginning with one.

Use gpPlot to draw the graph.

EXAMPLE library gaussplot; #include gp.sdf

// Initialize plot control structure struct gpPlotControl gp; gp = gpPlotCreate;

// Add frames gpAddHistFrame(&gp); gpAddXYLineFrame(&gp);

// Generate data and write data file for first frame struct gpData gdat; x = round(rndn(4000,1)*100); { b,m,freq } = gpCreateHistData(x,50); string vnames = { "Cat", "Freq" }; gdat = gpSetPlotData(m˜freq,vnames); ret = gpWritePlotData(&gdat,"mydata_hist.plt");

// Set data files for both frames ret = gpSetDataFile(&gp,1,"mydata_hist.plt"); ret = gpSetDataFile(&gp,2,"mydata_xyline.plt");

// Position frame 1 xpos = 0.25; ypos = 0.25; width = 10.5; height = 8;

3-26 GAUSS C R Command Reference 3-27 already exists and gpAddHistFFrame gpAddHistFFrame structure created with . gpPlot , mydata_xyline.plt gpPlotControl ); pgp gpHistFPlotCreate gpHistPlotCreate or , pointer to a plot control structure.  R ret = gpMoveFrame(&gp,1,xpos,ypos,width,height); // Position framexpos 2 = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,2,xpos,ypos,width,height); // Plot theret graph = gpPlot(&gp); A HistF plot is a frequency histogram generated from a vector of frequency Adds a HistF plot framegpPlotCreate to a gaussplot gpAddHistFFrame( pgp gphistplot.src gpPlotCreate The above example creates a graphplot, with and two the frames. second an Thethe XY first second Line contains frame plot. a is Hist The an framesframe. inset are drawn This moved in and example the assumes resized lower that so left-hand that corner of the first contains at least two variables.  C  INPUT FORMAT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpAddHistFFrame

counts.

By default, gpAddHistFFrame creates a frame with one line map, associating the first variable in the data file with the X-axis, and the second variable with the Y-axis. Use gpSetLineMaps to use different variables or to specify multiple line maps.

Frames are numbered in the order in which they are added, beginning with one.

Use gpPlot to draw the graph.

EXAMPLE library gaussplot; #include gp.sdf

// Initialize plot control structure struct gpPlotControl gp; gp = gpPlotCreate;

// Add frames gpAddHistFFrame(&gp); gpAddXYLineFrame(&gp);

// Generate data and write data file for first frame struct gpData gdat; f = { 10, 5, 0, 35, 11, 18, 55, 20 }; c = { 10, 20, 30, 40, 50, 60, 70, 80 }; string vnames = { "Cat", "Freq" }; gdat = gpSetPlotData(c˜f,vnames); ret = gpWritePlotData(&gdat,"mydata_histf.plt");

// Set data files for both frames ret = gpSetDataFile(&gp,1,"mydata_histf.plt"); ret = gpSetDataFile(&gp,2,"mydata_xyline.plt");

// Position frame 1 xpos = 0.25; ypos = 0.25;

3-28 GAUSS C R Command Reference 3-29 already exists and gpAddHistPFrame gpAddHistPFrame structure created with . gpPlot , mydata_xyline.plt gpPlotControl ); pgp gpHistPPlotCreate gpHistFPlotCreate or , pointer to a plot control structure.  R width = 10.5; height = 8; ret = gpMoveFrame(&gp,1,xpos,ypos,width,height); // Position framexpos 2 = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,2,xpos,ypos,width,height); // Plot theret graph = gpPlot(&gp); Adds a HistP plot framegpPlotCreate to a gaussplot gpAddHistPFrame( pgp gphistplot.src gpPlotCreate The above example creates a graphplot, with and two the frames. second an Thethe XY first second Line contains frame plot. a is HistF The an framesframe. inset are drawn This moved in and example the assumes resized lower that so left-hand that corner of the first contains at least two variables.  C  INPUT FORMAT LIBRARY SOURCE PURPOSE SEE ALSO GAUSS gpAddHistPFrame

REMARKS A HistP plot is a percentage histogram.

By default, gpAddHistPFrame creates a frame with one line map, associating the first variable in the data file with the X-axis, and the second variable with the Y-axis. Use gpSetLineMaps to use different variables or to specify multiple line maps.

Call gpCreateHistPData to generate from your data the vectors of category midpoints and frequency percentages that are needed to plot the graph, and write the second and fourth returns from gpCreateHistPData to your GAUSSplot data file.

Frames are numbered in the order in which they are added, beginning with one.

Use gpPlot to draw the graph.

EXAMPLE library gaussplot; #include gp.sdf

// Initialize plot control structure struct gpPlotControl gp; gp = gpPlotCreate;

// Add frames gpAddHistPFrame(&gp); gpAddXYLineFrame(&gp);

// Generate data and write data file for first frame struct gpData gdat; x = round(rndn(4000,1)*100); { b,m,freqct,freqp } = gpCreateHistPData(x,50); string vnames = { "Cat", "Prcnt" }; gdat = gpSetPlotData(m˜freqp,vnames); ret = gpWritePlotData(&gdat,"mydata_histp.plt");

// Set data files for both frames ret = gpSetDataFile(&gp,1,"mydata_histp.plt"); ret = gpSetDataFile(&gp,2,"mydata_xyline.plt");

3-30 GAUSS C R Command Reference 3-31 already exists and gpAddLineLegend gpAddLineLegend gpPlot , mydata_xyline.plt gpHistPPlotCreate ,  R // Position framexpos 1 = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,1,xpos,ypos,width,height); // Position framexpos 2 = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,2,xpos,ypos,width,height); // Plot theret graph = gpPlot(&gp); gaussplot gpPlotCreate Adds a line legend to a frame. gphistplot.src The above example creates a graphplot, with and two the frames. second an Thethe XY first second Line contains frame plot. a is HistP The an framesframe. inset are drawn This moved in and example the assumes resized lower that so left-hand that corner of the first contains at least two variables.  C  LIBRARY SOURCE PURPOSE SEE ALSO GAUSS gpAddLineSegment

FORMAT ret = gpAddLineLegend(pgp, framenum);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A line legend identifies each line map in the frame using the names of the line maps. By default, line maps are given either the same name as the variable associated with the Y (or R) axis in the line map or “Vnum”, where num is the index of the variable in the data file, if the variable names cannot be accessed from the structure file when the line maps are created. See Section 1.8 for information about structure files. Use gpSetLineMapNames to rename the line maps in a frame before adding a line legend.

This command applies only to Bar, XY Line and Polar Line plots.

EXAMPLE framenum = 1; ret = gpAddLineLegend(&gp,framenum);

SOURCE gplinemap.src

SEE ALSO gpMoveLineLegend, gpSetLineLegendBoxStyle, gpSetLineLegendMargin, gpSetLineLegendLineSpacing

gpAddLineSegment

PURPOSE Adds a line segment to the specified frame.

LIBRARY gaussplot

FORMAT ret = gpAddLineSegment(pgp, framenum, name, xstart, ystart, xend, yend, coord);

3-32 GAUSS C R Command Reference 3-33 ) in the coordinates yend , gpAddLineSegment xend ) to the point ( xend,yend,coord); 0) is lower left corner of frame. ystart , , . xstart starting and ending position inwhere frame (0 coordinates, 0-100, starting and ending position inand 2D Y grid plot coordinates, coordinates. i.e., X . string, name for the line segmentscalar, object. horizontal position at which the linescalar, vertical segment position begins. at which the linescalar, horizontal segment position begins. at which the linescalar, vertical segment position ends. at which the linescalar, position segment coordinate ends. system, one of the1 following: 2 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. coord  R framenum = 2; xstart = 2; xend = 3.2; ystart = 4.75; yend = 5.75; coord = 2; ret = gpAddLineSegment(&gp,framenum,"line1",xstart,ystart, ret = gpSetLineSegmentColor(&gp,framenum,"line1","blue"); specified with To add a line segment atgpAddLineSegment3D a specified position in 3D grid coordinates, call name xstart ystart xend yend coord ret Specifying a name for the linein segment other object commands allows that you set todrawn line reference from segment the the options. object point The ( line segment will be pgp framenum This example adds a line segmentthe to point frame (2, two, 4.75) drawing to thecolor the line of point segment the (3.2, from line 5.75) segment in to grid blue. coordinates. It then sets the  C  INPUT OUTPUT EXAMPLE REMARKS GAUSS gpAddLineSegment3D

SOURCE gplinesegment.src

SEE ALSO gpAddLineSegment3D, gpSetLineSegmentColor, gpSetLineSegmentThickness

gpAddLineSegment3D

PURPOSE Adds a line segment to a frame at a specified position in 3D grid coordinates.

LIBRARY gaussplot

FORMAT ret = gpAddLineSegment3D(pgp, framenum, name, xstart, ystart, zstart, xend, yend, zend);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name for the line segment object. xstart scalar, X-coordinate of the point at which the line segment begins. ystart scalar, Y-coordinate of the point at which the line segment begins. zstart scalar, Z-coordinate of the point at which the line segment begins. xend scalar, X-coordinate of the point at which the line segment ends. yend scalar, Y-coordinate of the point at which the line segment ends. zend scalar, Z-coordinate of the point at which the line segment ends.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Calling gpAddLineSegment3D allows you to specify a 3D grid coordinate position for the line segment. Call gpAddLineSegment to add a line segment at a specified position in frame coordinates or 2D grid coordinates.

3-34 GAUSS C R Command Reference 3-35 ) in 3D zend , yend , xend gpAddLogLogFrame , gpAddLogLogFrame structure created with . ) to the point ( zstart , zstart,xend,yend,zend); gpPlotControl ystart , xstart gpSetLineSegmentColor , gpLogLogPlotCreate or  R framenum = 2; xstart = 2; xend = 3.2; ystart = 4.75; yend = 5.75; zstart = 3; zend = 5; ret = gpAddLineSegment3D(&gp,framenum,"line1",xstart,ystart, ret = gpSetLineSegmentColor(&gp,framenum,"line1","blue"); gaussplot gpAddLineSegment gpSetLineSegmentThickness Adds a LogLog plot frame to a gplinesegment.src This example adds a line segmentthe to point frame (2, two, 4.75, drawing 3) thesets to line the the segment color point from of (3.2, the 5.75, line 5) segment in to 3D blue. grid coordinates. It then gpPlotCreate Specifying a name for the linein segment other object commands allows that you set todrawn line reference from segment the the options. object point The ( linegrid segment coordinates. will be This command applies ONLY to 3D Cartesian and 3D Contour plots.  C  LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpAddLogLogFrame

FORMAT gpAddLogLogFrame(pgp);

INPUT pgp pointer to a plot control structure.

REMARKS A LogLog plot is simply an XY Line plot that uses log scaling on the X and Y axes.

By default, gpAddLogLogFrame creates a frame with one line map, associating the first variable in the data file with the X-axis, and the second variable with the Y-axis. Use gpSetLineMaps to use different variables or to specify multiple line maps.

Frames are numbered in the order in which they are added, beginning with one.

Use gpPlot to draw the graph.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpPlotCreate;

ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAddLogLogFrame(&gp); gpAddXYLineFrame(&gp);

framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height);

framenum = 2; xpos = 2; ypos = 4.6; width = 3.5;

3-36 GAUSS C R Command Reference 3-37 already exists and gpAddLogXFrame gpAddLogXFrame structure created with mydata.plt erent variables or to specify multiple ff gpPlot , . to use di creates a frame with one line map, associating gpPlotControl ); pgp gpLogXPlotCreate gpLogLogPlotCreate or gpSetLineMaps , gpAddLogXFrame pointer to a plot control structure.  R height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp); gpAddLogXFrame( line maps. Frames are numbered in the order in which they are added, beginning with one. Adds a LogX plot framegpPlotCreate to a gaussplot pgp A LogX plot is simply an XY Line plot thatBy uses default, log scaling on thethe X-axis. first variable in the datathe file Y-axis. Use with the X-axis, and the second variable with gplogplot.src gpPlotCreate The above example creates a graphLogLog with plot, two and frames. the second Theresized an first so XY contains that Line a the plot. second Theof frame frames the is are first an moved frame. inset and drawn Thiscontains in example at the assumes least lower that left-hand two corner variables.  C  INPUT FORMAT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpAddLogYFrame

Use gpPlot to draw the graph.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpPlotCreate;

ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAddLogXFrame(&gp); gpAddXYLineFrame(&gp);

framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height);

framenum = 2; xpos = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp);

The above example creates a graph with two frames. The first contains a LogX plot, and the second an XY Line plot. The frames are moved and resized so that the second frame is an inset drawn in the lower left-hand corner of the first frame. This example assumes that mydata.plt already exists and contains at least two variables.

SOURCE gplogplot.src

SEE ALSO gpPlotCreate, gpLogXPlotCreate, gpPlot

3-38 GAUSS C R Command Reference 3-39 gpAddLogYFrame gpAddLogYFrame structure created with erent variables or to specify multiple ff . to use di creates a frame with one line map, associating gpPlotControl ); pgp gpLogYPlotCreate or gpSetLineMaps to draw the graph. gpAddLogYFrame pointer to a plot control structure.  R gpPlot library gaussplot; #include gp.sdf struct gpPlotControl gp; gp = gpPlotCreate; ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAddLogYFrame(&gp); gpAddXYLineFrame(&gp); framenum = 1; xpos = 0.25; line maps. Frames are numbered in the order in which they areUse added, beginning with one. A LogY plot is simply an XY Line plot thatBy uses default, log scaling on thethe Y-axis. first variable in the datathe file Y-axis. Use with the X-axis, and the second variable with pgp Adds a LogY plot framegpPlotCreate to a gaussplot gpAddLogYFrame(  C  INPUT FORMAT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpAddMacroFile

ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height);

framenum = 2; xpos = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp);

The above example creates a graph with two frames. The first contains a LogY plot, and the second an XY Line plot. The frames are moved and resized so that the second frame is an inset drawn in the lower left-hand corner of the first frame. This example assumes that mydata.plt already exists and contains at least two variables.

SOURCE gplogplot.src

SEE ALSO gpPlotCreate, gpLogYPlotCreate, gpPlot

gpAddMacroFile

PURPOSE Adds one or more macro files to a plot control structure, to be run at the end of the macro file created with the structure data.

LIBRARY gaussplot

FORMAT gpAddMacroFile(pgp, macrofile);

INPUT pgp pointer to a plot control structure.

3-40 GAUSS C R Command Reference 3-41 ‘File’ GAUSSplot GUI in ‘Macro Record’ structure created with gpAddPolarLineFrame gpAddPolarLineFrame . GAUSSplot creates a frame with one line map, “Record” option from the gpPlotControl → ); 1 string array, name(s) of macro file(s) created with . × pgp or any of the other plotting commands (see Section command allows you to create a graph using gpPolarLinePlotCreate for detailed instructions. or GAUSSplot string or N gpPlot writes the information out as a macro file and then runs the macro commands, modify it in the 1.2.1 gpAddPolarLineFrame pointer to a plot control structure.  ) to plot a graph based on the information in a plot control structure, R gpAddMacroFile gpAddMacroFile(&gp,"macro.mcr"); Adds a Polar Line plot frame to a gaussplot gpAddPolarLineFrame( pgp By default, associating the first variable in the data file with the Theta-axis, and the second menu), and then add thoseSee modifications Section to the program that created the graph. gp.src gpRunMacroFile gpPlotCreate When you call 2.1.16 GAUSSplot file to produce the graph.created Call macro this files command at to the run end one of or the more macro previously fileThe that produces your graph. GAUSSplot macrofile mode (by selecting the “Macro”  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS REMARKS SEE ALSO GAUSS gpAddPolarLineFrame

variable with the R-axis. Use gpSetLineMaps to use different variables or to specify multiple line maps.

Frames are numbered in the order in which they are added, beginning with one.

Use gpPlot to draw the graph.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpPlotCreate;

ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAddPolarLineFrame(&gp); gpAddBarFrame(&gp);

framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height);

framenum = 2; xpos = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp);

The above example creates a graph with two frames. The first contains a Polar Line plot, and the second a Bar plot. The frames are moved and resized so that the second frame is an inset drawn in the lower left-hand corner of the first frame. This example assumes that mydata.plt already exists and contains at least two variables.

3-42 GAUSS C R Command Reference 3-43 , xlen , ystart , gpAddRectangle gpAddRectangle xstart , gpPlot name , , 0) is lower left corner of frame. , framenum , pgp starting position, width, and height0-100, in where frame (0 coordinates, starting position, width and heighti.e., in X 2D and grid Y coordinates, plot coordinates. gpPolarLinePlotCreate scalar, width of the rectangle inframe X coordinates. plot coordinates or horizontal scalar, height of the rectangle inframe Y coordinates. plot coordinates or vertical scalar, position coordinate system, one of the1 following: 2 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. string, name for the line segment object. scalar, horizontal position of the bottomrectangle. left corner of the scalar, vertical position of the bottomrectangle. left corner of the , ); coord  R , = gpAddRectangle( ret xlen ylen coord ret pgp framenum name xstart ystart gppolarlineplot.src gpPlotCreate Adds a rectangular geometry object to the specified frame. gaussplot ylen  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE SEE ALSO GAUSS gpAddSquare

REMARKS Specifying a name for the rectangular geometry object allows you to reference the object in other commands that set options for the object. The following commands may be used to set options for rectangles and other types of geometries that have been added to your graph:

gpSetGeometryColor

gpSetGeometryLineThickness

gpSetGeometryLinePattern

gpSetGeometryLinePatternLength

gpFillGeometry

gpSetGeometryFillColor

EXAMPLE framenum = 2; xstart = 4; xlen = 1; ystart = 0; ylen = 5; coord = 2; ret = gpAddRectangle(&gp,framenum,"rec1",xstart,ystart, xlen,ylen,coord); ret = gpSetGeometryColor(&gp,framenum,"rec1","green");

This example adds a rectangle with a width of 1 and a height of 5 to frame two, beginning (with the bottom left corner) at the point (4,0). It then sets the color of the rectangle to green.

SOURCE gpgeometry.src

SEE ALSO gpAddSquare, gpSetGeometryColor, gpSetGeometryLineThickness

3-44 GAUSS C R Command Reference 3-45 , xlen , gpAddSquare gpAddSquare ystart , xstart , name , 0) is lower left corner of frame. , framenum , pgp starting position, width and heighti.e., in X 2D and grid Y coordinates, plot coordinates. starting position, width, and height0-100, in where frame (0 coordinates, 2 scalar, return code, 0 if successful, otherwise an error code. string, name for the line segment object. scalar, horizontal position of the bottomsquare. left corner of the scalar, vertical position of the bottom leftscalar, corner length of of the one square. side ofhorizontal the frame square coordinates. in X plot coordinatesscalar, or position coordinate system, one of the1 following: pointer to a plot control structure. scalar, frame number.  ); R = gpAddSquare( gpSetGeometryColor gpSetGeometryLineThickness ret Specifying a name for theobject square in geometry other object commands allows you thatcommands to set may reference options be the for used the to object.that set The have options following been for added squares to and your other graph: types of geometries name xstart ystart xlen coord pgp framenum Adds a square geometry object to the specified frame. gaussplot ret coord  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpAddTextObject

gpSetGeometryLinePattern gpSetGeometryLinePatternLength gpFillGeometry gpSetGeometryFillColor

EXAMPLE framenum = 2; xstart = 2; ystart = 1; xlen = 3; coord = 2; ret = gpAddSquare(&gp,framenum,"sq1",xstart,ystart, xlen,coord); ret = gpSetGeometryLineThickness(&gp,framenum,"sq1",0.4);

This example adds a square with sides of length 3 to frame two, beginning (with the bottom left corner) at the point (2,1). It then sets the line thickness of the square to 0.4.

SOURCE gpgeometry.src

SEE ALSO gpAddRectangle, gpSetGeometryColor, gpSetGeometryLineThickness

gpAddTextObject

PURPOSE Adds a text object to the specified frame.

LIBRARY gaussplot

FORMAT ret = gpAddTextObject(pgp, framenum, name, xpos, ypos, coord, text);

INPUT pgp pointer to a plot control structure.

3-46 GAUSS C R Command Reference 3-47 name ; this will text gpAddTextObject . To use one font inside argument allows you to 1 string array for name × Use the courier font forUse the the enclosed helvetica text. font for the enclosed text. Use the times font for the enclosed text. Use the Greek font for the enclosed text. Use the math font forUse the the enclosed user-defined text. font for thetext. enclosed > > > gpSetTextObjectFont 1 string array, text. × > > helvetica > . userdef courier frame coordinates, 0-100, where (0,0)corner is of the the lower left frame. 2D grid coordinates, i.e., X and Y plot coordinates. times greek math scalar, X position. scalar, Y position. scalar, position coordinate system, one of the1 following: 2 string or N scalar, return code, 0 if successful, otherwise an error code. scalar, frame number. string, name for the text object. > . . . < / > . . . < / > . . . < / > . . . < / > . . . < / > . . . < /  R courier helvetica times greek math userdef < < < < < < another (e.g. to insert ause Greek one or of mathematic the symbol following into substrings: a normal text string), to a null string if you do not need toTo add reference multi-line the text text to object the later. create frame, N input lines an of N text in the frame. By default, the text in athe text font object for is a written text in object, a call helvetica bold font. To change reference the object in other commands that set text options. You may set To add a text object togpAddTextObject3D a frame at a specified position in 3D plot coordinates,Specifying call a name for the text object with the xpos ypos coord text ret framenum name For example:  C  OUTPUT REMARKS GAUSS gpAddTextObject

y = r*sin(q)

produces the string:

y = r*sin(θ)

See Appendix A to see a complete list of the available characters in GAUSSplot.

The following formatting substrings are also supported:

. . . < /b> Bold the enclosed text (not always supported). . . . < /i> Italicize the enclosed text (not always supported). . . . < /sub> Subscript the enclosed text. . . . < /sup> Superscript the enclosed text. . . . < /verbatim> Write the enclosed text verbatim.

These font and formatting substrings can be nested inside one another or used together, for example:

Use courier bold for emphasis.

sets the text “courier bold” in a courier bold font.

EXAMPLE framenum = 2; xpos = 4.5; ypos = 10; coord = 2; ret = gpAddTextObject(&gp,framenum,"text1",xpos,ypos, coord,"f(x) = log(x+1)"); ret = gpSetTextObjectColor(&gp,framenum,"text1","blue");

This example adds a text object to frame two, placing the object so that its lower left corner is at the point (4.5, 10), and changes the text color to blue.

3-48 GAUSS C R Command Reference , , 3-49 name zpos , ypos , xpos , gpAddTextObject3D to add a text object at a gpSetTextObjectFont gpAddTextObject3D , name argument allows you to , name framenum , gpAddTextObject allows you to specify a 3D grid coordinate pgp 1 string array, text. × gpSetTextObjectColor , scalar, Z position in Z plot coordinates: string or N scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. string, name for the text object. scalar, X position in X plot coordinates. scalar, Y position in Y plot coordinates. gpAddTextObject3D  R = gpAddTextObject3D( ); ret text zpos text ret Calling reference the object in otherto commands a that null set string text options. if you You may do set not need to reference the text object later. pgp framenum name xpos ypos position for the text object.specified Call position in frame coordinates or 2D grid coordinates. Setting a name for the text object with the gptext.src gpAddTextObject3D gpSetTextObjectAnchorLocation Adds a text object to a frame at a specified position ingaussplot 3D grid coordinates.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpAddXYLineFrame

To add multi-line text to the frame, input an N×1 string array for text; this will create N lines of text in the frame.

By default, the text in a text object is written in a helvetica bold font. To change the font for a text object, call gpSetTextObjectFont. See gpAddTextObject for information on using one font inside another.

This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 2; xpos = 4.5; ypos = 10; zpos = 4; ret = gpAddTextObject3D(&gp,framenum,"text1",xpos, ypos,zpos,"f(x,y) = sin(x)*cos(y)"); ret = gpSetTextObjectColor(&gp,framenum,"text1","blue");

This example adds a text object to frame two at the point (4.5, 10, 4) and changes the text color to blue.

SOURCE gptext.src

SEE ALSO gpAddTextObject, gpSetTextObjectColor, gpSetTextObjectFont, gpSetTextObjectAnchorLocation

gpAddXYLineFrame

PURPOSE Adds an XY Line plot frame to a gpPlotControl structure created with gpPlotCreate or gpXYLinePlotCreate.

LIBRARY gaussplot

FORMAT gpAddXYLineFrame(pgp);

3-50 GAUSS C R Command Reference 3-51 gpAddXYLineFrame erent variables or to specify multiple ff to use di creates a frame with one line map, associating gpSetLineMaps to draw the graph. gpAddXYLineFrame pointer to a plot control structure.  R gpPlot library gaussplot; #include gp.sdf struct gpPlotControl gp; gp = gpPlotCreate; ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAddXYLineFrame(&gp); gpAddBarFrame(&gp); framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); framenum = 2; xpos = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp); By default, line maps. Frames are numbered in the order in which they areUse added, beginning with one. The above example creates a graph with two frames. The first contains an XY pgp the first variable in the datathe file Y-axis. Use with the X-axis, and the second variable with  C  INPUT EXAMPLE REMARKS GAUSS gpAddZone

Line plot, and the second a Bar plot. The frames are moved and resized so that the second frame is an inset drawn in the lower left-hand corner of the first frame. This example assumes that mydata.plt already exists and contains at least two variables.

SOURCE gpxylineplot.src

SEE ALSO gpPlotCreate, gpXYLinePlotCreate, gpPlot

gpAddZone

PURPOSE Adds the data for one zone to a gpData structure.

LIBRARY gaussplot

FORMAT ret = gpAddZone(pgdat, zonename, data);

INPUT pgdat pointer to a GAUSSplot data structure initialized by gpInitPlotData. zonename string, the name of the zone. data N×K matrix containing K variables that are N×1. - or - 3-dimensional K×N×P array containing K variables that are N×P. - or - 4-dimensional K×L×N×P array containing K variables that are L×N×P.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS If zonename is a null string, a default zone name will be created. For an explanation of the structure of a .plt data file, see Section 1.3.

For Bar, XY Line and Polar Line plots, data should be either an N×K matrix or a 3-dimensional array containing K variables that are N×1. For 2D Cartesian

3-52 GAUSS C R Command Reference 3-53 may be data gpAnimate3DRotation gpAnimate3DRotation gpSetPlotData , for more information on inputting data. should be a 3-dimensional array containing K 1.3.3 data P. For 3D Cartesian and 3D Contour plots, gpWritePlotData × ,  R library gaussplot; #include gp.sdf p = pi; x1 = seqa(0,p/4,15); y1 = sin(x1); a1 = aconcat(x1,y1,3); x2 = seqa(0,p/6,20); y2 = cos(x2); a2 = aconcat(x2,y2,3); struct gpData gdat; string vnames =gdat { = "X", gpInitPlotData(vnames); ret "Y" = }; gpAddZone(&gdat,"Zoneret 1",a1); = gpAddZone(&gdat,"Zoneret 2",a2); = gpWritePlotData(&gdat,"mydata.plt"); gpwritedata.src gpInitPlotData Animates the rotation of a plot about the X, Y andgaussplot Z axes. and 2D Contour plots, variables that are N either a 3-dimensional array containingsurface) K or 2-dimensional a variables (to 4-dimensional plot arraya a containing volume). K 3-dimensional See variables Section (to plot  C  LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpAnimate3DRotation

FORMAT ret = gpAnimate3DRotation(pgp, framenum, iter, xstep, ystep, zstep);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. iter scalar, number of iterations in animation loop. xstep scalar, −180 ≤ xstep ≤ 180, rotation about the X-axis in degrees. ystep scalar, −180 ≤ ystep ≤ 180, rotation about the Y-axis in degrees. zstep scalar, −180 ≤ zstep ≤ 180, rotation about the Z-axis in degrees.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS In each iteration of the animation loop, the plot will be rotated xstep degrees about the X-axis, ystep degrees about the Y-axis, and zstep degrees about the Z-axis in that order. If xstep, ystep or zstep is set to zero, then the plot will not be rotated about the corresponding axis.

To animate rotation about one axis, call gpAnimateXAxisRotation, gpAnimateYAxisRotation or gpAnimateZAxisRotation.

This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; iter = 50; xstep = 5; ystep = 3; zstep = 4; ret = gpAnimate3DRotation(&gp,framenum,iter,xstep,ystep, zstep);

SOURCE gpfieldzone.src

3-54 GAUSS C R Command Reference and 3-55 ); first skip , last , , first , iter field zones between gpAnimateFieldZones , gpAnimateFieldZones skip framenum , pgp gpAnimateYAxisRotation gpAnimateFieldZones , , . . pointer to a plot control structure. scalar, frame number. scalar, number of iterations in the animationscalar, loop. number of the first field zonescalar, in number the of animation the loop. last field zonescalar, in show the only animation one loop. in every scalar, return code, 0 if successful, otherwise an error code. last to 1 if you do not want to skip any field zones.  R gpAnimateLineMaps = gpAnimateFieldZones( skip framenum = 1; iter = 10; first = 2; last = 200; skip = 2; Set This command does NOT apply toLine frames plots. that To contain animate Bar, line XY mapscall Line in or a Polar frame containing one of these plot types, pgp framenum iter first last skip ret gpAnimateXAxisRotation Cycles through the specified field zones one at a time togaussplot produce animation. ret gpAnimateZAxisRotation  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpAnimateLineMaps

ret = gpAnimateFieldZones(&gp,framenum,iter,first,last,skip);

This example produces an animation loop that runs 10 times, cycling through all of the even-numbered field zones starting with 2 and ending with 200.

SOURCE gpfieldzone.src

SEE ALSO gpAnimate3DRotation, gpAnimateLineMaps

gpAnimateLineMaps

PURPOSE Cycles through the specified line maps one at a time to produce animation.

LIBRARY gaussplot

FORMAT ret = gpAnimateLineMaps(pgp, framenum, iter, first, last, skip);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. iter scalar, number of iterations in the animation loop. first scalar, number of the first line map in the animation loop. last scalar, number of the last line map in the animation loop. skip scalar, show only one in every skip line maps between first and last.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Set skip to 1 if you do not want to skip any line maps.

This command applies ONLY to frames that contain Bar, XY Line and Polar Line plots. To animate field zones in a frame containing one of the other plot types, call gpAnimateFieldZones.

3-56 GAUSS C R Command Reference 3-57 degrees ); xstep xstep , iter , gpAnimateXAxisRotation gpAnimateXAxisRotation framenum , 180, rotation about the X-axis in ≤ pgp xstep ≤ 180 − pointer to a plot control structure. scalar, frame number. scalar, number of iterations in animation loop. scalar, scalar, return code, 0 if successful, otherwise an error code. degrees.  R = gpAnimateXAxisRotation( framenum = 1; iter = 10; first = 1; last = 131; skip = 2; ret = gpAnimateLineMaps(&gp,framenum,iter,first,last,skip); about the X-axis. Animates the rotation of a plot about the X-axis. gaussplot ret pgp framenum iter xstep ret In each iteration of the animation loop, the plot will be rotated gplinemap.src gpAnimateFieldZones This example produces an animation loopof that the runs odd-numbered 10 line times, maps cycling starting through with all 1 and ending with 131.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpAnimateYAxisRotation

To animate rotation about the X, Y and Z axes, call gpAnimate3DRotation.

This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; iter = 72; xstep = 5; ret = gpAnimateXAxisRotation(&gp,framenum,iter,xstep);

SOURCE gpfieldzone.src

SEE ALSO gpAnimate3DRotation

gpAnimateYAxisRotation

PURPOSE Animates the rotation of a plot about the Y-axis.

LIBRARY gaussplot

FORMAT ret = gpAnimateYAxisRotation(pgp, framenum, iter, ystep);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. iter scalar, number of iterations in animation loop. ystep scalar, −180 ≤ ystep ≤ 180, rotation about the Y-axis in degrees.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS In each iteration of the animation loop, the plot will be rotated ystep degrees about the Y-axis.

To animate rotation about the X, Y and Z axes, call gpAnimate3DRotation.

3-58 GAUSS C R Command Reference . 3-59 degrees ); zstep zstep , iter , gpAnimate3DRotation gpAnimateZAxisRotation gpAnimateZAxisRotation framenum , 180, rotation about the Z-axis in ≤ pgp zstep ≤ 180 − scalar, number of iterations in animation loop. scalar, scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. degrees.  R = gpAnimateZAxisRotation( framenum = 1; iter = 72; ystep = 5; ret = gpAnimateYAxisRotation(&gp,framenum,iter,ystep); about the Z-axis. To animate rotation about the X, Y and Z axes,This call command applies ONLY to 3D Cartesian and 3D Contour plots. iter zstep ret In each iteration of the animation loop, the plot will be rotated Animates the rotation of a plot about the Z-axis. gaussplot ret pgp framenum gpfieldzone.src gpAnimate3DRotation This command applies ONLY to 3D Cartesian and 3D Contour plots.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpBarPlotCreate

EXAMPLE framenum = 1; iter = 72; zstep = 5; ret = gpAnimateZAxisRotation(&gp,framenum,iter,zstep);

SOURCE gpfieldzone.src

SEE ALSO gpAnimate3DRotation

gpBarPlotCreate

PURPOSE Creates a plot control structure and initializes its members to default values for a Bar plot.

LIBRARY gaussplot

FORMAT gp = gpBarPlotCreate;

OUTPUT gp plot control structure with its members set to default values for a Bar plot.

REMARKS You may use gp to plot a graph using either gpMakeBarPlot or gpPlot. Calling gpBarPlotCreate sets the plot type of the entire graph to Bar plot. To create a graph with multiple frames that contain plots of different types, use gpPlotCreate.

A plot control structure initialized with gpBarPlotCreate contains one frame by default.

EXAMPLE library gaussplot; #include gp.sdf

p = pi;

3-60 GAUSS C R Command Reference 3-61 . gpPlot ) will be or erent types, use V1 ff gpBoxPlotCreate ) with the Y-axis. gpBoxPlotCreate V2 gpMakeBoxPlot to initialize a plot control structure for a sets the plot type of the entire graph to Box. To gpPlot , to plot a graph using either . gp plot control structure with itsBox members plot. set to default values for a gpBoxPlotCreate gpBoxPlotCreate  R = gpBoxPlotCreate; x = seqa(0,p/4,15); y = sin(x); string vnames = { "V1",struct "V2" gpPlotControl }; gp; gp = gpBarPlotCreate; ret = gpMakeBarPlot(&gp,x,y,vnames); create a graph with multiple frames that contain plots of di Calling gpPlotCreate If you use gp gp You may use gpMakeBarPlot Creates a plot control structurea and Box initializes plot its (box members graph to percentile default plot). values for gaussplot gpbarplot.src This example illustrates how you maydefaults create for a all bar style plot and withassociated display one with options. line the The map, X-axis, first using and variable the ( second variable (  C  FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpCleanUp

multiple-frame graph, you will need to call gpAddBoxFrame for each frame in the graph. A graph initialized with gpBoxPlotCreate does NOT contain one frame by default. However, there is no need to call gpAddBoxFrame if you are using gpMakeBoxPlot to plot the graph.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpBoxPlotCreate;

rndseed 12345; nboxes = 5; npoints = 7; x=seqa(1,1,nboxes)’; y=rndn(npoints,nboxes);

call gpMakeBoxPlot(&gp,x,y);

This example illustrates how you may create a Box Plot with five line maps, using defaults for all style and display options. gpMakeBoxPlot

SOURCE gphistplot.src

SEE ALSO gpMakeBoxPlot, gpPlot

gpCleanUp

PURPOSE Deletes the data, macro, and structure files associated with a graph.

LIBRARY gaussplot

FORMAT ret = gpCleanUp(pgp);

3-62 GAUSS C R Command Reference 3-63 structure associated workspace. gpCreateHistData gpCreateHistData , you must do so before ); GAUSS v for more information on to generate temporary file names. , x 1.8 gpPlotControl gpCleanUp GAUSSplot structure from the 1 vector, vector of data. = gpCreateHistData( 1 vector, the breakpoints to be used to compute the frequencies – or – × × after creating a graph to delete the data, macro, and structure } N L scalar, the number of categories. scalar, return code, 0 if successful, otherwise an error code. , gpPlotControl pointer to a plot control structure. freq ,  m R gpCleanUp , b ret = gpCleanUp(&gp); Generates vectors of category breakpoints, categorycounts midpoints, for and a frequency Hist plot (frequency histogram). gaussplot { x v deleting the gp.src gpPlot pgp ret Call files associated with the graphstructure (see files). Section This is especiallythe important data if and you macro have files, not causing specified names for The names of these fileswith are the stored graph. in the Thus if you want to call  C  INPUT INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpCreateHistData

OUTPUT b P×1 vector, the breakpoints used for each category. m P×1 vector, the midpoints of each category. freq P×1 vector, computed frequency counts.

REMARKS If v is an L×1 vector, a final breakpoint equal to the maximum value of x will be added to the vector of breakpoints if the maximum breakpoint value is smaller. If v is a scalar, this command generates v evenly-spaced categories. The breakpoints of the categories are written to b and the midpoints of the categories to m.

Each time an element falls into one of the categories specified in b, the corresponding element of freq will be incremented by one. The categories are interpreted as follows:

f req[1] = x <= b[1] f req[2] = b[1] < x <= b[2] f req[3] = b[2] < x <= b[3] · · · f req[P] = b[P − 1] < x <= b[P]

To create your Hist plot, write m and freq to your .plt data file, and then call gpAddHistPlotFrame to add a Hist Plot frame and gpPlot to generate the graph.

EXAMPLE library gaussplot; #include gp.sdf

// Initialize plot control structure struct gpPlotControl gp; gp = gpPlotCreate;

// Add frames gpAddHistFrame(&gp);

3-64 GAUSS C R Command Reference 3-65 gpCreateHistData already exists and contains at mydata_xyline.plt  R gpAddXYLineFrame(&gp); // Generate datastruct and gpData write gdat; x data = file round(rndn(4000,1)*100); for{ first b,m,freq frame }string = vnames gpCreateHistData(x,50); =gdat { = "Cat", gpSetPlotData(m˜freq,vnames); ret "Freq" = }; gpWritePlotData(&gdat,"mydata_hist.plt"); // Set dataret files = for gpSetDataFile(&gp,1,"mydata_hist.plt"); ret both = frames gpSetDataFile(&gp,2,"mydata_xyline.plt"); // Position framexpos 1 = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,1,xpos,ypos,width,height); // Position framexpos 2 = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,2,xpos,ypos,width,height); // Plot theret graph = gpPlot(&gp); This example creates a graph withand two the frames, second the an first XYsecond containing Line frame a plot. is Hist The an plot, frames inset areThis drawn moved in example and assumes the resized that lower so left-hand that corner the of the first frame. least two variables.  C  GAUSS gpCreateHistPData

SOURCE gphistplot.src

SEE ALSO gpHistPlotCreate, gpPlot

gpCreateHistPData

PURPOSE Generates vectors of category breakpoints, category midpoints, frequency counts, and frequency percentages for a HistP plot (percentage histogram).

LIBRARY gaussplot

FORMAT { b, m, freqct, freqp } = gpCreateHistPData(x, v);

INPUT x N×1 vector, vector of data. v L×1 vector, the breakpoints to be used to compute the frequencies – or – scalar, the number of categories.

OUTPUT b P×1 vector, the breakpoints used for each category. m P×1 vector, the midpoints of each category. freqct P×1 vector, computed frequency counts. freqp P×1 vector, computed frequency percentages.

REMARKS If v is an L×1 vector, a final breakpoint equal to the maximum value of x will be added to the vector of breakpoints if the maximum breakpoint value is smaller. If v is a scalar, this command generates v evenly-spaced categories. The breakpoints of the categories are written to b and the midpoints of the categories to m.

Each time an element falls into one of the categories specified in b, the corresponding element of freq will be incremented by one. The categories are

3-66 GAUSS C R Command Reference 3-67 to generate the data file, and then call gpPlot gpCreateHistPData .plt ] P [1] [2] [3] [ b b b b to your = = = = < < < < freqp x x x x and < < < m 1] − to add a HistP Plot frame and P [1] [2] [ b b b = = = = ] P [1] [2] [3] [ · · · f req f req f req f req  R print gpGetErrorMessage(ret); library gaussplot; #include gp.sdf struct gpPlotControl gp; gp = gpPlotCreate; // Create randomrndseed data 454356; x = round(rndn(4000,1)*100); { b, m, freq, freqp// } Set = data gpCreateHistPData(x,50); struct in gpData gpdata gdat; string structure vnames =gdat { = "Cat", gpSetPlotData(m˜freq˜freqp,vnames); "Freq", "Prcnt" }; // Write dataret file = gpWritePlotData(&gdat,"hist.plt"); if (ret); endif; interpreted as follows: graph. gpAddHistPPlotFrame To create your HistP plot, write  C  EXAMPLE GAUSS gpExportBMP

// Set data file call gpSetDataFile(&gp,0,"hist.plt");

// Set up frame 1 call gpAddHistFrame(&gp); call gpSetLineMaps(&gp,1,1˜2); call gpMoveFrame(&gp,1,0.25,0.25,5.175,7.85);

// Set up frame 2 call gpAddHistPFrame(&gp); call gpSetLineMaps(&gp,1,1˜3); call gpSetBarColor(&gp,2,1,"blue","blue"); call gpMoveFrame(&gp,2,5.525,0.25,5.175,7.85);

// Plot the graph call gpPlot(&gp);

This example creates a graph with two frames, the first containing a Hist plot, and the second a HistP plot.

SOURCE gphistplot.src

SEE ALSO gpHistPPlotCreate, gpPlot

gpExportBMP

PURPOSE Exports a graph to a Windows Bitmap (BMP) format graphics file.

LIBRARY gaussplot

FORMAT ret = gpExportBMP(pgp, area, filename);

INPUT pgp pointer to a plot control structure.

3-68 GAUSS C R Command Reference 3-69 . gpExportEPS gpExportWMF gpExportEPS or one of the , graphic.bmp gpPlot gpExportPS , ); filename , gpExportJPEG area , , sets an option to export the graph to a BMP format commands. pgp export all frames. export entire workspace. - or - Plot scalar, area of the graph to export, one of the following: pointer to a plot control structure. -1 scalar, number of frame to export. string, name of BMP output file. scalar, return code, 0 if successful, otherwise an error code. scalar, area of the graph to export,-2 one of the following: gpExportBMP PlotType  R = gpExportEPS( area = -1; ret = gpExportBMP(&gp,area,"graphic.bmp"); area Exports a graph to an Encapsulated PostScript (EPS) format graphics file. gaussplot ret pgp gpMake This example exports all frames to the BMP graphics file gp.src gpSetExportImageWidth filename ret Calling graphics file once the graph has been created with area  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpExportHPGL

-2 export entire workspace. -1 export all frames. - or - scalar, number of frame to export. filename string, name of EPS output file.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Calling gpExportEPS sets an option to export the graph to an EPS format graphics file once the graph has been created with gpPlot or one of the gpMakePlotTypePlot commands.

EXAMPLE area = 3; ret = gpExportEPS(&gp,area,"graphic.eps");

This example exports frame three to the Encapsulated PostScript graphics file graphic.eps.

SOURCE gp.src

SEE ALSO gpSetPrintPalette, gpExportPS

gpExportHPGL

PURPOSE Exports a graph to an HP-GL format graphics file.

LIBRARY gaussplot

FORMAT ret = gpExportHPGL(pgp, area, filename);

INPUT pgp pointer to a plot control structure. area scalar, area of the graph to export, one of the following:

3-70 GAUSS C R Command Reference 3-71 . graphic.hp or one of the gpExportHPGL2 gpExportHPGL2 gpPlot ); filename , area 2 format graphics file. / , pgp sets an option to export the graph to an HP-GL format commands. export entire workspace. export entire workspace. export all frames. - or - gpExportPS , Plot -2 pointer to a plot control structure. scalar, area of the graph to export, one of the following: string, name of HP-GL output file. scalar, return code, 0 if successful, otherwise an error code. -2 -1 scalar, number of frame to export. gpExportHPGL PlotType  R = gpExportHPGL2( area = -1; ret = gpExportHPGL(&gp,area,"graphic.hp"); Exports a graph to an HP-GL gaussplot ret pgp area gpMake gp.src gpExportHPGL2 filename ret Calling graphics file once the graph has been created with This example exports all frames to the HP-GL graphics file  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpExportJPEG

-1 export all frames. - or - scalar, number of frame to export. filename string, name of HP-GL/2 output file.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Calling gpExportHPGL2 sets an option to export the graph to an HP-GL/2 format graphics file once the graph has been created with gpPlot or one of the gpMakePlotTypePlot commands.

EXAMPLE area = -1; ret = gpExportHPGL2(&gp,area,"graphic.hp");

This example exports all frames to the HP-GL/2 graphics file graphic.hp2.

SOURCE gp.src

SEE ALSO gpSetPrintPalette, gpExportHPGL, gpExportPS

gpExportJPEG

PURPOSE Exports a graph to a Joint Photographic Experts Group (JPEG) format graphics file.

LIBRARY gaussplot

FORMAT ret = gpExportJPEG(pgp, area, filename);

INPUT pgp pointer to a plot control structure. area scalar, area of the graph to export, one of the following: -2 export entire workspace.

3-72 GAUSS C R Command Reference 3-73 , gpExportPNG or one of the gpExportBMP gpExportPNG , gpPlot ); to set the quality of the exported filename , gpSetExportImageWidth , area , sets an option to export the graph to a JPEG format commands. pgp export all frames. - or - Plot string, name of JPEG output file. scalar, return code, 0 if successful, otherwise an error code. -1 scalar, number of frame to export. . gpSetExportJPEGQuality gpExportJPEG PlotType  R = gpExportPNG( area = -2; ret = gpExportJPEG(&gp,area,"graphic.jpg"); ret Exports a graph to a Portable Network Graphics (PNG) file. gaussplot gpMake You may call This example exports the entire workspacegraphic.jpg to the JPEG graphics file gp.src gpSetExportJPEGQuality filename ret Calling graphics file once the graph has been created with JPEG file. The range forfile the quality output is file set quality to is 75. 1 - 100. By default, the output gpExportPS  C  FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpExportPS

INPUT pgp pointer to a plot control structure. area scalar, area of the graph to export, one of the following: -2 export entire workspace. -1 export all frames. - or - scalar, number of frame to export. filename string, name of PNG output file.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Calling gpExportPNG sets an option to export the graph to a PNG format graphics file once the graph has been created with gpPlot or one of the gpMakePlotTypePlot commands.

EXAMPLE area = 3; ret = gpExportPNG(&gp,area,"graphic.png");

This example exports frame three to the PNG graphics file graphic.png.

SOURCE gp.src

SEE ALSO gpSetExportImageWidth, gpExportBMP, gpExportJPEG, gpExportPS

gpExportPS

PURPOSE Exports a graph to a PostScript (PS) format graphics file.

LIBRARY gaussplot

FORMAT ret = gpExportPS(pgp, area, filename);

INPUT pgp pointer to a plot control structure.

3-74 GAUSS C R Command Reference . 3-75 graphic.ps gpExportRAS or one of the gpExportRAS gpPlot ); gpExportHPGL , filename , area , gpExportEPS commands. pgp , sets an option to export the graph to a PostScript format export all frames. export entire workspace. - or - Plot scalar, area of the graph to export, one of the following: pointer to a plot control structure. -1 scalar, number of frame to export. string, name of PS output file. scalar, return code, 0 if successful, otherwise an error code. scalar, area of the graph to export,-2 one of the following: gpExportPS PlotType  R = gpExportRAS( area = 3; ret = gpExportPS(&gp,area,"graphic.ps"); area Exports a graph to a Sun Raster (RAS) format graphics file. gaussplot ret pgp gpMake This example exports frame three to the PostScript graphics file gp.src gpSetPrintPalette filename ret Calling graphics file once the graph has been created with area  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpExportTIFF

-2 export entire workspace. -1 export all frames. - or - scalar, number of frame to export. filename string, name of RAS output file.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Calling gpExportRAS sets an option to export the graph to a Sun Raster format graphics file once the graph has been created with gpPlot or one of the gpMakePlotTypePlot commands.

EXAMPLE area = -2; ret = gpExportRAS(&gp,area,"graphic.ras");

This example exports the entire workspace to the Sun file graphic.ras.

SOURCE gp.src

SEE ALSO gpSetExportImageWidth, gpExportBMP, gpExportJPEG, gpExportPS

gpExportTIFF

PURPOSE Exports a graph to a Tagged Image File Format (TIFF) graphics file.

LIBRARY gaussplot

FORMAT ret = gpExportTIFF(pgp, area, filename);

INPUT pgp pointer to a plot control structure. area scalar, area of the graph to export, one of the following:

3-76 GAUSS C R Command Reference 3-77 . , gpExportWMF or one of the gpExportWMF graphic.tif gpExportBMP , gpPlot ); filename , gpSetPrintPalette area , , sets an option to export the graph to a TIFF format commands. pgp export entire workspace. export all frames. - or - Plot scalar, area of the graph to export, one of the following: pointer to a plot control structure. string, name of TIFF output file. scalar, return code, 0 if successful, otherwise an error code. -2 -1 scalar, number of frame to export. gpExportTIFF PlotType  R = gpExportWMF( area = 2; ret = gpExportTIFF(&gp,area,"graphic.tif"); area Exports a graph to a Windows Meta File (WMF) format graphics file. gaussplot ret pgp gpMake gp.src gpSetExportImageWidth gpExportJPEG filename ret Calling graphics file once the graph has been created with This example exports frame two to the TIFF graphics file  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpExportXWD

-2 export entire workspace. -1 export all frames. - or - scalar, number of frame to export. filename string, name of WMF output file.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Calling gpExportWMF sets an option to export the graph to a WMF format graphics file once the graph has been created with gpPlot or one of the gpMakePlotTypePlot commands.

EXAMPLE area = 2; ret = gpExportWMF(&gp,area,"graphic.wmf");

This example exports frame two to the WMF graphics file graphic.wmf.

SOURCE gp.src

SEE ALSO gpSetPrintPalette, gpExportBMP, gpExportJPEG

gpExportXWD

PURPOSE Exports a graph to an X-Windows Format (XWD) graphics file.

LIBRARY gaussplot

FORMAT ret = gpExportXWD(pgp, area, filename);

INPUT pgp pointer to a plot control structure. area scalar, area of the graph to export, one of the following: -2 export entire workspace.

3-78 GAUSS C R Command Reference 3-79 or one of the gpExportPS , gpFillGeometry gpPlot gpFillGeometry ); fill , name gpExportJPEG , , framenum , gpExportBMP , pgp sets an option to export the graph to an X-Windows commands. export all frames. - or - Plot string, name of a geometry object. pointer to a plot control structure. scalar, frame number. string, name of XWD output file. scalar, return code, 0 if successful, otherwise an error code. -1 scalar, number of frame to export. . gpExportXWD PlotType  R = gpFillGeometry( area = 2; ret = gpExportXWD(&gp,area,"graphic.xwd"); name Specifies whether or not a geometry object is filled. gaussplot ret pgp framenum gp.src gpSetExportImageWidth filename ret Calling format graphics file once the graph has been created with This example exports frame two tographic.xwd the X-Windows Format graphics file gpMake  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpFillGridArea

fill scalar, one of the following: 0 do not fill grid area. 1 fill grid area.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, geometries are not filled. If you call gpFillGeometry to specify that a geometry is to be filled, the default fill color is white. To change the fill color, call gpSetGeometryFillColor.

You may call gpFillGeometry to set specify whether or not a geometry created with any of the following commands is to be filled:

gpAddCircle gpAddEllipse gpAddRectangle gpAddSquare

EXAMPLE framenum = 1; xstart = 0; ystart = 0; xradius = 1.5; coord = 2; thickness = 0.4; fill = 1; ret = gpAddCircle(&gp,framenum,"circ1",xstart,ystart,xradius, coord); ret = gpFillGeometry(&gp,framenum,"circ1",fill);

This example adds a circle of radius 1.5 to frame one, centered on the point (0,0). It then specifies that the circle is to be filled.

SOURCE gpgeometry.src

SEE ALSO gpSetGeometryFillColor, gpSetGeometryColor

3-80 GAUSS C R Command Reference 3-81 gpFramePause gpPositionGrid , gpFillGridArea ); fill , . Because grid area light source shading framenum gpUseGridAreaLighting , , . pgp do not fill grid area. fill grid area. scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. gpSetGridAreaFillColor  R = gpFillGridArea( framenum = 1; fill = 1; ret = gpFillGridArea(&gp,framenum,fill); is used by default inas 3D gray. Cartesian To and deactivate 3D grid Contour areagpUseGridAreaLighting plots, light the source grid shading, area call appears gp.src gpSetGridAreaFillColor fill ret By default, the grid areaunfilled is for filled all for other 3D plot Cartesiancolor, types. and call 3D The Contour default plots fill and color is white. To change the fill pgp framenum Specifies whether or not the grid area is filled. gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpFramePause

gpFramePause

PURPOSE Pauses drawing for a specified number of seconds after drawing for a frame is completed.

LIBRARY gaussplot

FORMAT ret = gpFramePause(pgp, framenum, pause);

INPUT pgp pointer to a plot control structure. framenum scalar or N×1 vector, frame number(s). pause scalar, number of seconds to pause drawing after the specified frame is completed.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The pause specified with gpFramePause is applicable only if each frame is shown as it is created. Thus this command is ignored unless gpShowDrawing is called with a draw argument of 2 (show each frame after the drawing for that frame is completed) or 3 (show all drawing). By default, draw is set to 1 (do not show drawing), and thus no pause is used.

EXAMPLE draw = 2; framenum = 2; pause = 0.25; gpShowDrawing(&gp,draw); ret = gpFramePause(&gp,framenum,pause);

This example shows each frame after the drawing for that frame is completed, and pauses drawing for 0.25 seconds after the second frame is displayed.

SOURCE gp.src

SEE ALSO gpShowDrawing

3-82 GAUSS C R Command Reference 3-83 . gpGetErrorMessage gpGetErrorMessage to get the associated message. gpSetErrorLevel ); errcode command fails, it returns an error code. Pass the gpGetErrorMessage scalar, error code. string, error message. GAUSSplot = gpGetErrorMessage(  errmsg = gpGetErrorMessage(ret); print errmsg; R library gaussplot; #include gp.sdf p = pi; x = seqa(0,p/4,15); y = sin(x); string vnames = { "V1",struct "V2" gpPlotControl }; gp; gp = gpBarPlotCreate; ret = gpMakeBarPlot(&gp,x,y,vnames); if (ret); endif; value of the error code into To change the level of error handling, call errcode errmsg By default, if a Returns the error message associated with a particular error code. gaussplot errmsg  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpHistPlotCreate

SOURCE gp.src

SEE ALSO gpSetErrorLevel

gpHistPlotCreate

PURPOSE Creates a plot control structure and initializes its members to default values for a Hist plot (frequency histogram).

LIBRARY gaussplot

FORMAT gp = gpHistPlotCreate;

OUTPUT gp plot control structure with its members set to default values for a Hist plot.

REMARKS You may use gp to plot a graph using either gpMakeHistPlot or gpPlot. Calling gpHistPlotCreate sets the plot type of the entire graph to Hist. To create a graph with multiple frames that contain plots of different types, use gpPlotCreate.

A plot control structure initialized with gpHistPlotCreate contains one frame by default.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpHistPlotCreate;

x = round(rndn(4000,1)*100); string vnames = { "Cat", "Freq" };

3-84 GAUSS C R Command Reference 3-85 . gpPlot or contains one erent types, use ff gpMakeHistPlot gpHistFPlotCreate gpHistFPlotCreate gpMakeHistFPlot gpHistFPlotCreate sets the plot type of the entire graph to HistF. To gpPlot , to plot a graph using either . gp into 50 evenly spaced categories, and associates the categories with plot control structure with itsHistF members plot. set to default values for a x gpHistFPlotCreate  R = gpHistFPlotCreate; library gaussplot; #include gp.sdf { b,m,freq,ret } = gpMakeHistPlot(&gp,x,50,vnames); frame by default. create a graph with multiple frames that contain plots of di Calling gpPlotCreate A plot control structure initialized with You may use Creates a plot control structurea and HistF initializes plot its (frequency members histogram). to default values for gaussplot gp gp breaks up the X-axis and the frequencies with the Y-axis. gphistplot.src gpMakeHistPlot This example illustrates how you mayline create map, a using frequency defaults histogram for with all one style and display options.  C  FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpHistPPlotCreate

f = { 10, 5, 0, 35, 11, 18, 55, 20 }; c = { 10, 20, 30, 40, 50, 60, 70, 80 }; string vnames = { "Cat", "Freq" };

struct gpPlotControl gp; gp = gpHistFPlotCreate; { ret } = gpMakeHistFPlot(&gp,c,f,vnames);

This example illustrates how you may create a frequency histogram with one line map, using defaults for all style and display options. gpMakeHistFPlot associates c with the X-axis and f with the Y-axis.

SOURCE gphistplot.src

SEE ALSO gpMakeHistFPlot, gpPlot

gpHistPPlotCreate

PURPOSE Creates a plot control structure and initializes its members to default values for a HistP plot (percentage histogram).

LIBRARY gaussplot

FORMAT gp = gpHistPPlotCreate;

OUTPUT gp plot control structure with its members set to default values for a HistP plot.

REMARKS You may use gp to plot a graph using either gpMakeHistPPlot or gpPlot. Calling gpHistPPlotCreate sets the plot type of the entire graph to HistP. To create a graph with multiple frames that contain plots of different types, use gpPlotCreate.

3-86 GAUSS C R Command Reference 3-87 . contains one gpInitPlotData gpInitPlotData gpMakeHistPPlot vnames gpHistPPlotCreate ); data structure containing vnames data structure and writes specified variable names to it. gpPlot , 1 string array of variable names for the data. × GAUSSplot N a GAUSSplot into 50 evenly spaced categories and calculates percentages of the x  = gpInitPlotData( R library gaussplot; #include gp.sdf x = round(rndn(4000,1)*100); string vnames = { "Cat",struct "Prcnt" gpPlotControl }; gp; gp = gpHistPPlotCreate; { b,m,freqct,freqp,ret } = gpMakeHistPPlot(&gp,x,50,vnames); Initializes a gaussplot gdat vnames gdat frame by default. gphistplot.src gpMakeHistPPlot This example illustrates how you mayline create map, a using percentage defaults histogram for withbreaks all one up style and display options. frequencies for each category. It thenand associates the the percentages categories with with the the Y-axis. X-axis A plot control structure initialized with  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpLogLogPlotCreate

REMARKS This command creates a GAUSSplot data structure, which contains variable names, but no data. Use gpAddZone to add data to the structure. Once the data has been added, it can be written to a .plt data file with gpWritePlotData.

EXAMPLE library gaussplot; #include gp.sdf

struct gpData gdat; string vnames = { "X1", "X2", "X3" }; gdat = gpInitPlotData(vnames);

SOURCE gpwritedata.src

SEE ALSO gpAddZone, gpWritePlotData, gpSetPlotData

gpLogLogPlotCreate

PURPOSE Creates a plot control structure and initializes its members to default values for a LogLog plot.

LIBRARY gaussplot

FORMAT gp = gpLogLogPlotCreate;

OUTPUT gp plot control structure with its members set to default values for a LogLog plot.

REMARKS You may use gp to plot a graph using either gpMakeLogLogPlot or gpPlot. Calling gpLogLogPlotCreate sets the plot type of the entire graph to LogLog. To create a graph with multiple frames that contain plots of different types, use gpPlotCreate.

A plot control structure initialized with gpLogLogPlotCreate contains one frame by default.

3-88 GAUSS C R Command Reference 3-89 . ) will be V1 gpPlot or gpLogXPlotCreate ) will be associated with gpLogXPlotCreate V2 gpMakeLogXPlot sets the plot type of the entire graph to LogX. To gpPlot , to plot a graph using either gp plot control structure with itsLogX members plot. set to default values for a gpLogXPlotCreate  R = gpLogXPlotCreate; library gaussplot; #include gp.sdf x = seqa(0.2,0.2,20); y = log(x); string vnames = { "V1",struct "V2" gpPlotControl }; gp; gp = gpLogLogPlotCreate; ret = gpMakeLogLogPlot(&gp,x,y,vnames); gplogplot.src gpMakeLogLogPlot Creates a plot control structurea and LogX initializes plot. its members to default values for gaussplot gp gp You may use Calling This example illustrates how you mayusing create defaults a for LogLog all plot style withassociated and one with display line the options. map, X-axis, The and first the variable second ( variable ( the Y-axis.  C  FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpLogYPlotCreate

create a graph with multiple frames that contain plots of different types, use gpPlotCreate.

A plot control structure initialized with gpLogXPlotCreate contains one frame by default.

EXAMPLE library gaussplot; #include gp.sdf

x = seqa(0.2,0.2,20); y = log(x); string vnames = { "V1", "V2" };

struct gpPlotControl gp; gp = gpLogXPlotCreate; ret = gpMakeLogXPlot(&gp,x,y,vnames);

This example illustrates how you may create a LogX plot with one line map, using defaults for all style and display options. The first variable (V1) will be associated with the X-axis, and the second variable (V2) will be associated with the Y-axis.

SOURCE gplogplot.src

SEE ALSO gpMakeLogXPlot, gpPlot

gpLogYPlotCreate

PURPOSE Creates a plot control structure and initializes its members to default values for a LogY plot.

LIBRARY gaussplot

FORMAT gp = gpLogYPlotCreate;

3-90 GAUSS C R Command Reference 3-91 . ) will be V1 gpPlot or contains one erent types, use ff ) will be associated with V2 gpMake2DCartesianPlot gpMake2DCartesianPlot gpMakeLogYPlot gpLogYPlotCreate sets the plot type of the entire graph to LogY. To gpPlot , to plot a graph using either . gp plot control structure with itsLogY members plot. set to default values for a gpLogYPlotCreate  R library gaussplot; #include gp.sdf x = seqa(0.2,0.2,20); y = log(x); string vnames = { "V1",struct "V2" gpPlotControl }; gp; gp = gpLogYPlotCreate; ret = gpMakeLogYPlot(&gp,x,y,vnames); gpPlotCreate A plot control structure initializedframe with by default. gplogplot.src gpMakeLogYPlot Writes a data file and draws a graph with one frame containing a 2D Cartesian create a graph with multiple frames that contain plots of di Calling You may use This example illustrates how you mayusing create defaults a for LogY all plot style with and one display line options. map, The first variable ( gp associated with the X-axis, and the second variable ( the Y-axis.  C  OUTPUT SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpMake2DCartesianPlot

plot.

LIBRARY gaussplot

FORMAT ret = gpMake2DCartesianPlot(pgp, x, y, vnames);

INPUT pgp pointer to a plot control structure created with gp2DCartesianPlotCreate. x N×P matrix, the variable to be associated with the X-axis. y N×P matrix, the variable to be associated with the Y-axis. vnames 2×1 string array, variable names.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command allows you to create a 2D Cartesian plot easily, without first writing the plot data to a .plt data file. It writes the variables x and y to a .plt data file with one zone, using the names in vnames, and then creates a 2D Cartesian plot with that data. If vnames is a null string, the names V1, V2,..., VM (or V01, V02,..., VM, if 9 < M < 100) will be generated automatically. gpMake2DCartesianPlot creates a graph with one frame containing only one field zone. For more complicated graphs, use gpPlot.

If data and macro file names have not been specified by calls to gpSetDataFile and gpSetMacroFile, then gpMake2DCartesianPlot will generate temporary names for the data and macro files it creates. The temporary data and macro file names will begin with gp and have .plt and .mcr extensions respectively. The files will be placed on the GAUSS temporary file path (edit gauss.cfg to change this path). To delete these temporary files after running your program, call gpCleanUp. The names of these files are stored in the structure that pgp is pointing at, so you must still have the structure in your GAUSS workspace when you call gpCleanUp.

EXAMPLE library gaussplot; #include gp.sdf

// Generate data

3-92 GAUSS C R Command Reference 3-93 to a cv and y , x ); vnames gpMake2DContourPlot , gpMake2DContourPlot cv , . y , x , pgp gpPlot data file. It writes the variables , .plt P matrix, the variable to beP associated matrix, with the the variable X-axis. to beP associated matrix, with the the contour Y-axis. variable. 1 string array, variable names. × × × × pointer to a plot controlgp2DContourPlotCreate structure created with N N N 3 scalar, return code, 0 if successful, otherwise an error code.  R = gpMake2DContourPlot( x = seqa(1,5,20); y = seqa(10,2,20).*log(x’); x = x’.*ones(20,20); string vnames = { "V1",struct "V2" gpPlotControl }; gp; gp = gp2DCartesianPlotCreate; ret = gpMake2DCartesianPlot(&gp,x,y,vnames); Writes a data file andplot. draws a graph with one frame containing a 2D Contour gaussplot ret pgp x y cv vnames ret This command allows you to createwriting a the 2D plot Contour data plot to easily, a without first gpcartesianplot.src gp2DCartesianPlotCreate  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpMake3DCartesianPlot

.plt data file with one zone, using the names in vnames, and then creates a 2D Contour plot with that data. If vnames is a null string, the names V1, V2,..., VM (or V01, V02,..., VM, if 9 < M < 100) will be generated automatically. gpMake2DContourPlot creates a graph with one frame containing only one field zone. For more complicated graphs, use gpPlot.

If data and macro file names have not been specified by calls to gpSetDataFile and gpSetMacroFile, then gpMake2DContourPlot will generate temporary names for the data and macro files it creates. The temporary data and macro file names will begin with gp and have .plt and .mcr extensions respectively. The files will be placed on the GAUSS temporary file path (edit gauss.cfg to change this path). To delete these temporary files after running your program, call gpCleanUp. The names of these files are stored in the structure that pgp is pointing at, so you must still have the structure in your GAUSS workspace when you call gpCleanUp.

EXAMPLE library gaussplot; #include gp.sdf

// Generate data p = pi; x = seqa(0,p/4,15)’; y = seqa(0,p/4,15);

cv = cos(x).*sin(x-y); x = x.*ones(15,15); y = y.*ones(15,15); string vnames = { "V1", "V2", "V3" };

struct gpPlotControl gp; gp = gp2DContourPlotCreate; ret = gpMake2DContourPlot(&gp,x,y,cv,vnames);

SOURCE gpcontourplot.src

SEE ALSO gp2DContourPlotCreate, gpPlot

3-94 GAUSS C R Command Reference 3-95 will . to a z gpPlot , and .mcr y temporary file , x and ); , and then creates a 3D .plt GAUSS vnames 100) will be generated , < z vnames gpMake3DCartesianPlot , M gpMake3DCartesianPlot . and have y gpMake3DCartesianPlot < creates a graph with one frame , gp x , then is a null string, the names . The names of these files are stored in , , if 9 pgp VM vnames data file. It writes the variables ,..., gpCleanUp 02 V .plt , to change this path). To delete these temporary files after 01 gpSetMacroFile V P matrix, the variable to be associatedP with matrix, the the X-axis. variable to be associatedP with matrix, the the Y-axis. variable to be associated with the Z-axis. 1 string array, variable names. × × × and × (or N N N 3 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot controlgp3DCartesianPlotCreate structure created with gpMake3DCartesianPlot VM gauss.cfg ,...,  data file with one zone, using the names in 2 R = gpMake3DCartesianPlot( V , 1 x y z vnames ret This command allows you to createwriting a the 3D plot Cartesian data plot to easily, a without first pgp Writes a data file andplot. draws a graph with one frame containing a 3D Cartesian gaussplot ret .plt automatically. containing only one field zone. For more complicated graphs, use Cartesian plot with that data.V If If data and macro filegpSetDataFile names have not been specified by calls to generate temporary names for thedata data and and macro macro file files names itextensions will creates. respectively. begin The The with temporary files will bepath placed (edit on the running your program, call  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpMake3DContourPlot

the structure that pgp is pointing at, so you must still have the structure in your GAUSS workspace when you call gpCleanUp.

EXAMPLE library gaussplot; #include gp.sdf

// Generate data p = pi; x = seqa(0,p/4,15)’; y = seqa(0,p/4,15);

z = cos(x).*sin(x-y); x = x.*ones(15,15); y = y.*ones(15,15); string vnames = { "V1", "V2", "V3" };

struct gpPlotControl gp; gp = gp3DCartesianPlotCreate; ret = gpMake3DCartesianPlot(&gp,x,y,z,vnames);

SOURCE gpcartesianplot.src

SEE ALSO gp3DCartesianPlotCreate, gpPlot

gpMake3DContourPlot

PURPOSE Writes a data file and draws a graph with one frame containing a 3D Contour plot.

LIBRARY gaussplot

FORMAT ret = gpMake3DContourPlot(pgp, x, y, z, cv, vnames);

INPUT pgp pointer to a plot control structure created with

3-96 GAUSS C R Command Reference to a 3-97 . cv will and z gpPlot , .mcr y temporary file , x and , and then creates a 3D .plt GAUSS 100) will be generated gpMake3DContourPlot < vnames M . gpMake3DContourPlot and have < . gp creates a graph with one frame , then . The names of these files are stored in , if 9 is a null string, the names VM gpCleanUp data file. It writes the variables vnames ,..., gpCleanUp 02 V .plt , to change this path). To delete these temporary files after 01 gpSetMacroFile is pointing at, so you must still have the structure in your V P matrix, the variable to be associatedP with matrix, the the Y-axis. variable to be associatedP with matrix, the the Z-axis. contour variable. P matrix, the variable to be associated with the X-axis. 1 string array, variable names. × × × × and pgp × (or N N N 4 scalar, return code, 0 if successful, otherwise an error code. gp3DContourPlotCreate N gpMake3DContourPlot VM gauss.cfg workspace when you call ,...,  data file with one zone, using the names in 2 R V , 1 library gaussplot; #include gp.sdf // Generate data p = pi; x = seqa(0,p/4,15)’; y = seqa(0,p/4,15); z = cos(x).*sin(x-y); automatically. containing only one field zone. For more complicated graphs, use If data and macro filegpSetDataFile names have not been specified by calls to the structure that GAUSS generate temporary names for thedata data and and macro macro file files names itextensions will creates. respectively. begin The The with temporary files will bepath placed (edit on the running your program, call y z cv vnames ret This command allows you to createwriting a the 3D plot Contour data plot to easily, a without first x .plt Contour plot with that data. If V  C  OUTPUT EXAMPLE REMARKS GAUSS gpMakeAxesIndependent

cv = sin(x).*cos(x-y); x = x.*ones(15,15); y = y.*ones(15,15); string vnames = { "V1", "V2", "V3", "V4" };

struct gpPlotControl gp; gp = gp3DContourPlotCreate; ret = gpMake3DContourPlot(&gp,x,y,z,cv,vnames);

SOURCE gpcontourplot.src

SEE ALSO gp3DContourPlotCreate, gpPlot

gpMakeAxesIndependent

PURPOSE Allows the axes of a plot to be sized independently of one another.

LIBRARY gaussplot

FORMAT ret = gpMakeAxesIndependent(pgp, framenum);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the axes of line plots are sized independently, 2D Cartesian and 2D Contour plots are XY-dependent with an XY-ratio of one, and 3D Cartesian and 3D Contour plots are XYZ-dependent with an XY-ratio of one and an XZ-ratio of one. This means that one unit on the X-axis must be the same length in the plot as one unit on the Y-axis, and for 3D plots, one unit on the X-axis must also be the same length as one unit on the Z-axis.

3-98 GAUSS C R Command Reference 3-99 or ); xyratio , gpMakeAxesXYDependent gpMakeAxesXYDependent framenum gpMakeAxesXYDependent , pgp . gpMakeAxesXYZDependent , pointer to a plot control structure. scalar, frame number. scalar, ratio of the length ofof one one unit unit on on the the X-axis Y-axis. to the length scalar, return code, 0 if successful, otherwise an error code. erent dependence ratios, call ff  R = gpMakeAxesXYDependent( library gaussplot; #include gp.sdf struct gpPlotControl gp; gp = gp3DCartesianPlotCreate; ret = gpSetDataFile(&gp,0,"mydata.plt"); ret = gpMakeAxesIndependent(&gp,1); ret = gpPlot(&gp); gaussplot ret pgp framenum xyratio ret gp.src gpMakeAxesXYDependent Makes the X and Y axes dependent on each other, using the specified XY-ratio. To specify di gpMakeAxesXYZDependent  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpMakeAxesXYZDependent

REMARKS By default, the axes of line plots are sized independently, 2D Cartesian and 2D Contour plots are XY-dependent with an XY-ratio of one, and 3D Cartesian and 3D Contour plots are XYZ-dependent with an XY-ratio of one and an XZ-ratio of one. This means that one unit on the X-axis must be the same length in the plot as one unit on the Y-axis, and for 3D plots, one unit on the X-axis must also be the same length as one unit on the Z-axis.

Changing the XY ratio has an inverse effect on the relative size of the Y-axis in the plot. Thus if you want to decrease the relative size of the Y-axis, then you should increase the XY-ratio. Similarly, to increase the relative size of the Y-axis, decrease the XY-ratio.

Call gpMakeAxesXYDependent to change a plot to XY-dependent or specify a different XY-ratio. To specify different XY and XZ ratios for 3D plots, call gpMakeAxesXYZDependent. Or to allow the axes to be sized independently, call gpMakeAxesIndependent.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gp2DCartesianPlotCreate;

ret = gpSetDataFile(&gp,0,"mydata.plt"); ret = gpMakeAxesXYDependent(&gp,1,10);

ret = gpPlot(&gp);

This example sets the XY-ratio for the first frame to 10, meaning that the length of one unit on the X-axis equals 10 times the length of one unit on the Y-axis.

SOURCE gp.src

SEE ALSO gpMakeAxesXYZDependent, gpMakeAxesIndependent

3-100 GAUSS C R Command Reference 3-101 ); xzratio , xyratio , ect on the relative sizes of the ff framenum gpMakeAxesXYZDependent , gpMakeAxesXYZDependent pgp . Or to allow the. axes to be sized independently, call scalar, ratio of the length ofof one one unit unit on on the the X-axis Y-axis. toscalar, the ratio length of the length ofof one one unit unit on on the the X-axis Z-axis. to the length scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. erent XY and XZ ratios. To change a plot to XY-dependent, call ff  R = gpMakeAxesXYZDependent( Y and Z axes in theand plot. Z axes, Thus then if you you shouldincrease want increase the to the relative decrease sizes XY the of and relative the XZ sizes Y ratios. of and the Similarly, Z to Y axes,This decrease command the applies XY only and to XZspecify 3D ratios. di Cartesian and 3D ContourgpMakeAxesXYDependent plots; call it to gpMakeAxesIndependent xyratio xzratio ret By default, the axes of lineContour plots plots are are sized XY-dependent with independently, an 2D3D XY-ratio Cartesian Contour of and plots one, 2D are and XYZ-dependent 3Dof with Cartesian one. an and XY-ratio This of means one that andplot one an as unit XZ-ratio one on unit the on X-axis thebe must Y-axis, the be and same the for length same 3D as length plots, one in one unit the unit on on the the Z-axis. Changing X-axis the must XY also and XZ ratios has an inverse e pgp framenum Makes the X, Y andand Z XZ axes dependent ratios. on one another, using the specified XY gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpMakeBarPlot

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gp3DCartesianPlotCreate;

ret = gpSetDataFile(&gp,0,"mydata.plt"); ret = gpMakeAxesXYZDependent(&gp,1,10,0.5);

ret = gpPlot(&gp);

This example sets the XY-ratio for the first frame to 10, and the XZ-ratio to 0.5. This means that the length of one unit on the X-axis equals 10 times the length of one unit on the Y-axis and half the length of one unit on the Z-axis.

SOURCE gp.src

SEE ALSO gpMakeAxesXYDependent, gpMakeAxesIndependent

gpMakeBarPlot

PURPOSE Writes a data file and draws a graph with one frame containing a Bar plot.

LIBRARY gaussplot

FORMAT ret = gpMakeBarPlot(pgp, x, y, vnames);

INPUT pgp pointer to a plot control structure created with gpBarPlotCreate. x N×1 vector or N×K matrix, the variable(s) to be associated with the X-axis. y N×1 vector or N×K matrix, the variable(s) to be associated with the Y-axis.

3-102 GAUSS C R Command Reference 1 × 3-103 to a . y K matrix. is an M × and contain will generate x y gpPlot extensions is a null string, the or / vnames gpMakeBarPlot 100) will be 1 vectors, then only and . If < .mcr × x M vnames temporary file path (edit and < are N K matrix, or vice versa, then vnames K matrices, then K line maps ). If y y × × ( . gpMakeBarPlot .plt , if 9 plots a graph with one frame, and GAUSS x VM cols is an N , then + ) y x will be plotted against the corresponding ( ,..., and have x gpCleanUp 02 gp V cols , . The names of these files are stored in the for more information. 01 V gpMakeBarPlot 1 vector and × (or gpSetMacroFile 1 string array or null string, variable names. data file. It writes the variables contained in VM gpCleanUp × is pointing at, so you must still have the structure in your and is an N M scalar, return code, 0 if successful, otherwise an error code. x ,..., pgp .plt 2 to change this path). To delete these temporary files after running . If V y , workspace when you call gpMakeXYLinePlot 1 will be used, since variable names are set once for all zones in the data 1 vector will be plotted against each of the columns in the N V  data file with one zone, using the names in × R generated automatically. If data and macro filegpSetDataFile names have not been specified by calls to After writing the data file, containing one or more line maps. If both temporary names for the datamacro and file macro names files will it begin creates. with respectively. The The temporary files data will and be placedgauss.cfg on the your program, call structure that GAUSS one line map will bewill created. be If created, they and are each both column N in To create a more complicated graph with multiple frames, use Observations containing missing values will bewritten deleted to before the the data data file. is multiple If columns, there then are each missing column values,data will and file, be since written variables to contained a invariables separate are the zone written same in to zone the multiple must zones,vnames be then equal only in the size. first Iffile. two the variable See names in column in the N vnames ret This command allows you to createplot a data Bar to plot a easily, without.plt first writing the string array, then M must equal names  C  OUTPUT REMARKS GAUSS gpMakeBoxPlot

EXAMPLE library gaussplot; #include gp.sdf

// Generate data p = pi; x = seqa(0,p/4,15); y = sin(x); string vnames = { "V1", "V2" };

struct gpPlotControl gp; gp = gpBarPlotCreate; ret = gpMakeBarPlot(&gp,x,y,vnames);

SOURCE gpbarplot.src

SEE ALSO gpBarPlotCreate, gpPlot

gpMakeBoxPlot

PURPOSE Writes a data file and draws a graph with one frame containing a Box plot (box graph percentile plot).

LIBRARY gaussplot

FORMAT ret = gpMakeBoxPlot(pgp, x, y);

INPUT pgp pointer to a plot control structure created with gpBoxPlot. x 1×P vector or N×P matrix, containing the group numbers corresponding to each column of y data. If scalar 0, a sequence from 1 to cols(y) will be generated automatically for the X-axis. y N×P matrix. Each column represents the set of y values for an individual percentile box symbol.

3-104 GAUSS C R Command Reference < grp . If 3-105 if , if 9 . If ) ) . P y before VM , are vnames N y , contain will generate ,..., y gpPlot grp extensions 02 or )+cols( / V gpMakeBoxPlot , grp and 01 .mcr . By default, the data and draws box symbols x V y y temporary file path (edit and reshape( (or cols( (or . gpShowSymbolLayer gpMakeBoxPlot VM .plt plots a graph with one frame, grp GAUSS ,..., , then 2 erent line map. The percentile box V , ff and have 1 . gpCleanUp V y gp . The names of these files are stored in the should be identical. grp gpMakeBoxPlot data file with one zone, using the names in gpSetMacroFile data file. gpCleanUp .plt corresponds to a di is pointing at, so you must still have the structure in your computes percentiles on the data in and to display symbols at the data points. 1 string array, then M must equal y scalar, return code, 0 if successful, otherwise an error code. × to a pgp .plt ) are not displayed. You may call to change this path). To delete these temporary files after running y P, each row of y , × workspace when you call is an M is a null string, the names grp  is N P) and R 100) will be generated automatically. × < grp This command allows you to createplot a data Box to plot a easily, without first writing the If gpMakeBoxPlot to represent those percentiles. It then writes ret is 1 vnames vnames considered a part of theline same maps line as map. there Thus are the columns graph in will contain as many Observations containing missing values will bewritten deleted to before the the data data file. is If there are missing values, and After writing the data file, containing percentile box symbols for each column in symbols and data points that correspond to a particular column of M If data and macro filegpSetDataFile names have not been specified bytemporary calls names to for the datamacro and file macro names files will it begin creates. with respectively. The The temporary files data will and be placedgauss.cfg on the your program, call structure that GAUSS points ( gpMakeBoxPlot To create a more complicated graph with multiple frames, use Each column of  C  OUTPUT REMARKS GAUSS gpMakeHistPlot

multiple columns, then each column will be written to a separate zone in the data file, since variables contained in the same zone must be equal in size. If the variables are written to multiple zones, then only the first two variable names in vnames will be used, since variable names are set once for all zones in the data file. See gpMakeXYLinePlot for more information.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpBoxPlotCreate;

rndseed 12345; nboxes = 5; npoints = 7; x=seqa(1,1,nboxes)’; y=rndn(npoints,nboxes);

call gpMakeBoxPlot(&gp,x,y);

This example illustrates how you may create a Box Plot with five line maps, using defaults for all style and display options.

SOURCE gpboxplot.src

SEE ALSO gpBoxPlotCreate, gpPlot

gpMakeHistPlot

PURPOSE Writes a data file and draws a graph with one frame containing a Hist plot (frequency histogram).

LIBRARY gaussplot

3-106 GAUSS C R Command Reference 3-107 will be x ); , the b vnames gpMakeHistPlot , v , x , ] P [1] [2] [3] [ pgp b b b b and the midpoints of the categories b evenly-spaced categories. The = = = = v < < < < . x x x x < < < will be incremented by one. The categories are 1] freq − P = gpMakeHistPlot( [1] [2] [ b b b } data file. 1 vector, vector of data. 1 vector, the breakpoints to be used to compute the frequencies 1 vector, computed frequency counts. 1 vector, the breakpoints used for each1 category. vector, the midpoints of each category. 1 string array or null string, variable names. – or – × = = = = × × × × × ret P scalar, return code, 0 if successful, otherwise an error code. pointer to a plot controlgpHistPlotCreate structure created with N L scalar, the number of categories. 2 P P ] , .plt P 1 vector, a final breakpoint equal to the maximum value of [1] [2] [3] [ · · · × freq f req f req f req , f req  m R . is a scalar, this command generates is an L , m v v b corresponding element of breakpoints of the categories are storedin in Each time an element falls into one of the categoriesinterpreted specified as in follows: added to the vector of breakpointsIf if the maximum breakpoint value is smaller. freq ret This command allows you to createplot a data Hist to plot a easily, without first writing the If { pgp x v vnames b m  C  INPUT FORMAT OUTPUT REMARKS GAUSS gpMakeHistFPlot

After computing the category and frequency vectors, gpMakeHistPlot writes m and freq to a .plt data file with one zone, using the names in vnames. If vnames is a null string, the names V1 and V2 will be used.

If data and macro file names have not been specified by calls to gpSetDataFile and gpSetMacroFile, then gpMakeHistPlot will generate temporary names for the data and macro files it creates. The temporary data and macro file names will begin with gp and have .plt and .mcr extensions respectively. The files will be placed on the GAUSS temporary file path (edit gauss.cfg to change this path). To delete these temporary files after running your program, call gpCleanUp. The names of these files are stored in the structure that pgp is pointing at, so you must still have the structure in your GAUSS workspace when you call gpCleanUp.

After writing the data file, gpMakeHistPlot plots a graph with one frame, containing one line map. To create a more complicated graph with multiple frames, use gpPlot.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpHistPlotCreate;

x = round(rndn(4000,1)*100); string vnames = { "Cat", "Freq" };

{ b,m,freq,ret } = gpMakeHistPlot(&gp,x,50,vnames);

SOURCE gphistplot.src

SEE ALSO gpHistPlotCreate, gpPlot

gpMakeHistFPlot

3-108 GAUSS C R Command Reference 3-109 will generate will be used. V2 extensions and gpMakeHistFPlot .mcr V1 temporary file path (edit and ); plots a graph with one frame, . gpMakeHistFPlot .plt will be created. data file with one zone, using the GAUSS ) f vnames , then .plt , . f and have rows( , gpCleanUp to a c gp f , . The names of these files are stored in the is a null string, the names and pgp c gpMakeHistFPlot gpSetMacroFile vnames writes . data file. 1 vector, numeric labels for categories. If this is a scalar 0,1 a vector, vector of frequency counts. gpCleanUp 1 string array or null string, variable names. is pointing at, so you must still have the structure in your × × and × . If 2 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot controlgpHistFPlotCreate structure created with N sequence from 1 to N pgp .plt to change this path). To delete these temporary files after running gpPlot vnames workspace when you call  R = gpMakeHistFPlot( If data and macro filegpSetDataFile names have not been specified by calls to After writing the data file, containing one line map. To createframes, a use more complicated graph with multiple temporary names for the datamacro and file macro names files will it begin creates. with respectively. The The temporary files data will and be placedgauss.cfg on the your program, call structure that GAUSS vnames ret This command allows you to createplot a data HistF to plot a easily, without first writing the gpMakeHistFPlot Writes a data file and(frequency draws histogram), a given graph a with vector one of frame frequency containing counts. a HistF plot gaussplot ret pgp c f names in  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpMakeHistPPlot

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpHistFPlotCreate;

f = { 10, 5, 0, 35, 11, 18, 55, 20 }; c = { 10, 20, 30, 40, 50, 60, 70, 80 }; string vnames = { "Cat", "Freq" };

{ b,m,freq,ret } = gpMakeHistFPlot(&gp,x,50,vnames);

SOURCE gphistplot.src

SEE ALSO gpHistFPlotCreate, gpPlot

gpMakeHistPPlot

PURPOSE Writes a data file and draws a graph with one frame containing a HistP plot (percentage histogram).

LIBRARY gaussplot

FORMAT { b, m, freqct, freqp, ret } = gpMakeHistPPlot(pgp, x, v, vnames);

INPUT pgp pointer to a plot control structure created with gpHistPPlotCreate. x N×1 vector, vector of data. v L×1 vector, the breakpoints to be used to compute the frequencies – or – scalar, the number of categories.

3-110 GAUSS C R Command Reference 3-111 writes . If will be x , the vnames b gpMakeHistPPlot gpMakeHistPPlot ] P [1] [2] [3] [ b b b b will be used. and the midpoints of the categories = = = = b V2 evenly-spaced categories. The < < < < v x x x x and V1 < < < will be incremented by one. The categories are 1] − freqct P [1] [2] [ b b b data file with one zone, using the names in = = = = data file. 1 vector, the breakpoints used for each1 category. vector, the midpoints of each category. 1 vector, computed frequency counts. 1 vector, computed frequency percentages. 1 string array or null string, variable names. × × × × × .plt ] 2 P P P P scalar, return code, 0 if successful, otherwise an error code. P [2] [3] [1] [ .plt to a 1 vector, a final breakpoint equal to the maximum value of · · · × is a null string, the names f reqct f reqct f reqct . f reqct  freqp R . is a scalar, this command generates is an L m freqp and v v vnames breakpoints of the categories are storedin in Each time an element falls into one of the categories specified in vnames b m freqct freqp ret This command allows you to createplot a data HistP to plot a easily, without first writing the If added to the vector of breakpointsIf if the maximum breakpoint value is smaller. corresponding element of interpreted as follows: m After computing the category and frequency vectors, The frequency percentages are calculated fromin the frequency counts and stored  C  OUTPUT REMARKS GAUSS gpMakeLogLogPlot

If data and macro file names have not been specified by calls to gpSetDataFile and gpSetMacroFile, then gpMakeHistPPlot will generate temporary names for the data and macro files it creates. The temporary data and macro file names will begin with gp and have .plt and .mcr extensions respectively. The files will be placed on the GAUSS temporary file path (edit gauss.cfg to change this path). To delete these temporary files after running your program, call gpCleanUp. The names of these files are stored in the structure that pgp is pointing at, so you must still have the structure in your GAUSS workspace when you call gpCleanUp.

After writing the data file, gpMakeHistPPlot plots a graph with one frame, containing one line map. To create a more complicated graph with multiple frames, use gpPlot.

EXAMPLE library gaussplot; #include gp.sdf

struct gpPlotControl gp; gp = gpHistPPlotCreate;

x = round(rndn(4000,1)*100); string vnames = { "Cat", "Prcnt" };

{ b,m,freqct,freqp,ret } = gpMakeHistPPlot(&gp,x,50,vnames);

SOURCE gphistplot.src

SEE ALSO gpHistPPlotCreate, gpPlot

gpMakeLogLogPlot

PURPOSE Writes a data file and draws a graph with one frame containing a LogLog plot.

LIBRARY gaussplot

3-112 GAUSS C R Command Reference . 1 × to a 3-113 y and is an M will x .mcr temporary file is a null string, gpLogLogPlot 100) will be and vnames < M 1 vectors, then only . If × .plt GAUSS < vnames gpMakeLogLogPlot . If ); are N ) , if 9 K matrix, or vice versa, then vnames K matrices, then K line maps y plots a graph with one frame, y × × . gpMakeLogLogPlot VM and have and vnames gp x is an N ,..., , then , )+cols( . The names of these files are stored in y y x 02 will be plotted against the corresponding , V x x , gpCleanUp K matrix, the variable(s) to be associated with K matrix, the variable(s) to be associated with 01 , × × cols( V pgp gpCleanUp (or gpMakeLogLogPlot 1 vector and × data file. It writes the variables contained in VM to change this path). To delete these temporary files after gpSetMacroFile is pointing at, so you must still have the structure in your 1 string array or null string, variable names. 1 vector or N 1 vector or N × × × and ,..., pgp .plt is an N 2 pointer to a plot control structure createdN with the X-axis. N the Y-axis. M scalar, return code, 0 if successful, otherwise an error code. x V , 1 . If y V gauss.cfg workspace when you call  data file with one zone, using the names in R = gpMakeLogLogPlot( the structure that GAUSS After writing the data file, containing one or more line maps. If both generated automatically. If data and macro filegpSetDataFile names have not been specified bygenerate calls temporary to names for thedata data and and macro macro file files names itextensions will creates. respectively. begin The The with temporary files will bepath placed (edit on the running your program, call one line map will bewill created. be If created, they and are each both column N in column in ret pgp x y vnames ret A LogLog plot is simplyaxes. an XY Line plot that uses log scaling on theThis X command and allows Y you to createthe a plot LogLog data plot to easily, a without first writing .plt string array, then M must equal the names  C  INPUT FORMAT OUTPUT REMARKS GAUSS gpMakeLogXPlot

the N×1 vector will be plotted against each of the columns in the N×K matrix. To create a more complicated graph with multiple frames, use gpPlot.

Observations containing missing values will be deleted before the data is written to the data file. If there are missing values, and x and/or y contain multiple columns, then each column will be written to a separate zone in the data file, since variables contained in the same zone must be equal in size. If the variables are written to multiple zones, then only the first two variable names in vnames will be used, since variable names are set once for all zones in the data file. See gpMakeXYLinePlot for more information.

EXAMPLE library gaussplot; #include gp.sdf

// Generate data x = seqa(0.2,0.2,20); y = log(x)˜ln(x); string vnames = { "V1", "V2", "V3" };

struct gpPlotControl gp; gp = gpLogLogPlotCreate; ret = gpMakeLogLogPlot(&gp,x,y,vnames);

SOURCE gplogplot.src

SEE ALSO gpLogLogPlotCreate, gpPlot

gpMakeLogXPlot

PURPOSE Writes a data file and draws a graph with one frame containing a LogX plot.

LIBRARY gaussplot

FORMAT ret = gpMakeLogXPlot(pgp, x, y, vnames);

3-114 GAUSS C R Command Reference 1 × . 3-115 to a . y K matrix. is an M × and will generate x is a null string, gpPlot gpLogXPlot 100) will be extensions vnames < gpMakeLogXPlot M 1 vectors, then only . If .mcr × < vnames temporary file path (edit and . If are N ) , if 9 K matrix, or vice versa, then vnames K matrices, then K line maps y y × × . gpMakeLogXPlot .plt VM plots a graph with one frame, and GAUSS x is an N ,..., , then )+cols( y x 02 will be plotted against the corresponding and have V x , gpCleanUp K matrix, the variable(s) to be associated with K matrix, the variable(s) to be associated with gp 01 × × cols( V . The names of these files are stored in the (or gpMakeLogXPlot 1 vector and × VM gpSetMacroFile 1 string array or null string, variable names. data file. It writes the variables contained in 1 vector or N 1 vector or N gpCleanUp × is pointing at, so you must still have the structure in your × × and ,..., is an N 2 N M scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure createdN with the X-axis. the Y-axis. x V pgp , .plt to change this path). To delete these temporary files after running 1 . If y V workspace when you call 1 vector will be plotted against each of the columns in the N  data file with one zone, using the names in × R After writing the data file, containing one or more line maps. If both generated automatically. If data and macro filegpSetDataFile names have not been specified bytemporary calls names to for the datamacro and file macro names files will it begin creates. with respectively. The The temporary files data will and be placedgauss.cfg on the your program, call structure that GAUSS one line map will bewill created. be If created, they and are each both column N in To create a more complicated graph with multiple frames, use Observations containing missing values will be deleted before the data is column in the N y vnames ret A LogX plot is simply an XY Line plot thatThis uses command log allows scaling you on to the createplot X-axis. a data LogX to plot a easily, without first writing the pgp x .plt string array, then M must equal the names  C  INPUT OUTPUT REMARKS GAUSS gpMakeLogYPlot

written to the data file. If there are missing values, and x and/or y contain multiple columns, then each column will be written to a separate zone in the data file, since variables contained in the same zone must be equal in size. If the variables are written to multiple zones, then only the first two variable names in vnames will be used, since variable names are set once for all zones in the data file. See gpMakeXYLinePlot for more information.

EXAMPLE library gaussplot; #include gp.sdf

// Generate data x = seqa(0.2,0.2,20); y = log(x)˜ln(x); string vnames = { "V1", "V2", "V3" };

struct gpPlotControl gp; gp = gpLogXPlotCreate; ret = gpMakeLogXPlot(&gp,x,y,vnames);

SOURCE gplogplot.src

SEE ALSO gpLogXPlotCreate, gpPlot

gpMakeLogYPlot

PURPOSE Writes a data file and draws a graph with one frame containing a LogY plot.

LIBRARY gaussplot

FORMAT ret = gpMakeLogYPlot(pgp, x, y, vnames);

INPUT pgp pointer to a plot control structure created with gpLogYPlot.

3-116 GAUSS C R Command Reference 1 × 3-117 to a . y K matrix. is an M × and contain will generate x y is a null string, gpPlot 100) will be extensions or / vnames < gpMakeLogYPlot M 1 vectors, then only and . If .mcr × x < vnames temporary file path (edit and . If are N ) , if 9 K matrix, or vice versa, then vnames K matrices, then K line maps y y × × . gpMakeLogYPlot .plt VM plots a graph with one frame, and GAUSS x is an N ,..., , then )+cols( y x 02 will be plotted against the corresponding and have V x , gpCleanUp K matrix, the variable(s) to be associated with K matrix, the variable(s) to be associated with gp 01 × × cols( V . The names of these files are stored in the (or gpMakeLogYPlot 1 vector and × VM gpSetMacroFile 1 string array or null string, variable names. data file. It writes the variables contained in 1 vector or N 1 vector or N gpCleanUp × is pointing at, so you must still have the structure in your × × and ,..., is an N 2 N M scalar, return code, 0 if successful, otherwise an error code. N the X-axis. the Y-axis. x V pgp , .plt to change this path). To delete these temporary files after running 1 . If y V workspace when you call 1 vector will be plotted against each of the columns in the N  data file with one zone, using the names in × R After writing the data file, containing one or more line maps. If both generated automatically. If data and macro filegpSetDataFile names have not been specified bytemporary calls names to for the datamacro and file macro names files will it begin creates. with respectively. The The temporary files data will and be placedgauss.cfg on the your program, call structure that GAUSS one line map will bewill created. be If created, they and are each both column N in To create a more complicated graph with multiple frames, use Observations containing missing values will bewritten deleted to before the the data data file. is If there are missing values, and column in the N y vnames ret A LogY plot is simply an XY Line plot thatThis uses command log allows scaling you on to the createplot Y-axis. a data LogY to plot a easily, without first writing the x .plt string array, then M must equal the names  C  OUTPUT REMARKS GAUSS gpMakePolarLinePlot

multiple columns, then each column will be written to a separate zone in the data file, since variables contained in the same zone must be equal in size. If the variables are written to multiple zones, then only the first two variable names in vnames will be used, since variable names are set once for all zones in the data file. See gpMakeXYLinePlot for more information.

EXAMPLE library gaussplot; #include gp.sdf

// Generate data x = seqa(0.2,0.2,20); y = log(x)˜ln(x); string vnames = { "V1", "V2", "V3" };

struct gpPlotControl gp; gp = gpLogYPlotCreate; ret = gpMakeLogYPlot(&gp,x,y,vnames);

SOURCE gplogplot.src

SEE ALSO gpLogYPlotCreate, gpPlot

gpMakePolarLinePlot

PURPOSE Writes a data file and draws a graph with one frame containing a Polar Line plot.

LIBRARY gaussplot

FORMAT ret = gpMakePolarLinePlot(pgp, theta, r, vnames);

INPUT pgp pointer to a plot control structure created with gpPolarLinePlotCreate.

3-118 GAUSS C R Command Reference is theta 3-119 will vnames is a null contain 100) will 1 vectors, K matrix, or r < . If × × .mcr or / M temporary file < vnames and are N and r is an N vnames K matrices, then K r ). If × , if 9 y ( .plt theta GAUSS and VM plots a graph with one will be plotted against the gpMakePolarLinePlot cols theta + ) ,..., x . gpMakePolarLinePlot theta ( and have 02 1 vector and V × gp , cols , then 01 . The names of these files are stored in V is an N gpCleanUp (or K matrix, the variable(s) to be associated with K matrix, the variable(s) to be associated with × × data file. It writes the variables contained in theta VM gpCleanUp gpMakePolarLinePlot . If r .plt ,..., 2 1 vector will be plotted against each of the columns in to change this path). To delete these temporary files after gpSetMacroFile is pointing at, so you must still have the structure in your × V , 1 string array or null string, variable names. 1 1 vector or N 1 vector or N × × × and V pgp data file with one zone, using the names in N M scalar, return code, 0 if successful, otherwise an error code. N the Theta-axis. the R-axis. .plt gauss.cfg workspace when you call . K matrix. To create a more complicated graph with multiple frames, use 1 string array, then M must equal  to a × × R r then only one line mapline will maps be will created. be If created, they and are each both column N in the structure that GAUSS After writing the data file, frame, containing one or more line maps. If both corresponding column in generate temporary names for thedata data and and macro macro file files names itextensions will creates. respectively. begin The The with temporary files will bepath placed (edit on the running your program, call vice versa, then the N the N gpPlot Observations containing missing values will bewritten deleted to before the the data data file. is multiple If columns, there then are each missing column values, will and be written to a separate zone in the and an M string, the names be generated automatically. If data and macro filegpSetDataFile names have not been specified by calls to r vnames ret This command allows you to createwriting a the plot Polar data Line to plot a easily, without first theta  C  OUTPUT REMARKS GAUSS gpMakeVectorsTangent

data file, since variables contained in the same zone must be equal in size. If the variables are written to multiple zones, then only the first two variable names in vnames will be used, since variable names are set once for all zones in the data file. See gpMakeXYLinePlot for more information.

EXAMPLE library gaussplot; #include gp.sdf

// Generate data theta1 = seqa(0,5,37); theta2 = seqa(270,5,19)|seqa(5,5,18); r1 = sin(theta1*pi/180); r2 = cos(theta2*pi/180); string vnames = { "Theta1", "Theta2", "R1", "R2" };

struct gpPlotControl gp; gp = gpPolarLinePlotCreate; ret = gpMakePolarLinePlot(&gp,theta1˜theta2,r1˜r2,vnames);

SOURCE gppolarlineplot.src

SEE ALSO gpPolarLinePlotCreate, gpPlot

gpMakeVectorsTangent

PURPOSE Projects the vectors in the vector layer onto the 3D field zone surface.

LIBRARY gaussplot

FORMAT ret = gpMakeVectorsTangent(pgp, framenum, fieldzonenum, tangent);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number.

3-120 GAUSS C R Command Reference 3-121 , gpMakeXYLinePlot gpMakeXYLinePlot argument set to 1 causes the gpSetVectorType , tangent . To activate the vector layer in a frame, ff with a 1 vector, field zone number(s). × . When the vector layer is activated, plain arrow gpSetVectorColor , do not project vectors onto theproject 3D vectors field onto zone the surface. 3D field zone surface. 0 1 scalar, return code, 0 if successful, otherwise an error code. scalar or N scalar, one of the following: gpMakeVectorsTangent  R gpShowVectorLayer framenum = 1; seton = 1; fieldzonenum = 2; tangent = 1; ret = gpShowVectorLayer(&gp,framenum,seton); ret = gpSetMakeVectorsTangent(&gp,framenum,fieldzonenum,tangent); Writes a data file and draws a graph with one frame containing an XY Line plot. call heads are used by default. Field zone numbers correspond tofile. the number of the associated zone in the data gpfieldzone.src gpShowVectorLayer component of the vectors normal togiving you the vectors 3D that field are zone tangent surface to to the be surface. removed, By default, the vector layer is turned o gpSetVectorVariables ret Calling fieldzonenum tangent  C  OUTPUT SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpMakeXYLinePlot

LIBRARY gaussplot

FORMAT ret = gpMakeXYLinePlot(pgp, x, y, vnames);

INPUT pgp pointer to a plot control structure created with gpXYLinePlotCreate. x N×1 vector or N×K matrix, the variable(s) to be associated with the X-axis. y N×1 vector or N×K matrix, the variable(s) to be associated with the Y-axis. vnames M×1 string array or null string, variable names.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command allows you to create an XY Line plot easily, without first writing the plot data to a .plt data file. It writes the variables contained in x and y to a .plt data file with one zone, using the names in vnames. If vnames is an M×1 string array, then M must equal cols(x)+cols(y). If vnames is a null string, the names V1, V2,..., VM (or V01, V02,..., VM, if 9 < M < 100) will be generated automatically.

If data and macro file names have not been specified by calls to gpSetDataFile and gpSetMacroFile, then gpMakeXYLinePlot will generate temporary names for the data and macro files it creates. The temporary data and macro file names will begin with gp and have .plt and .mcr extensions respectively. The files will be placed on the GAUSS temporary file path (edit gauss.cfg to change this path). To delete these temporary files after running your program, call gpCleanUp. The names of these files are stored in the structure that pgp is pointing at, so you must still have the structure in your GAUSS workspace when you call gpCleanUp.

After writing the data file, gpMakeXYLinePlot plots a graph with one frame, containing one or more line maps. If both x and y are N×1 vectors, then only one line map will be created. If they are both N×K matrices, then K line maps will be created, and each column in x will be plotted against the corresponding column in y. If x is an N×1 vector and y is an N×K matrix, or vice versa, then

3-122 GAUSS C R Command Reference 3-123 . K matrix. × contain y gpPlot or / and x gpMakeXYLinePlot will be used, since variable names are set once for all zones in the data 1 vector will be plotted against each of the columns in the N  0 0.5 1 1.5 2 2.5 3 3.5 57.29 . 3.5 . 4.7 15 4 12 17 813.4 20 29 . × R x = y = To create a more complicated graph with multiple frames, use Observations containing missing values will bewritten deleted to before the the data data file. is multiple If columns, there then are each missing column values,data will and file, be since written variables to contained a invariables separate are the zone written same in to zone the multiple must zones,vnames be then equal only in the size. first Iffile. two the variable For names example, in suppose that the variables for an XY Line plot are as follows: with variable names set to “X”out and as “Y”. follows: The generated data file would be laid the N  C  GAUSS gpMoveContourLegend

Zone 1 Variable Observations Data X 8 x Y 8 y[.,1]

Zone 2 Variable Observations Data X 5 x[3:7] Y 5 y[3:7,2]

EXAMPLE library gaussplot; #include gp.sdf

// Generate data x = seqa(0.2,0.2,20); y = log(x)˜ln(x); string vnames = { "V1", "V2", "V3" };

struct gpPlotControl gp; gp = gpXYLinePlotCreate; ret = gpMakeXYLinePlot(&gp,x,y,vnames);

SOURCE gpxylineplot.src

SEE ALSO gpXYLinePlotCreate, gpPlot

gpMoveContourLegend

PURPOSE Moves a contour legend to a specified location in the frame.

LIBRARY gaussplot

3-124 GAUSS C R Command Reference , 3-125 xpos , , contourgroupnum , gpMoveFieldZoneLegend framenum , must be preceded by a call to ypos); pgp gpSetContourLegendOrientation , . scalar, contour group number pointer to a plot control structure scalar, frame number scalar, horizontal location of the uppercontour right-hand legend corner as of a the percentage of the frame width. scalar, vertical location of the uppercontour right-hand legend corner as of a the percentage of the frame height. scalar, return code, 0 if successful, otherwise an error code. gpMoveContourLegend  R ); = gpMoveContourLegend( framenum = 1; contourgroupnum = 1; xpos = 85; ypos = 80; ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpMoveContourLegend(&gp,framenum,contourgroupnum,xpos, gpcontourplot.src gpAddContourLegend ret ypos pgp framenum contourgroupnum xpos ypos ret A call to gpAddContourLegend gpSetContourLegendBoxStyle  C  INPUT FORMAT OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpMoveFieldZoneLegend

gpMoveFieldZoneLegend

PURPOSE Moves a field zone legend frame to a specified location in the parent frame.

LIBRARY gaussplot

FORMAT ret = gpMoveFieldZoneLegend(pgp, framenum, xpos, ypos);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number of the parent frame. xpos scalar, horizontal location of the upper right-hand corner of the field zone legend frame as a percentage of the parent frame width. ypos scalar, vertical location of the upper right-hand corner of the field zone legend frame as a percentage of the parent frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpMoveFieldZoneLegend must be preceded by a call to gpAddFieldZoneLegendFrame.

The parent frame is the frame that the field zone legend describes. The field zone legend frame is an inset inside the parent frame.

EXAMPLE framenum = 1; xpos = 97; ypos = 15;

ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpMoveFieldZoneLegend(&gp,framenum,xpos,ypos);

SOURCE gpfieldzone.src

3-126 GAUSS C R Command Reference 3-127 , ); height , gpMoveFrame gpMoveFrame width , ypos , xpos , gpSetFieldZoneLegendBoxStyle , framenum , pgp pointer to a plot control structure scalar, frame number scalar, distance between the left-hand sideleft-hand of edge the of frame the and workspace the in paperscalar, ruler distance units. between the top ofthe the workspace frame in and paper the ruler top units. edgescalar, of width of the frame in paperscalar, ruler height units. of the frame in paper ruler units. scalar, return code, 0 if successful, otherwise an error code. .  R = gpMoveFrame( library gaussplot; #include gp.sdf struct gpPlotControl gp; gp = gpPlotCreate; gpSetFieldZoneLegendLineSpacing pgp framenum xpos ypos width height ret By default, all frames have afrom width the of left 9, edge a of heightframes the of will workspace, 8, be and and stacked 0.25 are one units locatedgpMoveFrame on from 1 top the unit of top another edge. unless Multiple a call is made to gpAddFieldZoneLegendFrame Moves and resizes a frame in the workspace. gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpMoveLineLegend

ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAddBarFrame(&gp); gpAddXYLineFrame(&gp);

framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height);

framenum = 2; xpos = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp);

This example creates a Bar plot frame and an XY Line plot frame, making the latter an inset in the lower left-hand corner of the former.

SOURCE gp.src

SEE ALSO gpSetFrameName, gpSetFrameStyle

gpMoveLineLegend

PURPOSE Moves a line legend to a specified location in the frame.

LIBRARY gaussplot

FORMAT ret = gpMoveLineLegend(pgp, framenum, xpos, ypos);

3-128 GAUSS C R Command Reference 3-129 . GAUSSplot gpOpenLayoutFile gpOpenLayoutFile , ); wait , . datafile , must be preceded by a call to gpSetLineLegendLineSpacing , layoutfile GAUSSplot gpSetLineLegendBoxStyle , . string, the name of a layout file created in scalar, horizontal location of the upperline right-hand legend corner as of a the percentage ofscalar, the vertical frame location width. of the upperline right-hand legend corner as of a the percentage of the frame height. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. gpMoveLineLegend  R framenum = 1; xpos = 85; ypos = 80; ret = gpAddLineLegend(&gp,framenum); ret = gpMoveLineLegend(&gp,framenum,xpos,ypos); Opens a layout file in gaussplot gpOpenLayoutFile( layoutfile gplinemap.src gpAddLineLegend gpSetLineLegendMargin xpos ypos ret A call to gpAddLineLegend pgp framenum  C  INPUT INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpPlot

datafile string or null string, data file name. wait scalar, one of the following: 0 do not wait; return to GAUSS immediately. 1 wait until the GAUSSplot window has been closed to return to GAUSS.

REMARKS In GAUSSplot it is possible to save all of the information for a graph as a layout file. This allows you to create a graph using GAUSSplot commands, modify the graph using the buttons and menu options in the GAUSSplot GUI, and then save the information for the modified graph to a file that can be re-opened later.

The layout file will contain the name of the data file(s) used to create the graph. To re-open the layout file with the same data file(s), call gpOpenLayoutFile, setting datafile to a null string. If datafile contains a data file name, the layout file will be opened with the data from the specified file. The new data file must have at least as many zones and variables as the original data file(s).

EXAMPLE wait = 0; gpOpenLayoutFile("layout.lay","mydata.plt",wait);

SOURCE gp.src

gpPlot

PURPOSE Draws a graph.

LIBRARY gaussplot

FORMAT ret = gpPlot(pgp);

INPUT pgp pointer to a plot control structure.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

3-130 GAUSS C R Command Reference 3-131 , then gpPlot to set the for 1.8 gpPlot to change this path). is pointing at, so you before gpSetMacroFile pgp extension. The file will be .mcr gauss.cfg workspace when you call gpSetDataFile GAUSS and have an gp "V1" "V3" }; after running you program (see Section temporary file path (edit GAUSS . gpCleanUp is pointing at. You must call will generate a temporary name for the macro file it creates. The  R pgp library gaussplot; #include gp.sdf // Generate data p = pi; x = seqa(0,p/4,15); y1 = sin(x); y2 = cos(x); string vnames =framenum { = "V1", 1; string "V2", linemaps "V3" = }; { "V1" "V2", struct gpData gdat; gdat = gpSetPlotData(x˜y1˜y2,vnames); ret = gpWritePlotData(&gdat,"mydata.plt"); struct gpPlotControl gp; gp = gpBarPlotCreate; ret = gpSetDataFile(&gp,framenum,"mydata.plt"); information on structure files). The names of these files aremust stored still in have the the structure structure that ingpCleanUp your This command creates a graphthat using the information contained indata the file(s) structure that will be used in the graph. If a macro file namegpPlot has not been specified bytemporary a name call will to begin with placed on the To delete this temporary file, asgraph, well call as the data and structure files used for the  C  EXAMPLE REMARKS GAUSS gpPlotCreate

ret = gpSetLineMaps(&gp,framenum,linemaps); ret = gpPlot(&gp);

The above example creates a graph with one frame containing two Bar plot line maps. In the first line map, V1 is associated with the X-axis and V2 with the Y-axis. In the second line map, V1 is again associated with the X-axis, and V3 is associated with the Y-axis.

SOURCE gp.src

SEE ALSO gpPlotCreate, gpOpenLayoutFile

gpPlotCreate

PURPOSE Creates a plot control structure and initializes its members to generic default values for a graph with frames containing different plot types.

LIBRARY gaussplot

FORMAT gp = gpPlotCreate;

OUTPUT gp plot control structure with its members set to generic default values.

REMARKS Use gpPlotCreate to create a plot control structure that does not have a plot type set for the entire graph. Since the graph has no plot type, it contains no frames by default. Therefore, you must add frames to the graph, using one or more of the following commands:

3-132 GAUSS C R Command Reference 3-133 . gpPlotCreate gpPlotCreate to plot a graph initialized with gpPlot gpAdd2DCartesianFrame gpAdd2DContourFrame gpAdd3DCartesianFrame gpAdd3DContourFrame gpAddBarFrame gpAddPolarLineFrame gpAddXYLineFrame  R library gaussplot; #include gp.sdf struct gpPlotControl gp; gp = gpPlotCreate; ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAdd2DContourFrame(&gp); gpAdd3DContourFrame(&gp); framenum = 1; xpos = 0.25; ypos = 0.25; width = 10.5; height = 8; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); framenum = 2; xpos = 2; ypos = 4.6; width = 3.5; height = 2.5; ret = gpMoveFrame(&gp,framenum,xpos,ypos,width,height); ret = gpPlot(&gp); The frames will be numberedwith in one. the order in which they are added, beginning You must use  C  EXAMPLE GAUSS gpPolarLinePlotCreate

The above example creates a graph with two frames. The first contains a 2D Contour plot, and the second a 3D Contour plot. The frames are moved and resized so that the second frame is an inset drawn in the lower left-hand corner of the first frame.

This example assumes that mydata.plt already exists and contains at least three variables. By default, a 2D Contour frame associates the first variable in the data file with the X-axis, the second variable with the Y-axis, and uses the last variable as the contour variable. Similarly, a 3D Contour frame associates the first three variables with the X, Y and Z axes, respectively, and uses the last variable as the contour variable.

SOURCE gp.src

SEE ALSO gpPlot

gpPolarLinePlotCreate

PURPOSE Creates a plot control structure and initializes its members to default values for a Polar Line plot.

LIBRARY gaussplot

FORMAT gp = gpPolarLinePlotCreate;

OUTPUT gp plot control structure with its members set to default values for a Polar Line plot.

REMARKS You may use gp to plot a graph using either gpMakePolarLinePlot or gpPlot. Calling gpPolarLinePlotCreate sets the plot type of the entire graph to Polar Line. To create a graph with multiple frames that contain plots of different types, use gpPlotCreate.

3-134 GAUSS C R Command Reference 3-135 ) will ); V1 top contains , ) with the R-axis. gpPositionGrid V2 bottom gpPositionGrid , right , left , gpPolarLinePlotCreate framenum , pgp gpPlot , scalar, frame number. pointer to a plot control structure.  R = gpPositionGrid( library gaussplot; #include gp.sdf theta = seqa(0,5,37); r = sin(theta*pi/180); string vnames = { "V1",struct "V2" gpPlotControl }; gp; gp = gpPolarLinePlotCreate; ret = gpMakePolarLinePlot(&gp,theta,r,vnames); framenum Positions the grid in a frame. gaussplot ret pgp one frame by default. gppolarlineplot.src gpMakePolarLinePlot This example illustrates how you maymap, create using a defaults Polar for Line all plot style with and one display line options. The first variable ( A plot control structure initialized with be associated with the Theta-axis, and the second variable (  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpPositionXAxis

left scalar, position of the left edge of the grid in frame units (0 - 100). right scalar, position of the right edge of the grid in frame units (0 - 100). bottom scalar, position of the bottom edge of the grid in frame units (0 - 100). top scalar, position of the top edge of the grid in frame units (0 - 100).

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The bottom-left corner of the frame is position (0,0) in frame units.

The default position of the grid is as follows:

left = 13; right = 88; bottom = 11; top = 88;

This command applies ONLY to Bar, XY Line, 2D Cartesian and 2D Contour plots.

EXAMPLE framenum = 1; left = 20; right = 88; bottom = 11; top = 88; ret = gpPositionGrid(&gp,framenum,left,right,bottom,top);

SOURCE gp.src

SEE ALSO gpPositionXAxis, gpPositionYAxis

3-136 GAUSS C R Command Reference 3-137 ); coord argument , gpPositionXAxis position axisnum , gpPositionXAxis ) in Y grid coordinates. on the vertical gridline as a on the corresponding Y-axis (the axisnum percent of the grid height below percent of the grid height above to link one or more line maps to an , axisnum position position 5, X-axis number. position position ≤ framenum , pgp axisnum ≤ gpSetLineMapAxes Y-axis with the same the grid minimum. the grid maximum. position X-axis at position X-axis position X-axis position X-axis at percentage of the grid height. scalar, 1 scalar, X-axis position. scalar, position coordinate system, one of the1 following: 2 3 4 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R = gpPositionXAxis( axisnum position coord ret Line plots allow up to five X and Y axes in a frame. The pgp framenum Positions an X-axis line in the specified frame. gaussplot ret specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one. By default, the first X-axissubsequent in X a axes frame are is positioned positioned at at the the grid grid maximum. minimum, and  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpPositionYAxis

This command applies ONLY to Bar, XY Line, 2D Cartesian and 2D Contour plots.

EXAMPLE framenum = 1; axisnum = 1; position = 50; coord = 4; ret = gpPositionXAxis(&gp,framenum,axisnum,position,coord);

This example vertically centers the first X-axis in the grid.

SOURCE gp.src

SEE ALSO gpPositionGrid, gpShowXAxis, gpSetXAxisColor

gpPositionYAxis

PURPOSE Positions a Y-axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpPositionYAxis(pgp, framenum, axisnum, position, coord);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. position scalar, Y-axis position. coord scalar, position coordinate system, one of the following: 1 position Y-axis at position on the corresponding X-axis (the X-axis with the same axisnum) in X grid coordinates. 2 position Y-axis position percent of the grid width to the left of the grid minimum.

3-138 GAUSS C R Command Reference 3-139 gpPrint gpPrint argument axisnum on the horizontal gridline as a percent of the grid width to the to link one or more line maps to a position position gpSetYAxisColor , gpSetLineMapAxes position Y-axis at percentage of the grid width. position Y-axis right of the grid maximum. gpShowYAxis , 4 scalar, return code, 0 if successful, otherwise an error code. 3  R framenum = 1; axisnum = 1; position = 0; coord = 3; ret = gpPositionYAxis(&gp,framenum,axisnum,position,coord); gp.src gpPositionGrid This example positions the first Y-axisof at the the grid). grid maximum (on the right edge ret Line plots allow up to five X and Y axes in a frame. The specifies which Y-axis the option iscontain set line for, plots. and By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. By default, the first Y-axis insubsequent a Y frame axes is are positioned positioned at at the the grid grid minimum, maximum. and This command applies ONLY to Bar,plots. XY Line, 2D Cartesian and 2D Contour  C  OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpPrint

PURPOSE Prints the graph.

LIBRARY gaussplot

FORMAT gpPrint(pgp);

INPUT pgp pointer to a plot control structure.

REMARKS Calling gpPrint causes the graph to be printed as soon as it has been plotted with gpPlot or one of the gpMakePlotTypePlot commands.

On Windows, the graph is printed to the default printer.

On UNIX and Linux, the graph is printed using the print spooler commands specified in the tecplot.cfg file found in the gaussplot subdirectory of your GAUSS installation directory. The tecplot.cfg file contains some sample print spooler commands that are commented out. You must set up the print spooler commands before you call gpPrint on UNIX or Linux. The syntax for the print spooler commands is as follows:

$!PRINTSETUP SPOOLER { print format = "spooler cmd" }

where spooler cmd is the desired spooler command, and print format is one of the following:

print format Used for PSMONOSPOOLCMD monochrome PostScript print output PSCOLORSPOOLCMD color PostScript print output HPGLSPOOLCMD HP-GL print output HPGL2MONOSPOOLCMD monochrome HP-GL/2 print output HPGL2COLORSPOOLCMD color HP-GL/2 print output

3-140 GAUSS C R Command Reference 3-141 2, you may do / , gpPrintToFile gpPrintToFile . gpPrintToFile 2 print output. , gpPrint / . . If you want to print to a file instead of a before calling gpSetPrintFormat , gpSetPrintFormat gpPrintToFile gpSetPrintPalette  { PSMONOSPOOLCMD = "lprHPGL2COLORSPOOLCMD @; = rm "lpr} @" -P hp5550 @; rm @" R SPOOLER monochrome = 1; ret = gpSetPrintPalette(&gp,monochrome); gpPrint(&gp); $!PRINTSETUP By default, the graph isimage, printed call in color. To print theprinter, graph call as a monochrome gp.src gpSetPrintPalette so by calling gpSetPaperOrientation specifies that the spooler commandmonochrome “lpr PostScript @; print rm output, @” and is@; the to rm spooler be @” command used is “lpr for to -P all be hp5550 used for all color HP-GL Use ‘@’ as a placeexample: holder for the file name in your spooler command. For The default format for printrecommend output that on you UNIX always and use Linux PostScriptyou is as want PostScript. to your We change print the format. print However, if output format to HP-GL or HP-GL  C  SOURCE EXAMPLE SEE ALSO GAUSS gpRedefineColor

PURPOSE Specifies a print output file name or sets print output to go to printer.

LIBRARY gaussplot

FORMAT gpPrintToFile(pgp, filename);

INPUT pgp pointer to a plot control structure. filename string, name of print output file.

REMARKS If filename contains a file name, then all subsequent print jobs (specified by the gpPrint command) will be sent to that file, instead of a printer, until another call to gpPrintToFile is encountered. If filename is a null string, all subsequent print jobs will be sent to a printer.

On UNIX/Linux, the type of output file that is created depends on the print output format specified with gpSetPrintFormat. By default, the ouptut file is PostScript.

On Windows, printing to a file generates a .prn file containing printer commands. To print a .prn file created by a call to gpPrintToFile, type the following at a command prompt:

copy file name lpt1 /b

Calling gpPrintToFile with a file name does not cause the graph to be printed to the file. It merely specifies that all subsequent print jobs be sent to the file. The command must be succeeded by a call to gpPrint.

By default, gpPrint sends output to a printer, not to a file.

EXAMPLE gpSetPrintToFile(&gp,"print.ps"); gpPrint(&gp);

SOURCE gp.src

SEE ALSO gpPrint, gpSetPrintFormat, gpSetPrintPalette

3-142 GAUSS C R Command Reference 2.2.1 3-143 . ); gpRotateAxes bvalue , GAUSSplot gpRedefineColor 255, green value(s). 255, blue value(s). 255, red value(s). gvalue ≤ ≤ ≤ , rvalue rvalue gvalue bvalue ≤ ≤ ≤ , color , 1 vector, 0 1 vector, 0 1 vector, 0 1 vector, indices of color(s) in color list. 1 string array, name(s) of color(s) to redefine. 1 vectors for all of the arguments. See Section pgp × × × × × × , use N – or – scalar or N scalar or N scalar or N scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. string or N scalar or N  R = gpRedefineColor( framenum = 1; fieldzonenum = 1; ret = gpRedefineColor(&gp,"custom6",55,127,199); ret = gpSetMeshColor(&gp,framenum,fieldzonenum,"custom6"); Output When you redefine a colorgraph in will the use color the palette, new all definition.gpRedefineColor instances of To redefine that multiple color colors in withfor the one the call list to of colors; color names are case insensitive in gp.src rvalue gvalue bvalue ret pgp color Sets the RGB values for a color in the color palette. gaussplot ret  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS GAUSS gpRotateAxes

gpRotateAxes

PURPOSE Rotates a plot about the X, Y and Z axes.

LIBRARY gaussplot

FORMAT ret = gpRotateAxes(pgp, framenum, xrotation, yrotation, zrotation);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. xrotation scalar, −180 ≤ xrotation ≤ 180, rotation about the X-axis in degrees. yrotation scalar, −180 ≤ yrotation ≤ 180, rotation about the Y-axis in degrees. zrotation scalar, −180 ≤ zrotation ≤ 180, rotation about the Z-axis in degrees.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command is a convenience function that allows you to rotate a plot about the X, Y and Z axes with a single command. If xrotation, yrotation, or zrotation is set to zero, then the plot will not be rotated about the corresponding axis. To rotate the plot about one axis, call gpRotateXAxis, gpRotateYAxis or gpRotateZAxis.

A call to gpRotateAxes rotates the plot xrotation degrees about the X-axis, yrotation degrees about the Y-axis, and zrotation degrees about the Z-axis in that order.

This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; xrotation = 45;

3-144 GAUSS C R Command Reference . 3-145 ); angle , gpAddTextObject gpRotateTextObject gpRotateTextObject name , 360, angle in degrees to rotate the text framenum ≤ gpRotateZAxis rotates the text object clockwise, while , , must be preceded by a call to pgp angle angle ≤ 360 − . By default, the angle is set to 0, i.e., the text object is gpRotateYAxis , pointer to a plot control structure. scalar, frame number. string, name of a text object createdscalar, by scalar, return code, 0 if successful, otherwise an error code. object from the horizontal. gpRotateTextObject  R = gpRotateTextObject( framenum = 1; yrotation = 90; zrotation = 180; ret = gpRotateAxes(&gp,framenum,xrotation,yrotation,zrotation); Rotates a text object from the horizontal. gaussplot ret pgp framenum name angle ret A call to gpAddTextObject drawn horizontally. Inputting a negative value for inputting a positive value rotates the text object counter-clockwise. gpfieldzone.src gpRotateXAxis  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpRotateXAxis

objectname = "text1"; angle = 15;

ret = gpAddTextObject(&gp,framenum,objectname,"f(x) = sin(x)"); ret = gpRotateTextObject(&gp,framenum,objectname,angle);

SOURCE gptext.src

SEE ALSO gpAddTextObject, gpSetTextObjectBoxStyle

gpRotateXAxis

PURPOSE Rotates a plot about the X-axis.

LIBRARY gaussplot

FORMAT ret = gpRotateXAxis(pgp, framenum, xrotation);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. xrotation scalar, −180 ≤ xrotation ≤ 180, rotation about the X-axis in degrees.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpRotateXAxis rotates the plot xrotation degrees about the X-axis. To rotate the plot about the X, Y and Z axes, call gpRotateAxes.

This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; xrotation = -45; ret = gpRotateXAxis(&gp,framenum,xrotation);

3-146 GAUSS C R Command Reference 3-147 . gpRotateYAxis gpRotateYAxis ); degrees about the Y-axis. gpRotateAxes yrotation 180, rotation about the Y-axis in yrotation , ≤ framenum yrotation ≤ , rotates the plot pgp 180 − pointer to a plot control structure. scalar, frame number. scalar, scalar, return code, 0 if successful, otherwise an error code. degrees. gpRotateYAxis  R = gpRotateYAxis( framenum = 1; yrotation = 130; ret = gpRotateYAxis(&gp,framenum,yrotation); ret This command applies ONLY to 3D Cartesian and 3D Contour plots. gpfieldzone.src gpRotateAxes pgp framenum yrotation ret A call to To rotate the plot about the X, Y and Z axes, call gpfieldzone.src gpRotateAxes Rotates a plot about the Y-axis. gaussplot  C  INPUT FORMAT OUTPUT LIBRARY SOURCE SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO SEE ALSO GAUSS gpRunMacroFile

gpRotateZAxis

PURPOSE Rotates a plot about the Z-axis.

LIBRARY gaussplot

FORMAT ret = gpRotateZAxis(pgp, framenum, zrotation);

INPUT pgp pointer to a plot control structure.

framenum scalar, frame number.

zrotation scalar, −180 ≤ zrotation ≤ 180, rotation about the Z-axis in degrees.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpRotateZAxis rotates the plot zrotation degrees about the Z-axis. To rotate the plot about the X, Y and Z axes, call gpRotateAxes.

This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; zrotation = -75; ret = gpRotateZAxis(&gp,framenum,zrotation);

SOURCE gpfieldzone.src

SEE ALSO gpRotateAxes

3-148 GAUSS C R Command Reference 3-149 . GAUSSplot gpRunMacroFile immediately. gpSet3DViewDistance window has been closed to . GAUSS gpOpenLayoutFile , . plotting command. ); GAUSSplot . wait GAUSS , gpSetMacroFile GAUSSplot or any of the other plotting commands (see Section GAUSSplot do not wait; return to wait until the return to macrofile gpSetMacroFile , scalar, one of the following: 0 1 string, the name of a macro file created with gpPlot writes the information out as a macro file and then runs the macro  ) to plot a graph based on the information in a plot control structure, R gpRunMacroFile("macro.mcr"); gp.src gpAddMacroFile wait When you call 2.1.16 GAUSSplot file to produce the graph.previously Call created this by command a to run a macro file that was The plotting commands generate aname temporary is file not name specified for with the macro file if a macrofile Runs a macro file in gaussplot gpRunMacroFile(  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSet3DViewDistance

gpSet3DViewDistance

PURPOSE Sets the distance between the viewer and the center point of a plot.

LIBRARY gaussplot

FORMAT ret = gpSet3DViewDistance(pgp, framenum, distance);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. distance scalar, distance between the viewer and the center point of a plot in 3D grid coordinates.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS If you call gpSet3DViewDistance to specify the distance between the viewer and the center point of a plot, GAUSSplot will choose an (X,Y,Z) coordinate position for the viewer that satisfies distance and maintains the current perspective as much as possible.

If 3D perspective is enabled (see gpUse3DPerspective), then increasing distance will decrease the size of the plot in the frame, and decreasing distance will increase the size of the plot in the frame. By default, 3D perspective is not used.

To specify an exact location for the viewer in 3D grid coordinates, call gpSet3DViewerPosition.

If you call gpSet3DViewerPosition or gpSetPlotFit after gpSet3DViewDistance, then distance will be overridden.

This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1;

3-150 GAUSS C R Command Reference 3-151 ); . zpos or , ypos , xpos gpSet3DViewDistance , gpRotateZAxis gpSet3DViewerPosition , gpSet3DViewerPosition gpSet3DViewerPosition framenum . If you call , and one or more of the rotation pgp , then the former command will reset the gpRotateYAxis , gpUse3DPerspective , to calculate an appropriate (X,Y,Z) coordinate position for pointer to a plot control structure. scalar, frame number. scalar, X-coordinate position of the viewer. scalar, Y-coordinate position of the viewer. scalar, Z-coordinate position of the viewer. scalar, return code, 0 if successful, otherwise an error code. gpSet3DViewDistance gpRotateXAxis gpSet3DViewerPosition  GAUSSplot gpSet3DViewerPosition R = gpSet3DViewerPosition( ret = gpSet3DViewDistance(&gp,framenum,distance); gaussplot ret pgp framenum xpos ypos zpos ret To specify a distance between theallow viewer and the center pointthe of viewer, a call plot and after If you call gpfieldzone.src gpSet3DViewerPosition Sets the position of the viewer in 3D grid coordinates. distance between the viewer and theas center much point as of possible, the the plot, perspective set while by maintaining, commands ( distance = 35;  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetActiveFieldZones

gpRotateAxes), then the operations will be performed in the order in which you call them. For example, if you call gpSet3DViewerPosition and then call gpRotateXAxis, then the specified viewer position will be set before the rotation and will be changed by the rotation. However, if you call gpRotateXAxis and then gpSet3DViewerPosition, then the specified viewer position will be set after the rotation.

If you call gpSet3DViewerPosition and one or more of the rotation animation commands (gpAnimateXAxisRotation, gpAnimateYAxisRotation, gpAnimateZAxisRotation, or gpAnimate3DRotation), the viewer position will be set before the animation, regardless of the order in which the commands are called.

Calling gpSetPlotFit after gpSet3DViewerPosition will override the specified viewer position.

Be careful not to specify a position for the viewer that will place the entire plot outside of the viewer’s field of view.

This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; xpos = 15; ypos = 15; zpos = 18; ret = gpSet3DViewerPosition(&gp,framenum,xpos,ypos,zpos);

SOURCE gpfieldzone.src

SEE ALSO gpSet3DViewDistance, gpUse3DPerspective

gpSetActiveFieldZones

PURPOSE Specifies which field zones to display in a frame.

3-152 GAUSS C R Command Reference 3-153 is called in ); fieldzonenum , gpSetActiveFieldZones gpAnimateFieldZones framenum , pgp 1 vector, number(s) of the field zone(s) to be × is encountered. If pointer to a plot control structure. scalar, frame number. scalar or N displayed. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetActiveFieldZones( library gaussplot; #include gp.sdf struct gpPlotControl gp; gp = gpPlotCreate; ret = gpSetDataFile(&gp,0,"mydata.plt"); gpAdd3DCartesianFrame(&gp); gpAdd2DContourFrame(&gp); ret = gpSetActiveFieldZones(&gp,1,1); ret = gpSetActiveFieldZones(&gp,2,2|3); ret = gpPlot(&gp); gpfieldzone.src This example activates the first fieldfield zone zones in in frame frame one two. and the second and third gaussplot ret pgp framenum fieldzonenum ret This command does not applyplot to types, Bar, XY the Line default or is PolargpAnimateFieldZones to Line display plots. all field For zones all in other a frame unless a call to the program, then only the first field zone is displayed by default.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE REMARKS GAUSS gpSetArrowColor

SEE ALSO gpSetAxisMap

gpSetArrowColor

PURPOSE Sets the color of an arrow.

LIBRARY gaussplot

FORMAT ret = gpSetArrowColor(pgp, framenum, name, color);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of an arrow object created by gpAddArrow. color string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS See Section 2.2.1 for the list of available colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; xstart = 0; xend = 1.5; ystart = 0; yend = 1; coord = 2; ret = gpAddArrow(&gp,framenum,"arrow1",xstart,ystart,xend, yend,coord); ret = gpSetArrowColor(&gp,framenum,"arrow1","green");

This example adds an arrow to frame one, drawing the arrow from the origin to point (1.5, 1). It then sets the color of the arrow to green.

3-154 GAUSS C R Command Reference 3-155 . ); angle gpAddArrow , name gpSetArrowHeadAngle , gpSetArrowHeadAngle gpSetArrowLineThickness , framenum , pgp pointer to a plot control structure. scalar, frame number. string, name of an arrow object createdscalar, by angle that one side ofsegment the in arrow degrees. head makes with the line scalar, return code, 0 if successful, otherwise an error code. gpSetArrowHeadStyle ,  R = gpSetArrowHeadAngle( framenum = 1; xstart = 0; xend = 0.5; ystart = 0; yend = 1.25; coord = 2; aname = "arrow1"; angle = 20; ret = gpAddArrow(&gp,framenum,aname,xstart,ystart,xend,yend, ret By default, the arrow head angle is set to 12. pgp framenum name angle ret gparrow.src gpAddArrow Sets the angle that one side of an arrow head makes withgaussplot the arrow line segment.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetArrowHeadAttachment

coord); ret = gpSetArrowHeadAngle(&gp,framenum,aname,angle);

This example adds an arrow to frame one and then sets the angle that one side of the arrow head makes with the arrow line segment to 20 degrees.

SOURCE gparrow.src

SEE ALSO gpAddArrow, gpSetArrowHeadStyle

gpSetArrowHeadAttachment

PURPOSE Specifies to which end of an arrow the arrow head is attached.

LIBRARY gaussplot

FORMAT ret = gpSetArrowHeadAttachment(pgp, framenum, name, attachment);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of an arrow object created by gpAddArrow. attachment scalar, one of the following: 1 arrow head attaches to the beginning of the line segment. 2 arrow head attaches to the end of the line segment. 3 arrow heads attach to both ends.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, arrows are drawn with an arrow head attached to the end of the line segment.

3-156 GAUSS C R Command Reference 3-157 . ); gpAddArrow gpSetArrowHeadSize gpSetArrowHeadSize framenum name size , pgp coord); pointer to a plot control structure. scalar, frame number. string, name of an arrow object createdscalar, by size of the arrow headheight. as a percentage of the frame gpSetArrowHeadStyle ,  R = gpSetArrowHeadSize( framenum = 1; xstart = 0; xend = 1.5; ystart = 0; yend = 1; coord = 2; aname = "arrow1"; attachment = 1; ret = gpAddArrow(&gp,framenum,aname,xstart,ystart,xend,yend, ret = gpSetArrowHeadAttachment(&gp,framenum,aname,attachment); gparrow.src gpAddArrow Sets the size of an arrow head. gaussplot ret pgp framenum name size This example adds an arrow toattachment frame to one the and beginning then of sets the the line arrow segment. head  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpSetArrowHeadStyle

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, arrow heads have a size of 5.

EXAMPLE framenum = 2; xstart = 0; xend = 1.5; ystart = 0; yend = 1; coord = 2; aname = "arrow1"; size = 7;

ret = gpAddArrow(&gp,framenum,aname,xstart,ystart,xend,yend,coord); ret = gpSetArrowHeadSize(&gp,framenum,aname,size);

This example adds an arrow to frame two and then sets the size of the arrow head to 7% of the frame height.

SOURCE gparrow.src

SEE ALSO gpAddArrow, gpSetArrowHeadStyle

gpSetArrowHeadStyle

PURPOSE Sets the style of an arrow head.

LIBRARY gaussplot

FORMAT ret = gpSetArrowHeadStyle(pgp,framenum,name,type,attachment,size,angle);

INPUT pgp pointer to a plot control structure.

3-158 GAUSS C R Command Reference 3-159 . gpAddArrow gpSetArrowHeadStyle plain arrow head. filled arrow head. hollow arrow head. arrow head attaches to the beginningarrow of head the attaches line to segment. the endarrow of heads the attach line to segment. both ends. scalar, angle in degrees that onewith side the of line the segment. arrow head makes scalar, return code, 0 if successful, otherwise an error code. scalar, arrow head type, one of the1 following: 2 3 scalar, arrow head attachment point, one of1 the following: 2 3 scalar, size of the arrow headheight. as a percentage of the frame scalar, frame number. string, name of an arrow object created by  R framenum = 1; xstart = 0; xend = 1.5; ystart = 0; yend = 1; coord = 2; aname = "arrow1"; type = 1; attachment = 1; angle ret This command is a convenience function,head which style allows parameters you with to a set single several function arrow call. By default, arrows are drawn withend plain of arrow the heads, line which segment. areangle An attached of arrow to 12. head the has a default size of 5 and a default type attachment size framenum name  C  OUTPUT EXAMPLE REMARKS GAUSS gpSetArrowHeadType

size = 7; angle = 20;

ret = gpAddArrow(&gp,framenum,aname,xstart,ystart,xend,yend, coord); ret = gpSetArrowHeadStyle(&gp,framenum,aname,type,attachment, size,angle);

SOURCE gparrow.src

SEE ALSO gpAddArrow, gpSetArrowHeadAngle, gpSetArrowHeadAttachment, gpSetArrowHeadSize, gpSetArrowHeadType

gpSetArrowHeadType

PURPOSE Sets the type of an arrow head.

LIBRARY gaussplot

FORMAT ret = gpSetArrowHeadType(pgp, framenum, name, type);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of an arrow object created by gpAddArrow. type scalar, arrow head type, one of the following: 1 plain arrow head. 2 filled arrow head. 3 hollow arrow head.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, arrows are drawn with plain arrow heads.

3-160 GAUSS C R Command Reference 3-161 . ); pattern , gpAddArrow name , gpSetArrowLinePattern gpSetArrowLinePattern framenum , pgp coord); – or – pointer to a plot control structure. scalar, frame number. string, name of an arrow objectstring, created name by of line pattern. scalar, index of line pattern in pattern list. gpSetArrowHeadStyle ,  R = gpSetArrowLinePattern( framenum = 1; xstart = 0; xend = 1.5; ystart = 0; yend = 1; coord = 2; aname = "arrow1"; type = 2; ret = gpAddArrow(&gp,framenum,aname,xstart,ystart,xend,yend, ret = gpSetArrowHeadType(&gp,framenum,aname,type); gparrow.src gpAddArrow Sets the pattern of the arrow line segment. gaussplot ret pgp framenum name pattern This example adds an arrow tofilled. frame one and then sets the arrow head type to  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpSetArrowLinePatternLength

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all arrows are drawn with solid line segments. The list of available line patterns is as follows:

1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot

Line pattern names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; xstart = 0; xend = 1.5; ystart = 0; yend = 1; coord = 2; aname = "arrow1";

ret = gpAddArrow(&gp,framenum,aname,xstart,ystart,xend,yend, coord); ret = gpSetArrowLinePattern(&gp,framenum,aname,"dashed");

This example adds an arrow to frame one and then sets the pattern of the arrow line segment to ‘dashed’.

SOURCE gparrow.src

SEE ALSO gpAddArrow, gpSetArrowLinePatternLength, gpSetArrowColor

gpSetArrowLinePatternLength

3-162 GAUSS C R Command Reference ); 3-163 . length , name , gpAddArrow framenum , pgp gpSetArrowLinePatternLength pointer to a plot control structure. scalar, frame number. string, name of an arrow object createdscalar, by length of one cycle ofthe the frame line height. pattern as a percentage of scalar, return code, 0 if successful, otherwise an error code.  R = gpSetArrowLinePatternLength( framenum = 1; xstart = 0; xend = 1.5; ystart = 0; yend = 1; coord = 2; aname = "arrow1"; length = 3; ret = gpAddArrow(&gp,framenum,aname,xstart,ystart,xend,yend,coord); ret = gpSetArrowLinePattern(&gp,framenum,aname,"dashed"); ret = gpSetArrowLinePatternLength(&gp,framenum,aname,length); gparrow.src Sets the length of the arrow line segment pattern. gaussplot ret pgp framenum name length ret This command is ignored ifthe the default line pattern pattern length is is set 2. to solid. For non-solid lines, This example adds an arrow tosegment frame to one, ‘dashed’, sets and the then pattern setsof of the the the length frame arrow of height. line one cycle of the pattern to 3%  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS GAUSS gpSetArrowLineThickness

SEE ALSO gpAddArrow, gpSetArrowLinePattern, gpSetArrowColor

gpSetArrowLineThickness

PURPOSE Sets the thickness of the arrow line segment.

LIBRARY gaussplot

FORMAT ret = gpSetArrowLineThickness(pgp, framenum, name, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of an arrow object created by gpAddArrow. thickness scalar, thickness of the arrow line segment as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, arrow line segments have a thickness of 0.1.

EXAMPLE framenum = 1; xstart = 0; xend = 1.5; ystart = 0; yend = 1; coord = 2; aname = "arrow1"; thickness = 0.4;

ret = gpAddArrow(&gp,framenum,aname,xstart,ystart,xend,yend, coord); ret = gpSetArrowLineThickness(&gp,framenum,aname,thickness);

3-164 GAUSS C R Command Reference 3-165 vars gpSetAxisMap gpSetAxisMap 1 vector or string array, × ); must be a 3 vars , vars framenum , pgp 1 vector, indices of the variables in the data file. 1 string array, names of the variables. – or – × × pointer to a plot control structure. scalar, frame number. K K scalar, return code, 0 if successful, otherwise an error code. gpSetArrowColor 1 vector or string array, with the first element corresponding to the , ×  R = gpSetAxisMap( gaussplot ret pgp framenum vars ret If the specified frame containsmust a be 2D a Cartesian 2 or 2D Contour plot, then gparrow.src gpAddArrow Sets the variable to be associated with each axis in a frame. X-axis and the second element3D to Cartesian the or Y-axis. If 3D the Contour specified plot, frame then contains a This example adds an arrow toarrow frame line one segment to and 0.4. then sets the thickness of the with the first element correspondingY-axis, to and the the X-axis, third the element second to element the to Z-axis. the By default, the first variable insecond the variable with data the file Y-axis, is and associatedZ-axis. (for with 3D the plots) X-axis, the the third variable with the  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetBarColor

EXAMPLE framenum = 1; vars = { 1, 4, 5 }; ret = gpSetAxisMap(&gp,framenum,vars);

This example associates the first variable in the data file with the X-axis, the fourth variable with the Y-axis, and the fifth variable with the Z-axis.

SOURCE gp.src

SEE ALSO gpSetActiveFieldZones

gpSetBarColor

PURPOSE Sets the color of the bars in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetBarColor(pgp, framenum, linemapnum, linecolor, fillcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). linecolor string, name of bar outline color. – or – scalar, index of color in color list. fillcolor string, name of bar fill color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

3-166 GAUSS C R Command Reference 3-167 , linemapnum , gpSetBarLineThickness gpSetBarLineThickness framenum , gpSetBarWidth , pgp 1 vector, line map number(s). "green"); × gpAddBarFrame , scalar, line thickness of the barheight outlines of as the a frame. percentage of the scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. scalar or N );  R = gpSetBarLineThickness( framenum = 3; linemapnum = 2; thickness = 0.6; ret = gpSetBarLineThickness(&gp,framenum,linemapnum,thickness); framenum = 1; linemapnum = 2; ret = gpSetBarColor(&gp,framenum,linemapnum,"custom25", thickness thickness ret By default, all bars outlines are set to a line thickness of 0.4. Sets the line thickness of the bar outlines in the specifiedgaussplot line map(s). ret pgp framenum linemapnum gpbarplot.src gpBarPlotCreate  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetBarOrientation

SOURCE gpbarplot.src

SEE ALSO gpSetBarColor, gpSetBarOrientation, gpSetBarWidth

gpSetBarOrientation

PURPOSE Sets the orientation of the bars in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetBarOrientation(pgp, framenum, linemapnum, orientation);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). orientation scalar, one of the following: 1 bars drawn vertically. 2 bars drawn horizontally.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, bars are drawn vertically.

EXAMPLE framenum = 2; linemapnum = 1; orientation = 2; ret = gpSetBarOrientation(&gp,framenum,linemapnum,orientation);

SOURCE gpbarplot.src

SEE ALSO gpSetBarColor, gpSetBarLineThickness, gpSetBarWidth

3-168 GAUSS C R Command Reference 3-169 ); width gpSetBarWidth , gpSetBoundaryColor gpSetBarOrientation , linemapnum , framenum , 1 vector, line map number(s). × pgp gpSetBarLineThickness , scalar, frame number. scalar or N scalar, width of the bars asframe. a percentage of the height of the scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure.  R = gpSetBarWidth( framenum = 3; linemapnum = 2; width = 1; ret = gpSetBarWidth(&gp,framenum,linemapnum,width); gpbarplot.src gpSetBarColor framenum linemapnum width ret By default, all bars are set to a width of 2.5. pgp Sets the width of the bars in the specified line map(s). gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetBoundaryThickness

gpSetBoundaryColor

PURPOSE Sets the color of the boundary line around the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetBoundaryColor(pgp, framenum, fieldzonenum, linecolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). linecolor string, name of boundary line color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Field zone numbers correspond to the number of the associated zone in the data file. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; fieldzonenum = 2; ret = gpSetBoundaryColor(&gp,framenum,fieldzonenum,"purple");

SOURCE gp.src

SEE ALSO gpSetBoundaryThickness, gpShowBoundaryLayer, gpShowFieldZoneBoundaryLayer

3-170 GAUSS C R Command Reference 3-171 , gpSetBoxColor fieldzonenum , , framenum gpSetBoundaryThickness , thickness); pgp 1 vector, field zone number(s). × gpShowBoundaryLayer , scalar, frame number. scalar or N scalar, thickness of the boundary lineheight as of a the percentage frame. of the scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. );  R = gpSetBoundaryThickness( framenum = 3; fieldzonenum = 2; thickness = 0.6; ret = gpSetBoundaryThickness(&gp,framenum,fieldzonenum, gp.src gpSetBoundaryColor gpShowFieldZoneBoundaryLayer thickness framenum fieldzonenum thickness ret By default, all boundary linescorrespond have a to thickness the of number 0.4. of the Field associated zone zone numbers in the data file. pgp Sets the line thickness of the boundary around the specified field zone(s). gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetBoxMinMaxMethod

gpSetBoxColor

PURPOSE Sets the color of the percentile box symbol for the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetBoxColor(pgp, framenum, linemapnum, boxcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). boxcolor string, name of line color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

This command operates only on frames containing Box plots.

EXAMPLE framenum = 1; linemapnum = 3; ret = gpSetBoxColor(&gp,framenum,linemapnum,"red");

SOURCE gpboxplot.src

SEE ALSO gpBoxPlotCreate, gpAddBoxFrame, gpSetBoxWidth

3-172 GAUSS C R Command Reference 3-173 3. = ); [1] , respectively. when creating a minmaxmethod minmaxmethod , intqrange intqrange th gpSetBoxMinMaxMethod 1.5 gpSetBoxMinMaxMethod - 25 - 1.5 + minmaxmethod th th th framenum gpAddBoxFrame 75 75 25 , = = = pgp 1 vector, where the first element is one of the × max min intqrange Minimum and maximum taken fromdata. the actual limits of the Statistical standard with the minimumcalculated and according maximum to interquartile range as follows: Minimum and maximum percentiles takenand from third the elements second of scalar or 3 and the second and thirdmaximum elements percentiles, are used optional only minimum if and scalar, return code, 0 if successful, otherwise an error code. following: 1 2 3 pointer to a plot control structure. scalar, frame number.  R = gpSetBoxMinMaxMethod( ret This command operates only oncalled frames BEFORE containing adding Box the plots, frame andmultiple-frame with must plot. be By default, minimum and maximumthe values are data. taken from the actual limits of minmaxmethod pgp framenum Sets the method by whichbox the symbols maximum in and the minimum specified values for frame the are percentile calculated. gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpSetBoxWidth

EXAMPLE framenum = 1; minmaxmethod = { 3, 10, 90 }; ret = gpSetBoxMinMaxMethod(&gp,framenum,minmaxmethod);

SOURCE gpboxplot.src

SEE ALSO gpBoxPlotCreate, gpAddBoxFrame, gpSetBoxColor, gpSetBoxWidth

gpSetBoxWidth

PURPOSE Sets the width of the percentile box symbols for the line maps in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetBoxWidth(pgp, framenum, boxwidth);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. boxwidth scalar, width of percentile box symbols in X-axis grid units.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command operates only on frames containing Box plots, and must be called BEFORE adding the frame with gpAddBoxFrame when creating a multiple-frame plot.

By default, box widths are set to one half of the average horizontal distance between percentile box symbols in the frame.

If boxwidth is set to 0, the box plot is drawn as two vertical lines representing the quartile ranges with a filled circle representing the 50th percentile.

3-174 GAUSS C R Command Reference 3-175 , , framenum , pgp gpSetBoxColor gpSetContourColorDistribution , gpSetContourColorDistribution 1 vector, contour group number(s). ); × gpAddBoxFrame banded distribution. continuous distribution. distribution , scalar or N , scalar, one of the following: 1 2 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R = gpSetContourColorDistribution( framenum = 1; boxwidth = 0; ret = gpSetBoxWidth(&gp,framenum,boxwidth); contourgroupnum distribution ret By default, contour groups usecolor banded between color contour distribution, which levels. uses Changing agroup the solid to color continuous distribution causes for the avary shade contour depending of on a distance color from used the between contour contour level. levels to Sets the color map distribution ofgroup. contour flooding for the specified contour gaussplot ret contourgroupnum pgp framenum gpSetBoxMinMaxMethod gpboxplot.src gpBoxPlotCreate  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetContourFloodGroup

All contour options are set within a contour group. Each field zone that is displayed as a contour plot must be associated with a particular contour group, which controls the contour options. Contour plots can be displayed with contour lines and/or contour flooding. If both lines and flooding are used in a field zone, they may be associated with different contour groups. By default a contour plot is displayed with contour flooding only, using contour group one to control all options.

EXAMPLE framenum = 1; contourgroupnum = 1; distribution = 2;

ret = gpSetContourColorDistribution(&gp,framenum, contourgroupnum,distribution);

This example sets the color map distribution of contour flooding for contour group one to continuous.

SOURCE gpcontourplot.src

SEE ALSO gpSetContourFloodGroup, gpSetContourVariable

gpSetContourFloodGroup

PURPOSE Sets the contour group to be used for contour flooding in the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetContourFloodGroup(pgp, framenum, fieldzonenum, contourgroupnum);

INPUT pgp pointer to a plot control structure.

3-176 GAUSS C R Command Reference 3-177 , erent contour groups. ff gpSetContourLegendBoxColor gpSetContourVariable 1 vector, field zone number(s). , × scalar, contour group number. or contour flooding. If both lines and flooding are used in a / scalar, return code, 0 if successful, otherwise an error code. scalar, frame number. scalar or N  R framenum = 1; contourgroupnum = 2; variableindex = 4; fieldzonenum = 2; ret = gpSetContourVariable(&gp,framenum,contourgroupnum,variableindex); ret = gpSetContourFloodGroup(&gp,framenum,fieldzonenum,contourgroupnum); By default, a contour plot isgroup displayed one with to contour control flooding all only, options. using contour gpSetContourColorDistribution gpcontourplot.src gpSetContourLineGroup field zone, they may be associated with di This example sets the contour variablevariable in in contour the group data two file. toflooding It the in then fourth field sets zone the two contour to group contour to group be two. used for contour contourgroupnum ret All contour options are setdisplayed within as a a contour contour group. plot Eachwhich must field controls be zone the associated that contour with is options. acontour particular Contour lines contour plots and group, can be displayed with framenum fieldzonenum  C  OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetContourLegendBoxColor

gpSetContourLegendBoxColor

PURPOSE Sets the outline and background colors of the box surrounding a contour legend.

LIBRARY gaussplot

FORMAT ret = gpSetContourLegendBoxColor(pgp, framenum, contourgroupnum, linecolor, fillcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. contourgroupnum scalar, contour group number. linecolor string, name of color to use for box outline. – or – scalar, index of color in color list. fillcolor string, name of color to use for box background. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpSetContourLegendBoxColor must be preceded by a call to gpAddContourLegend. If the contour legend box type is set to none, then these colors are not used. If the contour legend box type is set to hollow, then fillcolor is not used, since a hollow box has no background. By default, a contour legend has a hollow box, which is surrounded by a black line. To change the box type, call gpSetContourLegendBoxType.

See Section 2.2.1 for the list of available colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; contourgroupnum = 1;

3-178 GAUSS C R Command Reference 3-179 ); , fillcolor , framenum contourgroupnum,linecolor,fillcolor); , linecolor pgp , gpSetContourLegendBoxStyle gpSetContourLegendBoxStyle thickness , is set to a null string because the box type is hollow gpSetContourLegendBoxStyle , no box. hollow box (no background). filled box. boxtype scalar, contour group number. , fillcolor pointer to a plot control structure. scalar, frame number. scalar, one of the following: 1 2 3 scalar, thickness of the box outlineheight. as a percentage of the frame  R = gpSetContourLegendBoxStyle( linecolor = "red"; fillcolor = ""; ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpSetContourLegendBoxColor(&gp,framenum, contourgroupnum Sets the style of the box surrounding a contour legend. gaussplot ret pgp framenum contourgroupnum boxtype thickness In this example, and thus has no background. gpcontourplot.src gpAddContourLegend  C  INPUT FORMAT LIBRARY SOURCE PURPOSE SEE ALSO GAUSS gpSetContourLegendBoxThickness

linecolor string, name of color to use for box outline. – or – scalar, index of color in color list. fillcolor string, name of color to use for box background. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command is a convenience function that allows you to set several parameters at one time. See gpSetContourLegendBoxType, gpSetContourLegendBoxThickness, and gpSetContourLegendBoxColor to set the box style parameters individually.

A call to gpSetContourLegendBoxStyle must be preceded by a call to gpAddContourLegend. By default, a contour legend has a hollow box (i.e., a box with no background), which is surrounded by a black line that is 0.1% of the frame height. If boxtype is specified as hollow, then fillcolor is ignored.

See Section 2.2.1 for the list of available colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; contourgroupnum = 1; boxtype = 3; thickness = 0.4; linecolor = "red"; fillcolor = "white";

ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpSetContourLegendBoxStyle(&gp,framenum,contourgroupnum, boxtype,thickness,linecolor,fillcolor);

SOURCE gpcontourplot.src

SEE ALSO gpAddContourLegend, gpSetContourLegendBoxColor, gpSetContourLegendBoxThickness, gpSetContourLegendBoxType

3-180 GAUSS C R Command Reference 3-181 , framenum , must be preceded by a call to pgp gpSetContourLegendBoxType ); gpSetContourLegendBoxThickness gpSetContourLegendBoxStyle , . If the type of the contour box is set to none, then thickness scalar, contour group number. , scalar, thickness of the box outlineheight. as a percentage of the frame scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. is not used. By default, a contour legend has a hollow box (i.e., a box gpSetContourLegendBoxThickness  R = gpSetContourLegendBoxThickness( framenum = 1; contourgroupnum = 1; thickness = 0.4; ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpSetContourLegendBoxThickness(&gp,framenum,contourgroupnum,thickness); gpcontourplot.src gpAddContourLegend contourgroupnum thickness ret A call to gpAddContourLegend thickness with no background), with an outline that is 0.1% of the frame height. pgp framenum Sets the thickness of the outline of the box surrounding agaussplot contour legend. ret contourgroupnum  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetContourLegendBoxType

gpSetContourLegendBoxType

PURPOSE Sets the type of the box surrounding a contour legend.

LIBRARY gaussplot

FORMAT ret = gpSetContourLegendBoxType(pgp, framenum, contourgroupnum, boxtype);

INPUT pgp pointer to a plot control structure framenum scalar, frame number contourgroupnum scalar, contour group number boxtype scalar, one of the following: 1 no box. 2 hollow box (no background). 3 filled box.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpSetContourLegendBoxType must be preceded by a call to gpAddContourLegend. By default, a contour legend has a hollow box (i.e., a box with no background).

EXAMPLE framenum = 1; contourgroupnum = 1; boxtype = 3;

ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpSetContourLegendBoxType(&gp,framenum,contourgroupnum,boxtype);

SOURCE gpcontourplot.src

SEE ALSO gpAddContourLegend, gpSetContourLegendBoxStyle

3-182 GAUSS C R Command Reference 3-183 , framenum ); , must be preceded by a call to pgp heightunit “helv”). The default font height is 2.5% , gpSetContourLegendHeaderFont = gpSetContourLegendHeaderFont height , fonttype . By default, the header text in a contour legend is font height as a percentage of the heightfont of height the in frame. points. fonttype scalar, contour group number. – or – , 1 2 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. string, name of font. scalar, index of font in font list. scalar, font height. scalar, one of the following: gpSetContourLegendHeaderFont  R = gpSetContourLegendHeaderFont( of the frame height. The list of available fonts is as follows: gpAddContourLegend written in a helvetica font ( ret A call to pgp framenum contourgroupnum fonttype height heightunit Sets the font of the header text in a contour legend. gaussplot ret contourgroupnum  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpSetContourLegendLabelFont

1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef

Font names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; contourgroupnum = 2; height = 18; heightunit = 2;

ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpSetContourLegendHeaderFont(&gp,framenum,contourgroupnum, "timesitalic",height,heightunit);

SOURCE gpcontourplot.src

SEE ALSO gpAddContourLegend, gpSetContourLegendLabelFont, gpSetContourLegendLineSpacing, gpSetContourLegendMargin

gpSetContourLegendLabelFont

PURPOSE Sets the font of the labels in a contour legend.

LIBRARY gaussplot

3-184 GAUSS C R Command Reference 3-185 , ); framenum , . must be preceded by a call to pgp heightunit gpSetContourLegendLabelFont , GAUSSplot height , “helv”). The default font height is 2.5% of the frame = . By default, the labels in a contour legend are written in font height in points. font height as a percentage of the height of the frame. fonttype scalar, contour group number. – or – , fonttype 2 pointer to a plot control structure. scalar, frame number. string, name of font. scalar, index of font in fontscalar, font list. height. scalar, one of the following: 1 scalar, return code, 0 if successful, otherwise an error code. 1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef gpSetContourLegendLabelFont  R = gpSetContourLegendLabelFont( framenum = 1; height. The list of available fonts is as follows: Font names are case insensitive in gpAddContourLegend a helvetica font ( ret contourgroupnum pgp framenum contourgroupnum fonttype height heightunit ret A call to  C  INPUT FORMAT OUTPUT EXAMPLE REMARKS GAUSS gpSetContourLegendLineSpacing

contourgroupnum = 2; height = 18; heightunit = 2;

ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpSetContourLegendLabelFont(&gp,framenum,contourgroupnum, "timesitalic",height,heightunit);

SOURCE gpcontourplot.src

SEE ALSO gpAddContourLegend, gpSetContourLegendHeaderFont, gpSetContourLegendLineSpacing, gpSetContourLegendMargin

gpSetContourLegendLineSpacing

PURPOSE Sets the spacing between the lines of text in a contour legend.

LIBRARY gaussplot

FORMAT ret = gpSetContourLegendLineSpacing(pgp, framenum, contourgroupnum, linespacing);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. contourgroupnum scalar, contour group number. linespacing scalar, the spacing between lines of text in contour legend.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpSetContourLegendLineSpacing must be preceded by a call to gpAddContourLegend. By default, line spacing is set to 1.

3-186 GAUSS C R Command Reference , 3-187 , contourgroupnum , framenum , gpSetContourLegendMargin must be preceded by a call to pgp gpSetContourLegendMargin gpSetContourLegendSkip , gpSetContourLegendLabelFont . By default, the margin is set to 10. , scalar, contour group number. pointer to a plot control structure. scalar, frame number. scalar, the size of the marginand between the the surrounding contour box legend as text width. a percentage of the legend box scalar, return code, 0 if successful, otherwise an error code. gpSetContourLegendMargin );  R = gpSetContourLegendMargin( framenum = 1; contourgroupnum = 1; linespacing = 1.25; ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpSetContourLegendLineSpacing(&gp,framenum,contourgroupnum,linespacing); gpAddContourLegend Sets the size of thebox. margin between the contour legend text and the surrounding gaussplot ret margin pgp framenum contourgroupnum margin ret A call to gpcontourplot.src gpAddContourLegend gpSetContourLegendMargin  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetContourLegendOrientation

EXAMPLE framenum = 1; contourgroupnum = 1; margin = 20;

ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpSetContourLegendMargin(&gp,framenum,contourgroupnum,margin);

SOURCE gpcontourplot.src

SEE ALSO gpAddContourLegend, gpSetContourLegendLineSpacing, gpSetContourLegendSkip

gpSetContourLegendOrientation

PURPOSE Sets the orientation of a contour legend.

LIBRARY gaussplot

FORMAT ret = gpSetContourLegendOrientation(pgp, framenum, contourgroupnum, orientation);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. contourgroupnum scalar, contour group number. orientation scalar, one of the following: 1 legend oriented vertically. 2 legend oriented horizontally.

Output

ret scalar, return code, 0 if successful, otherwise an error code.

3-188 GAUSS C R Command Reference 3-189 , contourgroupnum contour levels in , gpSetContourLegendView contour levels in a contour , must be preceded by a call to skipnum gpSetContourLegendSkip framenum gpSetContourLegendSkip skipnum , pgp gpMoveContourLegend . By default, orientation is vertical. , scalar, contour group number. pointer to a plot control structure. scalar, frame number. scalar, show only one in every scalar, return code, 0 if successful, otherwise an error code. contour legend. gpSetContourLegendOrientation );  R = gpSetContourLegendSkip( framenum = 1; contourgroupnum = 1; orientation = 2; ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpSetContourLegendOrientation(&gp,framenum,contourgroupnum,orientation); Sets an option to show onlylegend. one in every gaussplot ret pgp framenum contourgroupnum skipnum ret A call to gpAddContourLegend gpcontourplot.src gpAddContourLegend skipnum  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetContourLegendView

REMARKS A call to gpSetContourLegendSkip must be preceded by a call to gpAddContourLegend. By default, all contour levels are shown (skipnum = 1).

EXAMPLE framenum = 1; contourgroupnum = 1; skipnum = 2;

ret = gpAddContourLegend(\verb+&+gp,framenum,contourgroupnum); ret = gpSetContourLegendSkip(\verb+&+gp,framenum,contourgroupnum,skipnum);

SOURCE gpcontourplot.src

SEE ALSO gpAddContourLegend, gpSetContourLegendLineSpacing, gpSetContourLegendMargin

gpSetContourLegendView

PURPOSE Sets view options for a contour legend.

LIBRARY gaussplot

FORMAT ret = gpSetContourLegendView(pgp, framenum, contourgroupnum, showheader, showlines);

INPUT pgp pointer to a plot control structure framenum scalar, frame number contourgroupnum scalar, contour group number showheader scalar, one of the following: 0 do not show contour legend header. 1 show contour legend header containing the name of the contour variable. showlines scalar, one of the following:

3-190 GAUSS C R Command Reference 3-191 , , fieldzonenum , gpSetContourLineColor gpSetContourLineColor framenum contourgroupnum,showheader,showlines); , must be preceded by a call to pgp gpSetContourLegendOrientation , . By default, both the contour legend header and lines do not show black lines separatingshow the black contour lines color separating bands. the contour color bands. pointer to a plot control structure. 0 1 scalar, return code, 0 if successful, otherwise an error code. gpSetContourLegendView );  R = gpSetContourLineColor( framenum = 1; contourgroupnum = 1; showheader = 1; showlines = 0; ret = gpAddContourLegend(&gp,framenum,contourgroupnum); ret = gpSetContourLegendView(&gp,framenum, linecolor Sets the color of the contour lines in the specified fieldgaussplot zone(s). ret pgp gpcontourplot.src gpAddContourLegend ret A call to gpAddContourLegend separating the contour color bands are shown. gpSetContourLegendBoxStyle  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetContourLineGroup

framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). linecolor string, name of contour line color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Field zone numbers correspond to the number of the associated zone in the data file. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; fieldzonenum = 2; floodon = 1; lineson = 1;

ret = gpShowFieldZoneContourLayer(&gp,framenum,fieldzonenum,floodon,lineson); ret = gpSetContourLineColor(&gp,framenum,fieldzonenum,"purple");

SOURCE gpcontourplot.src

SEE ALSO gpSetContourLineGroup, gpSetContourVariable

gpSetContourLineGroup

PURPOSE Sets the contour group to be used for contour lines in the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetContourLineGroup(pgp, framenum, fieldzonenum, contourgroupnum);

3-192 GAUSS C R Command Reference 3-193 to gpSetContourLineGroup overrides that default. erent contour groups. ff gpShowFieldZoneContourLayer 1 vector, field zone number(s). × scalar, contour group number. or contour flooding. If both lines and flooding are used in a / gpSetContourLineGroup scalar or N scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R framenum = 1; contourgroupnum = 2; variableindex = 4; fieldzonenum = 1; floodon = 1; lineson = 1; ret = gpShowFieldZoneContourLayer(&gp,framenum,fieldzonenum,floodon,lineson); ret = gpSetContourVariable(&gp,framenum,contourgroupnum,variableindex); ret = gpSetContourLineGroup(&gp,framenum,fieldzonenum,contourgroupnum); activate or deactivate contour lines andfor flooding. a If field, contour contour lines group aredefault. one activated will Calling be used to control the contour options by By default, a contour plot isgroup displayed one with to contour control flooding all only, options. using Use contour gpcontourplot.src field zone, they may be associated with di This example first activates contour linessets for the field contour zone variable one in in contourfile frame group and one. sets two to the It contour the then group fourth to variable be in used the for data contour lines to contour group two. fieldzonenum contourgroupnum ret All contour options are setdisplayed within as a a contour contour group. plot Eachwhich must field controls be zone the associated that contour with is options. acontour particular Contour lines contour plots and group, can be displayed with pgp framenum  C  INPUT OUTPUT SOURCE EXAMPLE REMARKS GAUSS gpSetContourVariable

SEE ALSO gpSetContourFloodGroup, gpSetContourVariable, gpSetContourLineColor

gpSetContourVariable

PURPOSE Sets the contour variable for the specified contour group(s).

LIBRARY gaussplot

FORMAT ret = gpSetContourVariable(pgp, framenum, contourgroupnum, variable);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. contourgroupnum scalar or N×1 vector, contour group number(s). variable scalar, index of variable in the data file. – or – string, name of variable.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS All contour options are set within a contour group. Each field zone that is displayed as a contour plot must be associated with a particular contour group, which controls the contour options. Contour plots can be displayed with contour lines and/or contour flooding. If both lines and flooding are used in a field zone, they may be associated with different contour groups.

By default, a contour plot is displayed with contour flooding only, using contour group one to control all options. Each contour group uses the last variable in the data file as the default contour variable.

EXAMPLE framenum = 1; contourgroupnum = 1;

3-194 GAUSS C R Command Reference , 3-195 datafile , linemapnum , gpSetCurveFitDataFile gpSetCurveFitDataFile framenum , pgp gpSetContourLineGroup , scalar, frame number. scalar, line map number. string or null string, name of curvestring fit or data null file. string, name of curve fit detail file. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. );  R = gpSetCurveFitDataFile( variableindex = 2; ret = gpSetContourVariable(&gp,framenum,contourgroupnum,variableindex); detailfile framenum linemapnum datafile detailfile ret This command allows you to specifyfunction files and to the which curve data the arewritten details written. in for ASCII a Both format. curve the fit curve fit data and details are Specifies files to which curve fit details and data are written. gaussplot ret pgp gpcontourplot.src gpSetContourFloodGroup This example sets the contour variablevariable in in contour the group data one file. to the second  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetCurveFitDependentVariable

If datafile is a null string, the curve data will not be written to a file. Likewise, if detailfile is a null string, the details for the curve fit function will not be written to a file.

The linemapnum argument must refer to a line map to which a curve fit has been applied with gpSetCurveFitType.

EXAMPLE framenum = 1; linemapnum = 1; ret = gpSetCurveFitDataFile(&gp,framenum,linemapnum, "curvedat.txt","curvedetails.txt");

SOURCE gp.src

SEE ALSO gpSetCurveFitType

gpSetCurveFitDependentVariable

PURPOSE Specifies whether the variable associated with the X-axis or the variable associated with the Y-axis should be the dependent variable in computing a curve fit.

LIBRARY gaussplot

FORMAT ret = gpSetCurveFitDependentVariable(pgp, framenum, linemapnum, axis);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). axis scalar, one of the following:

3-196 GAUSS C R Command Reference 3-197 ); ). x points ( f , = y gpSetCurveFitPoints linemapnum gpSetCurveFitRange gpSetCurveFitPoints , , framenum , pgp ). . By default, the variable associated with the Y-axis y ( f gpSetCurveFitPoints = , x sets the variable associated with thevariable, Y-axis computing as a the dependent curve fit function sets the variable associated with thedependent X-axis variable, computing as a the curve fit function scalar, frame number. pointer to a plot control structure. 2 scalar, return code, 0 if successful, otherwise an error code. 1  R gpSetCurveFitType = gpSetCurveFitPoints( framenum = 1; linemapnum = 3; type = 3; axis = 1; ret = gpSetCurveFitType(&gp,framenum,linemapnum,type); ret = gpSetCurveFitDependentVariable(&gp,framenum,linemapnum,axis); framenum Sets the number of points on a curve. gaussplot ret pgp is used as the dependent variable. gplinemap.src gpSetCurveFitType ret This command is used onlywith for line maps to which a curve fit has been applied  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetCurveFitPolynomialOrder

linemapnum scalar or N×1 vector, line map number(s). points scalar, number of points.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command is used only for line maps to which a curve fit has been applied with gpSetCurveFitType. By default, there are 200 data points on a curve.

EXAMPLE framenum = 1; linemapnum = 3; type = 3; points = 400; ret = gpSetCurveFitType(&gp,framenum,linemapnum,type); ret = gpSetCurveFitPoints(&gp,framenum,linemapnum,points);

SOURCE gplinemap.src

SEE ALSO gpSetCurveFitType, gpSetCurveFitRange, gpSetCurveFitWeightVariable

gpSetCurveFitPolynomialOrder

PURPOSE Sets the order of the polynomial function to be used for a curve fit.

LIBRARY gaussplot

FORMAT ret = gpSetCurveFitPolynomialOrder(pgp, framenum, linemapnum, order);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s).

3-198 GAUSS C R Command Reference ); 3-199 , max , min , gpSetCurveFitRange linemapnum gpSetCurveFitRange gpSetCurveFitRange , , . By default, a third-order polynomial framenum , 10, order of the polynomial function. ≤ pgp 1 vector, line map number(s). 1, a Linear fit is applied. order × = ≤ gpSetCurveFitPoints , order gpSetCurveFitType scalar, minimum value of the independent variable. pointer to a plot control structure. scalar, frame number. scalar or N scalar, 1 scalar, return code, 0 if successful, otherwise an error code.  R = gpSetCurveFitRange( framenum = 1; linemapnum = 3; type = 3; order = 4; ret = gpSetCurveFitType(&gp,framenum,linemapnum,type); ret = gpSetCurveFitPolynomialOrder(&gp,framenum,linemapnum,order); min Sets the range of the independent variable for a curve. gaussplot ret pgp framenum linemapnum gplinemap.src gpSetCurveFitType order ret This command is used onlybeen for applied line with maps to whichfunction a is Polynomial used. curve fit If has gpSetCurveFitWeightVariable  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetCurveFitSplineClamp

max scalar, maximum value of the independent variable.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command is used only for line maps to which one of the following curve fits has been applied: Linear fit, Polynomial fit, Exponential fit, Power fit, or the Stineman interpolation. Call gpSetCurveFitType to apply a curve fit to a line map. By default, there is no finite range set on the independent variable.

EXAMPLE framenum = 1; linemapnum = 3; type = 2; min = 0; max = 100; ret = gpSetCurveFitType(&gp,framenum,linemapnum,type); ret = gpSetCurveFitRange(&gp,framenum,linemapnum,min,max);

SOURCE gplinemap.src

SEE ALSO gpSetCurveFitType, gpSetCurveFitPoints, gpSetCurveFitWeightVariable

gpSetCurveFitSplineClamp

PURPOSE Sets the derivatives at the beginning and ending points of a spline fit curve.

LIBRARY gaussplot

FORMAT ret = gpSetCurveFitSplineClamp(pgp, framenum, linemapnum, bderiv, ederiv);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number.

3-200 GAUSS C R Command Reference 3-201 ); type , gpSetCurveFitType gpSetCurveFitType linemapnum , erentiable at the beginning and ending framenum ff , pgp 1 vector, line map number(s). erentiable at its endpoints. . By default, a Spline fit curve is not clamped, that × ff gpSetCurveFitPoints , scalar, derivative at the ending point of the spline fit curve. scalar, return code, 0 if successful, otherwise an error code. scalar or N scalar, derivative at the beginning point of the spline fit curve.  R gpSetCurveFitType = gpSetCurveFitType( framenum = 1; linemapnum = 3; type = 6; bderiv = 0; ederiv = 5; ret = gpSetCurveFitType(&gp,framenum,linemapnum,type); ret = gpSetCurveFitSplineClamp(&gp,framenum,linemapnum,bderiv,ederiv); ret Sets the curve fit type of the line(s) in the specified linegaussplot map(s). is, the derivatives at the beginningthat and is ending not points clamped are must notpoints be pre-set. and twice A have di a spline second derivativespine of need zero not at be both twice points. di However, a clamped gplinemap.src gpSetCurveFitType ederiv ret This command is used onlywith for line maps to which a Spline fit has been applied linemapnum bderiv  C  FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetCurveFitType

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). type scalar, one of the following: 1 No curve fit, linear segments are drawn between data points. 2 Linear fit. 3 Polynomial fit. 4 Exponential fit. 5 Power fit. 6 Spline fit. 7 Parametric spline fit. 8 Akima spline fit. 9 General curve fit. 10 Stineman interpolation.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, lines are drawn as line segments between data points.

Following is a description of each of the curve fit types:

Linear fit Fits a linear function to the data. Polynomial fit Fits a polynomial function of the Nth order to the data, where 1 ≤ N ≤ 10. If N = 1, a linear function is used. By default, N = 3. Call gpSetCurveFitPolynomialOrder to change the value of N. Exponential fit Fits an exponential function of the form y = a ∗ eb∗x to the data. An Exponential fit can be used only when the y-values are all <0 or all >0. Power fit Fits a power function of the form y = a ∗ xb to the data. A Power fit can be used only when the y-values are all < 0 or all > 0. Spline fit Draws a smooth curve that passes through every data point. Before the curve is drawn, the data points are sorted on the independent variable,

3-202 GAUSS C R Command Reference y 3-203 8. By or ≤ erent / n ff are n ≤ erent and f ff x ,..., 2 f , 1 f . gpSetCurveFitType as the independent variable is used. To use a di x 2 is the index of the data point, . . x are constants and 1 ), where . i x n ∗ ( c 3 n f c ∗ + n ,..., x . c 2 ), where c ∗ i + , ( 2 to specify a weight variable. 1 g c c ... = + + 1 y c ) x Fits a curve that passes through every data point, = ( 2 f y Draws a smooth curve that passes through every data ), and i ∗ . You may also use a weight variable for Linear, ( 2 gpSetCurveFitPoints f Fits an equation of the form c A Spline fit that uses a nonlinear average of the line gpSetGeneralCurveFitOptions = + ) x are smooth functions. You may clamp the spline by specifying x gpSetCurveFitSplineClamp gpSetCurveFitSplineClamp ( g 1 f ∗ and 1 f c =  as the dependent variable. You may change this by calling and the derivative of the fit functioncurve at with the beginning and ending points of the default, the function user-specified sub-functions, function or to specify whether the fit should use normalized segment slopes to find the slopes at the ending points of each segment. variables, call reflecting the computed slope atinflection each points point. than The the curve data will require. not have more point, using y from lowest to highest. You mayderivative of clamp the the fit spline function by at specifyingcurve the the with beginning and ending points of the R y framenum = 1; gpSetCurveFitDependentVariable Stineman interpolation A least squares algorithm isand used Power to fits. compute Linear, Polynomial, Exponential, By default, a curve fit functionand is computed using The number of points onnumber a of curve is points, 200 call by default. To specify a di Parametric spline fit Akima spline fit General curve fit For Linear, Polynomial, Exponential, and Powerinterpolation, fits you as may well specify as a thegpSetCurveFitRange range Stineman for the independent variablePolynomial, with Exponential, and Power fits.gpSetCurveFitWeightVariable Call  C  EXAMPLE GAUSS gpSetCurveFitWeightVariable

linemapnum = 3; type = 3; order = 2; ret = gpSetCurveFitType(&gp,framenum,linemapnum,type); ret = gpSetCurveFitPolynomialOrder(&gp,framenum,linemapnum,order);

SOURCE gplinemap.src

SEE ALSO gpSetCurveFitPoints, gpSetCurveFitDependentVariable, gpSetCurveFitRange, gpSetCurveFitWeightVariable, gpSetCurveFitDataFile

gpSetCurveFitWeightVariable

PURPOSE Specifies a weight variable for a curve.

LIBRARY gaussplot

FORMAT ret = gpSetCurveFitWeightVariable(pgp, framenum, linemapnum, variable);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). variable scalar, index of variable in the data file. – or – string, name of variable.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command is used only for line maps to which one of the following curve fits has been applied: Linear fit, Polynomial fit, Exponential fit, or Power fit. Call gpSetCurveFitType to apply a curve fit to a line map.

3-204 GAUSS C R Command Reference 3-205 gpSetDataFile gpSetDataFile ); gpSetCurveFitRange , datafile , will be set as the data file for all frames in the framenum to plot the graph. , 1 vector, frame number(s). × pgp datafile gpSetCurveFitPoints , . You must specify a data file for all of the frames in a gpPlot 0, then pointer to a plot control structure. scalar or N string, name of data file. scalar, return code, 0 if successful, otherwise an error code. =  R gpSetDataFile = gpSetDataFile( f ramenum framenum = 1; linemapnum = 3; type = 2; var = 5; ret = gpSetCurveFitType(&gp,framenum,linemapnum,type); ret = gpSetCurveFitWeightVariable(&gp,framenum,linemapnum,var); Sets the data file to be used for the specified frame(s). gaussplot ret pgp framenum datafile ret If gplinemap.src gpSetCurveFitType By default, no weight variable is used. graph. Otherwise, the data filespecify will frame be number(s), set then for the onlycall specified the frames specified must frames. already If exist you graph when before you calling  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetDataSetTitle

EXAMPLE framenum = 0; ret = gpSetDataFile(&gp,framenum,"mydata.plt");

This example sets mydata.plt as the data file to be used for all of the frames in the graph.

SOURCE gp.src

SEE ALSO gpSetMacroFile

gpSetDataSetTitle

PURPOSE Sets the title of a data set.

LIBRARY gaussplot

FORMAT ret = gpSetDataSetTitle(pgdat, title);

INPUT pgdat pointer to a GAUSSplot data structure. title string, title of data set.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The data set title is written at the top of the data file and is displayed in the headers of any frames that are associated with the data file by default. Call gpSetDataSetTitle before gpWritePlotData to specify a data set title.

If a data set title is not specified, then the name of the data file, without the .plt extension, will be used as the title.

EXAMPLE library gaussplot; #include gp.sdf

3-206 GAUSS C R Command Reference 3-207 , height , fonttype gpSetDefaultTextFont , gpSetDefaultTextFont and sets “First Observation” as framenum , pgp mydata.plt 1 vector, frame number(s). × gpSetFrameHeaderText , – or – scalar, one of the following: pointer to a plot control structure. scalar or N string, name of font. scalar, index of font in fontscalar, list. font height. );  R = gpSetDefaultTextFont( x = {y 0, = 0.4, { 0.5, 14, 0.67, 30, 0.8,struct 18, 1.05, gpData 22, 1.5, gdat; 29,string 1.6, 37, vnames 1.79, 42, =gdat 1.9 43, { = }; 32, "X", gpSetPlotData(x˜y,vnames); ret 38 "Y" = }; }; gpSetDataSetTitle(&gdat,"Firstret Observation"); = gpWritePlotData(&gdat,"mydata.plt"); heightunit ret pgp framenum fonttype height gpWritePlotData Sets the default font to be used for text objects in agaussplot plot. gpwritedata.src This example creates the data file heightunit the title of the data set.  C  INPUT FORMAT LIBRARY SOURCE PURPOSE SEE ALSO GAUSS gpSetErrorBarColor

1 font height as a percentage of the height of the frame. 2 font height in points.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all text objects are written in a bold helvetica font (fonttype = “helvbold”). The default font height is 14 points. The list of available fonts is as follows:

1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef

Font names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; fontheight = 5; heightunit = 1; ret = gpSetDefaultTextFont(&gp,framenum,"timesbold",fontheight,heightunit);

SOURCE gptext.src

SEE ALSO gpAddTextObject, gpSetTextObjectFont

gpSetErrorBarColor

3-208 GAUSS C R Command Reference ); 3-209 linecolor , , linemapnum , . To activate the error bar layer in a gpSetErrorBarLineThickness ff framenum . , pgp gpSetErrorBarSize 1 vector, line map number(s). , × gpShowLineMapErrorBarLayer , – or – for the list of colors; color names are case insensitive in scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. scalar or N string, name of error bar color. scalar, index of color in color list. . 2.2.1 gpShowErrorBarLayer  R = gpSetErrorBarColor( framenum = 1; seton = 1; linemapnum = 2; ret = gpShowErrorBarLayer(&gp,framenum,seton); ret = gpSetErrorBarColor(&gp,framenum,linemapnum,"purple"); frame, call See Section GAUSSplot gplinemap.src gpShowErrorBarLayer gpSetErrorBarVariable ret By default, the error bar layer is turned o Sets the color of the error bars in the specified line map(s). gaussplot ret pgp framenum linemapnum linecolor  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetErrorBarSize

gpSetErrorBarLineThickness

PURPOSE Sets the line thickness of the error bars in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetErrorBarLineThickness(pgp, framenum, linemapnum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). thickness scalar, line thickness of the error bars as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the error bar layer is turned off. To activate the error bar layer in a frame, call gpShowErrorBarLayer. When the layer is activated, all error bars are set to a line thickness of 0.1 by default.

EXAMPLE framenum = 3; seton = 1; linemapnum = 2; thickness = 0.4; ret = gpShowErrorBarLayer(&gp,framenum,seton); ret = gpSetErrorBarLineThickness(&gp,framenum,linemapnum,thickness);

SOURCE gplinemap.src

SEE ALSO gpSetErrorBarColor, gpSetErrorBarSize, gpSetErrorBarSkip, gpSetErrorBarType

3-210 GAUSS C R Command Reference 3-211 ); size , , gpSetErrorBarSkip gpSetErrorBarSize linemapnum , . To activate the error bar layer in a ff framenum . When the layer is activated, the crossbar , pgp 1 vector, line map number(s). × gpSetErrorBarLineThickness , gpSetErrorBarType , scalar or N scalar, length of the crossbar forof the the error height bars of as the a frame. percentage scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. gpShowErrorBarLayer  R = gpSetErrorBarSize( framenum = 3; seton = 1; linemapnum = 2; size = 4; ret = gpShowErrorBarLayer(&gp,framenum,seton); ret = gpSetErrorBarSize(&gp,framenum,linemapnum,size); frame, call for an error bar is set to a length of 2.5 by default. gplinemap.src gpSetErrorBarColor linemapnum size ret By default, the error bar layer is turned o gpSetErrorBarSkip pgp framenum Sets the length of the crossbar for the error bars in thegaussplot specified line map(s). ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetErrorBarSkip

gpSetErrorBarSkip

PURPOSE Sets an option to show error bars at only a subset of the data points in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetErrorBarSkip(pgp, framenum, linemapnum, skipnum, skipmode);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). skipnum scalar, skip. skipmode scalar, one of the following: 1 show error bars at every data point. 2 show error bars at only one in every skipnum data points. 3 show error bars at the first data point and at each successive data point that is at least skipnum percent of the frame height from the previous error bar.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the error bar layer is turned off. To activate the error bar layer in a frame, call gpShowErrorBarLayer. When the layer is activated, error bars are shown at every data point by default. If skipmode is set to 1, then skipnum is ignored.

EXAMPLE framenum = 3; seton = 1; linemapnum = 2; skipnum = 3;

3-212 GAUSS C R Command Reference 3-213 ); type , , gpSetErrorBarType gpSetErrorBarType linemapnum , framenum , pgp 1 vector, line map number(s). × gpSetErrorBarLineThickness , gpSetErrorBarType , error bars are drawn up frombar the variable is data positive point and where downthe the from error error the bar data variable point is where negative. error bars are drawn down fromerror the bar data variable point is where positive and the where down the from error the bar data variable point iserror negative. bars are drawn to theerror left bar of variable is the positive data andpoint point to where where the the the right error of bar the variableerror data is bars negative. are drawn to theerror right bar of variable is the positive data andwhere point to the where the error the left bar of variable the is data negative. point 1 2 3 4 pointer to a plot control structure. scalar, frame number. scalar or N scalar, one of the following:  R = gpSetErrorBarType( skipmode = 2; ret = gpShowErrorBarLayer(&gp,framenum,seton); ret = gpSetErrorBarSkip(&gp,framenum,linemapnum,skipnum,skipmode); Sets the type of the error bars in the specified linegaussplot map(s). ret pgp framenum linemapnum type gplinemap.src gpSetErrorBarColor gpSetErrorBarSize  C  INPUT FORMAT LIBRARY SOURCE PURPOSE SEE ALSO GAUSS gpSetErrorBarVariable

5 error bars are drawn both to the left and the right of the data points. 6 error bars are drawn both up and down from the data points. 7 error bars are drawn up and down from the data points as well as to the left and to the right of the data points.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the error bar layer is turned off. To activate the error bar layer in a frame, call gpShowErrorBarLayer. When the layer is activated, error bars are drawn both up and down from the data points by default.

EXAMPLE framenum = 3; seton = 1; linemapnum = 2; type = 4; ret = gpShowErrorBarLayer(&gp,framenum,seton); ret = gpSetErrorBarType(&gp,framenum,linemapnum,type);

SOURCE gplinemap.src

SEE ALSO gpSetErrorBarColor, gpSetErrorBarSize, gpSetErrorBarVariable

gpSetErrorBarVariable

PURPOSE Sets the variable to be used for the error bars in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetErrorBarVariable(pgp, framenum, linemapnum, variable);

INPUT pgp pointer to a plot control structure.

3-214 GAUSS C R Command Reference 3-215 , gpSetErrorLevel . To activate the error bar layer in a ff . When the error bar layer is activated, the 1 vector, line map number(s). to change this behavior). Therefore, if the error bar 1 vector containing 0.5 in each row, then at each × × gpShowLineMapErrorBarLayer , gpShowErrorBarType , – or – scalar, index of variable in the data file. string, name of variable. scalar, return code, 0 if successful, otherwise an error code. scalar, frame number. scalar or N gpShowErrorBarLayer  R gpSetErrorBarType framenum = 1; seton = 1; linemapnum = 2; variableindex = 5; ret = gpShowErrorBarLayer(&gp,framenum,seton); ret = gpSetErrorBarVariable(&gp,framenum,linemapnum,variableindex); frame, call second variable in the data file will be used as theThe error error bar bar variable variable by controls default. thepoints. magnitude By of default, the error error bars(call bars are from drawn the both data up and down from the data points gplinemap.src gpShowErrorBarLayer variable is defined as an N data point, error bars willdata be point drawn from as the well data as point from to the 0.5 data units point above to the 0.5 units below. This example sets the error barfifth variable variable for in line the map data two file. in frame one to the gpSetErrorBarColor variable ret By default, the error bar layer is turned o framenum linemapnum  C  OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetErrorLevel

gpSetErrorLevel

PURPOSE Sets the level of error handling in your program.

LIBRARY gaussplot

FORMAT ret = gpSetErrorLevel(pgp, level);

INPUT pgp pointer to a plot control structure. level scalar, one of the following: 1 return error codes if errors are encountered. 2 log error messages and return error codes if errors are encountered. 3 log error message and stop program run if an error is encountered.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, GAUSSplot commands simply return error codes if errors are encountered. You may pass the value of the error code into gpGetErrorMessage to get the associated message.

To set the level of error handling for your entire program, call gpSetErrorLevel immediately after initializing the plot control structure with one of the gpPlotTypePlotCreate commands.

The data write commands gpAddZone and gpWritePlotData do not use the error handling level specified by a call to gpSetErrorLevel. You are responsible for checking the returns from these commands yourself.

EXAMPLE library gaussplot; #include gp.sdf

3-216 GAUSS C R Command Reference 3-217 gpSetExportImageWidth gpSetExportImageWidth ); sets the image width for all subsequent width is encountered. The image width option is , pgp pointer to a plot control structure. scalar, width of the exported image in pixels. gpSetExportImageWidth gpSetExportImageWidth  R p = pi; x = seqa(0,p/4,15); y = sin(x); string vnames = { "V1",struct "V2" gpPlotControl }; gp; gp = gpBarPlotCreate; ret = gpSetErrorLevel(&gp,3); call gpMakeBarPlot(&gp,x,y,vnames); used for exports to the following file formats: exports to file formats for whichcall the to image width option is used until another gpSetExportImageWidth( pgp width By default, the width of the exported image is setCalling to 671 pixels. gpGetErrorMessage Specifies the width of the exported image in pixels. gaussplot gp.src  C  INPUT FORMAT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetExportJPEGQuality

File Format Export Command BMP gpExportBMP JPEG gpExportJPEG PNG gpExportPNG Sun Raster gpExportRAS TIFF gpExportTIFF X-Windows gpExportXWD

EXAMPLE area = -2; gpSetExportImageWidth(&gp,500); ret = gpExportBMP(&gp,area,"graphic.bmp");

This example sets the width of the exported image to 500, and then exports the entire workspace to the BMP graphics file graphic.bmp.

SOURCE gp.src

SEE ALSO gpSetExportJPEGQuality, gpSetPrintPalette

gpSetExportJPEGQuality

PURPOSE Specifies the quality of an output JPEG graphics file.

LIBRARY gaussplot

FORMAT gpSetExportJPEGQuality(pgp, quality);

INPUT pgp pointer to a plot control structure. quality scalar, 1 ≤ quality ≤ 100, quality of the output JPEG file.

REMARKS The higher quality is set, the larger and higher quality the JPEG output file. By default, quality is set to 75.

3-218 GAUSS C R Command Reference 3-219 , is linecolor , . framenum , pgp graphic.jpg sets the quality for all subsequent calls to gpSetFieldZoneLegendBoxColor gpSetExportJPEGQuality gpSetFieldZoneLegendBoxColor – or – – or – gpSetExportImageWidth until another call to pointer to a plot control structure. scalar, frame number of the parent frame. string, name of color to use for box outline. scalar, index of color instring, color name list. of color to use for box background. scalar, index of color in color list. , gpSetExportJPEGQuality );  R = gpSetFieldZoneLegendBoxColor( quality = 95; area = -2; gpSetExportJPEGQuality(&gp,quality); ret = gpExportJPEG(&gp,area,"graphic.jpg"); fillcolor gpExportJPEG Sets the outline and backgroundlegend. colors of the box surrounding a field zone gaussplot ret pgp framenum linecolor fillcolor This example sets the quality ofentire the workspace to JPEG the output JPEG file graphics to file 95, and then exports the Calling gpExportJPEG encountered. gp.src  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpSetFieldZoneLegendBoxStyle

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The parent frame is the frame that the field zone legend describes.

A call to gpSetFieldZoneLegendBoxColor must be preceded by a call to gpAddFieldZoneLegendFrame. If the field zone legend box type is set to none, then these colors are not used. If the line legend box type is set to hollow, then fillcolor is not used, since a hollow box has no background. By default, a field zone legend has a filled box with a black outline and a white background. To change the box type, call gpSetFieldZoneLegendBoxType.

See Section 2.2.1 for the list of available colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; boxtype = 2; linecolor = "red"; fillcolor = "";

ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpSetFieldZoneLegendBoxType(&gp,framenum,boxtype); ret = gpSetFieldZoneLegendBoxColor(&gp,framenum,linecolor,fillcolor);

In this example, fillcolor is set to a null string because the box type is hollow and thus has no background.

SOURCE gpfieldzone.src

SEE ALSO gpAddFieldZoneLegendFrame, gpSetFieldZoneLegendBoxStyle

gpSetFieldZoneLegendBoxStyle

PURPOSE Sets the style of the box surrounding a field zone legend.

3-220 GAUSS C R Command Reference 3-221 fillcolor , boxtype , , framenum , must be preceded by a call to is specified as hollow, then pgp , and are not used. By default, a field zone to set the box style parameters gpSetFieldZoneLegendBoxStyle boxtype . If ); gpSetFieldZoneLegendBoxType thickness and fillcolor , no box. hollow box (no background). filled box. – or – – or – string, name of color to use for box outline. scalar, index of color in colorstring, list. name of color to use for box background. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number of the parent frame. scalar, one of the following: 1 2 3 scalar, thickness of the box outlineof as the a parent percentage frame. of the height fillcolor , linecolor gpSetFieldZoneLegendBoxStyle ,  R linecolor = gpSetFieldZoneLegendBoxStyle( linecolor fillcolor ret The parent frame is the frame that the field zoneThis legend command describes. is a convenience functionparameters that at allows one you time. to See set several gaussplot ret thickness pgp framenum boxtype thickness gpSetFieldZoneLegendBoxThickness gpSetFieldZoneLegendBoxColor individually. A call to gpAddFieldZoneLegendFrame is not used, since athen hollow box has no background. If it is specified as none, legend has a filled box witha a white black background. outline that is 0.1% of the frame height and  C  INPUT FORMAT OUTPUT LIBRARY REMARKS GAUSS gpSetFieldZoneLegendBoxThickness

See Section 2.2.1 for the list of available colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; boxtype = 2; thickness = 0.4; linecolor = "red"; fillcolor = "";

ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpSetFieldZoneLegendBoxStyle(&gp,framenum,boxtype, thickness,linecolor,fillcolor);

SOURCE gpfieldzone.src

SEE ALSO gpAddFieldZoneLegendFrame, gpSetFieldZoneLegendBoxColor, gpSetFieldZoneLegendBoxThickness, gpSetFieldZoneLegendBoxType

gpSetFieldZoneLegendBoxThickness

PURPOSE Sets the thickness of the outline of the box surrounding a field zone legend.

LIBRARY gaussplot

FORMAT ret = gpSetFieldZoneLegendBoxThickness(pgp, framenum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number of the parent frame. thickness scalar, thickness of the box outline as a percentage of the height of the parent frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

3-222 GAUSS C R Command Reference 3-223 ); boxtype , must be preceded by a call framenum , pgp gpSetFieldZoneLegendBoxType . If the type of the field zone legend box is gpSetFieldZoneLegendBoxType gpSetFieldZoneLegendBoxStyle , is not used. By default, a field zone legend has a no box. hollow box (no background). filled box. thickness pointer to a plot control structure. scalar, frame number of the parent frame. scalar, one of the following: 1 2 3 scalar, return code, 0 if successful, otherwise an error code. gpSetFieldZoneLegendBoxThickness  R = gpSetFieldZoneLegendBoxType( gpAddFieldZoneLegendFrame framenum = 1; thickness = 0.4; ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpSetFieldZoneLegendBoxThickness(&gp,framenum,thickness); gpAddFieldZoneLegendFrame Sets the type of the box surrounding a field zone legend. gaussplot ret pgp framenum boxtype ret The parent frame is the frame that the field zoneA legend call describes. to to set to none, then filled box with an outline that is 0.1% of the parent frame height. gpfieldzone.src  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetFieldZoneLegendFont

REMARKS The parent frame is the frame that the field zone legend describes.

A call to gpSetFieldZoneLegendBoxType must be preceded by a call to gpAddFieldZoneLegendFrame. By default, a field zone legend has a filled box.

EXAMPLE framenum = 1; boxtype = 1;

ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpSetFieldZoneLegendBoxType(&gp,framenum,boxtype);

SOURCE gpfieldzone.src

SEE ALSO gpAddFieldZoneLegendFrame, gpSetFieldZoneLegendBoxStyle

gpSetFieldZoneLegendFont

PURPOSE Sets the font of the text in a field zone legend.

LIBRARY gaussplot

FORMAT ret = gpSetFieldZoneLegendFont(pgp, framenum, fonttype, height, heightunit);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number of the parent frame. fonttype string, name of font. – or – scalar, index of font in font list. height scalar, font height. heightunit scalar, one of the following:

3-224 GAUSS C R Command Reference , 3-225 . “helvbold”). The default font height gpSetFieldZoneLegendFont must be preceded by a call to = GAUSSplot gpSetFieldZoneLegendLineSpacing , . By default, the text in a field zone legend is fonttype font height in points. font height as a percentageframe. of the height of the parent 2 1 scalar, return code, 0 if successful, otherwise an error code. 1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef gpSetFieldZoneLegendFont  R framenum = 1; height = 13; heightunit = 2; ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpSetFieldZoneLegendFont(&gp,framenum,"timesitalic",height,heightunit); gpfieldzone.src gpAddFieldZoneLegendFrame is 3% of the parent frame height. The list of available fonts is as follows: Font names are case insensitive in ret The parent frame is the frame that the field zoneA legend call describes. to gpAddFieldZoneLegendFrame written in a helvetica bold font (  C  OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetFieldZoneLegendLineSpacing

gpSetFieldZoneLegendTitle

gpSetFieldZoneLegendLineSpacing

PURPOSE Sets the spacing between the lines of text in a field zone legend.

LIBRARY gaussplot

FORMAT ret = gpSetFieldZoneLegendLineSpacing(pgp, framenum, linespacing);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number of the parent frame. linespacing scalar, the spacing between lines of text in field zone legend.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The parent frame is the frame that the field zone legend describes.

A call to gpSetFieldZoneLegendLineSpacing must be preceded by a call to gpAddFieldZoneLegendFrame. By default, the line spacing is set to 1.

EXAMPLE framenum = 1; linespacing = 1.25;

ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpSetFieldZoneLegendLineSpacing(&gp,framenum,linespacing);

SOURCE gpfieldzone.src

SEE ALSO gpAddFieldZoneLegendFrame, gpSetFieldZoneLegendFont, gpSetFieldZoneLegendUpperMargin, gpSetFieldZoneLegendLowerMargin

3-226 GAUSS C R Command Reference ); 3-227 margin , framenum , must be preceded by a call to pgp . gpSetFieldZoneLegendLowerMargin gpSetFieldZoneLegendLowerMargin scalar, frame number of the parent frame. scalar, the size of the marginzone between legend the text bottom and of the the bottomrelation field of to the the surrounding height box of in the legend font. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. gpSetFieldZoneLegendLowerMargin  R = gpSetFieldZoneLegendLowerMargin( framenum = 1; margin = 1; ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpSetFieldZoneLegendLowerMargin(&gp,framenum,margin); gpfieldzone.src framenum margin ret The parent frame is the frame that the field zoneA legend call describes. to gpAddFieldZoneLegendFrame pgp If the margin is set toused 1, for then the the legend text. sizemargin of By that the default, is margin the half equals margin the the is size height set of of to the the 0.5, font font which used produces for a the legend text. Sets the size of thethe margin between bottom the of bottom the of surrounding the box. field zone legend text and gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS GAUSS gpSetFieldZoneLegendTitle

SEE ALSO gpAddFieldZoneLegendFrame, gpSetFieldZoneLegendUpperMargin, gpSetFieldZoneLegendLineSpacing

gpSetFieldZoneLegendTitle

PURPOSE Sets a title for a field zone legend.

LIBRARY gaussplot

FORMAT ret = gpSetFieldZoneLegendTitle(pgp, framenum, title);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number of the parent frame. title string, title for the legend.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The parent frame is the frame that the field zone legend describes.

A call to gpSetFieldZoneLegendTitle must be preceded by a call to gpAddFieldZoneLegendFrame. By default, a field zone legend has no title.

If gpSetFieldZoneLegendTitle is called, then title is added to the top of the field zone legend, centered horizontally. The spaces between the top of the legend text and the bottom of the title and between the top of the title and the top of the surrounding box are both controlled by gpSetFieldZoneLegendUpperMargin.

EXAMPLE framenum = 1; title = "Field Zone Legend"; ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpSetFieldZoneLegendTitle(&gp,framenum,title);

3-228 GAUSS C R Command Reference 3-229 , . By fonttype , framenum , must be preceded by calls to pgp gpSetFieldZoneLegendTitle gpSetFieldZoneLegendTitleFont gpSetFieldZoneLegendTitleFont gpSetFieldZoneLegendTitleFont and , font height as a percentageframe. of the height of the parent font height in points. ); – or – 1 2 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number of the parent frame. string, name of font. scalar, index of font in fontscalar, list. font height. scalar, one of the following: gpSetFieldZoneLegendTitleFont heightunit  , R = gpSetFieldZoneLegendTitleFont( ret height ret The parent frame is the frame that the field zoneA legend call describes. to gpAddFieldZoneLegendFrame pgp framenum fonttype height heightunit gpfieldzone.src gpAddFieldZoneLegendFrame Sets the font of the title in a field zone legend. gaussplot default, if a title exists, itof is available fonts written is in as the follows: same font as the legend text. The list  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetFieldZoneLegendUpperMargin

1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef

Font names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; height = 13; heightunit = 2;

ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpSetFieldZoneLegendTitleFont(&gp,framenum,"timesitalic",height,heightunit);

SOURCE gpfieldzone.src

SEE ALSO gpAddFieldZoneLegendFrame, gpSetFieldZoneLegendTitle, gpSetFieldZoneLegendFont

gpSetFieldZoneLegendUpperMargin

PURPOSE Sets the size of the margin between the top of the field zone legend text and the top of the surrounding box.

LIBRARY gaussplot

FORMAT ret = gpSetFieldZoneLegendUpperMargin(pgp, framenum, margin);

3-230 GAUSS C R Command Reference , 3-231 , then must be preceded by a call to gpSetFieldZoneNames gpSetFieldZoneLegendTitle gpSetFieldZoneLegendLowerMargin , . scalar, the size of the marginlegend between text the and top the of top the ofheight field the of zone surrounding the box legend in font. relation to the scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number of the parent frame. gpSetFieldZoneLegendUpperMargin controls the space between the top of the legend text and the bottom of  R framenum = 1; margin = 1; ret = gpAddFieldZoneLegendFrame(&gp,framenum); ret = gpSetFieldZoneLegendUpperMargin(&gp,framenum,margin); gpfieldzone.src gpAddFieldZoneLegendFrame margin the legend title as well astop the of space the between surrounding the box. top of the legend title and the gpSetFieldZoneLegendLineSpacing margin ret The parent frame is the frame that the field zone legendA describes. call to If the margin is set toused 1, for then the the legend text. sizemargin of By that the default, is margin the half equals margin the the is size height set of of to the the 0.5, font font which used produces for a If the a legend title text. is added to the legend with pgp framenum gpAddFieldZoneLegendFrame  C  INPUT OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetFrameBackgroundColor

gpSetFieldZoneNames

PURPOSE Sets names for all of the field zones in a frame.

LIBRARY gaussplot

FORMAT ret = gpSetFieldZoneNames(pgp, framenum, names);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. names N×1 string array, names of the field zones.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, a field zone is given the same name as the associated zone in the data file. If you write the data file yourself, you may specify zone names with gpAddZone. Otherwise, default names (“Zone 1”, “Zone 2”,..., “Zone N”) are used.

These names are used to identify the field zones in a field zone legend. Call gpSetFieldZoneNames to rename the field zones in the frame before adding a legend.

N must equal the number of field zones in the specified frame.

EXAMPLE framenum = 1; string names = { "Observed data", "Estimation" }; ret = gpSetFieldZoneNames(&gp,framenum,names);

SOURCE gpfieldzone.src

SEE ALSO gpAddFieldZoneLegendFrame

3-232 GAUSS C R Command Reference ); 3-233 backgroundcolor , gpSetFrameName , framenum gpSetFrameHeaderColor , pgp gpSetFrameBackgroundColor gpSetFrameStyle , if you do not want to display the frame background. – or – string, name of background color. scalar, index of color in color list. for the list of colors; color names are case insensitive in scalar, frame number. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. . 2.2.1  R gpSetFrameStyle = gpSetFrameBackgroundColor( framenum = 1; ret = gpSetFrameBackgroundColor(&gp,framenum,"custom2"); gp.src gpSetFrameHeaderColor framenum backgroundcolor ret See Section GAUSSplot Call pgp Sets the background color for the specified frame. gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetFrameHeaderText

gpSetFrameHeaderColor

PURPOSE Sets the header color for the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetFrameHeaderColor(pgp, framenum, headercolor);

INPUT pgp pointer to a plot control structure.

framenum scalar, frame number.

headercolor string, name of header color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

Call gpSetFrameStyle if you do not want to display the frame header.

EXAMPLE framenum = 1; ret = gpSetFrameHeaderColor(&gp,framenum,"blue");

SOURCE gp.src

SEE ALSO gpSetFrameBackgroundColor, gpSetFrameStyle, gpSetFrameName

3-234 GAUSS C R Command Reference 3-235 gpSetFrameHeaderText gpSetFrameHeaderText ); text , 12 XY Line plot 3 2D Cartesian plot 4 3D Cartesian plot Polar Line plot pgp 2004 would be displayed as ‘1 Dec 2004’. If you include / 1 / pointer to a plot control structure. string, frame header text.  R &(TIME) Current time Text Input&(DATASETTITLE) Title of&(DATE) data set in associated data&(FRAMENAME) file &(PLOTTYPE) Name Output of in frame Frame Header Current Basic date plot type of frame, numeric, one of the following: If you include ‘&(DATE)’ in yourdisplayed frame as header DD text Mon string, YYYY, the whereexample, date Mon the will is date be the 12 abbreviated month‘&(TIME)’ name. in For your frame headerHH:MI:SS. text string, the time will be displayed as The text string may include anyproduced normal only text with characters special (although input, somefollowing see dynamic may below), text be as options: well as any or all of the pgp name Sets the text to be displayed in all frame headers in agaussplot graph. gpSetFrameHeaderText(  C  INPUT FORMAT LIBRARY PURPOSE REMARKS GAUSS gpSetFrameName

The following characters may be produced only with special input:

Character Text Input & \& \ \\\\ ” \\\”

By default, the following frame header text string is used:

"&(FRAMENAME) o &(DATE) o &(DATASETTITLE)"

where the substring

o

produces a long vertical bar. See Appendix A for a list of all of the available characters in GAUSSplot.

EXAMPLE framenum = 1; text = "&(FRAMENAME), &(DATE), &(TIME)"; gpSetFrameHeaderText(&gp,text);

SOURCE gp.src

SEE ALSO gpSetFrameName, gpSetFrameStyle, gpMoveFrame

gpSetFrameName

PURPOSE Sets the name for the specified frame.

3-236 GAUSS C R Command Reference is 3-237 , framenum showborder , gpSetFrameStyle ”, where gpSetFrameStyle ); gpMoveFrame , showheader framenum name , , framenum framenum , , pgp gpSetFrameStyle pgp , ); pointer to a plot control structure. pointer to a plot control structure. scalar, frame number. string, frame name. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetFrameStyle( = gpSetFrameName( framenum = 1; name = "USret Map"; = gpSetFrameName(&gp,framenum,name); Sets style options for the specified frame. gaussplot ret showbackground pgp gp.src gpSetFrameHeaderText gaussplot ret pgp framenum name ret By default, a frame ispadded given the on name the “Frame left withheader zeros by to default. three digits. The name is displayed in the frame  C  INPUT INPUT FORMAT FORMAT OUTPUT LIBRARY LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetGeneralCurveFitOptions

framenum scalar, frame number. showheader scalar, one of the following: 0 do not display frame header. 1 display frame header. showborder scalar, one of the following: 0 do not display frame border. 1 display frame border. showbackground scalar, one of the following: 0 do not display frame background. 1 display frame background.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the frame header, border, and background are all displayed.

EXAMPLE framenum = 1; showheader = 0; showborder = 0; showbackground = 1; ret = gpSetFrameStyle(&gp,framenum,showheader,showborder,showbackground);

SOURCE gp.src

SEE ALSO gpMoveFrame, gpSetFrameName, gpSetWorkspaceView

gpSetGeneralCurveFitOptions

PURPOSE Sets the sub-functions f1, f2,..., fn to be used in a curve fit function of the form y = c1 ∗ f1(x) + c2 ∗ f2(x) + ... + cn ∗ fn(x), where 1 ≤ n ≤ 8, and specifies whether to use normalized x and/or y variables.

LIBRARY gaussplot

3-238 GAUSS C R Command Reference , 3-239 linemapnum , ’s online help for more framenum , variable. variable. x y GAUSSplot pgp 8, terms for the fit function. ≤ variable. gpSetGeneralCurveFitOptions variable. . See M y x ≤ . By default, the function 1 vector, line map number(s). × is used. ); 2 x allows most common C operators and functions. Use ‘x’ use a normalized do not use a normalized use a normalized do not use a normalized ∗ 1 string array, 1 3 × c normy 1 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. scalar or N M scalar, one of the following: 0 1 scalar, one of the following: 0 terms + , x gpSetCurveFitType ∗ 2 c normx  + , 1 R c = gpSetGeneralCurveFitOptions( = framenum = 1; linemapnum = 3; type = 9; string terms =normx { = "1", 0; normy "sin(x)", = "cos(x)" 0; }; ret = gpSetCurveFitType(&gp,framenum,linemapnum,type); ret = gpSetGeneralCurveFitOptions(&gp,framenum,linemapnum,terms,normx,normy); The syntax for as the independent variable in eachvariable that of is the associated terms, with even if thegpSetCurveFitDependentVariable you X-axis have as set the the dependent variable by a call to y information by clicking on the‘Mapping ‘Help’ Style’ button on dialog the box. ‘Curves’ tab of the ret This command applies only toapplied line with maps to which a General curve fit has been ret pgp framenum linemapnum terms normx normy terms  C  INPUT FORMAT OUTPUT EXAMPLE REMARKS GAUSS gpSetGeometryColor

This example sets the curve fit type for line map three in frame one to a General curve fit and then sets the curve fit sub-functions to produce a function of the form y = c1 + c2 ∗ sin(x) + c3 ∗ cos(x).

SOURCE gplinemap.src

SEE ALSO gpSetCurveFitType, gpSetCurveFitPoints, gpSetCurveFitDependentVariable

gpSetGeometryColor

PURPOSE Sets the color of a geometry object.

LIBRARY gaussplot

FORMAT ret = gpSetGeometryColor(pgp, framenum, name, color);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of a geometry object. color string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS See Section 2.2.1 for the list of available colors; color names are case insensitive in GAUSSplot.

You may call gpSetGeometryColor to set the color of a geometry created with any of the following commands:

gpAddCircle

3-240 GAUSS C R Command Reference 3-241 ); , fillcolor , name , gpSetGeometryFillColor gpSetGeometryFillColor framenum , pgp gpSetGeometryLinePattern , coord); string, name of a geometry object. pointer to a plot control structure. scalar, frame number.  R = gpSetGeometryFillColor( framenum = 1; xstart = 0; ystart = 0; xradius = 1.5; coord = 2; ret = gpAddCircle(&gp,framenum,"circ1",xstart,ystart,xradius, ret = gpSetGeometryColor(&gp,framenum,"circ1","green"); gpAddEllipse gpAddRectangle gpAddSquare name gpFillGeometry Sets the fill color of a geometry object. gaussplot ret pgp framenum gpgeometry.src gpSetGeometryLineThickness This example adds a circle of(0,0). radius It 1.5 then to sets frame the one, color centered of on the the circle point to green.  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpSetGeometryFillColor

fillcolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS See Section 2.2.1 for the list of available colors; color names are case insensitive in GAUSSplot.

By default, geometries are not filled. If you call gpFillGeometry to specify that a geometry is to be filled, the default fill color is white.

You may call gpSetGeometryFillColor to set the fill color of a geometry created with any of the following commands:

gpAddCircle gpAddEllipse gpAddRectangle gpAddSquare

EXAMPLE framenum = 1; xstart = 0; ystart = 0; xradius = 1.5; coord = 2; fill = 1; ret = gpAddCircle(&gp,framenum,"circ1",xstart,ystart,xradius, coord); ret = gpFillGeometry(&gp,framenum,"circ1",fill); ret = gpSetGeometryFillColor(&gp,framenum,"circ1","red");

This example adds a circle of radius 1.5 to frame one, centered on the point (0,0). It then specifies that the circle is to be filled and sets the fill color to red.

SOURCE gpgeometry.src

SEE ALSO gpFillGeometry, gpSetGeometryColor

3-242 GAUSS C R Command Reference 3-243 ); pattern , name , . to set the line pattern of a framenum gpSetGeometryLinePattern , GAUSSplot gpSetGeometryLinePattern pgp – or – string, name of line pattern. scalar, index of line pattern in pattern list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. string, name of a geometry object. gpSetGeometryLinePattern 1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot  R = gpSetGeometryLinePattern( gpAddCircle gpAddEllipse geometry created with any of the following commands: You may call pattern ret By default, geometry objects areline drawn using patterns solid is lines. as follows: The list of available Line pattern names are case insensitive in pgp framenum name Sets the line pattern of a geometry object. gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpSetGeometryLinePatternLength

gpAddRectangle gpAddSquare

EXAMPLE framenum = 1; xstart = 0; ystart = 0; xradius = 1.5; coord = 2; ret = gpAddCircle(&gp,framenum,"circ1",xstart,ystart,xradius, coord); ret = gpSetGeometryLinePattern(&gp,framenum,"circ1","dashed");

This example adds a circle of radius 1.5 to frame one, centered on the point (0,0). It then sets the line pattern of the circle to ’dashed’.

SOURCE gpgeometry.src

SEE ALSO gpSetGeometryLinePatternLength, gpSetGeometryColor, gpSetGeometryLineThickness

gpSetGeometryLinePatternLength

PURPOSE Sets the line pattern length of a geometry object.

LIBRARY gaussplot

FORMAT ret = gpSetGeometryLinePatternLength(pgp, framenum, name, length);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of a geometry object.

3-244 GAUSS C R Command Reference 3-245 , to set the line pattern gpSetGeometryLineThickness gpSetGeometryLineColor , coord); plength); scalar, length of one cycle ofthe the frame line height. pattern as a percentage of scalar, return code, 0 if successful, otherwise an error code. gpSetGeometryLinePatternLength  R framenum = 1; xstart = 0; ystart = 0; xradius = 1.5; coord = 2; plength = 5; ret = gpAddCircle(&gp,framenum,"circ1",xstart,ystart,xradius, ret = gpSetGeometryLinePattern(&gp,framenum,"circ1","dashed"); ret = gpSetGeometryLinePatternLength(&gp,framenum,"circ1", gpAddCircle gpAddEllipse gpAddRectangle gpAddSquare gpgeometry.src gpSetGeometryLinePattern length ret This command is ignored ifthe the default line pattern pattern length is is set 2. to solid. For non-solidYou lines, may call This example adds a circle of(0,0). radius It 1.5 then to sets frame thelength one, line to centered pattern 5. on of the the point circle to ’dashed’, and the line pattern gpSetGeometryLineThickness length of a geometry created with any of the following commands:  C  OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetGeometryLineThickness

gpSetGeometryLineThickness

PURPOSE Sets the line thickness of a geometry object.

LIBRARY gaussplot

FORMAT ret = gpSetGeometryLineThickness(pgp, framenum, name, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of a geometry object. thickness scalar, line thickness of the geometry object as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, geometry objects have a line thickness of 0.1.

You may call gpSetGeometryLineThickness to set the line thickness of a geometry created with any of the following commands:

gpAddCircle gpAddEllipse gpAddRectangle gpAddSquare

EXAMPLE framenum = 1; xstart = 0; ystart = 0; xradius = 1.5; coord = 2;

3-246 GAUSS C R Command Reference 3-247 ); nsides , gpFillGeometry , name , gpSetGeometryNumSides thickness); gpSetGeometryNumSides framenum , pgp gpSetGeometryLinePattern coord); , pointer to a plot control structure. scalar, frame number. string, name of a geometry object. scalar, number of sides approximating thegeometry circular object. or elliptical scalar, return code, 0 if successful, otherwise an error code.  R = gpSetGeometryNumSides( thickness = 0.4; ret = gpAddCircle(&gp,framenum,"circ1",xstart,ystart,xradius, ret = gpSetGeometryLineThickness(&gp,framenum,"circ1", Sets the number of sides approximating a circular or elliptical geometry object. gaussplot ret pgp framenum name nsides ret By default, circular and ellipticalsides. geometry objects are approximated by 72 gpgeometry.src gpSetGeometryColor This example adds a circle of(0,0). radius It 1.5 then to sets frame the one, line centered thickness on of the the point circle to 0.4.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetGridAreaFillColor

To create regular polygons with nsides sides, call this function after gpAddCircle. To create non-regular polygons with nsides sides, call this function after gpAddEllipse.

EXAMPLE framenum = 1; xstart = 0; ystart = 0; xradius = 1.5; coord = 2; nsides = 8; ret = gpAddCircle(&gp,framenum,"oct1",xstart,ystart,xradius, coord); ret = gpSetGeometryNumSides(&gp,framenum,"oct1",nsides);

This example adds an octogon of radius 1.5 to frame one, centered on the point (0,0).

SOURCE gpgeometry.src

SEE ALSO gpAddCircle, gpAddEllipse, gpSetGeometryColor

gpSetGridAreaFillColor

PURPOSE Sets the fill color for the grid area in a frame.

LIBRARY gaussplot

FORMAT ret = gpSetGridAreaFillColor(pgp, framenum, fillcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fillcolor string, name of fill color. – or – scalar, index of color in color list.

3-248 GAUSS C R Command Reference , 3-249 max , min , I-planes. gpSetIPlaneRange gpSetIPlaneRange gpPositionGrid fieldzonenum , skipnum , framenum , pgp 1 vector, field zone number(s). . × gpUseGridAreaLighting , scalar, show only one in every pointer to a plot control structure. scalar, frame number. scalar or N scalar, first I-plane to display. scalar, last I-plane to display. scalar, return code, 0 if successful, otherwise an error code. );  R = gpSetIPlaneRange( framenum = 1; fill = 1; ret = gpFillGridArea(&gp,framenum,fill); ret = gpSetGridAreaFillColor(&gp,framenum,"custom2"); skipnum gaussplot ret pgp framenum fieldzonenum min max gp.src gpFillGridArea Sets the range of I-planes to display in I, IJ, IK or IJK plane surface plotting. skipnum By default, the grid areaunfilled is for filled all for other 3D plot Cartesianlight types. and source 3D The shading Contour default is plots fill used and colorthe by is grid default white. area in Because appears 3D grid as Cartesian area gpUseGridAreaLighting gray. and To 3D deactivate Contour grid plots, area light source shading, call ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetJPlaneRange

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command applies only to 3D Cartesian and 3D Contour volume plots for which I, IJ, IK or IJK plane surface plotting has been selected with gpSetSurfacesToPlot. See that command for more information on these surface plotting options.

Assuming that the X, Y and Z-axis variables used in the graph are L × N × P, then there are P I-planes in the graph. Thus, max must be ≤ P. By default, min is set to 1, max is set to P and skip is set to 1 (i.e., all I-planes between 1 and P are displayed).

EXAMPLE framenum = 1; fieldzonenum = 2; iplanes = 3; min = 2; max = 10; skip = 2; ret = gpSetSurfacesToPlot(&gp,framenum,fieldzonenum,iplanes); ret = gpSetIPlaneRange(&gp,framenum,fieldzonenum,min,max,skip);

This example specifies that all of the even I-planes beginning with 2 and ending with 10 be displayed in the frame.

SOURCE gpfieldzone.src

SEE ALSO gpSetSurfacesToPlot, gpSetJPlaneRange, gpSetKPlaneRange

gpSetJPlaneRange

PURPOSE Sets the range of J-planes to display in J, JK, IJ or IJK plane surface plotting.

LIBRARY gaussplot

3-250 GAUSS C R Command Reference max , , 3-251 P, then × min max N × , min , . By default, N J-planes. gpSetJPlaneRange ≤ gpSetKPlaneRange fieldzonenum , skipnum , must be max framenum , pgp 1 vector, field zone number(s). × gpSetIPlaneRange , . See that command for more information on these pointer to a plot control structure. scalar, frame number. scalar or N scalar, first J-plane to display. scalar, last J-plane to display. scalar, show only one in every scalar, return code, 0 if successful, otherwise an error code. are all set to 1 (i.e., only the first J-plane is displayed). );  R skip = gpSetJPlaneRange( framenum = 1; fieldzonenum = 2; jplanes = 4; min = 3; max = 7; skip = 1; ret = gpSetSurfacesToPlot(&gp,framenum,fieldzonenum,jplanes); ret = gpSetJPlaneRange(&gp,framenum,fieldzonenum,min,max,skip); gpSetSurfacesToPlot there are N J-planes inand the graph. Thus, gpfieldzone.src This command applies only towhich 3D J, Cartesian JK, and IJ 3D or ContourgpSetSurfacesToPlot IJK volume plots plane for surface plotting hassurface been plotting selected options. with Assuming that the X, Y and Z-axis variables used in the graph are L This example specifies that all of7 the be J-planes displayed beginning in with the 3 frame. and ending with ret pgp framenum fieldzonenum min max skipnum ret skipnum  C  INPUT FORMAT OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetKPlaneRange

gpSetKPlaneRange

PURPOSE Sets the range of K-planes to display in K, IK, JK or IJK plane surface plotting.

LIBRARY gaussplot

FORMAT ret = gpSetKPlaneRange(pgp, framenum, fieldzonenum, min, max, skipnum);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). min scalar, first K-plane to display. max scalar, last K-plane to display. skipnum scalar, show only one in every skipnum K-planes.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command applies only to 3D Cartesian and 3D Contour volume plots for which K, IK, JK or IJK plane surface plotting has been selected with gpSetSurfacesToPlot. See that command for more information on these surface plotting options.

Assuming that the X, Y and Z-axis variables used in the graph are L×N×P, then there are L K-planes in the graph. Thus, max must be ≤ L. By default, min, max and skip are all set to 1 (i.e., only the first K-plane is displayed).

EXAMPLE framenum = 1; fieldzonenum = 2; kplanes = 5; min = 2; max = 8; skip = 1;

3-252 GAUSS C R Command Reference 3-253 ); ect ff e , gpSetLightingEffect fieldzonenum gpSetLightingEffect , gpSetJPlaneRange , ect. ect. framenum ff ff , pgp ect is used. This command applies ONLY to ff 1 vector, field zone number(s). × gpSetIPlaneRange , paneled lighting e gouraud lighting e ect to use in the specified field zone(s). ff scalar, one of the following: 1 2 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. scalar or N  R = gpSetLightingEffect( ect ff framenum = 1; fieldzonenum = 2; ret = gpSetSurfacesToPlot(&gp,framenum,fieldzonenum,kplanes); ret = gpSetKPlaneRange(&gp,framenum,fieldzonenum,min,max,skip); e ret By default, a paneled lighting3D e Cartesian and 3D Contour plots. Sets the lighting e gaussplot ret pgp framenum fieldzonenum gpfieldzone.src gpSetSurfacesToPlot This example specifies that all ofwith the 8 K-planes be beginning displayed with in 2 the and frame. ending  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetLineColor

effect = 2; ret = gpSetLightingEffect(&gp,framenum,fieldzonenum,effect);

SOURCE gpfieldzone.src

SEE ALSO gpUseLightingEffect, gpUseFieldZoneContourLighting, gpUseFieldZoneShadeLighting

gpSetLineColor

PURPOSE Sets the color of the line(s) in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetLineColor(pgp, framenum, linemapnum, linecolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). linecolor string, name of line color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; linemapnum = 3; ret = gpSetLineColor(&gp,framenum,linemapnum,"red");

SOURCE gplinemap.src

3-254 GAUSS C R Command Reference ); 3-255 is not fillcolor , fillcolor linecolor , gpSetLineThickness , framenum gpSetLineLegendBoxColor , gpSetLineLegendBoxColor must be preceded by a call to pgp . . gpAddXYLineFrame , . If the line legend box type is set to none, then these colors – or – – or – for the list of available colors; color names are case pointer to a plot control structure. scalar, frame number. string, name of color to use for box outline. scalar, index of color in colorstring, list. name of color to use for box background. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. GAUSSplot 2.2.1 gpSetLineLegendBoxColor  R = gpSetLineLegendBoxColor( framenum = 1; linecolor = "red"; A call to insensitive in pgp framenum linecolor fillcolor ret gpAddLineLegend are not used. If the line legend box type is set to hollow, then gpXYLinePlotCreate Sets the outline and background colors of the box surrounding agaussplot line legend. ret used, since a hollow box hashollow box, no which background. is By surrounded default, bygpSetLineLegendBoxType a a line black legend line. has a To change the box type, call See Section  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetLineLegendBoxStyle

fillcolor = "";

ret = gpAddLineLegend(&gp,framenum); ret = gpSetLineLegendBoxColor(&gp,framenum,linecolor,fillcolor);

In this example, fillcolor is set to a null string because the box type is hollow and thus has no background.

SOURCE gplinemap.src

SEE ALSO gpAddLineLegend, gpSetLineLegendBoxStyle

gpSetLineLegendBoxStyle

PURPOSE Sets the style of the box surrounding a line legend.

LIBRARY gaussplot

FORMAT ret = gpSetLineLegendBoxStyle(pgp, framenum, boxtype, thickness, linecolor, fillcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. boxtype scalar, one of the following: 1 no box. 2 hollow box (no background). 3 filled box. thickness scalar, thickness of the box outline as a percentage of the frame height. linecolor string, name of color to use for box outline. – or – scalar, index of color in color list.

3-256 GAUSS C R Command Reference , 3-257 to set linecolor is not used, fillcolor , , thickness,linecolor,fillcolor); gpSetLineLegendBoxColor must be preceded by a call to gpSetLineLegendBoxThickness gpSetLineLegendBoxType , and , is specified as hollow, then gpSetLineLegendBoxType . boxtype are not used. By default, a line legend has a hollow box, gpSetLineLegendBoxColor , . If – or – for the list of available colors; color names are case string, name of color to use for box background. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. GAUSSplot thickness 2.2.1 gpSetLineLegendBoxStyle and  R framenum = 1; boxtype = 3; thickness = 0.4; linecolor = "red"; fillcolor = "white"; ret = gpAddLineLegend(&gp,framenum); ret = gpSetLineLegendBoxStyle(&gp,framenum,boxtype, the box style parameters individually. A call to insensitive in gplinemap.src gpAddLineLegend gpSetLineLegendBoxThickness gpAddLineLegend fillcolor ret This command is a convenience functionparameters that at allows one you time. to See setgpSetLineLegendBoxThickness several since a hollow box has nofillcolor background. If it iswhich specified is as surrounded none, by then a black line that is 0.1% ofSee the Section frame height.  C  OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetLineLegendBoxType

gpSetLineLegendBoxThickness

PURPOSE Sets the thickness of the outline of the box surrounding a line legend.

LIBRARY gaussplot

FORMAT ret = gpSetLineLegendBoxThickness(pgp, framenum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. thickness scalar, thickness of the box outline as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpSetLineLegendBoxThickness must be preceded by a call to gpAddLineLegend. If the type of the line legend box is set to none, then thickness is not used. By default, a line legend has a hollow box (i.e., a box with no background), with an outline that is 0.1% of the frame height.

EXAMPLE framenum = 1; thickness = 0.4;

ret = gpAddLineLegend(&gp,framenum); ret = gpSetLineLegendBoxThickness(&gp,framenum,thickness);

SOURCE gplinemap.src

SEE ALSO gpAddLineLegend, gpSetLineLegendBoxStyle

3-258 GAUSS C R Command Reference 3-259 ); boxtype , gpSetLineLegendFont framenum gpSetLineLegendBoxType , must be preceded by a call to pgp gpSetLineLegendBoxStyle no box. hollow box (no background). filled box. , . By default, a line legend has a hollow box (i.e., a box with scalar, one of the following: 1 2 3 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. gpSetLineLegendBoxType  R = gpSetLineLegendBoxType( framenum = 1; boxtype = 3; ret = gpAddLineLegend(&gp,framenum); ret = gpSetLineLegendBoxType(&gp,framenum,boxtype); gplinemap.src gpAddLineLegend boxtype ret A call to gpAddLineLegend no background). pgp framenum Sets the type of the box surrounding a line legend. gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetLineLegendFont

gpSetLineLegendFont

PURPOSE Sets the font of the text in a line legend.

LIBRARY gaussplot

FORMAT ret = gpSetLineLegendFont(pgp, framenum, fonttype, height, heightunit);

INPUT pgp pointer to a plot control structure.

framenum scalar, frame number.

fonttype string, name of font. – or – scalar, index of font in font list.

height scalar, font height.

heightunit scalar, one of the following:

1 font height as a percentage of the height of the frame. 2 font height in points.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpSetLineLegendFont must be preceded by a call to gpAddLineLegend. By default, the text in a line legend is written in a helvetica bold font (fonttype = “helvbold”). The default font height is 3% of the frame height. The list of available fonts is as follows:

3-260 GAUSS C R Command Reference 3-261 ); linespacing , , framenum . , pgp gpSetLineLegendLineSpacing gpSetLineLegendLineSpacing GAUSSplot gpSetLineLegendLineSpacing , 1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef  R = gpSetLineLegendLineSpacing( framenum = 1; height = 18; heightunit = 2; ret = gpAddLineLegend(&gp,framenum); ret = gpSetLineLegendFont(&gp,framenum,"timesitalic",height,heightunit); ret Sets the spacing between the lines of text in a line legend. gaussplot gplinemap.src gpAddLineLegend gpSetLineLegendMargin Font names are case insensitive in  C  FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpSetLineLegendMargin

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linespacing scalar, the spacing between lines of text in line legend.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpSetLineLegendLineSpacing must be preceded by a call to gpAddLineLegend. By default, the line spacing is set to 1.

EXAMPLE framenum = 1; linespacing = 1.25;

ret = gpAddLineLegend(&gp,framenum); ret = gpSetLineLegendLineSpacing(&gp,framenum,linespacing);

SOURCE gplinemap.src

SEE ALSO gpAddLineLegend, gpSetLineLegendFont, gpSetLineLegendMargin

gpSetLineLegendMargin

PURPOSE Sets the size of the margin between the line legend text and the surrounding box.

LIBRARY gaussplot

FORMAT ret = gpSetLineLegendMargin(pgp, framenum, margin);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. margin scalar, the size of the margin between the line legend text and the surrounding box as a percentage of the legend box width.

3-262 GAUSS C R Command Reference 3-263 , xaxisnum , gpSetLineMapAxes gpSetLineMapAxes linemapnum , 5, X-axis number. 5, Y-axis number. must be preceded by a call to ≤ ≤ framenum , pgp 1 vector, line map number(s). xaxisnum yaxisnum × ≤ ≤ gpSetLineLegendLineSpacing . By default, the margin is set to 10. , pointer to a plot control structure. scalar, frame number. scalar or N scalar, 1 scalar, 1 scalar, return code, 0 if successful, otherwise an error code. scalar, return code, 0 if successful, otherwise an error code. ); gpSetLineLegendMargin  R = gpSetLineMapAxes( framenum = 1; margin = 20; ret = gpAddLineLegend(&gp,framenum); ret = gpSetLineLegendMargin(&gp,framenum,margin); ret yaxisnum pgp framenum linemapnum xaxisnum yaxisnum ret gpAddLineLegend gplinemap.src gpAddLineLegend Sets the X and Y axes to be used for the specifiedgaussplot line map(s). A call to ret  C  INPUT FORMAT OUTPUT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetLineMapNames

REMARKS Line plots allow up to five X and Y axes in a frame. By default, only one X-axis and one Y-axis are used. To display additional X and/or Y axes, call gpSetLineMapAxes to link one or more line maps to X and/or Y axes numbered greater than one. Axes that are added in this way are displayed by default. Call gpShowXAxis or gpShowYAxis to deactivate display of these axes.

Calling gpSetLineMapAxes will create the specified line map(s) if they do not already exist, associating the first variable in the first zone of the data file with the X-axis and the second variable in the first zone of the data file with the Y-axis. It will also create the specified frame if it does not yet exist. However, if the program calls gpPlotCreate to initialize the plot control structure, then there is no plot type associated with the graph. Thus gpAddXYLineFrame, and/or gpAddBarFrame should be called before gpSetLineMapAxes to ensure that the frame defaults are set correctly for the plot type.

Call gpSetLineMaps to specify multiple line maps in a frame or different variables for the X and Y axes. Call gpSetLineMapZone to specify a different zone for one or more line maps.

EXAMPLE framenum = 3; linemapnum = { 2, 3 }; xaxisnum = 1; yaxisnum = 2; ret = gpSetLineMapAxes(&gp,framenum,linemapnum,xaxisnum,yaxisnum);

This example specifies that line maps two and three should be plotted along the first X-axis and a second Y-axis.

SOURCE gplinemap.src

SEE ALSO gpSetLineMaps, gpSetLineMapZone

gpSetLineMapNames

3-264 GAUSS C R Command Reference 3-265 is the index of the for information gpSetLineMaps 1.8 num ); names ”, where , num framenum , pgp to rename the line maps in a frame before adding a line 1 string array, line map names. gpAddLineLegend × , pointer to a plot control structure. scalar, frame number. N scalar, return code, 0 if successful, otherwise an error code.  R = gpSetLineMapNames( framenum = 3; string names =ret { = "sin(x)", gpSetLineMapNames(&gp,framenum,names); "cos(x)", "log(x)" }; By default, line maps arewith given either the the Y same (or name R) as axis the in variable the associated line map or “V gplinemap.src gpSetLineMaps Sets names for all of the line maps in a frame. gaussplot ret pgp framenum names ret variable in the data file, ifstructure the file variable when names the cannot line beabout maps accessed structure are from files. created. the See Section These names are used togpSetLineMapNames identify the line maps inlegend. a line legend. Use N must equal the number of line maps in the specified frame.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetLineMaps

gpSetLineMaps

PURPOSE Sets all of the line maps for a specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetLineMaps(pgp, framenum, linemaps);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemaps N×2 matrix, in which the first column contains the indices of the variables to be associated with the X-axis (or Theta-axis) for each line map, and the second column contains the indices of the variables to be associated with the Y-axis or (R-axis). - or - N×2 string array, in which the first column contains the names of the variables to be associated with the X-axis (or Theta-axis) for each line map, and the second column contains the names of the variables to be associated with the Y-axis or (R-axis).

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, XY Line and Bar plots contain one line map, in which the first variable in the data file is associated with the X-axis and the second variable with the Y-axis. Polar Line plots also contain one line map by default; for Polar plots, the first variable in the data file is associated with the Theta-axis and the second variable with the R-axis.

A call to gpSetLineMaps will create N line maps in the specified frame. If the specified frame does not yet exist, the frame will be created. However, if the program calls gpPlotCreate to initialize the plot control structure, then there is no plot type associated with the graph. Thus gpAddXYLineFrame, gpAddBarFrame, and/or gpAddPolarLineFrame should be called before gpSetLineMaps to ensure that the frame defaults are set correctly for the plot type.

3-266 GAUSS C R Command Reference 3-267 , the variable linemaps gpSetLineMapZone for that frame. gpSetLineMapAxes , commands to plot the graph, then structure file associated with the data Plot .fsr gpSetLineMaps structure file cannot be accessed, you must use PlotType .fsr gpSetLineMapZone , 1234 1 1 2 3 4 5 5 6 gpMake for more information). If the data file has not yet been Line Map X-axis variable Y-axis variable . See one of the following commands for more information: 1.8  R gpMakeBarPlot gpMakePolarLinePlot gpMakeXYLinePlot framenum = 3; linemaps = {ret 1 = 4, gpSetLineMaps(&gp,framenum,linemaps); 1 5, 2 5, 3 6 }; gplinemap.src gpSetLineMapNames created, or the associated variable indices instead of variable names. If the specified frame hascontain already only been one created line and map, youassociated in want with which the the the frame X first to or variableR-axis, in Theta-axis then the and there data the is file second no is variable with need the to Y call or If you call one ofthe the line maps will begpSetLineMaps set automatically, and you do not need to call This example creates four line mapsthe in frame the contains third an frame XY as Line follows, or assuming Bar that plot: If you input a stringnames array must containing match variable names the for namesfile in (see the Section  C  SOURCE EXAMPLE SEE ALSO GAUSS gpSetLineMapZone

gpSetLineMapZone

PURPOSE Sets the zone in the data file to be used for the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetLineMapZone(pgp, framenum, linemapnum, zonenum);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). zonenum scalar, zone number.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, XY Line and Bar plots contain one line map, in which the first variable in the first zone of the data file is associated with the X-axis and the second variable in the first zone with the Y-axis. Polar Line plots also contain one line map by default; for Polar Line plots, the first variable in the first zone of the data file is associated with the Theta-axis and the second variable in the first zone with the R-axis.

Call gpSetLineMaps to specify multiple line maps in a frame or different variables for the X and Y (or Theta and R) axes. Call gpSetLineMapZone to specify a different zone for one or more line maps.

A call to gpSetLineMapZone will create the specified line map(s) if they do not already exist, using the above mentioned defaults for the X and Y (or Theta and R) variables. It will also create the specified frame if it does not yet exist. However, if the program calls gpPlotCreate to initialize the plot control structure, then there is no plot type associated with the graph. Thus gpAddXYLineFrame, gpAddBarFrame, and/or gpAddPolarLineFrame should be called before gpSetLineMapZone to ensure that the frame defaults are set correctly for the plot type.

3-268 GAUSS C R Command Reference 3-269 ); pattern , gpSetLinePattern gpSetLinePattern linemapnum , framenum , pgp 1 vector, line map number(s). × – or – gpSetLineMapAxes , pointer to a plot control structure. scalar, frame number. scalar or N string, name of line pattern. scalar, index of line pattern in pattern list. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetLinePattern( framenum = 3; linemapnum = {zonenum 2, = 3, 2; ret 5 = }; gpSetLineMapZone(&gp,framenum,linemapnum,zonenum); Sets the pattern of the line(s) in the specified line map(s). gaussplot ret pgp framenum linemapnum pattern ret By default, all lines areas drawn as follows: solid lines. The list of available line patterns is gplinemap.src gpSetLineMaps This example specifies that the variablesframe for three line are maps to two, be three, taken and from five the in second zone in the data file.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetLinePatternLength

1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot

Line pattern names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; linemapnum = 2; ret = gpSetLinePattern(&gp,framenum,linemapnum,"dashed");

SOURCE gplinemap.src

SEE ALSO gpSetLinePatternLength, gpSetLineColor, gpSetLineThickness

gpSetLinePatternLength

PURPOSE Sets the pattern length of the line(s) in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetLinePatternLength(pgp, framenum, linemapnum, length);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). length scalar, length of one cycle of the line pattern as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

3-270 GAUSS C R Command Reference 3-271 ); color , name , gpSetLineSegmentColor gpSetLineSegmentColor framenum gpSetLineThickness , , . pgp . gpSetLineColor , – or – for the list of available colors; color names are case pointer to a plot control structure. scalar, frame number. string, name of a linegpAddLineSegment segment object created by string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. GAUSSplot 2.2.1  R = gpSetLineSegmentColor( framenum = 1; linemapnum = 2; length = 4; ret = gpSetLinePattern(&gp,framenum,linemapnum,"dashdot"); ret = gpSetLinePatternLength(&gp,framenum,linemapnum,length); Sets the color of a line segment. gaussplot ret pgp framenum name color ret See Section insensitive in This command is ignored ifthe the default line pattern pattern length is is set 2. to solid. For non-solid lines, gplinemap.src gpSetLinePattern  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS REMARKS SEE ALSO GAUSS gpSetLineSegmentPattern

EXAMPLE framenum = 1; xstart = 0; xend = 1.25; ystart = 0; yend = -1.25; coord = 2; ret = gpAddLineSegment(&gp,framenum,"line1",xstart,ystart,xend,yend,coord); ret = gpSetLineSegmentColor(&gp,framenum,"line1","green");

This example adds a line segment to frame one, drawing the line segment from the origin to the point (1.25, −1.25). It then sets the color of the line segment to green.

SOURCE gplinesegment.src

SEE ALSO gpAddLineSegment, gpSetLineSegmentThickness

gpSetLineSegmentPattern

PURPOSE Sets the pattern of the line segment.

LIBRARY gaussplot

FORMAT ret = gpSetLineSegmentPattern(pgp, framenum, name, pattern);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of a line segment object created by gpAddLineSegment. pattern string, name of line pattern. – or – scalar, index of line pattern in pattern list.

3-272 GAUSS C R Command Reference 3-273 , . GAUSSplot gpSetLineSegmentPatternLength gpSetLineSegmentPatternLength gpSetLineSegmentPatternLength , scalar, return code, 0 if successful, otherwise an error code. 1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot  R framenum = 1; xstart = 0; xend = 1.5; ystart = 0; yend = 1; coord = 2; aname = "lineseg1"; ret = gpAddLineSegment(&gp,framenum,aname,xstart,ystart,xend,yend,coord); ret = gpSetLineSegmentPattern(&gp,framenum,aname,"dashdotdot"); gplinesegment.src gpAddLineSegment This example adds a line segmentline to segment frame to one ‘dashdotdot’. and then sets the pattern of the gpSetLineSegmentColor By default, all line segments arepatterns drawn is as as solid follows: lines. The list of available line Line pattern names are case insensitive in ret  C  OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetLineSegmentPatternLength

PURPOSE Sets the length of the line segment pattern.

LIBRARY gaussplot

FORMAT ret = gpSetLineSegmentPatternLength(pgp, framenum, name, length);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of a line segment object created by gpAddLineSegment. length scalar, length of one cycle of the line pattern as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command is ignored if the line pattern is set to solid. For non-solid lines, the default pattern length is 2.

EXAMPLE framenum = 1; xstart = 0; xend = 1.5; ystart = 0; yend = 1; coord = 2; lsname = "lineseg1"; length = 3;

ret = gpAddLineSegment(&gp,framenum,lsname,xstart,ystart,xend,yend,coord); ret = gpSetLineSegmentPattern(&gp,framenum,lsname,"dashdotdot"); ret = gpSetLineSegmentPatternLength(&gp,framenum,lsname,length);

This example adds a line segment to frame one, sets the pattern of the line segment to ‘dashdotdot’, and then sets the length of one cycle of the pattern to 3% of the frame height.

3-274 GAUSS C R Command Reference ); 3-275 thickness , name , , framenum , gpSetLineSegmentThickness pgp gpSetLineSegmentThickness . gpSetLineSegmentPattern , pointer to a plot control structure. scalar, frame number. string, name of a linegpAddLineSegment segment object created by scalar, thickness of the line segmentframe as height. a percentage of the scalar, return code, 0 if successful, otherwise an error code.  R = gpSetLineSegmentThickness( framenum = 1; xstart = 0; xend = 1; ystart = 0.25; yend = 1.75; coord = 2; lname = "line1"; thickness = 0.4; ret pgp framenum name thickness ret By default, line segments have a thickness of 0.1. gplinesegment.src gpAddLineSegment gpSetLineSegmentColor Sets the thickness of a line segment. gaussplot  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetLineThickness

ret = gpAddLineSegment(&gp,framenum,lname,xstart,ystart,xend,yend,2); ret = gpSetLineSegmentThickness(&gp,framenum,lname,thickness);

This example adds a line segment to frame one and then sets the thickness of the line segment to 0.4.

SOURCE gplinesegment.src

SEE ALSO gpAddLineSegment, gpSetLineSegmentColor

gpSetLineThickness

PURPOSE Sets the thickness of the line(s) in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetLineThickness(pgp, framenum, linemapnum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). thickness scalar, thickness of the line(s) as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all lines have a thickness of 0.1.

EXAMPLE framenum = 3; linemapnum = 2; thickness = 0.4; ret = gpSetLineThickness(&gp,framenum,linemapnum,thickness);

3-276 GAUSS C R Command Reference 3-277 to gauss.cfg gpSetMacroFile macro file, which is ) take the information gpSetMacroFile 2.1.16 GAUSSplot ); temporary file path. Edit GUI to create the graph. macrofile GAUSS , is not called, a temporary name will be generated, and the pgp gpSetLinePattern , plotting commands (see Section pointer to a plot control structure. string, name of macro file. GAUSSplot .  R GAUSSplot gpSetMacroFile gpSetMacroFile(&gp,"plot.mcr"); If gpSetMacroFile( then run in the file will be placed onchange the this path. To delete thegpCleanUp temporary file after running your program, call pgp macrofile The in a plot control structure and write it out to a gp.src gpSetDataFile gplinemap.src gpSetLineColor Sets the name of the macro file to be created. gaussplot  C  INPUT FORMAT LIBRARY SOURCE SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO SEE ALSO GAUSS gpSetMeshColor

gpSetMagnification

PURPOSE Resizes a plot.

LIBRARY gaussplot

FORMAT ret = gpSetMagnification(pgp, framenum, magnification);

INPUT pgp pointer to a plot control structure. framenum scalar or N×1 vector, frame number(s). magnification scalar, plot magnification.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS If magnification is set to 1, then the plot data will fill the whole frame. Setting magni f ication > 1 enlarges the plot, while setting magni f ication < 1 reduces the size of the plot.

By default, Polar Line plots are sized to fit all data points, axes, text, arrows and other geometric objects to the frame (see gpSetPlotFit), and thus magnification is less than 1. All other plot types have a magnification of 1 by default.

If you call both gpSetMagnification and gpSetPlotFit, the last one called will override.

EXAMPLE framenum = 1; magnification = 1.25; ret = gpSetMagnification(&gp,framenum,magnification);

SOURCE gp.src

SEE ALSO gpSetPlotFit, gpSetTranslation, gpSetFrameStyle

3-278 GAUSS C R Command Reference 3-279 ); meshcolor , gpSetMeshColor gpSetMeshLinePattern , gpSetMeshLinePattern fieldzonenum , framenum , 1 vector, field zone number(s). × pgp for the list of colors; color names are case insensitive in gpShowFieldZoneMeshLayer , – or – 2.2.1 scalar, frame number. scalar or N string, name of mesh color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. .  R = gpSetMeshColor( framenum = 1; fieldzonenum = 2; ret = gpSetMeshColor(&gp,framenum,fieldzonenum,"purple"); gpfieldzone.src gpShowMeshLayer framenum fieldzonenum meshcolor ret Field zone numbers correspond tofile. the number See of Section the associatedGAUSSplot zone in the data pgp Sets the color of the mesh layer in the specified field zone(s). gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetMeshLinePattern

gpSetMeshLinePattern

PURPOSE Sets the line pattern of the mesh in the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetMeshLinePattern(pgp, framenum, fieldzonenum, pattern);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). pattern string, name of line pattern. – or – scalar, index of line pattern in pattern list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, mesh is drawn with solid lines. The list of available line patterns is as follows:

1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot

Line pattern names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; linemapnum = 2; ret = gpSetMeshLinePattern(&gp,framenum,linemapnum,"dashdotdot");

SOURCE gpfieldzone.src

3-280 GAUSS C R Command Reference , , 3-281 fieldzonenum , , framenum gpSetMeshLineThickness , , pgp gpSetMeshLinePatternLength gpSetMeshLinePatternLength gpSetMeshColor , gpSetMeshType , 1 vector, field zone number(s). gpSetMeshColor × , pointer to a plot control structure. scalar, frame number. scalar or N scalar, length of one cycle ofthe the frame line height. pattern as a percentage of scalar, return code, 0 if successful, otherwise an error code.  ); R = gpSetMeshLinePatternLength( framenum = 1; fieldzonenum = 2; length = 4; ret = gpSetMeshLinePattern(&gp,framenum,fieldzonenum,"dashdot"); ret = gpSetMeshLinePatternLength(&gp,framenum,fieldzonenum,length); gpfieldzone.src gpSetMeshLinePattern gpSetMeshType pgp framenum fieldzonenum length ret This command is ignored ifthe the default line pattern pattern length is is set 2. to solid. For non-solid lines, gpSetMeshLinePatternLength Sets the length of the mesh line pattern in the specifiedgaussplot field zone(s). ret length gpSetMeshLineThickness  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO SEE ALSO GAUSS gpSetMeshLineThickness

gpSetMeshLineThickness

PURPOSE Sets the line thickness of the mesh layer in the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetMeshLineThickness(pgp, framenum, fieldzonenum, thickness);

INPUT pgp pointer to a plot control structure.

framenum scalar, frame number.

fieldzonenum scalar or N×1 vector, field zone number(s).

thickness scalar, line thickness of the mesh layer as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the mesh layer in each field zone has a line thickness of 0.1. Field zone numbers correspond to the number of the associated zone in the data file.

EXAMPLE framenum = 3; fieldzonenum = 2; thickness = 0.4; ret = gpSetMeshLineThickness(&gp,framenum,fieldzonenum,thickness);

SOURCE gpfieldzone.src

SEE ALSO gpSetMeshColor, gpSetMeshLinePattern, gpSetMeshType

3-282 GAUSS C R Command Reference 3-283 ); type gpSetMeshType , gpSetMeshType fieldzonenum , framenum , 1 vector, field zone number(s). × pgp Wire frame - mesh is drawnexcept under scatter all and other vector field and layers thuscontour cannot or be shade seen layers if are the active. Overlay - mesh is drawn overHidden other line field - zone mesh layers. isand drawn lines over that other are field hidden zone behind layers, other surfaces are removed. scalar or N scalar, one of the following: 1 2 3 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R = gpSetMeshType( framenum = 2; fieldzonenum = 2; meshtype = 3; ret = gpSetMeshType(&gp,framenum,fieldzonenum,meshtype); gpfieldzone.src By default, overlay mesh is used.of the Field associated zone zone numbers in correspond the to data the file. number This example sets the mesh typehidden for line. the second field zone in the second frame to fieldzonenum type ret pgp framenum Sets the type of the mesh in the specified field zone(s). gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS GAUSS gpSetPaperOrientation

SEE ALSO gpSetMeshColor, gpSetMeshLinePattern, gpSetMeshLineThickness

gpSetPaperOrientation

PURPOSE Sets the orientation of the page on which the graph is displayed.

LIBRARY gaussplot

FORMAT ret = gpSetPaperOrientation(pgp, orientation);

INPUT pgp pointer to a plot control structure. orientation scalar, one of the following: 1 portrait. 2 landscape.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the page is landscape.

EXAMPLE orientation = 1; ret = gpSetPaperOrientation(&gp,orientation);

SOURCE gp.src

SEE ALSO gpSetPaperSize, gpPrint

gpSetPaperSize

PURPOSE Sets the size of the page on which the graph is displayed.

3-284 GAUSS C R Command Reference 3-285 , then the gpSetPlotData gpSetPlotData ); 8.5). 8). 8.26772). 11.6929). 1 and writes the data to the structure. gpSetPaperOrientation × × 11). × × × orientation 8.5). × × , gpPrint , pgp data structure for a data file with only one zone letter (11 double (17 A4 (11.6929 A3 (16.5354 Custom1 (14 Custom2 (10 pointer to a plot control structure. scalar, one of the following: 1 2 3 4 5 6 scalar, return code, 0 if successful, otherwise an error code. . The dimensions assume that the page is landscape. If the page GAUSSplot height  × R = gpSetPaperSize( size = 3; ret = gpSetPaperSize(&gp,size); gp.src gpSetPaperOrientation Creates a containing K variables that are N gaussplot ret pgp size ret By default, the page sizewidth is letter. All dimensions areorientation given in is inches changed and by are adimensions call will to be reversed.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetPlotFit

LIBRARY gaussplot

FORMAT gdat = gpSetPlotData(x, vnames);

INPUT x N×K matrix containing K variables that are each N×1 and are horizontally concatenated. vnames K×1 string array, variable names.

OUTPUT gdat a GAUSSplot data structure containing x and vnames.

REMARKS Use gpSetPlotData to write data to a gpData structure for a data file with only one zone containing K variables that are N×1.

EXAMPLE library gaussplot; #include gp.sdf

p = pi; x = seqa(0,p/4,15); y = sin(x);

struct gpData gdat; string vnames = { "X", "Y" }; gdat = gpSetPlotData(x˜y,vnames); ret = gpWritePlotData(&gdat,"mydata.plt");

SOURCE gpwritedata.src

SEE ALSO gpWritePlotData, gpInitPlotData, gpAddZone

gpSetPlotFit

PURPOSE Controls how a plot is sized to the frame.

3-286 GAUSS C R Command Reference 3-287 , the last one called or gpSetPolarAxesTitles gpSetWorkspaceView ); , gpSetPlotFit fit and , framenum gpSet3DViewDistance 1 vector, frame number(s). will override the 3D view specifications. , × gpSetFrameStyle after pgp , resize to fit all data points toresize the to frame. fit all datageometric points, objects axes, text, to arrows the and frame. other gpSetMagnification pointer to a plot control structure. scalar or N scalar, one of the following: 1 2 scalar, return code, 0 if successful, otherwise an error code. gpSetPlotFit  R = gpSetPlotFit( framenum = 1; fit = 2; ret = gpSetPlotFit(&gp,framenum,fit); gpSet3DViewerPosition If you call both gp.src gpSetMagnification gaussplot ret pgp framenum fit ret By default, Polar Line plotsother are geometric sized objects to to fit the allonly frame, data the while points, data all axes, points text, other arrows to plot and the types frame. are sized to fit Calling will override.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetPrintFormat

gpSetPolarAxesTitles

PURPOSE Sets the titles for the polar axes in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetPolarAxesTitles(pgp, framenum, thetatitle, rtitle);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. thetatitle string, title for the Theta-axis. rtitle string, title for the R-axis.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, each axis is titled with the name(s) of the variable(s) that are associated with that axis (the variables are separated by a comma and a space if there are more than one).

This command is a convenience function that allows you to set the titles for both axes at one time. Use gpSetThetaAxisTitle or gpSetRAxisTitle to set the title for only one axis.

EXAMPLE framenum = 1; ret = gpSetPolarAxesTitles(&gp,framenum,"Theta","R");

SOURCE gppolarlineplot.src

SEE ALSO gpSetThetaAxisTitle, gpSetRAxisTitle, gpShowPolarAxes

3-288 GAUSS C R Command Reference 3-289 2 formats are printed / gpSetPrintFormat gpSetPrintFormat command) until another call to ); gpPrint to print the graph as a monochrome image. printfmt , is ignored for HP-GL format print output. specifies the print output format used for all pgp 2. / is encountered. HP-GL. HP-GL PostScript. 2 3 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, print output format, one of the1 following: gpSetPrintPalette gpSetPrintPalette gpSetPrintFormat  R = gpSetPrintFormat( printfmt = 3; ret = gpSetSetPrintFormat(&gp,printfmt); ret = gpPrint(&gp); gp.src subsequent print jobs (specified bygpSetPrintFormat the By default, graphs printed using the PostScript and HP-GL ret The default format for printrecommend output that on you UNIX always and use Linux PostScriptplatforms. is output PostScript. when We printing on these Calling in color. Call Graphs printed using the HP-GLimages; format are always printed as monochrome pgp printfmt Sets the print output format for printing on UNIX or Linux. gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS GAUSS gpSetPrintPalette

SEE ALSO gpPrint, gpPrintToFile, gpSetPrintPalette

gpSetPrintPalette

PURPOSE Sets the print/export palette to monochrome or color.

LIBRARY gaussplot

FORMAT ret = gpSetPrintPalette(pgp, palette);

INPUT pgp pointer to a plot control structure. palette scalar, one of the following: 1 print/export as monochrome image. 2 print/export as color image.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all images are printed and exported as color images.

Calling gpSetPrintPalette specifies the print/export palette used for all subsequent printing and exporting to file formats for which the palette option is used until another call to gpSetPrintPalette is encountered. The palette option is used for exports to the following file formats:

File Format Export Command EPS gpExportEPS HPGL/2 gpExportHPGL2 PostScript gpExportPS TIFF gpExportTIFF WMF gpExportWMF

EXAMPLE palette = 1;

3-290 GAUSS C R Command Reference 3-291 . gpSetRAxisColor ); gpSetRAxisColor for the list of colors; color gpPrint , 2.2.1 graphic.ps linecolor , . framenum , GAUSSplot gpSetPrintFormat pgp export palette to monochrome, and then exports the , / – or – scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. string, name of color. scalar, index of color in color list.  R = gpSetRAxisColor( framenum = 1; ret = gpSetRAxisColor(&gp,framenum,"green"); area = -2; ret = gpSetPrintPalette(&gp,palette); ret = gpExportPS(&gp,area,"graphic.ps"); names are case insensitive in This command applies ONLY to frames that contain Polar Line plots. ret By default, all axis lines are black. See Section Sets the color of the R-axis line in the specified frame. gaussplot ret pgp framenum linecolor entire workspace to the PostScript graphics file gp.src gpSetExportImageWidth This example sets the print  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetRAxisLabelColor

SOURCE gppolarlineplot.src

SEE ALSO gpShowPolarAxes, gpSetRAxisThickness

gpSetRAxisLabelColor

PURPOSE Sets the color of the R-axis tick labels in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetRAxisLabelColor(pgp, framenum, textcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. textcolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all axis tick labels are black. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

This command applies ONLY to frames that contain Polar Line plots.

EXAMPLE framenum = 2; ret = gpSetRAxisLabelColor(&gp,framenum,"purple");

SOURCE gppolarlineplot.src

SEE ALSO gpSetRAxisLabelFont, gpSetRAxisLabelOffset, gpSetRAxisLabelSkip

3-292 GAUSS C R Command Reference = 3-293 , fonttype height , fonttype gpSetRAxisLabelFont , gpSetRAxisLabelFont framenum , pgp font height as a percentage of the heightfont of height the in frame. points. font height as a percentage of the length of the axis line. – or – 1 2 3 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. string, name of font. scalar, index of font in font list. scalar, font height. scalar, one of the following: );  R = gpSetRAxisLabelFont( ret By default, all polar axes tick“helv”) labels with are a written font in heightfonts a equal is helvetica to font as 3% ( follows: of the frame height. The list of available pgp framenum fonttype height heightunit Sets the type and sizeframe. of the font used for the R-axis tick labels in the specified gaussplot ret heightunit  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpSetRAxisLabelOffset

1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef

Font names are case insensitive in GAUSSplot. This command applies ONLY to frames that contain Polar Line plots.

EXAMPLE framenum = 1; fontheight = 10; heightunit = 2; ret = gpSetRAxisLabelFont(&gp,framenum,"times",fontheight,heightunit);

SOURCE gppolarlineplot.src

SEE ALSO gpSetRAxisLabelColor, gpSetRAxisLabelOffset, gpSetRAxisLabelSkip

gpSetRAxisLabelOffset

PURPOSE Sets the offset of the R-axis tick labels from the axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetRAxisLabelOffset(pgp, framenum, offset);

INPUT pgp pointer to a plot control structure.

3-294 GAUSS C R Command Reference 3-295 ); R-axis tick labels. gpSetRAxisLabelSkip , skipnum gpSetRAxisLabelSkip R-axis tick labels in the , gpSetRAxisLabelSkip skipnum set of 1. This command applies ONLY skipnum ff framenum , pgp gpSetRAxisLabelFont , set of tick labels from axis line as a percentage of the ff pointer to a plot control structure. scalar, frame number. scalar, show only one in every scalar, return code, 0 if successful, otherwise an error code. scalar, frame number. scalar, o frame height. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetRAxisLabelSkip( set ff framenum = 1; offset = 2; ret = gpSetRAxisLabelOffset(&gp,framenum,offset); gaussplot ret pgp framenum skipnum ret framenum o ret By default, all axis tickto labels frames have an that o contain Polar Line plots. gppolarlineplot.src gpSetRAxisLabelColor Sets an option to show onlyspecified one frame. in every  C  INPUT FORMAT OUTPUT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetRAxisRange

REMARKS By default, all axis tick labels are shown (skipnum = 1). This command applies ONLY to frames that contain Polar Line Plots.

EXAMPLE framenum = 3; skipnum = 2; ret = gpSetRAxisLabelSkip(&gp,framenum,skipnum);

SOURCE gppolarlineplot.src

SEE ALSO gpSetRAxisLabelColor, gpSetRAxisLabelFont, gpSetRAxisLabelOffset

gpSetRAxisRange

PURPOSE Sets the range of the R-axis in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetRAxisRange(pgp, framenum, min, max);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. min scalar, minimum value for the R-axis. max scalar, maximum value for the R-axis.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the range of the R-axis is calculated based on the values of the data points. Since radii are plotted along the R-axis, all r values should be magnitudes, and therefore, positive. This command applies ONLY to frames that contain Polar Line plots.

3-296 GAUSS C R Command Reference 3-297 ); thickness gpSetRAxisThickness , gpSetRAxisThickness framenum , pgp . scalar, frame number. scalar, thickness of the axis linethe as frame. a percentage of the height of scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. gpSetRAxisTicks  R = gpSetRAxisThickness( framenum = 1; thickness = 0.6; ret = gpSetRAxisThickness(&gp,framenum,thickness); framenum = 1; min = 5; max = 15; ret = gpSetRAxisRange(&gp,framenum,min,max); framenum thickness ret By default, all axis linesONLY are to set frames to that a contain thickness Polar of Line 0.4. plots. This command applies Sets the thickness of the R-axis line in the specified frame. gaussplot ret pgp gppolarlineplot.src gpSetRAxisTicks To change the number of majorthem, and call minor tick marks or the distance between  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetRAxisTicks

SOURCE gppolarlineplot.src

SEE ALSO gpSetRAxisColor

gpSetRAxisTicks

PURPOSE Sets the distance between major tick marks and the number of minor tick marks on the R-axis in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetRAxisTicks(pgp, framenum, majorstep, minornum);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. majorstep scalar, step between major tick marks in R-axis units. minornum scalar, number of minor tick marks between each set of major tick marks.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the step between major tick marks and the number of minor tick marks on the R-axis is calculated based on the range of the axis. To modify the range of the R-axis, call gpSetRAxisRange. This command applies ONLY to frames that contain Polar Line plots.

EXAMPLE framenum = 1; majorstep = 2; minornum = 3; ret = gpSetRAxisTicks(&gp,framenum,majorstep,minornum);

This example sets the distance between major tick marks on the R-axis to 2

3-298 GAUSS C R Command Reference 3-299 gpSetRAxisTitle to set the titles for both gpSetRAxisTitle ); title , framenum , gpSetPolarAxesTitles pgp pointer to a plot control structure. scalar, frame number. string, title. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetRAxisTitle( framenum = 1; ret = gpSetRAxisTitle(&gp,framenum,"R"); gppolarlineplot.src By default, each axis isassociated titled with with that the axis name(s) (the ofthere variables the are are variable(s) more separated that than by are one). a comma Use and a space if gaussplot ret pgp framenum title ret the Theta and R axes in a frame. This command applies ONLY to frames that contain Polar Line plots. gp.src gpSetRAxisRange Sets the title for the R-axis in the specified frame. units, and the number ofto minor 3. tick marks Thus between there each are set 0.5 of units major from tick one marks tick mark to the next.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetRAxisTitleColor

SEE ALSO gpSetPolarAxesTitles, gpSetRAxisTitleColor, gpSetRAxisTitleFont, gpSetRAxisTitleOffset

gpSetRAxisTitleColor

PURPOSE Sets the color of the R-axis title in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetRAxisTitleColor(pgp, framenum, textcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. textcolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all axis titles are black. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot. This command applies ONLY to frames that contain Polar Line plots.

EXAMPLE framenum = 1; ret = gpSetRAxisTitleColor(&gp,framenum,"green");

SOURCE gppolarlineplot.src

SEE ALSO gpSetRAxisTitle, gpSetRAxisTitleFont, gpSetRAxisTitleOffset

3-300 GAUSS C R Command Reference 3-301 fonttype , height , gpSetRAxisTitleFont fonttype gpSetRAxisTitleFont , framenum , pgp font height as a percentage of the heightfont of height the in frame. points. font height as a percentage of the length of the axis line. – or – 1 2 3 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. string, name of font. scalar, index of font in font list. scalar, font height. scalar, one of the following: );  R = gpSetRAxisTitleFont( “helvbold”) with a font height equal to 3.6% of the frame height. The list of ret By default, all polar axis= tick labels are written inavailable a fonts bold is helvetica as font follows: ( pgp framenum fonttype height heightunit Sets the type and size of the font used for the R-axis title in thegaussplot specified frame. ret heightunit  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpSetRAxisTitleOffset

1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef

Font names are case insensitive in GAUSSplot. This command applies ONLY to frames that contain Polar Line plots.

EXAMPLE framenum = 1; fontheight = 5; heightunit = 1; ret = gpSetRAxisTitleFont(&gp,framenum,"timesbold",fontheight,heightunit);

SOURCE gppolarlineplot.src

SEE ALSO gpSetRAxisTitle, gpSetRAxisTitleColor, gpSetRAxisTitleOffset

gpSetRAxisTitleOffset

PURPOSE Sets the offset of the R-axis title from the axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetRAxisTitleOffset(pgp, framenum, offset);

INPUT pgp pointer to a plot control structure.

3-302 GAUSS C R Command Reference ); 3-303 scattercolor , gpSetScatterColor gpSetScatterColor fieldzonenum gpSetRAxisTitleFont , , framenum , pgp 1 vector, field zone number(s). × set of title from axis line as a percentage of the height ff gpSetRAxisTitleColor , – or – set is set to 6. This command applies ONLY to frames that ff pointer to a plot control structure. scalar, frame number. scalar or N string, name of scatter color. scalar, index of color in color list. scalar, frame number. scalar, o of the frame. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetScatterColor( set ff framenum = 1; offset = 8; ret = gpSetRAxisTitleOffset(&gp,framenum,offset); gaussplot ret contain Polar Line plots. pgp framenum fieldzonenum scattercolor framenum o ret By default, the o gppolarlineplot.src gpSetRAxisTitle Sets the color of the scatter symbols in the specified field zone(s).  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetScatterFillMode

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the scatter layer is turned off. To activate the scatter layer in a frame, call gpShowScatterLayer.

Field zone numbers correspond to the number of the associated zone in the data file. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; seton = 1; fieldzonenum = 3; ret = gpShowScatterLayer(&gp,framenum,seton); ret = gpSetScatterColor(&gp,framenum,fieldzonenum,"purple");

SOURCE gpfieldzone.src

SEE ALSO gpShowScatterLayer, gpShowFieldZoneScatterLayer, gpSetScatterFillMode, gpSetScatterShape

gpSetScatterFillMode

PURPOSE Sets the fill mode of the scatter symbols in the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetScatterFillMode(pgp, framenum, fieldzonenum, fillmode, fillcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s).

3-304 GAUSS C R Command Reference 3-305 . GAUSSplot gpSetScatterShape , gpSetScatterLineThickness . To activate the scatter layer in a frame, is ignored. ff . fillcolor . When the scatter layer is activated, scatter symbols fillcolor gpSetScatterLineThickness , use line color. use background color. use no fill. – or – 2 3 4 string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. scalar, one of the following: 1 is not set to 4, then  for the list of colors; color names are case insensitive in R gpShowScatterLayer fillmode framenum = 1; seton = 1; fieldzonenum = 3; fillmode = 2; ret = gpShowScatterLayer(&gp,framenum,seton); ret = gpSetScatterFillMode(&gp,framenum,fieldzonenum,fillmode,""); call are not filled by default. If Frames are numbered in thecorrespond order to that the they are number created. of the Field associated zone zone numbers in the data file. See Section gpfieldzone.src gpSetScatterColor By default, the scatter layer is turned o 2.2.1 fillcolor ret fillmode  C  OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetScatterLineThickness

gpSetScatterLineThickness

PURPOSE Sets the line thickness of the scatter symbols in the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetScatterLineThickness(pgp, framenum, fieldzonenum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). thickness scalar, line thickness of the scatter symbols as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the scatter layer is turned off. To activate the scatter layer in a frame, call gpShowScatterLayer. When the scatter layer is activated, all scatter symbols have a line thickness of 0.1 by default.

Field zone numbers correspond to the number of the associated zone in the data file.

EXAMPLE framenum = 3; seton = 1; fieldzonenum = 2; thickness = 0.4; ret = gpShowScatterLayer(&gp,framenum,seton); ret = gpSetScatterLineThickness(&gp,framenum,fieldzonenum,thickness);

SOURCE gpfieldzone.src

3-306 GAUSS C R Command Reference 3-307 ); shape , gpSetScatterShape gpSetScatterShape fieldzonenum gpSetScatterSize , , . To activate the scatter layer in a frame, ff framenum , pgp 1 vector, field zone number(s). . When the scatter layer is activated, the default × gpSetScatterShape , – or – scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. scalar or N string, name of symbol shape. scalar, index of symbol shape in symbol shape list.  R gpShowScatterLayer = gpSetScatterShape( call symbol shape is a square. The list of available shapes is as follows: ret ret By default, the scatter layer is turned o pgp framenum fieldzonenum shape gpSetScatterColor Sets the shape of the scatter symbols in the specified field zone(s). gaussplot  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS SEE ALSO GAUSS gpSetScatterShapeASCII

1 Square 2 Del (delta) 3 Grad (gradient) 4 RTri (right triangle) 5 LTri (left triangle) 6 Diamond 7 Circle 8 Point 9 Cube 10 Sphere 11 Octahedron

Scatter shape names are case insensitive in GAUSSplot. Use gpSetScatterShapeASCII to use an ASCII character for the scatter symbols in a field zone.

EXAMPLE framenum = 1; seton = 1; fieldzonenum = 3; ret = gpShowScatterLayer(&gp,framenum,seton); ret = gpSetScatterShape(&gp,framenum,fieldzonenum,"diamond");

SOURCE gpfieldzone.src

SEE ALSO gpSetScatterShapeASCII, gpSetScatterColor, gpSetScatterSize

gpSetScatterShapeASCII

PURPOSE Sets the shape of the scatter symbols in the specified field zone(s) to an ASCII character.

LIBRARY gaussplot

FORMAT ret = gpSetScatterShapeASCII(pgp, framenum, fieldzonenum,

3-308 GAUSS C R Command Reference 3-309 . GAUSSplot gpSetScatterSize gpSetScatterSize , . To activate the scatter layer in a frame, ff 1 vector, field zone number(s). . When the scatter layer is activated, the default to use a preset symbol shape. × gpSetScatterColor , Base font, normal ASCII characters. Greek font. Math font. ); ’. for a list of all of the available characters in π pointer to a plot control structure. scalar, frame number. scalar or N scalar, one of the following: 1 2 3 string, single character to use as symbol. scalar, return code, 0 if successful, otherwise an error code. A character ,  R gpSetScatterShape gpShowScatterLayer framenum = 1; seton = 1; fieldzonenum = 3; fonttype = 2; ret = gpShowScatterLayer(&gp,framenum,seton); ret = gpSetScatterShapeASCII(&gp,framenum,fieldzonenum,fonttype,"p"); call symbol shape is a square. Use See Appendix gpfieldzone.src gpSetScatterShape By default, the scatter layer is turned o This example sets the symbol shapethe for Greek the letter third ‘ field zone in the first frame to fonttype pgp framenum fieldzonenum fonttype character ret  C  INPUT OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetShadeColor

gpSetScatterSize

PURPOSE Sets the size of the scatter symbols in the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetScatterSize(pgp, framenum, fieldzonenum, size);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). size scalar, size of the scatter symbols as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the scatter layer is turned off. To activate the scatter layer in a frame, call gpShowScatterLayer. When the scatter layer is activated, all scatter symbols have a size of 2.5 by default.

Field zone numbers correspond to the number of the associated zone in the data file.

EXAMPLE framenum = 3; seton = 1; fieldzonenum = 2; size = 1.5; ret = gpShowScatterLayer(&gp,framenum,seton); ret = gpSetScatterSize(&gp,framenum,fieldzonenum,size);

SOURCE gpfieldzone.src

SEE ALSO gpSetScatterColor, gpSetScatterShape

3-310 GAUSS C R Command Reference 3-311 ); shadecolor , gpSetShadeColor , gpSetShadeColor fieldzonenum , . To activate the shade layer in a frame, ff gpUseTranslucency , framenum , 1 vector, field zone number(s). pgp × . for the list of colors; color names are case insensitive in gpShowFieldZoneShadeLayer , – or – 2.2.1 string, name of shade color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. scalar or N .  R gpShowShadeLayer = gpSetShadeColor( framenum = 1; seton = 1; fieldzonenum = 1; ret = gpShowShadeLayer(&gp,framenum,seton); ret = gpSetShadeColor(&gp,framenum,fieldzonenum,"blue"); call Field zone numbers correspond tofile. the number See of Section the associated zone in the data shadecolor ret By default, the shade layer is turned o GAUSSplot gpfieldzone.src gpShowShadeLayer gpUseFieldZoneShadeLighting pgp framenum fieldzonenum Sets the color of the shading in the specified field zone(s). gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetSurfacesToPlot

gpSetSurfacesToPlot

PURPOSE Specifies which surfaces are to be displayed for a 3D Cartesian or 3D Contour volume plot.

LIBRARY gaussplot

FORMAT ret = gpSetSurfacesToPlot(pgp, framenum, fieldzonenum, surfaces);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). surfaces scalar, one of the following: 1 boundary cell faces 2 exposed cell faces 3 I-Planes 4 J-Planes 5 K-Planes 6 IJ-Planes 7 JK-Planes 8 IK-Planes 9 IJK-Planes 10 every surface

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The following table explains each of the surface plotting options, assuming that the X, Y and Z-axis variables used in the graph are L×N×P:

3-312 GAUSS C R Command Reference 3-313 , for information on data gpSetSymbolColor . gpSetIPlaneRange gpSetKPlaneRange tpum.pdf , P surfaces in the specified range (1 - L) P surfaces in the specified range (1 - N) N surfaces in the specified range (1 - P) N surfaces in the specified range (1 - P), N surfaces in the specifiedP range surfaces (1 in - the P) specified range (1 - N) N surfaces in the specified range (1 - P) × × × × × × × in the file P surfaces in the specified range (1 - L) P surfaces in the specified range (1 - L) P surfaces in the specified range (1 - N) × × × P surfaces in the specified range (1 - L) P surfaces in the specified range (1 - N) and the gpSetKPlaneRange × ×  or / M  ’ and the N and the N the L the N and the L data values are plotted as well as the outer surfaces gpSetJPlaneRange and ,  U R

  Every surface Display all surfaces cell facescell faces zone used. Then the surfaces between blanked and unblanked JK-planesIK-planes Display the L IJK-planes Display the L Display the L J-planesK-planesIJ-planes Display the L Display the N Display the L boundaryexposed Display all surfaces that are on the outside of the data Identical toI-planes boundary cell faces unless data blanking is Display the L R 7 8 9 4 5 6 10 Option1 2 Explanation 3 framenum = 1; fieldzonenum = 2; ret = gpSetSurfacesToPlot(&gp,framenum,fieldzonenum,10); gpfieldzone.src gpSetIPlaneRange By default, exposed cell face plottingvolume is plots. used for 3D Cartesian and 3D Contour See the T blanking for the exposed cell face option. To set the specified ranges for options 3 - 9, call gpSetJPlaneRange  C  SOURCE EXAMPLE SEE ALSO GAUSS gpSetSymbolFillMode

gpSetSymbolColor

PURPOSE Sets the color of the symbols in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetSymbolColor(pgp, framenum, linemapnum, symbolcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). symbolcolor string, name of symbol color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the symbol layer is turned off. To activate the symbol layer in a frame, call gpShowSymbolLayer.

See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; seton = 1; linemapnum = 3; ret = gpShowSymbolLayer(&gp,framenum,seton); ret = gpSetSymbolColor(&gp,framenum,linemapnum,"purple");

SOURCE gplinemap.src

SEE ALSO gpShowSymbolLayer, gpShowLineMapSymbols, gpSetSymbolShape

3-314 GAUSS C R Command Reference , 3-315 fillmode , linemapnum gpSetSymbolFillMode , gpSetSymbolFillMode . To activate the symbol layer in a ff framenum is ignored. , . When the symbol layer is activated, symbols pgp . fillcolor 1 vector, line map number(s). × fillcolor no fill. use line color. use background color. use – or – for the list of colors; color names are case insensitive in scalar or N scalar, one of the following: 1 2 3 4 string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. . 2.2.1 gpShowSymbolLayer is not set to 4, then );  R = gpSetSymbolFillMode( fillmode framenum = 1; linemapnum fillmode fillcolor ret By default, the symbol layer is turned o GAUSSplot pgp framenum frame, call Sets the fill mode of the symbols in the specified linegaussplot map(s). ret are not filled by default. If See Section fillcolor  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpSetSymbolLineThickness

seton = 1; linemapnum = 3; fillmode = 3; ret = gpShowSymbolLayer(&gp,framenum,seton); ret = gpSetSymbolFillMode(&gp,framenum,linemapnum,fillmode,"");

SOURCE gplinemap.src

SEE ALSO gpSetSymbolColor, gpSetSymbolLineThickness, gpSetSymbolShape

gpSetSymbolLineThickness

PURPOSE Sets the line thickness of the symbols in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetSymbolLineThickness(pgp, framenum, linemapnum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). thickness scalar, line thickness of the symbols as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the symbol layer is turned off. To activate the symbol layer in a frame, call gpShowSymbolLayer. When the symbol layer is activated, all symbols have a line thickness of 0.1 by default.

EXAMPLE framenum = 3;

3-316 GAUSS C R Command Reference 3-317 ); shape , gpSetSymbolShape gpSetSymbolShape linemapnum , gpSetSymbolSize , . To activate the symbol layer in a ff framenum . When the symbol layer is activated, the , pgp 1 vector, line map number(s). × gpSetSymbolShape , – or – scalar, frame number. scalar or N string, name of symbol shape. scalar, index of symbol shape in symbol shape list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. gpShowSymbolLayer  R = gpSetSymbolShape( seton = 1; linemapnum = 2; thickness = 0.4; ret = gpShowSymbolLayer(&gp,framenum,seton); ret = gpSetSymbolLineThickness(&gp,framenum,linemapnum,thickness); default symbol shape is a square. The list of available shapes is as follows: framenum linemapnum shape ret By default, the symbol layerframe, is call turned o Sets the shape of the symbols in the specified line map(s). gaussplot ret pgp gplinemap.src gpSetSymbolColor  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetSymbolShapeASCII

1 Square 2 Del (delta) 3 Grad (gradient) 4 RTri (right triangle) 5 LTri (left triangle) 6 Diamond 7 Circle

Symbol shape names are case insensitive in GAUSSplot. Use gpSetSymbolShapeASCII to use an ASCII character for the symbols in a line map.

EXAMPLE framenum = 1; seton = 1; linemapnum = 3; ret = gpShowSymbolLayer(&gp,framenum,seton); ret = gpSetSymbolShape(&gp,framenum,linemapnum,"diamond");

SOURCE gplinemap.src

SEE ALSO gpSetSymbolShapeASCII, gpSetSymbolColor, gpSetSymbolSize, gpSetSymbolSkip

gpSetSymbolShapeASCII

PURPOSE Sets the shape of the symbols in the specified line map(s) to an ASCII character.

LIBRARY gaussplot

FORMAT ret = gpSetSymbolShapeASCII(pgp, framenum, linemapnum, fonttype, character);

INPUT pgp pointer to a plot control structure.

3-318 GAUSS C R Command Reference 3-319 . , GAUSSplot gpSetSymbolSize gpSetSymbolSize , . To activate the symbol layer in a ff . When the symbol layer is activated, the 1 vector, line map number(s). × to use a preset symbol shape. gpSetSymbolColor , Base font, normal ASCII characters. Greek font. Math font. ’. for a list of all of the available characters in π scalar, one of the following: 1 2 3 string, single character to use as symbol. scalar, return code, 0 if successful, otherwise an error code. scalar, frame number. scalar or N A gpShowSymbolLayer  R gpSetSymbolShape framenum = 1; seton = 1; linemapnum = 3; fonttype = 2; ret = gpShowSymbolLayer(&gp,framenum,seton); ret = gpSetSymbolShapeASCII(&gp,framenum,linemapnum,fonttype,"p"); gpSetSymbolSkip gplinemap.src gpSetSymbolShape This example sets the symbol shapethe for Greek the letter third ‘ line map in the first frame to fonttype character ret By default, the symbol layerframe, is call turned o framenum linemapnum default symbol shape is a square. Use See Appendix  C  OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetSymbolSkip

gpSetSymbolSize

PURPOSE Sets the size of the symbols in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpSetSymbolSize(pgp, framenum, linemapnum, size);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). size scalar, size of the symbols as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the symbol layer is turned off. To activate the symbol layer in a frame, call gpShowSymbolLayer. When the symbol layer is activated, all symbols have a size of 2.5 by default.

EXAMPLE framenum = 3; seton = 1; linemapnum = 2; size = 1.5; ret = gpShowSymbolLayer(&gp,framenum,seton); ret = gpSetSymbolSize(&gp,framenum,linemapnum,size);

SOURCE gplinemap.src

SEE ALSO gpSetSymbolColor, gpSetSymbolShape, gpSetSymbolSkip

3-320 GAUSS C R Command Reference is 3-321 , skipnum data points. skipnum , gpSetSymbolSkip skipnum percent of the frame is set to 1, then gpSetSymbolSkip linemapnum skipnum , skipmode . To activate the symbol layer in a ff framenum . When the symbol layer is activated, symbols , 1 vector, line map number(s). pgp × show symbols at every data point. show symbols at only one inshow every symbols at the first datadata point point and that at is each atheight successive least from the previous symbol. scalar, frame number. scalar or N scalar, skip. scalar, one of the following: 1 2 3 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. gpShowSymbolLayer );  R = gpSetSymbolSkip( framenum = 3; seton = 1; linemapnum = 2; skipnum = 5; skipmode framenum linemapnum skipnum skipmode ret By default, the symbol layer is turned o ignored. pgp frame, call Sets an option to show symbolsspecified at line only map(s). a subset of the data points in the gaussplot ret are shown at every data point by default. If  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpSetTextObjectAnchorLocation

skipmode = 2; ret = gpShowSymbolLayer(&gp,framenum,seton); ret = gpSetSymbolSkip(&gp,framenum,linemapnum,skipnum,skipmode);

SOURCE gplinemap.src

SEE ALSO gpSetSymbolColor, gpSetSymbolShape, gpSetSymbolSize

gpSetTextObjectAnchorLocation

PURPOSE Sets the anchor location of a text object.

LIBRARY gaussplot

FORMAT ret = gpSetTextObjectAnchorLocation(pgp, framenum, name, horizontal, vertical);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of a text object created by gpAddTextObject. horizontal scalar, one of the following: 1 anchor the left hand side of the text object to the specified X position. 2 anchor the horizontal midpoint of the text object to the specified X position. 3 anchor the right hand side of the text object to the specified X position. vertical scalar, one of the following: 1 anchor the bottom edge of the text object to the specified Y position. 2 anchor the vertical midpoint of the text object to the specified Y position.

3-322 GAUSS C R Command Reference 3-323 horizontal,vertical); must be preceded by a call to gpSetTextObjectBoxColor gpSetTextObjectBoxColor ypos,coord,"3D Contour Plot"); gpRotateTextObject anchor the top edge ofposition. the text object to the specified Y , . 3 scalar, return code, 0 if successful, otherwise an error code. gpSetTextObjectAnchorLocation  R ret = gpSetTextObjectAnchorLocation(&gp,framenum,"text1", framenum = 1; xpos = 41; ypos = 91; coord = 1; horizontal = 2; vertical = 2; ret = gpAddTextObject(&gp,framenum,"text1",xpos, gaussplot gptext.src gpAddTextObject Sets the outline and background colors of the box surrounding a text object. This example adds a text object,(0 moves - it 100), to and the then positionposition. centers (41,91) the in text frame box units both vertically and horizontally on that ret A call to gpAddTextObject  C  OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetTextObjectBoxColor

FORMAT ret = gpSetTextObjectBoxColor(pgp, framenum, name, linecolor, fillcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of a text object created by gpAddTextObject. linecolor string, name of color to use for box outline.. – or – scalar, index of color in color list fillcolor string, name of color to use for box background.. – or – scalar, index of color in color list

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpSetTextObjectBoxColor must be preceded by a call to gpAddTextObject. If the text object box type is set to none, then these colors are not used. If the text object box type is set to hollow, then fillcolor is not used, since a hollow box has no background. By default, the box type for a text object is set to none. To change the box type, call gpSetTextObjectBoxType.

See Section 2.2.1 for the list of available colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; objectname = "text1"; xpos = 41; ypos = 91; coord = 1; filledbox = 3; linecolor = "red"; fillcolor = "white";

ret = gpAddTextObject(&gp,framenum,objectname,xpos, ypos,coord,"f(x) = sin(x)"); ret = gpSetTextObjectBoxType(&gp,framenum,objectname,filledbox);

3-324 GAUSS C R Command Reference . 3-325 , boxtype . , . name gpAddTextObject , gpSetTextObjectBoxStyle framenum gpSetTextObjectBoxStyle , pgp ); fillcolor gpSetTextObjectBoxStyle , no box. hollow box (no background). filled box. , – or – – or – scalar, one of the following: 1 2 3 scalar, thickness of the box outlineheight. as a percentage of the frame string, name of color to use for box outline. scalar, index of color instring, color name list of color to use for box background. scalar, index of color in color list pointer to a plot control structure. scalar, frame number. string, name of a text object created by linecolor ,  R = gpSetTextObjectBoxStyle( ret = gpSetTextObjectBoxColor(&gp,framenum,objectname,linecolor,fillcolor); thickness boxtype thickness linecolor fillcolor Sets the style of the box surrounding a text object. gaussplot ret pgp framenum name gptext.src gpAddTextObject This example adds a text objectto to filled, frame and one, sets sets the the box box outline type color of to the red text and object the box fill color to white.  C  INPUT FORMAT LIBRARY SOURCE PURPOSE SEE ALSO GAUSS gpSetTextObjectBoxThickness

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS This command is a convenience function that allows you to set several parameters at one time. See gpSetTextObjectBoxType, gpSetTextObjectBoxThickness, and gpSetTextObjectBoxColor to set the box style parameters individually.

A call to gpSetTextObjectBoxStyle must be preceded by a call to gpAddTextObject. If boxtype is set to none, then thickness, linecolor, and fillcolor are not used. If boxtype is set to hollow, then fillcolor is not used, since a hollow box has no background. By default, the box type for a text object is set to none.

See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; objectname = "text1"; xpos = 41; ypos = 91; coord = 1; filledbox = 3; thickness = 0.4; linecolor = "red"; fillcolor = "white";

ret = gpAddTextObject(&gp,framenum,objectname,xpos, ypos,coord,"f(x) = sin(x)"); ret = gpSetTextObjectBoxStyle(&gp,framenum,objectname,filledbox, thickness,linecolor,fillcolor);

SOURCE gptext.src

SEE ALSO gpAddTextObject, gpSetTextObjectBoxColor, gpSetTextObjectBoxThickness, gpSetTextObjectBoxType

3-326 GAUSS C R Command Reference is . 3-327 , thickness name , gpAddTextObject framenum , must be preceded by a call to pgp gpSetTextObjectBoxThickness to change the box type. gpSetTextObjectBoxThickness . If the text object box type is set to none, then string, name of a text object createdscalar, by thickness of the box outlineheight. as a percentage of the frame scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. gpSetTextObjectBoxType gpSetTextObjectBoxThickness );  R = gpSetTextObjectBoxThickness( framenum = 1; objectname = "text1"; xpos = 41; ypos = 91; coord = 1; filledbox = 3; thickness = 0.4; ret = gpAddTextObject(&gp,framenum,objectname,xpos,ypos,coord,"f(x)ret = = sin(x)"); gpSetTextObjectBoxType(&gp,framenum,objectname,filledbox); name thickness ret A call to pgp framenum gpAddTextObject Sets the thickness of the outline of the box surrounding agaussplot text object. ret not used. By default, theis box changed type to for filled a or text0.1. hollow, object then Call is the set default to thickness none. of If the the box box outline type is thickness  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpSetTextObjectBoxType

ret = gpSetTextObjectBoxThickness(&gp,framenum,objectname,thickness);

This example adds a text object to frame one, sets the box type of the text object to filled, and sets the thickness of the box outline to 0.4.

SOURCE gptext.src

SEE ALSO gpAddTextObject, gpSetTextObjectBoxStyle

gpSetTextObjectBoxType

PURPOSE Sets the type of the box surrounding a text object.

LIBRARY gaussplot

FORMAT ret = gpSetTextObjectBoxType(pgp, framenum, name, boxtype);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of a text object created by gpAddTextObject. boxtype scalar, one of the following: 1 no box. 2 hollow box (no background). 3 filled box.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpSetTextObjectBoxType must be preceded by a call to gpAddTextObject. By default, the box type for a text object is set to none.

EXAMPLE framenum = 1;

3-328 GAUSS C R Command Reference . 3-329 . ); GAUSSplot textcolor , gpAddTextObject name gpSetTextObjectColor , gpSetTextObjectColor framenum , must be preceded by a call to pgp gpSetTextObjectBoxStyle . By default, the text in a text object is black. See Section , – or – pointer to a plot control structure. scalar, frame number. string, name of a text object createdstring, by name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. gpSetTextObjectColor  for the list of colors; color names are case insensitive in R = gpSetTextObjectColor( objectname = "text1"; xpos = 41; ypos = 91; coord = 1; filledbox = 3; ret = gpAddTextObject(&gp,framenum,objectname,xpos,ypos,coord,"f(x)ret = = sin(x)"); gpSetTextObjectBoxType(&gp,framenum,objectname,filledbox); 2.2.1 Sets the color of the text in a text object. gaussplot ret pgp framenum name textcolor ret A call to gpAddTextObject gptext.src gpAddTextObject  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetTextObjectFont

EXAMPLE framenum = 1; objectname = "text1"; xpos = 41; ypos = 91; coord = 1; ret = gpAddTextObject(&gp,framenum,objectname,xpos, ypos,coord,"f(x) = sin(x)"); ret = gpSetTextObjectColor(&gp,framenum,objectname,"blue");

SOURCE gptext.src

SEE ALSO gpAddTextObject, gpSetTextObjectFont, gpSetTextObjectLineSpacing, gpSetTextObjectMargin

gpSetTextObjectFont

PURPOSE Sets the font of the text in a text object.

LIBRARY gaussplot

FORMAT ret = gpSetTextObjectFont(pgp, framenum, name, fonttype, height, heightunit);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of a text object created by gpAddTextObject. fonttype string, name of font. – or – scalar, index of font in font list. height scalar, font height. heightunit scalar, one of the following: 1 font height as a percentage of the height of the frame.

3-330 GAUSS C R Command Reference 3-331 gpSetTextObjectFont . "timesitalic",height,heightunit); must be preceded by a call to GAUSSplot ypos,coord,"f(x) = sin(x)"); “helvbold”). The default font height is 14 points. The list font height in points. . By default, the text in a text object is written in a helvetica = 2 scalar, return code, 0 if successful, otherwise an error code. 1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef fonttype gpSetTextObjectFont  R framenum = 1; objectname = "text1"; xpos = 41; ypos = 91; coord = 1; height = 18; heightunit = 2; ret = gpAddTextObject(&gp,framenum,objectname,xpos, ret = gpSetTextObjectFont(&gp,framenum,objectname, gptext.src of available fonts is as follows: Font names are case insensitive in ret A call to gpAddTextObject bold font (  C  OUTPUT SOURCE EXAMPLE REMARKS GAUSS gpSetTextObjectLineSpacing

SEE ALSO gpSetDefaultTextFont, gpAddTextObject, gpSetTextObjectColor

gpSetTextObjectLineSpacing

PURPOSE Sets the spacing between the lines of text in a text object.

LIBRARY gaussplot

FORMAT ret = gpSetTextObjectLineSpacing(pgp, framenum, name, linespacing);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. name string, name of a text object created by gpAddTextObject. linespacing scalar, the spacing between the lines of text.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS A call to gpSetTextObjectLineSpacing must be preceded by a call to gpAddTextObject. By default, line spacing is set to 1.

EXAMPLE framenum = 1; objectname = "text1"; xpos = 41; ypos = 91; coord = 1; linespacing = 1.5;

ret = gpAddTextObject(&gp,framenum,objectname,xpos,ypos,coord,"f(x) = sin(x)"); ret = gpSetTextObjectLineSpacing(&gp,framenum,objectname,linespacing);

SOURCE gptext.src

3-332 GAUSS C R Command Reference . 3-333 , ); margin , gpAddTextObject name , gpSetTextObjectMargin gpSetTextObjectFont , gpSetTextObjectMargin framenum , must be preceded by a call to pgp , then the margin is set by default to 20. gpSetTextObjectColor . By default, the box type is set to none, so there is no , pointer to a plot control structure. scalar, frame number. string, name of a text object createdscalar, by the size of the marginsurrounding between box the as text a and percentage the of the text height. scalar, return code, 0 if successful, otherwise an error code. gpSetTextObjectMargin  R = gpSetTextObjectMargin( framenum = 1; objectname = "text1"; xpos = 41; ypos = 91; coord = 1; filledbox = 3; margin = 60; ret A call to gpAddTextObject margin. However, if the box typegpSetTextObjectBoxType is changed to hollow or filled with pgp framenum name margin ret gpAddTextObject gpSetTextObjectMargin Sets the size of thebox. margin between the text in a text object and the surrounding gaussplot  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetThetaAxisColor

ret = gpAddTextObject(&gp,framenum,objectname,xpos, ypos,coord,"f(x) = sin(x)"); ret = gpSetTextObjectBoxType(&gp,framenum,objectname,filledbox); ret = gpSetTextObjectMargin(&gp,framenum,objectname,margin);

SOURCE gptext.src

SEE ALSO gpAddTextObject, gpSetTextObjectColor, gpSetTextObjectFont, gpSetTextObjectLineSpacing

gpSetThetaAxisColor

PURPOSE Sets the color of the Theta-axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetThetaAxisColor(pgp, framenum, linecolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linecolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all axis lines are black. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot. This command applies ONLY to frames that contain Polar Line plots.

EXAMPLE framenum = 1; ret = gpSetThetaAxisColor(&gp,framenum,"green");

3-334 GAUSS C R Command Reference 3-335 ); , for the list of colors; textcolor , 2.2.1 . This command applies ONLY framenum gpSetThetaAxisLabelColor , gpSetThetaAxisLabelColor pgp GAUSSplot gpSetThetaAxisLabelOffset , gpSetThetaAxisThickness , – or – pointer to a plot control structure. scalar, frame number. string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetThetaAxisLabelColor( framenum = 2; ret = gpSetThetaAxisLabelColor(&gp,framenum,"purple"); gppolarlineplot.src gpSetThetaAxisLabelFont ret By default, all axis tickcolor labels names are are black. case See insensitive Section in to frames that contain Polar Line plots. pgp framenum textcolor ret gppolarlineplot.src gpShowPolarAxes Sets the color of the Theta-axis tick labels in the specifiedgaussplot frame. gpSetThetaAxisLabelSkip  C  INPUT FORMAT OUTPUT LIBRARY SOURCE SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO SEE ALSO GAUSS gpSetThetaAxisLabelFont

gpSetThetaAxisLabelFont

PURPOSE Sets the type and size of the font used for the Theta-axis tick labels in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetThetaAxisLabelFont(pgp, framenum, fonttype, height, heightunit);

INPUT pgp pointer to a plot control structure.

framenum scalar, frame number.

fonttype string, name of font. – or – scalar, index of font in font list.

height scalar, font height.

heightunit scalar, one of the following:

1 font height as a percentage of the height of the frame. 2 font height in points. 3 font height as a percentage of the length of the axis line.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all polar axes tick labels are written in a helvetica font (fonttype = “helv”) with a font height equal to 3% of the frame height. The list of available fonts is as follows:

3-336 GAUSS C R Command Reference 3-337 , ); set ff o , framenum . This command applies ONLY , gpSetThetaAxisLabelOffset pgp gpSetThetaAxisLabelOffset GAUSSplot gpSetThetaAxisLabelOffset , 1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek set of the Theta-axis tick labels from the axis line in the specified 10 Math 11 UserDef ff  R = gpSetThetaAxisLabelOffset( framenum = 1; fontheight = 10; heightunit = 2; ret = gpSetThetaAxisLabelFont(&gp,framenum,"times",fontheight,heightunit); ret Sets the o frame. gaussplot gppolarlineplot.src gpSetThetaAxisLabelColor gpSetThetaAxisLabelSkip Font names are case insensitive in to frames that contain Polar Line plots.  C  FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpSetThetaAxisLabelSkip

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. offset scalar, offset of tick labels from axis line as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all axis tick labels have an offset of 1. This command applies ONLY to frames that contain Polar Line plots.

EXAMPLE framenum = 1; offset = 2; ret = gpSetThetaAxisLabelOffset(&gp,framenum,offset);

SOURCE gppolarlineplot.src

SEE ALSO gpSetThetaAxisLabelColor, gpSetThetaAxisLabelFont, gpSetThetaAxisLabelSkip

gpSetThetaAxisLabelSkip

PURPOSE Sets an option to show only one in every skipnum Theta-axis tick labels in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetThetaAxisLabelSkip(pgp, framenum, skipnum);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. skipnum scalar, show only one in every skipnum Theta-axis tick labels.

3-338 GAUSS C R Command Reference , 3-339 , ); max gpSetThetaMode , . π 1). This command applies min = gpSetThetaAxisRange , gpSetThetaAxisRange skipnum framenum , pgp gpSetThetaAxisLabelFont , is calculated in degrees, and the range of the Theta-axis is 0 - mode is changed to radians with a call to pointer to a plot control structure. scalar, frame number. scalar, minimum value for the Theta-axis. scalar, maximum value for the Theta-axis. scalar, return code, 0 if successful, otherwise an error code. scalar, return code, 0 if successful, otherwise an error code. theta theta  R = gpSetThetaAxisRange( framenum = 3; skip = 2; ret = gpSetThetaAxisLabelSkip(&gp,framenum,skip); ONLY to frames that contain Polar Line Plots. Sets the range of the Theta-axis in the specified frame. gaussplot ret pgp framenum min max ret By default, 360. If the then the default range of the Theta-axis becomes 0 - 2 By default, all axis tick labels are shown ( gppolarlineplot.src gpSetThetaAxisLabelColor ret gpSetThetaAxisLabelOffset  C  INPUT FORMAT OUTPUT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS REMARKS SEE ALSO GAUSS gpSetThetaAxisThickness

If you call gpSetThetaAxisPeriod to reset the Theta-axis range, you should not set (max − min) > period, where period is the theta range of a complete circle. If the theta mode is set to degrees, then the default period is 360. If the theta mode is set to radians, then the default period is 2π. Call gpSetThetaPeriod to change the period of theta.

EXAMPLE framenum = 1; min = 0; max = 180; ret = gpSetThetaAxisRange(&gp,framenum,min,max);

This example sets the range of the Theta-axis to 0 - 180. Assuming that the period of theta is still set to the default of 360, this call to gpSetThetaAxisRange will cause only the top half of the Theta-axis circle to be displayed.

SOURCE gppolarlineplot.src

SEE ALSO gpSetThetaMode, gpSetThetaPeriod, gpSetThetaAxisTicks

gpSetThetaAxisThickness

PURPOSE Sets the thickness of the Theta-axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetThetaAxisThickness(pgp, framenum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. thickness scalar, thickness of the axis line as a percentage of the height of the frame.

3-340 GAUSS C R Command Reference ); 3-341 minornum , majorstep gpSetThetaAxisTicks , gpSetThetaAxisTicks framenum , pgp pointer to a plot control structure. scalar, frame number. scalar, step between major tick marks inscalar, Theta-axis number units. of minor tick markstick between marks. each set of major scalar, return code, 0 if successful, otherwise an error code. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetThetaAxisTicks( framenum = 1; thickness = 0.6; ret = gpSetThetaAxisThickness(&gp,framenum,thickness); Sets the distance between majoron tick the marks Theta-axis and in the the number specified of frame. minor tick marks gaussplot ret pgp framenum majorstep minornum ret By default, the step betweenmarks major on tick the marks Theta-axis and is the calculated number based of on minor the tick range of the axis. To modify By default, all axis linesONLY are to set frames to that a contain thickness Polar of Line 0.4. plots. This command applies gppolarlineplot.src gpSetThetaAxisColor ret  C  INPUT FORMAT OUTPUT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS REMARKS SEE ALSO GAUSS gpSetThetaAxisTitle

the range of the Theta-axis, call gpSetThetaAxisRange. This command applies ONLY to frames that contain Polar Line plots.

EXAMPLE framenum = 1; majorstep = 15; minornum = 2; ret = gpSetThetaAxisTicks(&gp,framenum,majorstep,minornum);

This example sets the distance between major tick marks on the Theta-axis to 15 units, and the number of minor tick marks between each set of major tick marks to 2. Thus there are 5 units from one tick mark to the next.

SOURCE gp.src

SEE ALSO gpSetThetaAxisRange

gpSetThetaAxisTitle

PURPOSE Sets the title for the Theta-axis in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetThetaAxisTitle(pgp, framenum, title);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. title string, title.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, each axis is titled with the name(s) of the variable(s) that are associated with that axis (the variables are separated by a comma and a space if

3-342 GAUSS C R Command Reference 3-343 ); , textcolor , for the list of colors; color 2.2.1 framenum gpSetThetaAxisTitleColor , gpSetThetaAxisTitleColor . This command applies ONLY to pgp gpSetThetaAxisTitleOffset to set the titles for both the Theta and R axes in a , GAUSSplot gpSetThetaAxisTitleColor , – or – pointer to a plot control structure. scalar, frame number. string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code.  R gpSetPolarAxesTitles = gpSetThetaAxisTitleColor( framenum = 1; ret = gpSetThetaAxisTitle(&gp,framenum,"Theta"); names are case insensitive in frames that contain Polar Line plots. Sets the color of the Theta-axis title in the specified frame. gaussplot ret pgp framenum textcolor ret By default, all axis titles are black. See Section gppolarlineplot.src gpSetPolarAxesTitles there are more than one).Polar This Line command plots. applies ONLY to frames that contain Use frame. gpSetThetaAxisTitleFont  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetThetaAxisTitleFont

EXAMPLE framenum = 1; ret = gpSetThetaAxisTitleColor(&gp,framenum,"green");

SOURCE gppolarlineplot.src

SEE ALSO gpSetThetaAxisTitle, gpSetThetaAxisTitleFont, gpSetThetaAxisTitleOffset

gpSetThetaAxisTitleFont

PURPOSE Sets the type and size of the font used for the Theta-axis title in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetThetaAxisTitleFont(pgp, framenum, fonttype, height, heightunit);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fonttype string, name of font. – or – scalar, index of font in font list. height scalar, font height. heightunit scalar, one of the following: 1 font height as a percentage of the height of the frame. 2 font height in points. 3 font height as a percentage of the length of the axis line.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

3-344 GAUSS C R Command Reference = 3-345 fonttype , . This command applies ONLY gpSetThetaAxisTitleOffset gpSetThetaAxisTitleOffset GAUSSplot gpSetThetaAxisTitleColor , 1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek set of the Theta-axis title from the axis line in the specified frame. 10 Math 11 UserDef ff  R framenum = 1; fontheight = 5; heightunit = 1; ret = gpSetThetaAxisTitleFont(&gp,framenum,"timesbold",fontheight,heightunit); gaussplot gppolarlineplot.src gpSetThetaAxisTitle gpSetThetaAxisTitleOffset Sets the o By default, all polar axes titles“helvbold”) are with written a in font a heightavailable bold equal fonts helvetica to is font 3.6% as ( of follows: the frame height. The list of Font names are case insensitive in to frames that contain Polar Line plots.  C  LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetThetaMode

FORMAT ret = gpSetThetaAxisTitleOffset(pgp, framenum, offset);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. offset scalar, offset of title from axis line as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the offset is set to 6. This command applies ONLY to frames that contain Polar Line plots.

EXAMPLE framenum = 1; offset = 8; ret = gpSetThetaAxisTitleOffset(&gp,framenum,offset);

SOURCE gppolarlineplot.src

SEE ALSO gpSetThetaAxisTitle, gpSetThetaAxisTitleColor, gpSetThetaAxisTitleFont

gpSetThetaMode

PURPOSE Specifies whether theta is calculated in degrees or in radians.

LIBRARY gaussplot

FORMAT ret = gpSetThetaMode(pgp, framenum, mode);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. mode scalar, one of the following:

3-346 GAUSS C R Command Reference mode 3-347 , call resets π theta , then the before , you should not also gpSetThetaPeriod , then the period gpSetThetaMode gpSetThetaPeriod also changes the gpSetThetaMode . You can change the Theta-axis π to a value other than 360 or 2 gpSetThetaAxisTicks , range of a complete circle) is 360. If gpSetThetaRange theta gpSetThetaPeriod gpSetThetaMode . However, since theta in degrees. in radians. gpSetThetaPeriod theta theta mode to radians, which causes the period to be set to (i.e., the . π . theta theta . Calling gpSetThetaPeriod calculate calculate , . is calculated in degrees, and the range of the Theta-axis is 0 - mode is changed to radians with gpSetThetaRange 1 2 scalar, return code, 0 if successful, otherwise an error code. range of a complete circle. . To change the period of theta theta π mode is set to radians with theta  R gpSetThetaMode theta , and the range to 0 - 2 π framenum = 1; mode = 2; ret = gpSetThetaMode(&gp,framenum,mode); Sets the 2 gppolarlineplot.src gpSetThetaRange This example sets the ret By default, 360. If the default range of the Theta-axisrange becomes by 0 calling - 2 the Theta-axis range, you shouldgpSetThetaMode not call The default period of the becomes 2 gpSetThetaPeriod call to a user-specified mode, which iswant to neither change degrees nor the radians. period by Therefore, calling if you  C  OUTPUT SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetTileMargins

LIBRARY gaussplot

FORMAT ret = gpSetThetaPeriod(pgp, framenum, period);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. period scalar, number of units on the Theta-axis that make a complete circle.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, theta is calculated in degrees, and the period of theta is 360. If the theta mode is changed to radians with gpSetThetaPeriod, then the default period of theta becomes 2π. To change the period of theta to a value other than 360 or 2π, call gpSetThetaPeriod. Calling gpSetThetaPeriod also changes the theta mode to a user-specified mode, which is neither degrees nor radians. Therefore, if you want to change the period by calling gpSetThetaPeriod, you should not also set the theta mode with gpSetThetaMode.

Calling gpSetThetaPeriod resets the Theta-axis range to 0 - period. Call gpSetThetaRange after gpSetThetaPeriod to change the range of the Theta-axis.

EXAMPLE framenum = 1; period = 100; ret = gpSetThetaPeriod(&gp,framenum,period);

This example sets the theta period to 100 (meaning that 100 units on the Theta-axis make a complete circle), changes the theta mode to a user-specified mode (neither degrees nor radians), and resets the range of the Theta-axis to 0 - 100.

SOURCE gppolarlineplot.src

SEE ALSO gpSetThetaMode, gpSetThetaRange, gpSetThetaAxisTicks

3-348 GAUSS C R Command Reference ); 3-349 before gpTile bmargin , gpSetTileMargins tmargin , gpSetTileMargins gpSetTileMargins rmargin , lmargin , pgp leaves 0.25 inch margins between the frames and the edges scalar, margin between frames and right edgescalar, of margin paper between in frames inches. and top edgescalar, of margin paper between in frames inches. and bottominches. edge of paper in scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, margin between frames and left edge of paper in inches. gpTile .  R = gpSetTileMargins( framesperrow = 3; lrmargin = 0.5; tmargin = 0.25; bmargin = 0.4; ret = gpSetTileMargins(&gp,lrmargin,lrmargin,tmargin,bmargin); ret = gpTile(&gp,framesperrow); This example sets the margins betweenthe the paper frames to and 0.5 the inches, leftpaper the and to margin right between 0.25 edges the inches, of frames andthe and the paper the margin between to top the 0.4 edge frames inches. of and the It the then bottom generates edge three of rows of frames in the graph, rmargin tmargin bmargin ret By default, of the paper. To change thegpTile margins, you must call pgp lmargin Sets the margins between the framescommand. and the edges of the paper for the gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpSetTranslation

placing three frames in the first and third rows and two frames in the second row. The example assumes that a total of 8 frames have been added to the graph.

SOURCE gp.src

SEE ALSO gpTile, gpMoveFrame

gpSetTranslation

PURPOSE Translates a plot horizontally and/or vertically.

LIBRARY gaussplot

FORMAT ret = gpSetTranslation(pgp, framenum, xtranslate, ytranslate);

INPUT pgp pointer to a plot control structure. framenum scalar or N×1 vector, frame number(s). xtranslate scalar, horizontal translation as a percentage of the frame width. ytranslate scalar, vertical translation as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the plot is centered. Inputting a positive value for xtranslate translates the plot right, while a negative value translates the plot left. Similarly, a positive value for ytranslate translates the plot up, while a negative value translates the plot down.

EXAMPLE framenum = 1; xtranslate = 25; ytranslate = -15; ret = gpSetTranslation(&gp,framenum,xtranslate,ytranslate);

3-350 GAUSS C R Command Reference 3-351 , gpSetTranslucency gpSetTranslucency fieldzonenum , gpSetFrameStyle , framenum , pgp 1 vector, field zone number(s). × gpSetPlotFit , pointer to a plot control structure. scalar, frame number. scalar or N scalar, percentage of translucency. scalar, return code, 0 if successful, otherwise an error code. );  R = gpSetTranslucency( framenum = 1; seton = 1; fieldzonenum = 2; translucency = 75; ret = gpUseTranslucencyEffect(&gp,framenum,seton); ret = gpSetTranslucency(&gp,framenum,fieldzonenum,translucency); gaussplot ret translucency pgp framenum fieldzonenum translucency ret Field zone numbers correspond tofile. the number By of default, the translucency associated is zone set in to the 50%. data gp.src gpSetMagnification Sets the percentage of translucency offield shade zone(s). and contour layers in the specified This example translates the plot 25%the of frame the height frame down. width to the right and 15% of  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetVectorArrowHeadType

SOURCE gpfieldzone.src

SEE ALSO gpUseTranslucencyEffect, gpUseFieldZoneTranslucency, gpShowShadeLayer

gpSetVectorArrowHeadType

PURPOSE Sets the arrow head type for the vectors in the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetVectorArrowHeadType(pgp, framenum, fieldzonenum, type);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). type scalar, one of the following: 1 plain arrow head. 2 filled arrow head. 3 hollow arrow head.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the vector layer is turned off. To activate the vector layer in a frame, call gpShowVectorLayer. When the vector layer is activated, plain arrow heads are used by default.

Field zone numbers correspond to the number of the associated zone in the data file.

EXAMPLE framenum = 1;

3-352 GAUSS C R Command Reference ); 3-353 vectorcolor , gpSetVectorColor gpSetVectorColor fieldzonenum , gpSetVectorVariables , . To activate the vector layer in a frame, ff framenum , pgp 1 vector, field zone number(s). × . for the list of colors; color names are case insensitive in gpSetVectorType , – or – 2.2.1 string, name of vector color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. scalar or N .  R gpShowVectorLayer = gpSetVectorColor( seton = 1; fieldzonenum = 2; type = 3; ret = gpShowVectorLayer(&gp,framenum,seton); ret = gpSetVectorArrowHeadType(&gp,framenum,fieldzonenum,type); call Field zone numbers correspond tofile. the number See of Section the associated zone in the data vectorcolor ret By default, the vector layer is turned o Sets the color of the vectors in the specified field zone(s). gaussplot ret pgp framenum fieldzonenum GAUSSplot gpfieldzone.src gpSetVectorColor  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetVectorLinePattern

EXAMPLE framenum = 1; seton = 1; fieldzonenum = 2; ret = gpShowVectorLayer(&gp,framenum,seton); ret = gpSetVectorColor(&gp,framenum,fieldzonenum,"purple");

SOURCE gpfieldzone.src

SEE ALSO gpShowVectorLayer, gpShowFieldZoneVectorLayer, gpSetVectorLinePattern, gpSetVectorLineThickness

gpSetVectorLinePattern

PURPOSE Sets the line pattern of the vectors in the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetVectorLinePattern(pgp, framenum, fieldzonenum, pattern);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). pattern string, name of line pattern. – or – scalar, index of line pattern in pattern list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the vector layer is turned off. To activate the vector layer in a frame, call gpShowVectorLayer. When the vector layer is activated, vectors are drawn with solid lines by default.

3-354 GAUSS C R Command Reference , 3-355 fieldzonenum , gpSetVectorType , . framenum , pgp GAUSSplot gpSetVectorLinePatternLength gpSetVectorColor , gpSetVectorLinePatternLength 1 vector, field zone number(s). × scalar or N pointer to a plot control structure. scalar, frame number. 1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot  ); R = gpSetVectorLinePatternLength( framenum = 1; seton = 1; fieldzonenum = 2; ret = gpShowVectorLayer(&gp,framenum,seton); ret = gpSetVectorLinePattern(&gp,framenum,fieldzonenum,"dashdotdot"); fieldzonenum Sets the length of the vector line pattern in the specifiedgaussplot field zone(s). ret pgp framenum gpfieldzone.src gpSetVectorLinePatternLength length The list of available line patterns is as follows: Line pattern names are case insensitive in  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpSetVectorLineThickness

length scalar, length of one cycle of the line pattern as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the vector layer is turned off. To activate the vector layer in a frame, call gpShowVectorLayer. When the vector layer is activated, vectors are drawn with solid lines by default, and the line pattern length is ignored. If a different line pattern is selected with gpSetVectorLinePattern, the default pattern length is 2.

EXAMPLE framenum = 1; seton = 1; fieldzonenum = 2; length = 4; ret = gpShowVectorLayer(&gp,framenum,seton); ret = gpSetVectorLinePattern(&gp,framenum,fieldzonenum,"dashdot"); ret = gpSetVectorLinePatternLength(&gp,framenum,fieldzonenum,length);

SOURCE gpfieldzone.src

SEE ALSO gpSetVectorLinePattern, gpSetVectorColor, gpSetVectorLineThickness

gpSetVectorLineThickness

PURPOSE Sets the line thickness of the vectors in the specified field zone(s).

LIBRARY gaussplot

FORMAT ret = gpSetVectorLineThickness(pgp, framenum, fieldzonenum, thickness);

3-356 GAUSS C R Command Reference 3-357 ); type , gpSetVectorType gpSetVectorType fieldzonenum , gpSetVectorVariables , . To activate the vector layer in a frame, ff framenum , 1 vector, field zone number(s). pgp × . When the vector layer is activated, vectors have a gpSetVectorType , scalar or N scalar, line thickness of the vectorsof as the a frame. percentage of the height scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R gpShowVectorLayer = gpSetVectorType( framenum = 3; seton = 1; fieldzonenum = 2; thickness = 0.4; ret = gpShowVectorLayer(&gp,framenum,seton); ret = gpSetVectorLineThickness(&gp,framenum,fieldzonenum,thickness); ret gpfieldzone.src gpSetVectorColor Sets the type of vector used in the specified field zone(s). gaussplot fieldzonenum thickness ret By default, the vector layer iscall turned o line thickness of 0.1 by default. Field zone numbers correspond tofile. the number of the associated zone in the data pgp framenum  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetVectorVariables

INPUT pgp pointer to a plot control structure.

framenum scalar, frame number.

fieldzonenum scalar or N×1 vector, field zone number(s).

type scalar, one of the following:

1 vector tail at data point. 2 vector head at data point. 3 vector midpoint at data point. 4 display only vector head.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the vector layer is turned off. To activate the vector layer in a frame, call gpShowVectorLayer. When the vector layer is activated, vectors are placed in the graph with the vector tails at data points by default.

Field zone numbers correspond to the number of the associated zone in the data file.

EXAMPLE framenum = 1; seton = 1; fieldzonenum = 2; type = 3; ret = gpShowVectorLayer(&gp,framenum,seton); ret = gpSetVectorType(&gp,framenum,fieldzonenum,type);

SOURCE gpfieldzone.src

SEE ALSO gpSetVectorColor, gpSetVectorArrowHeadType, gpSetVectorVariables

3-358 GAUSS C R Command Reference 3-359 variables ); variables gpSetVectorVariables , gpSetVectorVariables 1 vector or string array. This × framenum . To activate the vector layer in a frame, ff , pgp should be a 3 . 1 string array, names of variables. 1 vector, indices of the variables in the data file. – or – × × variables N N scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. 1 vector or string array. If the frame contains a 3D Cartesian or ×  R gpShowVectorLayer = gpSetVectorVariables( framenum = 1; showvectors = 1; variables = {ret 1,4,5 = }; gpShowVectorLayer(&gp,framenum,showvectors); ret = gpSetVectorVariables(&gp,framenum,variables); should be a 2 3D Contour plot, call If the specified frame contains a 2D Cartesian or 2D Contour plot, command does not apply to Bar, XY Line or PolarBy Line default, plots. the first andvector second components variables in for the 2D data plots, set andused will the as be first, the used second vector components as and for the third 3D variables will plots. be variables ret By default, the vector layer is turned o pgp framenum Sets the variables to use asspecified the frame. vector components for the vectors in the gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpSetWorkspaceView

SOURCE gpfieldzone.src

SEE ALSO gpShowVectorLayer, gpShowFieldZoneVectorLayer, gpSetVectorColor, gpSetVectorType

gpSetWorkspaceView

PURPOSE Sets workspace view options.

LIBRARY gaussplot

FORMAT gpSetWorkspaceView(pgp, showruler, showpaper);

INPUT pgp pointer to a plot control structure. showruler scalar, one of the following: 0 do not display the ruler. 1 display the ruler. showpaper scalar, one of the following: 0 do not display the paper. 1 display the paper.

REMARKS By default, a ruler is shown on the bottom and the right-hand side of the workspace, and paper is shown behind the frames in the workspace.

EXAMPLE showruler = 0; showpaper = 0; gpSetWorkspaceView(&gp,showruler,showpaper);

SOURCE gp.src

SEE ALSO gpSetFrameStyle

3-360 GAUSS C R Command Reference 3-361 ); argument linecolor gpSetXAxisColor axisnum , gpSetXAxisColor for the list of colors; color 2.2.1 axisnum to link one or more line maps to an , . This command does not apply to 5, X-axis number. ≤ framenum , GAUSSplot pgp axisnum ≤ gpSetLineMapAxes – or – scalar, 1 string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R = gpSetXAxisColor( framenum = 1; axisnum = 1; ret = gpSetXAxisColor(&gp,framenum,axisnum,"green"); frames that contain Polar Line plots. gp.src axisnum linecolor ret Line plots allow up to five X and Y axes in a frame. The names are case insensitive in pgp framenum Sets the color of an X-axis line in the specified frame. gaussplot ret specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are By default, all axis lines are black. See Section  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS GAUSS gpSetXAxisGridLineColor

SEE ALSO gpShowXAxis, gpPositionXAxis, gpSetXAxisThickness

gpSetXAxisGridLineColor

PURPOSE Sets the color of the X-axis major gridlines.

LIBRARY gaussplot

FORMAT ret = gpSetXAxisGridLineColor(pgp, framenum, axisnum, linecolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum leq 5, X-axis number. linecolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional X axes, call gpSetLineMapAxes to link one or more line maps to an X-axis numbered greater than one. X axes that are added in this way are displayed by default.

By default, major gridlines are black. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; axisnum = 1; show = 1; ret = gpShowXAxisGridLines(&gp,framenum,axisnum,show);

3-362 GAUSS C R Command Reference 3-363 , argument , axisnum , axisnum framenum , to link one or more line maps to an pgp gpSetXAxisGridLineThickness 5, X-axis number. gpSetXAxisGridLineThickness ≤ gpSetXAxisGridLineThickness axisnum , ≤ gpSetLineMapAxes pointer to a plot control structure. scalar, frame number. scalar, 1 scalar, thickness of the X-axis majorthe gridlines height as of a the percentage frame. of scalar, return code, 0 if successful, otherwise an error code. );  R = gpSetXAxisGridLineThickness( ret = gpSetXAxisGridLineColor(&gp,framenum,axisnum,"red"); gaussplot ret thickness pgp framenum axisnum thickness ret Line plots allow up to five X and Y axes in a frame. The gp.src gpShowXAxisGridLines Sets the thickness of the X-axis major gridlines. gpSetXAxisGridPattern specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are By default, major gridlines have a line thickness of 0.1.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetXAxisGridPattern

EXAMPLE framenum = 1; axisnum = 1; show = 1; thickness = 0.25; ret = gpShowXAxisGridLines(&gp,framenum,axisnum,show); ret = gpSetXAxisGridLineThickness(&gp,framenum,axisnum,thickness);

SOURCE gp.src

SEE ALSO gpShowXAxisGridLines, gpSetXAxisGridLineColor, gpSetXAxisGridPattern

gpSetXAxisGridPattern

PURPOSE Sets the pattern of the X-axis major gridlines.

LIBRARY gaussplot

FORMAT ret = gpSetXAxisGridPattern(pgp, framenum, axisnum, pattern);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number. pattern string, name of line pattern. – or – scalar, index of line pattern in pattern list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display

3-364 GAUSS C R Command Reference 3-365 , , axisnum , . framenum , to link one or more line maps to an pgp GAUSSplot gpSetXAxisGridPatternLength gpSetXAxisGridPatternLength gpShowXAxisGridLines , gpSetLineMapAxes 1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot  ); R = gpSetXAxisGridPatternLength( framenum = 1; axisnum = 1; show = 1; ret = gpShowXAxisGridLines(&gp,framenum,axisnum,show); ret = gpSetXAxisGridPattern(&gp,framenum,axisnum,"dashed"); Sets the length of the X-axis major grid line pattern. gaussplot ret gp.src gpSetXAxisGridPatternLength length additional X axes, call X-axis numbered greater than one.displayed X by axes default. that are added in this way are By default, major gridlines arefollows: solid. The list of available line patterns is as Line pattern names are case insensitive in gpSetXAxisGridLineColor  C  FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpSetXAxisLabelColor

INPUT pgp pointer to a plot control structure.

framenum scalar, frame number.

axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number.

length scalar, length of one cycle of the line pattern as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional X axes, call gpSetLineMapAxes to link one or more line maps to an X-axis numbered greater than one. X axes that are added in this way are displayed by default.

Major gridlines are drawn as solid lines by default, and the pattern length is ignored. If a different line pattern is selected with gpSetXAxisGridLinePattern, then the default pattern length is 2.

EXAMPLE framenum = 1; axisnum = 1; show = 1; length = 4; ret = gpShowXAxisGridLines(&gp,framenum,axisnum,show); ret = gpSetXAxisGridPattern(&gp,framenum,axisnum,"dashed"); ret = gpSetXAxisGridPatternLength(&gp,framenum,axisnum,length);

SOURCE gp.src

SEE ALSO gpSetXAxisGridPattern, gpShowXAxisGridLines, gpSetXAxisGridLineColor

3-366 GAUSS C R Command Reference 3-367 ); argument textcolor , for the list of colors; axisnum axisnum 2.2.1 , gpSetXAxisLabelColor . This command does not apply gpSetXAxisLabelColor to link one or more line maps to an framenum 5, X-axis number. , ≤ GAUSSplot pgp axisnum ≤ gpSetLineMapAxes – or – scalar, 1 string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R = gpSetXAxisLabelColor( framenum = 2; axisnum = 1; ret = gpSetXAxisLabelColor(&gp,framenum,axisnum,"purple"); gp.src axisnum textcolor ret Line plots allow up to five X and Y axes in a frame. The color names are case insensitive in to frames that contain Polar Line plots. pgp framenum Sets the color of X-axis tick labels in the specified frame. gaussplot ret specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are By default, all axis tick labels are black. See Section  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS GAUSS gpSetXAxisLabelFont

SEE ALSO gpSetXAxisLabelFont, gpSetXAxisLabelOffset, gpSetXAxisLabelSkip

gpSetXAxisLabelFont

PURPOSE Sets the type and size of the font used for X-axis tick labels in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetXAxisLabelFont(pgp, framenum, axisnum, fonttype, height, heightunit);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number. fonttype string, name of font. – or – scalar, index of font in font list. height scalar, font height. heightunit scalar, one of the following: 1 font height as a percentage of the height of the frame. 2 font height in points. 3 font height as a percentage of the length of the axis line (valid only for 3D Cartesian and 3D Contour plots).

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional X axes, call gpSetLineMapAxes to link one or more line maps to an

3-368 GAUSS C R Command Reference 3-369 “helv”). = fonttype , gpSetXAxisLabelOffset . This command does not apply GAUSSplot gpSetXAxisLabelOffset , 1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef  R framenum = 1; axisnum = 1; fontheight = 10; heightunit = 2; ret = gpSetXAxisLabelFont(&gp,framenum,axisnum,"times",fontheight,heightunit); gpSetXAxisLabelSkip gp.src gpSetXAxisLabelColor The default font height is3D equal Contour to plots 3% and of equal theThe to axis list 3% length of of for available the 3D fonts frame Cartesian is height and as for follows: all other plot types. Font names are case insensitive in to frames that contain Polar Line plots. X-axis numbered greater than one.displayed X by axes default. that are added in this way are By default, all axis tick labels are written in a helvetica font (  C  SOURCE EXAMPLE SEE ALSO GAUSS gpSetXAxisLabelOffset

gpSetXAxisLabelOffset

PURPOSE Sets the offset of X-axis tick labels from the axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetXAxisLabelOffset(pgp, framenum, axisnum, offset);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number. offset scalar, offset of tick labels from axis line.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional X axes, call gpSetLineMapAxes to link one or more line maps to an X-axis numbered greater than one. X axes that are added in this way are displayed by default.

The offset is defined as a percentage of the median axis length for 3D Cartesian and 3D Contour plots, and as a percentage of the frame height for all other plot types. By default, all axis tick labels have an offset of 1. This command does not apply to frames that contain Polar Line plots.

EXAMPLE framenum = 1; axisnum = 1; offset = 2; ret = gpSetXAxisLabelOffset(&gp,framenum,axisnum,offset);

SOURCE gp.src

3-370 GAUSS C R Command Reference 3-371 ); argument skipnum , axisnum X-axis tick labels. gpSetXAxisLabelSkip 1). This command does , axisnum = gpSetXAxisLabelSkip X-axis tick labels in the , gpSetXAxisLabelSkip skipnum to link one or more line maps to an skipnum skipnum framenum 5, X-axis number. , ≤ pgp gpSetXAxisLabelFont axisnum , ≤ gpSetLineMapAxes pointer to a plot control structure. scalar, frame number. scalar, 1 scalar, show only one in every scalar, return code, 0 if successful, otherwise an error code.  R = gpSetXAxisLabelSkip( framenum = 3; axisnum = 1; skip = 2; ret = gpSetXAxisLabelSkip(&gp,framenum,axisnum,skip); pgp framenum axisnum skipnum ret Line plots allow up to five X and Y axes in a frame. The gpSetXAxisLabelColor Sets an option to show onlyspecified one frame. in every gaussplot ret specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are By default, all axis ticknot labels apply are to shown ( frames that contain Polar Line Plots.  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetXAxisMinorGridLineColor

SOURCE gp.src

SEE ALSO gpSetXAxisLabelColor, gpSetXAxisLabelFont, gpSetXAxisLabelOffset

gpSetXAxisMinorGridLineColor

PURPOSE Sets the color of the X-axis minor gridlines.

LIBRARY gaussplot

FORMAT ret = gpSetXAxisMinorGridLineColor(pgp, framenum, axisnum, linecolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number. linecolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional X axes, call gpSetLineMapAxes to link one or more line maps to an X-axis numbered greater than one. X axes that are added in this way are displayed by default.

By default, minor gridlines are black. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot.

3-372 GAUSS C R Command Reference , , 3-373 axisnum , argument axisnum framenum , pgp to link one or more line maps to an 5, X-axis number. ≤ gpSetXAxisMinorGridLineThickness , gpSetXAxisMinorGridLineThickness gpSetXAxisMinorGridLineThickness axisnum ≤ gpSetLineMapAxes scalar, frame number. scalar, 1 scalar, thickness of the X-axis minorof gridlines the as height a of percentage the frame. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. );  R = gpSetXAxisMinorGridLineThickness( framenum = 1; axisnum = 1; show = 1; ret = gpShowXAxisMinorGridLines(&gp,framenum,axisnum,show); ret = gpSetXAxisMinorGridLineColor(&gp,framenum,axisnum,"red"); thickness framenum axisnum thickness ret Line plots allow up to five X and Y axes in a frame. The Sets the thickness of the X-axis minor gridlines. gaussplot ret pgp specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis are that used. To display gp.src gpShowXAxisMinorGridLines gpSetXAxisMinorGridPattern  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetXAxisMinorGridPattern

X-axis numbered greater than one. X axes that are added in this way are displayed by default.

By default, minor gridlines have a line thickness of 0.1.

EXAMPLE framenum = 1; axisnum = 1; show = 1; thickness = 0.25; ret = gpShowXAxisMinorGridLines(&gp,framenum,axisnum,show); ret = gpSetXAxisMinorGridLineThickness(&gp,framenum,axisnum,thickness);

SOURCE gp.src

SEE ALSO gpShowXAxisMinorGridLines, gpSetXAxisMinorGridLineColor, gpSetXAxisMinorGridPattern

gpSetXAxisMinorGridPattern

PURPOSE Sets the pattern of the X-axis minor gridlines.

LIBRARY gaussplot

FORMAT ret = gpSetXAxisMinorGridPattern(pgp, framenum, axisnum, pattern);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number. pattern string, name of line pattern. – or – scalar, index of line pattern in pattern list.

3-374 GAUSS C R Command Reference , 3-375 argument axisnum . to link one or more line maps to an gpShowXAxisMinorGridLines GAUSSplot , gpSetXAxisMinorGridPatternLength gpSetXAxisMinorGridPatternLength gpSetLineMapAxes scalar, return code, 0 if successful, otherwise an error code. 1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot  R framenum = 1; axisnum = 1; show = 1; ret = gpShowXAxisMinorGridLines(&gp,framenum,axisnum,show); ret = gpSetXAxisMinorGridPattern(&gp,framenum,axisnum,"dashed"); Sets the length of the X-axis minor grid line pattern. gp.src gpSetXAxisMinorGridPatternLength Line plots allow up to five X and Y axes in a frame. The ret specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are By default, minor gridlines arefollows: dotted. The list of available line patterns is as Line pattern names are case insensitive in gpSetXAxisMinorGridLineColor  C  OUTPUT SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetXAxisRange

LIBRARY gaussplot

FORMAT ret = gpSetXAxisMinorGridPatternLength(pgp, framenum, axisnum, length);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number. length scalar, length of one cycle of the line pattern as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional X axes, call gpSetLineMapAxes to link one or more line maps to an X-axis numbered greater than one. X axes that are added in this way are displayed by default.

Minor gridlines are drawn as dotted lines with a pattern length of 2 by default.

EXAMPLE framenum = 1; axisnum = 1; show = 1; length = 4; ret = gpShowXAxisMinorGridLines(&gp,framenum,axisnum,show); ret = gpSetXAxisMinorGridPattern(&gp,framenum,axisnum,"dashdotdot"); ret = gpSetXAxisMinorGridPatternLength(&gp,framenum,axisnum,length);

SOURCE gp.src

SEE ALSO gpSetXAxisMinorGridPattern, gpShowXAxisMinorGridLines, gpSetXAxisMinorGridLineColor

3-376 GAUSS C R Command Reference 3-377 ); argument max , min axisnum gpSetXAxisRange , gpSetXAxisRange axisnum to link one or more line maps to an , 5, X-axis number. ≤ framenum , pgp axisnum ≤ gpSetLineMapAxes . scalar, 1 scalar, minimum value for the X-axis. scalar, maximum value for the X-axis. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R = gpSetXAxisRange( framenum = 1; axisnum = 1; axisnum min max ret Line plots allow up to five X and Y axes in a frame. The pgp framenum Sets the range of an X-axis in the specified frame. gaussplot ret specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are The range of an X-axisdefault. is calculated If based the on axes the areand values dependent 3D of on Cartesian the one and data another, 2D points whichdetermined and by is by 3D the the Contour default X, for plots, Y 2D thenOtherwise, and the the (for range range 3D of is plots), the determined Z X-axisof by values is major of only and the the minor data X tick points. values.gpSetXAxisTicks marks To change or the the number distance between them, call  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpSetXAxisThickness

min = 5; max = 15; ret = gpSetXAxisRange(&gp,framenum,axisnum,min,max);

SOURCE gp.src

SEE ALSO gpSetXAxisTicks

gpSetXAxisThickness

PURPOSE Sets the thickness of an X-axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetXAxisThickness(pgp, framenum, axisnum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number. thickness scalar, thickness of the axis line as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional X axes, call gpSetLineMapAxes to link one or more line maps to an X-axis numbered greater than one. X axes that are added in this way are displayed by default.

All axis lines are set to a thickness of 0.4 by default. This command does not apply to frames that contain Polar Line plots.

3-378 GAUSS C R Command Reference 3-379 , argument majorstep gpSetXAxisTicks axisnum , gpSetXAxisTicks axisnum to link one or more line maps to an , 5, X-axis number. ≤ framenum , pgp axisnum ≤ gpSetLineMapAxes scalar, 1 scalar, step between major tick marks inscalar, X-axis number units. of minor tick markstick between marks. each set of major scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. );  R = gpSetXAxisTicks( framenum = 1; axisnum = 1; thickness = 0.6; ret = gpSetXAxisThickness(&gp,framenum,axisnum,thickness); axisnum majorstep minornum ret Line plots allow up to five X and Y axes in a frame. The Sets the distance between majoron tick an marks X-axis and in the the number specified of frame. minor tick marks gaussplot ret pgp framenum specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis are that used. To display gp.src gpSetXAxisColor minornum  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetXAxisTitle

X-axis numbered greater than one. X axes that are added in this way are displayed by default.

The step between major tick marks and the number of minor tick marks on an X-axis is calculated based on the range of the axis by default. To modify the range of an X-axis, call gpSetXAxisRange.

EXAMPLE framenum = 1; axisnum = 1; majorstep = 2; minornum = 3; ret = gpSetXAxisTicks(&gp,framenum,axisnum,majorstep,minornum);

This example sets the distance between major tick marks on the first X-axis to 2 units, and the number of minor tick marks between each set of major tick marks to 3. Therefore, there will be 0.5 units from one tick mark to the next.

SOURCE gp.src

SEE ALSO gpSetXAxisRange

gpSetXAxisTitle

PURPOSE Sets the title for an X-axis in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetXAxisTitle(pgp, framenum, axisnum, title);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number. title string, title.

3-380 GAUSS C R Command Reference 3-381 ); argument textcolor , axisnum axisnum , gpSetXAxisTitleColor , gpSetXAxisTitleColor to link one or more line maps to an framenum 5, X-axis number. , ≤ pgp gpSetXAxisTitleFont axisnum , ≤ gpSetLineMapAxes scalar, 1 pointer to a plot control structure. scalar, frame number. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetXAxisTitleColor( framenum = 1; axisnum = 1; ret = gpSetXAxisTitle(&gp,framenum,axisnum,"X"); axisnum Sets the color of an X-axis title in the specified frame. gaussplot ret pgp framenum gp.src gpSetXAxisTitleColor gpSetXAxisTitleOffset Line plots allow up to five X and Y axes in a frame. The ret specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are Each axis is titled withthat the axis name(s) by of default the (the variable(s)are that variables are more are separated than associated by one). with a comma and a space if there  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetXAxisTitleFont

textcolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional X axes, call gpSetLineMapAxes to link one or more line maps to an X-axis numbered greater than one. X axes that are added in this way are displayed by default.

All axis titles are black by default. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot. This command does not apply to frames that contain Polar Line plots.

EXAMPLE framenum = 1; axisnum = 1; ret = gpSetXAxisTitleColor(&gp,framenum,axisnum,"green");

SOURCE gp.src

SEE ALSO gpSetXAxisTitle, gpSetXAxisTitleFont, gpSetXAxisTitleOffset

gpSetXAxisTitleFont

PURPOSE Sets the type and size of the font used for an X-axis title in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetXAxisTitleFont(pgp, framenum, axisnum, fonttype, height, heightunit);

3-382 GAUSS C R Command Reference 3-383 “helvbold”) argument = axisnum fonttype gpSetXAxisTitleFont to link one or more line maps to an 5, X-axis number. ≤ axisnum ≤ gpSetLineMapAxes font height as a percentage of the height offont the height frame. in points. font height as a percentage(valid of only the for length 3D of Cartesian the and axis 3D line Contour plots) – or – 1 2 3 scalar, return code, 0 if successful, otherwise an error code. scalar, frame number. scalar, 1 string, name of font. scalar, index of font in font list. scalar, font height. scalar, one of the following: pointer to a plot control structure.  R by default. The default fontCartesian height and is 3D equal Contour to plots 3.6%other and of plot equal the types. to axis 3.6% The length of list for the of 3D frame available height fonts for is all as follows: Line plots allow up to five X and Y axes in a frame. The ret specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are All axis tick labels are written in a bold helvetica font ( framenum axisnum fonttype height heightunit pgp  C  INPUT OUTPUT REMARKS GAUSS gpSetXAxisTitleOffset

1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef

Font names are case insensitive in GAUSSplot. This command does not apply to frames that contain Polar Line plots.

EXAMPLE framenum = 1; axisnum = 1; fontheight = 5; heightunit = 1; ret = gpSetXAxisTitleFont(&gp,framenum,axisnum,"timesbold",fontheight,heightunit);

SOURCE gp.src

SEE ALSO gpSetXAxisTitle, gpSetXAxisTitleColor, gpSetXAxisTitleOffset

gpSetXAxisTitleOffset

PURPOSE Sets the offset of an X-axis title from the axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetXAxisTitleOffset(pgp, framenum, axisnum, offset);

INPUT pgp pointer to a plot control structure.

3-384 GAUSS C R Command Reference 3-385 argument gpSetYAxisColor axisnum gpSetYAxisColor gpSetXAxisTitleFont , set is defined as a percentage of ff to link one or more line maps to an 5, X-axis number. ≤ axisnum set of title from axis line. ≤ ff gpSetLineMapAxes gpSetXAxisTitleColor , scalar, o scalar, return code, 0 if successful, otherwise an error code. scalar, frame number. scalar, 1  R set ff framenum = 1; axisnum = 1; offset = 10; ret = gpSetXAxisTitleOffset(&gp,framenum,axisnum,offset); gaussplot gpSetXAxisTitle Sets the color of a Y-axis line in the specified frame. the median axis length, andas the a default percentage is of 8. the Fordoes height all not of other apply the plot to frame, types, frames and it that the is contain default defined Polar is Line 6. plots. This command gp.src o ret Line plots allow up to five X and Y axes in a frame. The framenum axisnum specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are For 3D Cartesian and 3D Contour plots, the o  C  OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetYAxisGridLineColor

FORMAT ret = gpSetYAxisColor(pgp, framenum, axisnum, linecolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. linecolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

All axis lines are black by default. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot. This command does not apply to frames that contain Polar Line plots.

EXAMPLE framenum = 1; axisnum = 1; ret = gpSetYAxisColor(&gp,framenum,axisnum,"blue");

SOURCE gp.src

SEE ALSO gpShowYAxis, gpSetYAxisThickness

gpSetYAxisGridLineColor

PURPOSE Sets the color of the Y-axis major gridlines.

3-386 GAUSS C R Command Reference ); 3-387 linecolor argument , , axisnum axisnum for the list of colors; , 2.2.1 . to link one or more line maps to a framenum , gpSetYAxisGridLineThickness pgp 5, Y-axis number. ≤ GAUSSplot gpSetYAxisGridLineThickness axisnum , ≤ gpSetLineMapAxes – or – pointer to a plot control structure. scalar, frame number. scalar, 1 string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetYAxisGridLineColor( framenum = 1; axisnum = 1; show = 1; ret = gpShowYAxisGridLines(&gp,framenum,axisnum,show); ret = gpSetYAxisGridLineColor(&gp,framenum,axisnum,"blue"); Line plots allow up to five X and Y axes in a frame. The gp.src gpShowYAxisGridLines gaussplot ret pgp framenum axisnum linecolor ret specifies which Y-axis the option iscontain set line for, plots. and By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are By default, major gridlines are black. See Section gpSetYAxisGridPattern color names are case insensitive in  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetYAxisGridLineThickness

gpSetYAxisGridLineThickness

PURPOSE Sets the thickness of the Y-axis major gridlines.

LIBRARY gaussplot

FORMAT ret = gpSetYAxisGridLineThickness(pgp, framenum, axisnum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. thickness scalar, thickness of the Y-axis major gridlines as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

By default, major gridlines have a line thickness of 0.1.

EXAMPLE framenum = 1; axisnum = 1; show = 1; thickness = 0.25; ret = gpShowYAxisGridLines(&gp,framenum,axisnum,show); ret = gpSetYAxisGridLineThickness(&gp,framenum,axisnum,thickness);

SOURCE gp.src

3-388 GAUSS C R Command Reference 3-389 ); argument pattern , , axisnum axisnum , gpSetYAxisGridPattern gpSetYAxisGridPattern to link one or more line maps to a framenum , 5, Y-axis number. ≤ pgp gpSetYAxisGridLineColor axisnum , ≤ gpSetLineMapAxes – or – pointer to a plot control structure. scalar, frame number. scalar, 1 string, name of line pattern. scalar, index of line pattern in pattern list. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetYAxisGridPattern( ret pgp framenum axisnum pattern ret Line plots allow up to five X and Y axes in a frame. The gpShowYAxisGridLines Sets the pattern of the Y-axis major gridlines. gaussplot specifies which Y-axis the option iscontain set line for, plots. and By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are By default, major gridlines arefollows: solid. The list of available line patterns is as gpSetYAxisGridPattern  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS SEE ALSO GAUSS gpSetYAxisGridPatternLength

1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot

Line pattern names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; axisnum = 1; show = 1; ret = gpShowYAxisGridLines(&gp,framenum,axisnum,show); ret = gpSetYAxisGridPattern(&gp,framenum,axisnum,"dashdot");

SOURCE gp.src

SEE ALSO gpSetYAxisGridPatternLength, gpShowYAxisGridLines, gpSetYAxisGridLineColor

gpSetYAxisGridPatternLength

PURPOSE Sets the length of the Y-axis major grid line pattern.

LIBRARY gaussplot

FORMAT ret = gpSetYAxisGridPatternLength(pgp, framenum, axisnum, length);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number.

3-390 GAUSS C R Command Reference 3-391 argument erent line pattern is ff axisnum , gpSetYAxisLabelColor gpSetYAxisLabelColor , then the default pattern length is to link one or more line maps to a gpShowYAxisGridLines , gpSetLineMapAxes scalar, length of one cycle ofthe the frame line height. pattern as a percentage of scalar, return code, 0 if successful, otherwise an error code. gpSetYAxisGridLinePattern  R framenum = 1; axisnum = 1; show = 1; length = 4; ret = gpShowYAxisGridLines(&gp,framenum,axisnum,show); ret = gpSetYAxisGridPattern(&gp,framenum,axisnum,"dashdot"); ret = gpSetYAxisGridPatternLength(&gp,framenum,axisnum,length); selected with 2. gpSetYAxisGridPattern Sets the color of Y-axis tick labels in the specified frame. gaussplot length ret Line plots allow up to fivespecifies X which and Y-axis the Y option axes is incontain set a line for, frame. plots. and The By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are Major gridlines are drawn as solid lines by default. If a di gp.src gpSetYAxisGridLineColor  C  OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetYAxisLabelFont

FORMAT ret = gpSetYAxisLabelColor(pgp, framenum, axisnum, textcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. textcolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

All axis tick labels are black by default. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot. This command does not apply to frames that contain Polar Line plots.

EXAMPLE framenum = 1; axisnum = 2; ret = gpSetYAxisLabelColor(&gp,framenum,axisnum,"red");

SOURCE gp.src

SEE ALSO gpSetYAxisLabelFont, gpSetYAxisLabelOffset, gpSetYAxisLabelSkip

gpSetYAxisLabelFont

PURPOSE Sets the type and size of the font used for Y-axis tick labels in the specified frame.

3-392 GAUSS C R Command Reference 3-393 , argument fonttype “helv”) by default. , = axisnum axisnum gpSetYAxisLabelFont fonttype , to link one or more line maps to a framenum 5, Y-axis number. , ≤ pgp axisnum ≤ gpSetLineMapAxes font height as a percentage of thefont height height of in the points. frame. font height as a percentage(valid of only the for length 3D of Cartesian the and axis 3D line Contour plots). ); – or – scalar, font height. scalar, one of the following: 1 2 3 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. scalar, 1 string, name of font. scalar, index of font in font list. heightunit  , R = gpSetYAxisLabelFont( Line plots allow up to five X and Y axes in a frame. The height heightunit ret gaussplot ret height pgp framenum axisnum fonttype specifies which Y-axis the option iscontain set line for, plots. and By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are All axis tick labels areThe written default in font a height helvetica is font3D equal ( Contour to plots 3% and of equal theThe to axis list 3% length of of for available the 3D fonts frame Cartesian is height and as for follows: all other plot types.  C  INPUT FORMAT OUTPUT LIBRARY REMARKS GAUSS gpSetYAxisLabelOffset

1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef

Font names are case insensitive in GAUSSplot. This command does not apply to frames that contain Polar Line plots.

EXAMPLE framenum = 1; axisnum = 1; height = 12; heightunit = 2; ret = gpSetYAxisLabelFont(&gp,framenum,axisnum,"timesitalic",height,heightunit);

SOURCE gp.src

SEE ALSO gpSetYAxisLabelColor, gpSetYAxisLabelOffset, gpSetYAxisLabelSkip

gpSetYAxisLabelOffset

PURPOSE Sets the offset of Y-axis tick labels from the axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetYAxisLabelOffset(pgp, framenum, axisnum, offset);

3-394 GAUSS C R Command Reference 3-395 argument axisnum gpSetYAxisLabelSkip , gpSetYAxisLabelSkip Y-axis tick labels in the gpSetYAxisLabelSkip set of 1. This command does ff to link one or more line maps to a skipnum 5, Y-axis number. ≤ gpSetYAxisLabelFont axisnum , set of tick labels from axis line. ≤ ff gpSetLineMapAxes scalar, 1 scalar, o scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. set is defined as a percentage of the median axis length for 3D Cartesian  ff R set ff framenum = 2; axisnum = 1; offset = 2; ret = gpSetYAxisLabelOffset(&gp,framenum,axisnum,offset); gp.src gpSetYAxisLabelColor Sets an option to show onlyspecified one frame. in every axisnum o ret Line plots allow up to five X and Y axes in a frame. The not apply to frames that contain Polar Line plots. pgp framenum specifies which Y-axis the option iscontain set line for, plots. and By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are The o and 3D Contour plots, andtypes. as a By percentage default, of all the axis frame tick height labels for have all an other o plot  C  INPUT OUTPUT SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetYAxisMinorGridLineColor

LIBRARY gaussplot

FORMAT ret = gpSetYAxisLabelSkip(pgp, framenum, axisnum, skipnum);

INPUT pgp pointer to a plot control structure.

framenum scalar, frame number.

axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number.

skipnum scalar, show only one in every skipnum Y-axis tick labels.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

All axis tick labels are shown (skipnum = 1) by default. This command does not apply to frames that contain Polar Line Plots.

EXAMPLE framenum = 1; axisnum = 2; skip = 2; ret = gpSetYAxisLabelSkip(&gp,framenum,axisnum,skip);

SOURCE gp.src

SEE ALSO gpSetYAxisLabelColor, gpSetYAxisLabelFont, gpSetYAxisLabelOffset

3-396 GAUSS C R Command Reference 3-397 , argument axisnum , axisnum for the list of colors; framenum 2.2.1 , . pgp to link one or more line maps to a gpSetYAxisMinorGridLineColor 5, Y-axis number. ≤ gpSetYAxisMinorGridLineColor GAUSSplot axisnum ≤ gpSetLineMapAxes – or – scalar, frame number. scalar, 1 string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. );  R = gpSetYAxisMinorGridLineColor( framenum = 1; axisnum = 1; show = 1; ret = gpShowYAxisMinorGridLines(&gp,framenum,axisnum,show); ret = gpSetYAxisMinorGridLineColor(&gp,framenum,axisnum,"blue"); framenum axisnum linecolor ret Line plots allow up to five X and Y axes in a frame. The pgp color names are case insensitive in Sets the color of the Y-axis minor gridlines. gaussplot ret linecolor specifies which Y-axis the option iscontain set line for, plots. and By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are By default, minor gridlines are black. See Section  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpSetYAxisMinorGridLineThickness

SOURCE gp.src

SEE ALSO gpShowYAxisMinorGridLines, gpSetYAxisMinorGridLineThickness, gpSetYAxisMinorGridPattern

gpSetYAxisMinorGridLineThickness

PURPOSE Sets the thickness of the Y-axis minor gridlines.

LIBRARY gaussplot

FORMAT ret = gpSetYAxisMinorGridLineThickness(pgp, framenum, axisnum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. thickness scalar, thickness of the Y-axis minor gridlines as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

By default, minor gridlines have a line thickness of 0.1.

EXAMPLE framenum = 1;

3-398 GAUSS C R Command Reference 3-399 , , argument axisnum , axisnum framenum , pgp gpSetYAxisMinorGridPattern gpSetYAxisMinorGridPattern 5, Y-axis number. ≤ gpSetYAxisMinorGridLineColor , axisnum ≤ – or – scalar, frame number. scalar, 1 string, name of line pattern. scalar, index of line pattern in pattern list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. );  R = gpSetYAxisMinorGridPattern( axisnum = 1; show = 1; thickness = 0.25; ret = gpShowYAxisMinorGridLines(&gp,framenum,axisnum,show); ret = gpSetYAxisMinorGridLineThickness(&gp,framenum,axisnum,thickness); framenum axisnum pattern ret Line plots allow up to five X and Y axes in a frame. The gpSetYAxisMinorGridPattern Sets the pattern of the Y-axis minor gridlines. gaussplot ret pattern pgp specifies which Y-axis the option iscontain set line for, plots. and By it default, is one used X-axis only and by one frames Y-axis that are used. To display gp.src gpShowYAxisMinorGridLines  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetYAxisMinorGridPatternLength

additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

By default, minor gridlines are dotted. The list of available line patterns is as follows: 1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot

Line pattern names are case insensitive in GAUSSplot.

EXAMPLE framenum = 1; axisnum = 1; show = 1; ret = gpShowYAxisMinorGridLines(&gp,framenum,axisnum,show); ret = gpSetYAxisMinorGridPattern(&gp,framenum,axisnum,"dashdot");

SOURCE gp.src

SEE ALSO gpSetYAxisMinorGridPatternLength, gpShowYAxisMinorGridLines, gpSetYAxisMinorGridLineColor

gpSetYAxisMinorGridPatternLength

PURPOSE Sets the length of the Y-axis minor grid line pattern.

LIBRARY gaussplot

FORMAT ret = gpSetYAxisMinorGridPatternLength(pgp, framenum, axisnum, length);

3-400 GAUSS C R Command Reference 3-401 , argument axisnum gpSetYAxisRange gpSetYAxisRange to link one or more line maps to a 5, Y-axis number. ≤ gpShowYAxisMinorGridLines , axisnum ≤ gpSetLineMapAxes scalar, 1 scalar, length of one cycle ofthe the frame line height. pattern as a percentage of scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R framenum = 1; axisnum = 1; show = 1; length = 4; ret = gpShowYAxisMinorGridLines(&gp,framenum,axisnum,show); ret = gpSetYAxisMinorGridPattern(&gp,framenum,axisnum,"dashdotdot"); ret = gpSetYAxisMinorGridPatternLength(&gp,framenum,axisnum,length); Sets the range of a Y-axis in the specified frame. gp.src gpSetYAxisMinorGridPattern gpSetYAxisMinorGridLineColor axisnum length ret Line plots allow up to five X and Y axes in a frame. The pgp framenum specifies which Y-axis the option iscontain set line for, plots. and By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are Minor gridlines are drawn as dotted lines with a pattern length of 2 by default.  C  INPUT OUTPUT SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetYAxisRange

LIBRARY gaussplot

FORMAT ret = gpSetYAxisRange(pgp, framenum, axisnum, min, max);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. min scalar, minimum value for the Y-axis. max scalar, maximum value for the Y-axis.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

The range of the Y-axis is calculated based on the values of the data points by default. If the axes are dependent on one another, which is the default for 2D and 3D Cartesian and 2D and 3D Contour plots, then the range of the Y-axis will be determined by the X, Y and (for 3D plots) Z values of the data points. Otherwise, the range will be determined by only the Y values. To change the number of major and minor tick marks or the distance between them, call gpSetYAxisTicks.

EXAMPLE framenum = 1; axisnum = 2; min = -10; max = 100; ret = gpSetYAxisRange(&gp,framenum,axisnum,min,max);

SOURCE gp.src

SEE ALSO gpSetYAxisTicks

3-402 GAUSS C R Command Reference 3-403 ); argument thickness , axisnum axisnum gpSetYAxisThickness , gpSetYAxisThickness to link one or more line maps to a 4 by default. This command does not framenum . 5, Y-axis number. , ≤ pgp axisnum ≤ gpSetLineMapAxes scalar, 1 scalar, thickness of the axis linethe as frame. a percentage of the height of scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R = gpSetYAxisThickness( framenum = 1; axisnum = 1; thickness = 0.2; ret = gpSetYAxisThickness(&gp,framenum,axisnum,thickness); gp.src axisnum thickness ret Line plots allow up to five X and Y axes in a frame. The pgp framenum Sets the thickness of a Y-axis line in the specified frame. gaussplot ret specifies which Y-axis the option iscontain set line for, plots. and By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are All axis lines are set to a thickness of 0 apply to frames that contain Polar Line plots.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS GAUSS gpSetYAxisTicks

SEE ALSO gpSetYAxisColor

gpSetYAxisTicks

PURPOSE Sets the distance between major tick marks and the number of minor tick marks on a Y-axis in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetYAxisTicks(pgp, framenum, axisnum, majorstep, minornum);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. majorstep scalar, step between major tick marks in Y-axis units. minornum scalar, number of minor tick marks between each set of major tick marks.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

The step between major tick marks and the number of minor tick marks on the Y-axis is calculated based on the range of the axis by default. To modify the range of the Y-axis, call gpSetYAxisRange.

3-404 GAUSS C R Command Reference 3-405 argument ); gpSetYAxisTitle title axisnum gpSetYAxisTitle , axisnum , 5, Y-axis number. ≤ framenum , pgp axisnum ≤ pointer to a plot control structure. scalar, frame number. scalar, 1 string, title. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetYAxisTitle( framenum = 1; axisnum = 2; majorstep = 1; minornum = 3; ret = gpSetYAxisTicks(&gp,framenum,axisnum,majorstep,minornum); Sets the title for a Y-axis in the specified frame. gaussplot ret pgp framenum axisnum title ret Line plots allow up to five X and Y axes in a frame. The gp.src gpSetYAxisRange This example sets the distance betweento major 1 tick unit, marks and on themarks the number to second of 3. Y-axis minor tick Therefore, marks there between will each be set 0.25 of units major from tick one tick mark to the next. specifies which Y-axis the option iscontain set line for, plots. and By it default, is one used X-axis only and by one frames Y-axis that are used. To display  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetYAxisTitleColor

additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

Each axis is titled with the name(s) of the variable(s) that are associated with that axis by default (the variables are separated by a comma and a space if there are more than one).

EXAMPLE framenum = 1; axisnum = 1; ret = gpSetYAxisTitle(&gp,framenum,axisnum,"Y");

SOURCE gp.src

SEE ALSO gpSetYAxisTitleColor, gpSetYAxisTitleFont, gpSetYAxisTitleOffset

gpSetYAxisTitleColor

PURPOSE Sets the color of a Y-axis title in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetYAxisTitleColor(pgp, framenum, axisnum, textcolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. textcolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

3-406 GAUSS C R Command Reference 3-407 , argument fonttype , axisnum for the list of colors; color gpSetYAxisTitleFont axisnum gpSetYAxisTitleFont , 2.2.1 gpSetYAxisTitleOffset , to link one or more line maps to a . This command does not apply to framenum 5, Y-axis number. , ≤ pgp GAUSSplot axisnum ≤ gpSetLineMapAxes gpSetYAxisTitleFont , ); – or – pointer to a plot control structure. scalar, frame number. scalar, 1 string, name of font. scalar, index of font in font list. heightunit  , R = gpSetYAxisTitleFont( framenum = 1; axisnum = 1; ret = gpSetYAxisTitleColor(&gp,framenum,axisnum,"purple"); gaussplot ret height pgp framenum axisnum fonttype gp.src gpSetYAxisTitle Sets the type and size of the font used for a Y-axis title in the specified frame. Line plots allow up to fivespecifies X which and Y-axis the Y option axes is incontain set a line for, frame. plots. and The By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are All axis titles are blacknames by are default. case See insensitive Section in frames that contain Polar Line plots.  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetYAxisTitleFont

height scalar, font height. heightunit scalar, one of the following: 1 font height as a percentage of the height of the frame. 2 font height in points. 3 font height as a percentage of the length of the axis line (valid only for 3D Cartesian and 3D Contour plots).

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

All axis tick labels are written in a bold helvetica font (fonttype = “helvbold”) by default. The default font height is equal to 3.6% of the axis length for 3D Cartesian and 3D Contour plots and equal to 3.6% of the frame height for all other plot types. The list of available fonts is as follows:

1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef

Font names are case insensitive in GAUSSplot. This command does not apply to frames that contain Polar Line plots.

EXAMPLE framenum = 1;

3-408 GAUSS C R Command Reference 3-409 ); set ff argument o , axisnum axisnum , gpSetYAxisTitleOffset gpSetYAxisTitleOffset gpSetYAxisTitleOffset , set is defined as a percentage of ff to link one or more line maps to a framenum , 5, Y-axis number. ≤ pgp axisnum set of title from axis line. ≤ ff gpSetLineMapAxes gpSetYAxisTitleColor , pointer to a plot control structure. scalar, frame number. scalar, 1 scalar, o scalar, return code, 0 if successful, otherwise an error code. set of a Y-axis title from the axis line in the specified frame. ff  R = gpSetYAxisTitleOffset( set ff axisnum = 1; height = 15; heightunit = 2; ret = gpSetYAxisTitleFont(&gp,framenum,axisnum,"courierbold",height,heightunit); Sets the o gaussplot ret pgp framenum axisnum o ret Line plots allow up to five X and Y axes in a frame. The the median axis length, and the default is 8. For all other plot types, it is defined gp.src gpSetYAxisTitle specifies which Y-axis the option iscontain set line for, plots. and By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are For 3D Cartesian and 3D Contour plots, the o  C  INPUT FORMAT OUTPUT LIBRARY SOURCE PURPOSE REMARKS SEE ALSO GAUSS gpSetZAxisColor

as a percentage of the height of the frame, and the default is 6. This command does not apply to frames that contain Polar Line plots.

EXAMPLE framenum = 3; axisnum = 1; offset = 5; ret = gpSetYAxisTitleOffset(&gp,framenum,axisnum,offset);

SOURCE gp.src

SEE ALSO gpSetYAxisTitle, gpSetYAxisTitleColor, gpSetYAxisTitleFont

gpSetZAxisColor

PURPOSE Sets the color of the Z-axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetZAxisColor(pgp, framenum, linecolor);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linecolor string, name of color. – or – scalar, index of color in color list.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all axis lines are black. See Section 2.2.1 for the list of colors; color names are case insensitive in GAUSSplot. This command applies only to frames that contain 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 2;

3-410 GAUSS C R Command Reference 3-411 ); , linecolor for the list of colors; , 2.2.1 . This command applies only to gpSetZAxisGridLineColor framenum gpSetZAxisGridLineColor , pgp GAUSSplot gpSetZAxisGridLineThickness , – or – pointer to a plot control structure. scalar, frame number. string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. gpSetZAxisThickness ,  R = gpSetZAxisGridLineColor( framenum = 1; ret = gpSetZAxisGridLineColor(&gp,framenum,"blue"); ret = gpSetZAxisColor(&gp,framenum,"red"); By default, major gridlines are black. See Section gp.src gpShowZAxisGridLines gaussplot ret pgp framenum linecolor ret gpSetZAxisGridPattern gp.src gpShowZAxis Sets the color of the Z-axis major gridlines. color names are case insensitive in frames that contain 3D Cartesian and 3D Contour plots.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO SEE ALSO GAUSS gpSetZAxisGridLineThickness

gpSetZAxisGridLineThickness

PURPOSE Sets the thickness of the Z-axis major gridlines.

LIBRARY gaussplot

FORMAT ret = gpSetZAxisGridLineThickness(pgp, framenum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. thickness scalar, thickness of the Z-axis major gridlines as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, major gridlines have a line thickness of 0.1. This command applies only to frames that contain 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; thickness = 0.25; ret = gpSetZAxisGridLineThickness(&gp,framenum,thickness);

SOURCE gp.src

SEE ALSO gpShowZAxisGridLines, gpSetZAxisGridLineColor, gpSetZAxisGridPattern

gpSetZAxisGridPattern

PURPOSE Sets the pattern of the Z-axis major gridlines.

3-412 GAUSS C R Command Reference 3-413 , ); pattern . This command applies , GAUSSplot framenum gpSetZAxisGridPatternLength , gpShowZAxisGridLines pgp , – or – pointer to a plot control structure. scalar, frame number. string, name of line pattern. scalar, index of line pattern in pattern list. scalar, return code, 0 if successful, otherwise an error code. 1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot  R = gpSetZAxisGridPattern( framenum = 1; ret = gpSetZAxisGridPattern(&gp,framenum,"dashdot"); gp.src gpSetZAxisGridPatternLength By default, major gridlines arefollows: solid. The list of available line patterns is as Line pattern names are caseonly insensitive in to frames that contain 3D Cartesian and 3D Contour plots. gaussplot ret pgp framenum pattern ret gpSetZAxisGridLineColor  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpSetZAxisLabelColor

gpSetZAxisGridPatternLength

PURPOSE Sets the length of the Z-axis major grid line pattern.

LIBRARY gaussplot

FORMAT ret = gpSetZAxisGridPatternLength(pgp, framenum, length);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. length scalar, length of one cycle of the line pattern as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Major gridlines are drawn as solid lines by default. If a different line pattern is selected with gpSetZAxisGridLinePattern, then the default pattern length is 2. This command applies only to frames that contain 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; length = 4; ret = gpSetZAxisGridPattern(&gp,framenum,"dashdot"); ret = gpSetZAxisGridPatternLength(&gp,framenum,length);

SOURCE gp.src

SEE ALSO gpSetZAxisGridPattern, gpShowZAxisGridLines, gpSetZAxisGridLineColor

3-414 GAUSS C R Command Reference 3-415 ); for the list of colors; gpSetZAxisLabelSkip , textcolor 2.2.1 gpSetZAxisLabelFont , gpSetZAxisLabelFont . This command applies only to gpSetZAxisLabelColor framenum , GAUSSplot pgp gpSetZAxisLabelOffset , – or – scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. string, name of color. scalar, index of color in color list.  R = gpSetZAxisLabelColor( framenum = 1; ret = gpSetZAxisLabelColor(&gp,framenum,"blue"); gp.src gpSetZAxisLabelFont Sets the type and sizeframe. of the font used for the Z-axis tick labels in the specified ret By default, all axis tickcolor labels names are are black. case See insensitive Section in frames that contain 3D Cartesian and 3D Contour plots. pgp framenum textcolor Sets the color of the Z-axis tick labels in the specifiedgaussplot frame. ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE PURPOSE REMARKS SEE ALSO GAUSS gpSetZAxisLabelFont

LIBRARY gaussplot

FORMAT ret = gpSetZAxisLabelFont(pgp, framenum, fonttype, height, heightunit);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fonttype string, name of font. – or – scalar, index of font in font list. height scalar, font height. heightunit scalar, one of the following: 1 font height as a percentage of the height of the frame 2 font height in points. 3 font height as a percentage of the length of the axis line (valid only for 3D Cartesian and 3D Contour plots).

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all axis tick labels are written in a helvetica font (fonttype = “helv”). The default font height is equal to 3% of the axis length for 3D Cartesian and 3D Contour plots and equal to 3% of the frame height for all other plot types. The list of available fonts is as follows:

1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef

3-416 GAUSS C R Command Reference 3-417 ); set ff , o , gpSetZAxisLabelOffset . This command applies ONLY gpSetZAxisLabelOffset framenum set of 1. This command applies only to ff , pgp GAUSSplot gpSetZAxisLabelOffset , set of tick labels from axis line as a percentage of the ff pointer to a plot control structure. scalar, frame number. scalar, o median axis length. scalar, return code, 0 if successful, otherwise an error code. set of the Z-axis tick labels from the axis line in the specified frame. ff  R = gpSetZAxisLabelOffset( set ff framenum = 1; framenum = 1; fontheight = 4; heightunit = 1; ret = gpSetZAxisLabelFont(&gp,framenum,"courier",fontheight,heightunit); Sets the o gaussplot ret pgp framenum o ret By default, all axis tick labels3D have Cartesian an and o 3D Contour plots. gp.src gpSetZAxisLabelColor Font names are case insensitive in gpSetZAxisLabelSkip to 3D Cartesian and 3D Contour plots.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetZAxisLabelSkip

offset = 3; ret = gpSetZAxisLabelOffset(&gp,framenum,offset);

SOURCE gp.src

SEE ALSO gpSetZAxisLabelColor, gpSetZAxisLabelFont, gpSetZAxisLabelSkip

gpSetZAxisLabelSkip

PURPOSE Sets an option to show only one in every skipnum Z-axis tick labels in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetZAxisLabelSkip(pgp, framenum, skipnum);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. skipnum scalar, show only one in every skipnum Z-axis tick labels.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all axis tick labels are shown (skipnum = 1). This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 3; ret = gpSetZAxisLabelSkip(&gp,framenum,2);

SOURCE gp.src

SEE ALSO gpSetZAxisLabelColor, gpSetZAxisLabelFont, gpSetZAxisLabelOffset

3-418 GAUSS C R Command Reference , 3-419 ); linecolor , for the list of colors; framenum 2.2.1 , . This command applies only to pgp gpSetZAxisMinorGridLineColor GAUSSplot gpSetZAxisMinorGridLineThickness , gpSetZAxisMinorGridLineThickness – or – scalar, frame number. string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure.  R = gpSetZAxisMinorGridLineColor( framenum = 1; show = 1; ret = gpShowZAxisMinorGridLines(&gp,framenum,show); ret = gpSetZAxisMinorGridLineColor(&gp,framenum,"blue"); gp.src gpShowZAxisMinorGridLines framenum linecolor ret By default, minor gridlines are black. See Section gpSetZAxisMinorGridPattern pgp color names are case insensitive in Sets the color of the Z-axis minor gridlines. gaussplot ret 3D Cartesian and 3D Contour plots.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetZAxisMinorGridPattern

gpSetZAxisMinorGridLineThickness

PURPOSE Sets the thickness of the Z-axis minor gridlines.

LIBRARY gaussplot

FORMAT ret = gpSetZAxisMinorGridLineThickness(pgp, framenum, thickness);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. thickness scalar, thickness of the Z-axis minor gridlines as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, minor gridlines have a line thickness of 0.1. This command applies only to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; show = 1; thickness = 0.25; ret = gpShowZAxisMinorGridLines(&gp,framenum,show); ret = gpSetZAxisMinorGridLineThickness(&gp,framenum,thickness);

SOURCE gp.src

SEE ALSO gpShowZAxisMinorGridLines, gpSetZAxisMinorGridLineColor, gpSetZAxisMinorGridPattern

3-420 GAUSS C R Command Reference 3-421 ); pattern , . This command applies framenum , GAUSSplot pgp gpSetZAxisMinorGridPattern gpSetZAxisMinorGridPattern – or – string, name of line pattern. scalar, index of line pattern in pattern list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. 1 Solid 2 Dashed 3 DashDot 4 Dotted 5 LongDash 6 DashDotDot  R = gpSetZAxisMinorGridPattern( framenum = 1; show = 1; ret = gpShowZAxisMinorGridLines(&gp,framenum,show); ret = gpSetZAxisMinorGridPattern(&gp,framenum,"dashdot"); only to 3D Cartesian and 3D Contour plots. pattern ret By default, minor gridlines arefollows: dotted. The list of available line patterns is as Line pattern names are case insensitive in pgp framenum Sets the pattern of the Z-axis minor gridlines. gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS GAUSS gpSetZAxisMinorGridPatternLength

SOURCE gp.src

SEE ALSO gpSetZAxisMinorGridPatternLength, gpShowZAxisMinorGridLines, gpSetZAxisMinorGridLineColor

gpSetZAxisMinorGridPatternLength

PURPOSE Sets the length of the Z-axis minor grid line pattern.

LIBRARY gaussplot

FORMAT ret = gpSetZAxisMinorGridPatternLength(pgp, framenum, length);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. length scalar, length of one cycle of the line pattern as a percentage of the frame height.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Minor gridlines are drawn as dotted lines with a pattern length of 2 by default. This command applies only to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; show = 1; length = 4; ret = gpShowZAxisMinorGridLines(&gp,framenum,show); ret = gpSetZAxisMinorGridPattern(&gp,framenum,"dashdotdot"); ret = gpSetZAxisMinorGridPatternLength(&gp,framenum,length);

SOURCE gp.src

3-422 GAUSS C R Command Reference 3-423 , . This command ); gpSetZAxisRange max gpSetZAxisRange , min , gpSetZAxisTicks gpShowZAxisMinorGridLines , framenum , pgp pointer to a plot control structure. scalar, frame number. scalar, minimum value for the Z-axis. scalar, maximum value for the Z-axis. scalar, return code, 0 if successful, otherwise an error code.  R = gpSetZAxisRange( framenum = 1; min = 0; max = 65; ret = gpSetZAxisRange(&gp,framenum,min,max); gp.src pgp framenum min max ret By default, the range ofpoints. the Z-axis If is the calculated axes based areCartesian on dependent and the on 3D values one of Contour another, the plots, whichby data then is the the the X, range default Y of for and the 3D determined Z Z-axis by values will of only be the the determined data Z values.marks points. or To Otherwise, change the the the distance range number between will of them, be major call and minor tick gpSetZAxisMinorGridPattern Sets the range of the Z-axis in the specified frame. gaussplot ret gpSetZAxisMinorGridLineColor applies only to 3D Cartesian and 3D Contour plots.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpSetZAxisThickness

SEE ALSO gpSetZAxisTicks

gpSetZAxisThickness

PURPOSE Sets the thickness of the Z-axis line in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetZAxisThickness(pgp, framenum, thickness);

INPUT pgp pointer to a plot control structure.

framenum scalar, frame number.

thickness scalar, thickness of the axis line as a percentage of the height of the frame.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all axis lines are set to a thickness of 0.4. This command applies only to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; ret = gpSetZAxisThickness(&gp,framenum,0.8);

SOURCE gp.src

SEE ALSO gpSetZAxisColor

3-424 GAUSS C R Command Reference 3-425 ); minornum gpSetZAxisTicks , gpSetZAxisTicks majorstep , . This command applies only to 3D framenum , pgp gpSetZAxisRange scalar, frame number. scalar, step between major tick marks in Z-axisscalar, number units. of minor tick markstick between marks. each set of major scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure.  R = gpSetZAxisTicks( framenum = 1; majorstep = 1; minornum = 4; ret = gpSetZAxisTicks(&gp,framenum,majorstep,minornum); gp.src Cartesian and 3D Contour plots. This example sets the distance betweenand major the tick number marks of on minor theTherefore, tick Z-axis there marks to will between 1 be each unit, 0.2 set units of from major one tick tick marks mark to to 4. the next. framenum majorstep minornum ret By default, the step betweenmarks major on tick the marks Z-axis and is therange calculated number of based of the on minor Z-axis, the tick call range of the axis. To modify the pgp Sets the distance between majoron tick the marks Z-axis and in the the number specified of frame. minor tick marks gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS GAUSS gpSetZAxisTitle

SEE ALSO gpSetZAxisRange

gpSetZAxisTitle

PURPOSE Sets the title for the Z-axis in the specified frame.

LIBRARY gaussplot

FORMAT ret = gpSetZAxisTitle(pgp, framenum, title);

INPUT pgp pointer to a plot control structure.

framenum scalar, frame number.

title string, title.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, the Z-axis is titled with the name of the variable that is associated with it. This command applies only to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; ret = gpSetZAxisTitle(&gp,framenum,"Z");

SOURCE gp.src

SEE ALSO gpSetZAxisTitleColor, gpSetZAxisTitleFont, gpSetZAxisTitleOffset

3-426 GAUSS C R Command Reference 3-427 ); for the list of colors; color textcolor gpSetZAxisTitleFont , gpSetZAxisTitleFont gpSetZAxisTitleColor 2.2.1 gpSetZAxisTitleOffset , . This command applies only to 3D framenum , pgp GAUSSplot gpSetZAxisTitleFont , – or – string, name of color. scalar, index of color in color list. scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R = gpSetZAxisTitleColor( framenum = 2; ret = gpSetZAxisTitleColor(&gp,framenum,"red"); Cartesian and 3D Contour plots. Sets the type and size of the font used for the Z-axis title in the specified frame. gp.src gpSetZAxisTitle textcolor ret By default, all axis titlesnames are are black. case See insensitive Section in pgp framenum Sets the color of the Z-axis title in the specified frame. gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE PURPOSE REMARKS SEE ALSO GAUSS gpSetZAxisTitleFont

LIBRARY gaussplot

FORMAT ret = gpSetZAxisTitleFont(pgp, framenum, fonttype, height, heightunit);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fonttype string, name of font. – or – scalar, index of font in font list. height scalar, font height. heightunit scalar, one of the following: 1 font height as a percentage of the height of the frame. 2 font height in points. 3 font height as a percentage of the length of the axis line

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, all Z-axis tick labels are written in a bold helvetica font (fonttype = “helvbold”). The default font height is equal to 3.6% of the axis length. The list of available fonts is as follows:

1 Courier 2 CourierBold 3 Helv 4 HelvBold 5 Times 6 TimesBold 7 TimesItalic 8 TimesItalicBold 9 Greek 10 Math 11 UserDef

Font names are case insensitive in GAUSSplot. This command applies only to 3D Cartesian and 3D Contour plots.

3-428 GAUSS C R Command Reference 3-429 ); set ff o , gpSetZAxisTitleOffset gpSetZAxisTitleOffset gpSetZAxisTitleOffset , framenum , pgp set of title from axis line as a percentage of the median ff gpSetZAxisTitleColor , set is set to 8. This command applies only to 3D Cartesian or ff axis length. pointer to a plot control structure. scalar, frame number. scalar, o scalar, return code, 0 if successful, otherwise an error code. set of the Z-axis title from the axis line in the specified frame. ff  R = gpSetZAxisTitleOffset( set ff framenum = 2; offset = 10; ret = gpSetZAxisTitleOffset(&gp,framenum,offset); framenum = 1; height = 4.5; heightunit = 1; ret = gpSetZAxisTitleFont(&gp,framenum,"timesitalicbold",height,heightunit); 3D Contour plots. Sets the o gaussplot ret pgp framenum o ret By default, the o gp.src gp.src gpSetZAxisTitle  C  INPUT FORMAT OUTPUT LIBRARY SOURCE SOURCE EXAMPLE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpShow3DOrientationAxis

SEE ALSO gpSetZAxisTitle, gpSetZAxisTitleColor, gpSetZAxisTitleFont

gpShow3DOrientationAxis

PURPOSE Activates or deactivates display of the 3D orientation axis in a frame.

LIBRARY gaussplot

FORMAT ret = gpShow3DOrientationAxis(pgp, framenum, show3dorientation);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. show3dorientation scalar, one of the following: 0 do not display the 3D orientation axis. 1 display the 3D orientation axis.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The 3D orientation axis is the small set of axes that appear in the upper-right hand corner of 3D Cartesian and 3D Contour plots by default to show you how your plot is oriented. This command applies only to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; noshow = 0; ret = gpShow3DOrientationAxis(&gp,framenum,noshow);

SOURCE gp.src

SEE ALSO gpShowXAxis, gpShowYAxis, gpShowZAxis

3-430 GAUSS C R Command Reference 3-431 gpShowBarLayer gpShowBarLayer ); activate , framenum . , 1 vector, frame number(s). × pgp deactivate the bar layer. activate the bar layer. activates or deactivates the bar layer in the specified frame. 0 1 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar or N scalar, one of the following:  R gpShowLineMapBarLayer = gpShowBarLayer( framenum = 1; activate = 1; ret = gpShowBarLayer(&gp,framenum,activate); gplinemap.src ret Layers are controlled on twofield levels: zones in in a the frame frame. anddefault in If in each a each of layer line the is map line activated orframe, in maps field then a or zone it frame, in is then the not itframe, frame. displayed is regardless in displayed If of any by a their of layer specific the is settings. line not maps activated or in field a zonesBy in default the the bar layergpShowBarLayer is activated in frames containing BarTo activate plots. or Calling deactivate the barcall layer for a subset of the line maps in a frame, pgp framenum activate This command applies ONLY to line plots. Activates or deactivates the bar layer in the specified frame(s). gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS GAUSS gpShowBoundaryLayer

SEE ALSO gpShowLineMapBarLayer, gpAddBarFrame, gpSetBarColor

gpShowBoundaryLayer

PURPOSE Activates or deactivates the boundary layer in the specified frame(s).

LIBRARY gaussplot

FORMAT ret = gpShowBoundaryLayer(pgp, framenum, activate);

INPUT pgp pointer to a plot control structure. framenum scalar or N×1 vector, frame number(s). activate scalar, one of the following: 0 deactivate the boundary layer. 1 activate the boundary layer.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The boundary layer is displayed as a line connecting all data points around the edge of the data zone. In other words, suppose that a field zone describes the set of points (X,Y), where X and Y are both 3×3 variables:

X[1,1] X[1,2] X[1,3] Y[1,1] Y[1,2] Y[1,3] X[2,1] X[2,2] X[2,3] Y[2,1] Y[2,2] Y[2,3] X[3,1] X[3,2] X[3,3] Y[3,1] Y[3,2] Y[3,3]

Then the boundary line for that field zone would be a line through the following points: (X[1,1],Y[1,1]), (X[1,2],Y[1,2]), (X[1,3],Y[1,3]), (X[2,3],Y[2,3]), (X[3,3],Y[3,3]), (X[3,2],Y[3,2]), (X[3,1],Y[3,1]), (X[2,1],Y[2,1]), and then back to (X[1,1], Y[1,1]).

For a field zone that describes a 3-D surface, this generally appears as a boundary line around the edge of that surface. By default, the boundary has a

3-432 GAUSS C R Command Reference 3-433 activates ); gpShowContourLayer activate 1% of the frame height. . , gpShowContourLayer gpShowBoundaryLayer gpSetBoundaryColor framenum , . , pgp 4% of the frame height to distinguish it from mesh lines (if .  R = gpShowContourLayer( framenum = 1; activate = 0; ret = gpShowBoundaryLayer(&gp,framenum,activate); ret Activates or deactivates the contour layer in the specified frame(s). gaussplot gpfieldzone.src gpShowFieldZoneBoundaryLayer line thickness of 0 present), which have a default line thickness of 0 Layers are controlled on twofield levels: zones in in a the frame frame. anddefault in If in each a each of layer line the is map line activated orframe, in maps field then a or zone it frame, in is then the not itframe, frame. displayed is regardless in displayed If of any by a their of layer specific the is settings. line not maps activated or in field a zonesThe in boundary the layer is activated in2D frames and containing 3D 2D Contour and plots 3Dor by Cartesian deactivates default. the and Calling boundary layer indeactivate the the boundary specified layer frame. for To activate agpShowFieldZoneBoundaryLayer or subset of the field zones in a frame, call This command applies ONLY to 2Dplots. and 3D Cartesian and 2D and 3D Contour  C  FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpShowDrawing

INPUT pgp pointer to a plot control structure. framenum scalar or N×1 vector, frame number(s). activate scalar, one of the following: 0 deactivate the contour layer. 1 activate the contour layer.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings.

The contour layer is activated in frames containing 2D and 3D Contour plots by default. When the contour layer is activated in a frame, the default is for contour flooding to be displayed in each of the field zones in the frame. Calling gpShowContourLayer activates or deactivates the contour layer in the specified frame. To activate or deactivate the contour layer for a subset of the field zones in a frame or to use contour lines, call gpShowFieldZoneContourLayer.

This command applies ONLY to 2D and 3D Cartesian and 2D and 3D Contour plots.

EXAMPLE framenum = 1; activate = 1; ret = gpShowContourLayer(&gp,framenum,activate);

SOURCE gpfieldzone.src

SEE ALSO gpShowFieldZoneContourLayer, gpAdd2DContourFrame, gpAdd3DContourFrame, gpSetContourVariable

3-434 GAUSS C R Command Reference 3-435 gpShowDrawing gpShowErrorBarLayer gpShowErrorBarLayer ); draw , do not show drawing; show graphcompleted. only when all drawing is do not show frame drawing, butdrawing show for each that frame frame after is the completed. show all drawing. pgp is set to 1, and thus the graph is shown only when all drawing 1 2 3 pointer to a plot control structure. scalar, one of the following: draw  R draw = 2; gpShowDrawing(&gp,draw); Activates or deactivates the error bar layer in the specified frame(s). gp.src gpFramePause By default, has been completed. pgp draw Specifies whether or not drawing is shown. gaussplot gpShowDrawing(  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE PURPOSE REMARKS SEE ALSO GAUSS gpShowFieldZoneBoundaryLayer

LIBRARY gaussplot

FORMAT ret = gpShowErrorBarLayer(pgp, framenum, activate);

INPUT pgp pointer to a plot control structure. framenum scalar or N×1 vector, frame number(s). activate scalar, one of the following: 0 deactivate the error bar layer. 1 activate the error bar layer.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings.

The error bar layer is never activated by default. Calling gpShowErrorBarLayer activates or deactivates the error bar layer in the specified frame. To activate or deactivate the error bar layer for a subset of the line maps in a frame, call gpShowLineMapErrorBarLayer.

If the error bar layer is activated in a frame, then the second variable in the data file is used to control the magnitudes of the error bars by default. Call gpSetErrorBarVariable to use a different variable.

This command applies ONLY to line plots.

EXAMPLE framenum = 1; activate = 1; ret = gpShowErrorBarLayer(&gp,framenum,activate);

SOURCE gplinemap.src

SEE ALSO gpShowLineMapErrorBarLayer, gpSetErrorBarColor

3-436 GAUSS C R Command Reference is , 3-437 activate fieldzonenum , is set. If will be set activate framenum . , fieldzonenum activates the boundary layer in the pgp activate gpShowFieldZoneBoundaryLayer gpShowFieldZoneBoundaryLayer for more information). The plot control structure and then activates or deactivates the boundary 1 vector, field zone number(s). 1 vector of ones and zeros: × × 1.3.1 deactivate the boundary layer. activate the boundary layer. framenum scalar or N scalar or N 0 1 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. gpShowFieldZoneBoundaryLayer );  1 vector, then each of the field zones in R × = gpShowFieldZoneBoundaryLayer( fieldzonenum activate ret Layers are controlled on twofield levels: zones in in a the frame frame. anddefault in If in each a each of layer line the is map line activated orframe, in maps then field a or it zone frame, is in then not the it displayedregardless frame. is in of displayed If any their by a of specific layer the settings. is linein The not maps frames boundary activated or containing in layer field 2D a is zones and activated in 3D by the Cartesian default frame, plots and 2DCalling and 3D Contour plots. an N pgp framenum frame indicated by layer in the specified field zones depending on how The number of field zonesthe in data a file frame (see is Section determined by the number of zones in Activates or deactivates the boundary layer in the specified field zone(s). gaussplot ret activate according to the corresponding element of  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS GAUSS gpShowFieldZoneBoundaryLayer

contains information for only those field zones for which you have specified options; thus there may be fewer field zones in the plot control structure than in the frame. If you call gpShowFieldZoneBoundaryLayer for a subset of the field zones in the frame with an activate argument set to a scalar one (or a vector of zeros and ones), then it will assume that you want the boundary layer to be deactivated for all of the unspecified field zones in the frame. Therefore, it will deactivate the boundary layer for all of the field zones that are contained in the plot control structure but not specified in the call to gpShowFieldZoneBoundaryLayer.

If you call gpShowFieldZoneBoundaryLayer for a subset of the field zones in the frame with an activate argument set to a scalar zero, then it will assume that you want the boundary layer to be activated for all of the other field zones in the frame. In this case, it will not set any options for the unspecified field zones because, by default, when a layer is activated in a frame, it is activated for each line map or field zone in that frame.

Because it is possible that not all of the field zones that will appear in the frame are contained in the plot control structure, the safest way to use this command is to specify for each field zone in the frame whether the boundary layer should be activated or deactivated.

To activate or deactivate the boundary layer in the frame alone, call gpShowBoundaryLayer.

This command applies ONLY to 2D and 3D Cartesian and 2D and 3D Contour plots.

EXAMPLE framenum = 1; fieldzonenum = { 1,2,3,4,5 }; activate = { 1,0,0,1,1 }; ret = gpShowFieldZoneBoundaryLayer(&gp,framenum,fieldzonenum,activate);

This example deactivates the boundary layer for the second and third field zones in the frame, and activates it for the first, fourth and fifth field zones.

SOURCE gpfieldzone.src

3-438 GAUSS C R Command Reference , 3-439 fieldzonenum , gpSetBoundaryThickness , framenum , pgp gpShowFieldZoneContourLayer gpShowFieldZoneContourLayer 1 vector, field zone number(s). 1 vector of ones and zeros: 1 vector of ones and zeros: × × × gpSetBoundaryColor , ); activate contour lines. deactivate contour flooding. activate contour flooding. deactivate contour lines. 1 pointer to a plot control structure. scalar, frame number. scalar or N scalar or N 0 1 scalar or N 0 scalar, return code, 0 if successful, otherwise an error code. showlines ,  R = gpShowFieldZoneContourLayer( pgp framenum fieldzonenum showflood showlines ret Layers are controlled on twofield levels: zones in in a the frame frame. anddefault in If in each a each of layer line the is map line activated orframe, in maps field then a or zone it frame, in is then the not itframe, frame. displayed is regardless in displayed If of any by a their of layer specific the is settings.default line not in maps The activated frames or in contour containing field a layer 2D zones isis and in activated activated 3D by the in Contour a plots. frame, When theof the default the contour is field layer for zones contour in flooding the to frame. be displayed in each gpShowBoundaryLayer Activates or deactivates contour lines and flooding in the specified field zone(s). gaussplot ret showflood  C  INPUT FORMAT OUTPUT LIBRARY PURPOSE REMARKS SEE ALSO GAUSS gpShowFieldZoneContourLayer

Calling gpShowFieldZoneContourLayer activates the contour layer in the frame indicated by framenum and then activates or deactivates contour flooding and contour lines in the specified field zones depending on how showflood and showlines are set. If either showflood or showlines is an N×1 vector, then each of the field zones in fieldzonenum will be set according to the corresponding element of that vector.

The number of field zones in a frame is determined by the number of zones in the data file (see Section 1.3.1 for more information). The plot control structure contains information for only those field zones for which you have specified options; thus there may be fewer field zones in the plot control structure than in the frame. If you call gpShowFieldZoneContourLayer for a subset of the field zones in the frame with either showflood or showlines set to a scalar one (or a vector of zeros and ones), then it will assume that you want the contour layer to be deactivated for all of the unspecified field zones in the frame. Therefore, it will deactivate the contour layer for all of the field zones that are contained in the plot control structure but not specified in the call to gpShowFieldZoneContourLayer.

If you call gpShowFieldZoneContourLayer for a subset of the field zones in the frame with showflood or showlines set to a scalar zero, then it will assume that you want the contour layer to be activated for all of the other field zones in the frame. In this case, it will not set any options for the unspecified field zones because, by default, when the contour layer is activated in a frame, then the contour layer is activated for each line map or field zone in that frame. In this case, contour flooding will be displayed in all of the unspecified frames because that is the default.

Because it is possible that not all of the field zones that will appear in the frame are contained in the plot control structure, the safest way to use this command is to specify for each field zone in the frame whether contour flooding and/or contour lines should be activated or deactivated.

To activate or deactivate the contour layer in the frame alone, call gpShowContourLayer.

This command applies ONLY to 2D and 3D Cartesian and 2D and 3D Contour plots.

3-440 GAUSS C R Command Reference 3-441 , fieldzonenum , , showflooding,showlines); framenum , gpShowFieldZoneMeshLayer pgp gpShowFieldZoneMeshLayer gpSetContourVariable 1 vector, field zone number(s). 1 vector of ones and zeros: , × × gpSetContourFloodGroup , deactivate the mesh layer. activate the mesh layer. pointer to a plot control structure. scalar, frame number. scalar or N scalar or N 0 1 scalar, return code, 0 if successful, otherwise an error code. );  R = gpShowFieldZoneMeshLayer( framenum = 1; fieldzonenum = {showflooding 1,2,3,4,5 = }; {showlines 1,0,0,1,1 = }; {ret 0,1,0,1,0 = }; gpShowFieldZoneContourLayer(&gp,framenum,fieldzonenum, ret pgp framenum fieldzonenum activate ret gpSetContourLineGroup Activates or deactivates the mesh layer in the specified field zone(s). gaussplot activate This example activates contour flooding forin the the first, frame fourth and and activates fifth contour field lines zones for the second andgpcontourplot.src fourth field zones. gpShowContourLayer  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpShowFieldZoneMeshLayer

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings. The mesh layer is activated by default in frames containing 2D and 3D Cartesian plots.

Calling gpShowFieldZoneMeshLayer activates the mesh layer in the frame indicated by framenum and then activates or deactivates the mesh layer in the specified field zones depending on how activate is set. If activate is an N×1 vector, then each of the field zones in fieldzonenum will be set according to the corresponding element of activate.

The number of field zones in a frame is determined by the number of zones in the data file (see Section 1.3.1 for more information). The plot control structure contains information for only those field zones for which you have specified options; thus there may be fewer field zones in the plot control structure than in the frame. If you call gpShowFieldZoneMeshLayer for a subset of the field zones in the frame with an activate argument set to a scalar one (or a vector of zeros and ones), then it will assume that you want the mesh layer to be deactivated for all of the unspecified field zones in the frame. Therefore, it will deactivate the mesh layer for all of the field zones that are contained in the plot control structure but not specified in the call to gpShowFieldZoneMeshLayer.

If you call gpShowFieldZoneMeshLayer for a subset of the field zones in the frame with an activate argument set to a scalar zero, then it will assume that you want the mesh layer to be activated for all of the other field zones in the frame. In this case, it will not set any options for the unspecified field zones because, by default, when a layer is activated in a frame, it is activated for each line map or field zone in that frame.

Because it is possible that not all of the field zones that will appear in the frame are contained in the plot control structure, the safest way to use this command is to specify for each field zone in the frame whether the mesh layer should be activated or deactivated.

To activate or deactivate the mesh layer in the frame alone, call gpShowMeshLayer.

3-442 GAUSS C R Command Reference , 3-443 fieldzonenum , framenum , pgp gpSetMeshLineThickness , gpShowFieldZoneScatterLayer gpShowFieldZoneScatterLayer 1 vector, field zone number(s). 1 vector of ones and zeros: × × gpSetMeshColor deactivate the scatter layer. activate the scatter layer. , pointer to a plot control structure. scalar, frame number. scalar or N scalar or N 0 1 scalar, return code, 0 if successful, otherwise an error code. );  R = gpShowFieldZoneScatterLayer( framenum = 1; fieldzonenum = 2; activate = 0; ret = gpShowFieldZoneMeshLayer(&gp,framenum,fieldzonenum,activate); ret pgp framenum fieldzonenum activate ret gpShowMeshLayer Activates or deactivates the scatter layer in the specified field zone(s). gaussplot activate This example deactivates the mesh layerlayer in will the still second be field displayed zone. in all The other mesh field zones ingpfieldzone.src the frame. This command applies ONLY to 2Dplots. and 3D Cartesian and 2D and 3D Contour  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpShowFieldZoneScatterLayer

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings. The scatter layer is never activated by default.

Calling gpShowFieldZoneScatterLayer activates the scatter layer in the frame indicated by framenum and then activates or deactivates the scatter layer in the specified field zones depending on how activate is set. If activate is an N×1 vector, then each of the field zones in fieldzonenum will be set according to the corresponding element of activate.

The number of field zones in a frame is determined by the number of zones in the data file (see Section 1.3.1 for more information). The plot control structure contains information for only those field zones for which you have specified options; thus there may be fewer field zones in the plot control structure than in the frame. If you call gpShowFieldZoneScatterLayer for a subset of the field zones in the frame with an activate argument set to a scalar one (or a vector of zeros and ones), then it will assume that you want the scatter layer to be deactivated for all of the unspecified field zones in the frame. Therefore, it will deactivate the scatter layer for all of the field zones that are contained in the plot control structure but not specified in the call to gpShowFieldZoneScatterLayer.

If you call gpShowFieldZoneScatterLayer for a subset of the field zones in the frame with an activate argument set to a scalar zero, then it will assume that you want the scatter layer to be activated for all of the other field zones in the frame. In this case, it will not set any options for the unspecified field zones because, by default, when a layer is activated in a frame, it is activated for each line map or field zone in that frame.

Because it is possible that not all of the field zones that will appear in the frame are contained in the plot control structure, the safest way to use this command is to specify for each field zone in the frame whether the scatter layer should be activated or deactivated.

To activate or deactivate the scatter layer in the frame alone, call

3-444 GAUSS C R Command Reference 3-445 , fieldzonenum , gpSetScatterShape , framenum , pgp gpShowFieldZoneShadeLayer gpShowFieldZoneShadeLayer 1 vector, field zone number(s). 1 vector of ones and zeros: × × gpSetScatterColor , . deactivate the shade layer. activate the shade layer. pointer to a plot control structure. scalar, frame number. scalar or N scalar or N 0 1 scalar, return code, 0 if successful, otherwise an error code. );  R = gpShowFieldZoneShadeLayer( framenum = 1; fieldzonenum = {activate 1,2,4 = }; 1; ret = gpShowFieldZoneScatterLayer(&gp,framenum,fieldzonenum,activate); Activates or deactivates the shade layer in the specified field zone(s). gaussplot ret activate pgp framenum fieldzonenum activate ret gpfieldzone.src gpShowScatterLayer gpShowScatterLayer This command applies ONLY to 2Dplots. and 3D Cartesian and 2D and 3D Contour  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpShowFieldZoneShadeLayer

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings. The shade layer is never activated by default.

Calling gpShowFieldZoneShadeLayer activates the shade layer in the frame indicated by framenum and then activates or deactivates the shade layer in the specified field zones depending on how activate is set. If activate is an N×1 vector, then each of the field zones in fieldzonenum will be set according to the corresponding element of activate.

The number of field zones in a frame is determined by the number of zones in the data file (see Section 1.3.1 for more information). The plot control structure contains information for only those field zones for which you have specified options; thus there may be fewer field zones in the plot control structure than in the frame. If you call gpShowFieldZoneShadeLayer for a subset of the field zones in the frame with an activate argument set to a scalar one (or a vector of zeros and ones), then it will assume that you want the shade layer to be deactivated for all of the unspecified field zones in the frame. Therefore, it will deactivate the shade layer for all of the field zones that are contained in the plot control structure but not specified in the call to gpShowFieldZoneShadeLayer.

If you call gpShowFieldZoneShadeLayer for a subset of the field zones in the frame with an activate argument set to a scalar zero, then it will assume that you want the shade layer to be activated for all of the other field zones in the frame. In this case, it will not set any options for the unspecified field zones because, by default, when a layer is activated in a frame, it is activated for each line map or field zone in that frame.

Because it is possible that not all of the field zones that will appear in the frame are contained in the plot control structure, the safest way to use this command is to specify for each field zone in the frame whether the shade layer should be activated or deactivated.

To activate or deactivate the shade layer in the frame alone, call

3-446 GAUSS C R Command Reference , 3-447 fieldzonenum , framenum , gpUseFieldZoneShadeLighting pgp , gpShowFieldZoneVectorLayer gpShowFieldZoneVectorLayer , 1 vector, field zone number(s). 1 vector of ones and zeros: × × gpSetShadeColor , . deactivate the vector layer. activate the vector layer. pointer to a plot control structure. scalar, frame number. scalar or N scalar or N 0 1 scalar, return code, 0 if successful, otherwise an error code. );  R = gpShowFieldZoneVectorLayer( framenum = 1; fieldzonenum = {activate 3,5 = }; 1; ret = gpShowFieldZoneShadeLayer(&gp,framenum,fieldzonenum,activate); ret pgp framenum fieldzonenum activate ret Activates or deactivates the vector layer in the specified field zone(s). gaussplot activate gpfieldzone.src gpShowShadeLayer gpUseTranslucencyEffect gpShowShadeLayer This command applies ONLY to 2Dplots. and 3D Cartesian and 2D and 3D Contour  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpShowFieldZoneVectorLayer

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings. The vector layer is never activated by default.

Calling gpShowFieldZoneVectorLayer activates the vector layer in the frame indicated by framenum and then activates or deactivates the vector layer in the specified field zones depending on how activate is set. If activate is an N×1 vector, then each of the field zones in fieldzonenum will be set according to the corresponding element of activate.

The number of field zones in a frame is determined by the number of zones in the data file (see Section 1.3.1 for more information). The plot control structure contains information for only those field zones for which you have specified options; thus there may be fewer field zones in the plot control structure than in the frame. If you call gpShowFieldZoneVectorLayer for a subset of the field zones in the frame with an activate argument set to a scalar one (or a vector of zeros and ones), then it will assume that you want the vector layer to be deactivated for all of the unspecified field zones in the frame. Therefore, it will deactivate the vector layer for all of the field zones that are contained in the plot control structure but not specified in the call to gpShowFieldZoneVectorLayer.

If you call gpShowFieldZoneVectorLayer for a subset of the field zones in the frame with an activate argument set to a scalar zero, then it will assume that you want the vector layer to be activated for all of the other field zones in the frame. In this case, it will not set any options for the unspecified field zones because, by default, when a layer is activated in a frame, it is activated for each line map or field zone in that frame.

Because it is possible that not all of the field zones that will appear in the frame are contained in the plot control structure, the safest way to use this command is to specify for each field zone in the frame whether the vector layer should be activated or deactivated.

To activate or deactivate the vector layer in the frame alone, call

3-448 GAUSS C R Command Reference 3-449 gpShowLineLayer ); gpShowLineLayer activate gpSetVectorType , , framenum , 1 vector, frame number(s). pgp × gpSetVectorColor , . deactivate the line layer. activate the line layer. pointer to a plot control structure. scalar or N scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code.  R = gpShowLineLayer( framenum = 1; fieldzonenum = {activate 1,2,3,4,5 = }; {ret 0,0,1,0,1 = }; gpShowFieldZoneVectorLayer(&gp,framenum,fieldzonenum,activate); gaussplot ret pgp framenum activate ret gpfieldzone.src gpShowVectorLayer Activates or deactivates the line layer in the specified frame(s). This example activates the vector layerthe for frame. only the third and fifth field zones in gpShowVectorLayer This command applies ONLY to 2Dplots. and 3D Cartesian and 2D and 3D Contour  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpShowLineMapBarLayer

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings.

By default the line layer is activated in frames containing XY Line and Polar Line plots. Calling gpShowLineLayer activates or deactivates the line layer in the specified frame. To activate or deactivate the line layer for a subset of the line maps in a frame, call gpShowLineMapLineLayer.

This command applies ONLY to Bar, XY Line, and Polar Line plots.

EXAMPLE framenum = 1; activate = 1; ret = gpShowSymbolLayer(&gp,framenum,activate); activate = 0; ret = gpShowLineLayer(&gp,framenum,activate);

SOURCE gplinemap.src

SEE ALSO gpShowLineMapLineLayer, gpAddXYLineFrame, gpSetLineColor

gpShowLineMapBarLayer

PURPOSE Activates or deactivates the bar layer in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpShowLineMapBarLayer(pgp, framenum, linemapnum, activate);

INPUT pgp pointer to a plot control structure.

3-450 GAUSS C R Command Reference . 3-451 1 × is an N gpShowBarLayer activate will be set according to the is set. If gpShowLineMapBarLayer for a subset of the line maps in the frame for a subset of the line maps in the frame activate linemapnum activates the bar layer in the frame . 1 vector, line map number(s). 1 vector of ones and zeros: . × × activate and then activates or deactivates the bar layer in the deactivate the bar layer. activate the bar layer. argument set to a scalar zero, then it will assume that you want argument set to a scalar one (or a vector of zeros and ones), scalar or N 0 1 scalar, return code, 0 if successful, otherwise an error code. scalar, frame number. scalar or N framenum gpShowLineMapBarLayer gpShowLineMapBarLayer activate activate gpShowLineMapBarLayer  R the bar layer to becase, activated for it all will of not the set otherdefault, any line when options maps a for in layer the the is unspecified frame.field activated line in zone maps In a in because, this frame, that by it frame. is activated for each lineTo map activate or or deactivate the bar layer in the frame alone, call activate ret Layers are controlled on twofield levels: zones in in a the frame frame. anddefault in If in each a each of layer line the is map line activated orframe, in maps field then a or zone it frame, in is then the not itframe, frame. displayed is regardless in displayed If of any by a their of layer specific the is settings.in line not frames maps The activated containing or in bar Bar field a layer plots. zones is in activated by the default Calling with an framenum linemapnum indicated by specified line maps depending onvector, how then each of the line maps in then it will assume thatunspecified you line want maps the in bar the layerall frame. to of be Therefore, the deactivated it for line will all maps deactivate ofgpShowLineMapBarLayer that the the are bar not layer specified for in the call to If you call corresponding element of If you call with an  C  OUTPUT REMARKS GAUSS gpShowLineMapErrorBarLayer

This command applies ONLY to line plots.

EXAMPLE framenum = 1; linemapnum = { 1,4,5 }; activate = 0; ret = gpShowLineMapBarLayer(&gp,framenum,linemapnum,activate);

SOURCE gplinemap.src

SEE ALSO gpAddBarFrame, gpShowBarLayer, gpSetBarColor

gpShowLineMapErrorBarLayer

PURPOSE Activates or deactivates the error bar layer in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpShowLineMapErrorBarLayer(pgp, framenum, linemapnum, activate);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). activate scalar or N×1 vector of ones and zeros: 0 deactivate the error bar layer. 1 activate the error bar layer.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a

3-452 GAUSS C R Command Reference is 3-453 activate is set. If will be set according gpSetErrorBarSize activate , for a subset of the line maps in the for a subset of the line maps in the linemapnum gpShowLineMapLineLayer activates the error bar layer in the . . activate and then activates or deactivates the error bar gpSetErrorBarColor , . argument set to a scalar one (or a vector of zeros and argument set to a scalar zero, then it will assume that you framenum activate activate gpShowLineMapErrorBarLayer gpShowLineMapErrorBarLayer gpShowLineMapErrorBarLayer  1 vector, then each of the line maps in R × framenum = 1; linemapnum = {activate 2,5 = }; 1; ret = gpShowLineMapErrorBarLayer(&gp,framenum,linemapnum,activate); gplinemap.src gpShowErrorBarLayer If you call want the error bar layerframe. to be In activated this for case, all it ofbecause, will the by not other default, set line when any maps a options inline layer for the map is the or activated unspecified in field line a zone maps frame, in it that is frame. activated forTo each activate or deactivate the errorgpShowErrorBarLayer bar layer in the frame alone, call This command applies ONLY to line plots. an N If you call frame with an ones), then it will assumeall that of you the want unspecified the line errorerror maps bar bar in layer layer the to for frame. be all deactivated Therefore, for gpShowLineMapErrorBarLayer of it the will line deactivate maps the that are not specified in the call to frame with an frame indicated by layer in the specified line maps depending on how to the corresponding element of frame, then it is notframe, displayed regardless in of any their of specific the settings.by line default. maps The or error field bar zones layer in is the never activated Calling  C  SOURCE EXAMPLE SEE ALSO GAUSS gpShowLineMapLineLayer

gpShowLineMapLineLayer

PURPOSE Activates or deactivates the line layer in the specified line map(s).

LIBRARY gaussplot

FORMAT ret = gpShowLineMapLineLayer(pgp, framenum, linemapnum, activate);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). activate scalar or N×1 vector of ones and zeros: 0 deactivate the line layer. 1 activate the line layer.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings. The line layer is activated in frames containing XY Line and Polar Line plots by default.

Calling gpShowLineMapLineLayer activates the line layer in the frame indicated by framenum and then activates or deactivates the line layer in the specified line maps depending on how activate is set. If activate is an N×1 vector, then each of the line maps in linemapnum will be set according to the corresponding element of activate.

If you call gpShowLineMapLineLayer for a subset of the line maps in the frame with an activate argument set to a scalar one (or a vector of zeros and

3-454 GAUSS C R Command Reference 3-455 , linemapnum , framenum , gpSetLineColor , for a subset of the line maps in the gpShowLineMapSymbolLayer pgp gpShowLineMapSymbolLayer . argument set to a scalar zero, then it will assume that you gpShowLineLayer , . activate gpShowLineMapLineLayer );  R = gpShowLineMapSymbolLayer( framenum = 1; linemapnum = {activate 1,4,5 = }; 0; ret = gpShowLineMapLineLayer(&gp,framenum,linemapnum,activate); Activates or deactivates the symbol layer in the specified line map(s). gaussplot ret gplinemap.src gpAddXYLineFrame ones), then it will assumethe that unspecified you line want the maps line inlayer layer the for to frame. all be Therefore, of deactivated it for the will allgpShowLineMapLineLayer line deactivate of maps the that line are not specified in the call to If you call activate frame with an want the line layer tothis be case, activated for it all will of not thedefault, set other when any line a options maps layer for in is the thefield activated unspecified in frame. zone line a in maps In frame, that because, it frame. by is activated for each lineTo map activate or or deactivate the linegpShowLineLayer layer in the frame alone, call This command applies ONLY to Bar, XY Line, and Polar Line plots.  C  FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpShowLineMapSymbolLayer

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. linemapnum scalar or N×1 vector, line map number(s). activate scalar or N×1 vector of ones and zeros: 0 deactivate the symbol layer. 1 activate the symbol layer.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings. The symbol layer is never activated by default.

Calling gpShowLineMapSymbolLayer activates the symbol layer in the frame indicated by framenum and then activates or deactivates the symbol layer in the specified line maps depending on how activate is set. If activate is an N×1 vector, then each of the line maps in linemapnum will be set according to the corresponding element of activate.

If you call gpShowLineMapSymbolLayer for a subset of the line maps in the frame with an activate argument set to a scalar one (or a vector of zeros and ones), then it will assume that you want the symbol layer to be deactivated for all of the unspecified line maps in the frame. Therefore, it will deactivate the symbol layer for all of the line maps that are not specified in the call to gpShowLineMapSymbolLayer.

If you call gpShowLineMapSymbolLayer for a subset of the line maps in the frame with an activate argument set to a scalar zero, then it will assume that you want the symbol layer to be activated for all of the other line maps in the frame. In this case, it will not set any options for the unspecified line maps because, by default, when a layer is activated in a frame, it is activated for each line map or field zone in that frame.

3-456 GAUSS C R Command Reference 3-457 ); gpShowMeshLayer gpShowMeshLayer activate gpSetSymbolShape , , framenum , 1 vector, frame number(s). pgp × gpSetSymbolColor , . deactivate the mesh layer. activate the mesh layer. pointer to a plot control structure. scalar or N scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code.  R = gpShowMeshLayer( framenum = 1; linemapnum = {activate 1,4,5 = }; 1; ret = gpShowLineMapSymbolLayer(&gp,framenum,linemapnum,activate); Activates or deactivates the mesh layer in the specified frame(s). gaussplot ret pgp framenum activate ret Layers are controlled on twofield levels: zones in in a the frame frame. and in If each a of layer the is line activated in maps a or frame, then it is displayed by gplinemap.src gpShowSymbolLayer To activate or deactivate the symbolgpShowSymbolLayer layer in the frame alone, call This command applies ONLY to Bar, XY Line, and Polar Line plots.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpShowPolarAxes

default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings.

By default the mesh layer is activated in frames containing 2D and 3D Cartesian plots. Calling gpShowMeshLayer activates or deactivates the mesh layer in the specified frame. To activate or deactivate the mesh layer for a subset of the field zones in a frame, call gpShowFieldZoneMeshLayer.

This command applies ONLY to 2D and 3D Cartesian and 2D and 3D Contour plots.

EXAMPLE framenum = 1; activate = 0; ret = gpShowMeshLayer(&gp,framenum,activate);

SOURCE gpfieldzone.src

SEE ALSO gpShowFieldZoneMeshLayer, gpSetMeshColor, gpSetMeshLineThickness

gpShowPolarAxes

PURPOSE Specifies which of the polar axes are to be displayed in a frame.

LIBRARY gaussplot

FORMAT ret = gpShowPolarAxes(pgp, framenum, showtheta, showr);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. showtheta scalar, one of the following: 0 do not display the Theta-axis.

3-458 GAUSS C R Command Reference 3-459 ); gpShowScatterLayer activate gpShowScatterLayer , framenum , pgp 1 vector, frame number(s). × deactivate the scatter layer. do not display the R-axis. display the R-axis. display the Theta-axis. 0 pointer to a plot control structure. scalar or N scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code. 1 scalar, one of the following:  R = gpShowScatterLayer( framenum = 1; showtheta = 1; showr = 0; ret = gpShowPolarAxes(&gp,framenum,showtheta,showr); Activates or deactivates the scatter layer in the specified frame(s). gaussplot ret pgp framenum activate gppolarlineplot.src gpSetPolarAxesTitles ret By default, both the ThetaONLY and to R frames axes that are contain displayed. Polar This Line command plots. applies showr  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpShowShadeLayer

1 activate the scatter layer.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings.

The scatter layer is never activated by default. Calling gpShowScatterLayer activates or deactivates the scatter layer in the specified frame. To activate or deactivate the scatter layer for a subset of the field zones in a frame, call gpShowFieldZoneScatterLayer.

This command applies ONLY to 2D and 3D Cartesian and 2D and 3D Contour plots.

EXAMPLE framenum = 1; activate = 1; ret = gpShowScatterLayer(&gp,framenum,activate);

SOURCE gpfieldzone.src

SEE ALSO gpShowFieldZoneScatterLayer, gpSetScatterColor, gpSetScatterShape

gpShowShadeLayer

PURPOSE Activates or deactivates the shade layer in the specified frame(s).

LIBRARY gaussplot

FORMAT ret = gpShowShadeLayer(pgp, framenum, activate);

3-460 GAUSS C R Command Reference 3-461 gpShowShadeLayer , gpShowSymbolLayer gpUseTranslucencyEffect , gpSetShadeColor , . 1 vector, frame number(s). × deactivate the shade layer. activate the shade layer. scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar or N  R framenum = 1; activate = 1; ret = gpShowShadeLayer(&gp,framenum,activate); gpfieldzone.src gpShowFieldZoneShadeLayer gpUseFieldZoneShadeLighting activate ret Layers are controlled on twofield levels: zones in in a the frame frame. anddefault in If in each a each of layer line the is map line activated orframe, in maps field then a or zone it frame, in is then the not itframe, frame. displayed is regardless in displayed If of any by a their of layer specific the is settings. line not maps activated or in field a zones inThe the shade layer is never activated by default. Calling This command applies ONLY to 2Dplots. and 3D Cartesian and 2D and 3D Contour pgp framenum activates or deactivates the shade layerdeactivate in the the shade specified layer frame. for a TogpShowFieldZoneShadeLayer activate subset or of the field zones in a frame, call  C  INPUT OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpShowSymbolLayer

gpShowSymbolLayer

PURPOSE Activates or deactivates the symbol layer in the specified frame(s).

LIBRARY gaussplot

FORMAT ret = gpShowSymbolLayer(pgp, framenum, activate);

INPUT pgp pointer to a plot control structure. framenum scalar or N×1 vector, frame number(s). activate scalar, one of the following: 0 deactivate the symbol layer. 1 activate the symbol layer.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Layers are controlled on two levels: in a frame and in each of the line maps or field zones in the frame. If a layer is activated in a frame, then it is displayed by default in each line map or field zone in the frame. If a layer is not activated in a frame, then it is not displayed in any of the line maps or field zones in the frame, regardless of their specific settings.

The symbol layer is never activated by default. Calling gpShowSymbolLayer activates or deactivates the symbol layer in the specified frame. To activate or deactivate the symbol layer for a subset of the line maps in a frame, call gpShowLineMapSymbolLayer.

This command applies ONLY to Bar, XY Line and Polar Line plots.

EXAMPLE framenum = 1; activate = 1; ret = gpShowSymbolLayer(&gp,framenum,activate);

SOURCE gplinemap.src

3-462 GAUSS C R Command Reference 3-463 ); gpSetSymbolShape gpShowVectorLayer , gpShowVectorLayer gpShowVectorLayer activate , framenum . , gpSetSymbolColor , pgp 1 vector, frame number(s). × deactivate the vector layer. activate the vector layer. pointer to a plot control structure. scalar or N scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code.  R = gpShowVectorLayer( framenum = 1; pgp framenum activate ret Layers are controlled on twofield levels: zones in in a the frame frame. anddefault in If in each a each of layer line the is map line activated orframe, in maps field then a or zone it frame, in is then the not itframe, frame. displayed is regardless in displayed If of any by a their of layer specific the is settings. line not maps activated or in field a zonesThe in vector the layer is never activated by default. Calling gpShowLineMapSymbolLayer Activates or deactivates the vector layer in the specified frame(s). gaussplot ret activates or deactivates the vector layerdeactivate in the the vector specified layer frame. for a TogpShowFieldZoneVectorLayer activate subset or of the field zones in a frame, call This command applies ONLY to 2Dplots. and 3D Cartesian and 2D and 3D Contour  C  INPUT FORMAT OUTPUT LIBRARY EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpShowXAxis

activate = 1; ret = gpShowVectorLayer(&gp,framenum,activate);

SOURCE gpfieldzone.src

SEE ALSO gpShowFieldZoneVectorLayer, gpSetVectorVariables, gpSetVectorColor

gpShowXAxis

PURPOSE Activates or deactivates display of an X-axis in a frame.

LIBRARY gaussplot

FORMAT ret = gpShowXAxis(pgp, framenum, axisnum, showx);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number. showx scalar, one of the following: 0 do not display X-axis. 1 display X-axis.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional X axes, call gpSetLineMapAxes to link one or more line maps to an X-axis numbered greater than one. X axes that are added in this way are displayed by default.

3-464 GAUSS C R Command Reference 3-465 ); argument showgl , , axisnum axisnum , gpShowXAxisGridLines gpShowXAxisGridLines to link one or more line maps to an gpSetXAxisColor , framenum 5, X-axis number. , ≤ pgp axisnum ≤ gpSetLineMapAxes gpPositionXAxis , do not display X-axis major gridlines. display X-axis major gridlines. scalar, 1 scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number.  R = gpShowXAxisGridLines( framenum = 1; axisnum = 1; noshow = 0; ret = gpShowXAxis(&gp,framenum,axisnum,noshow); axisnum showgl ret Line plots allow up to five X and Y axes in a frame. The gpSetXAxisTitle Activates or deactivates display of X-axis major gridlines in a frame. gaussplot ret pgp framenum specifies which X-axis the optioncontain is line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis are that used. To display gp.src gpSetLineMapAxes  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpShowXAxisLabels

X-axis numbered greater than one. X axes that are added in this way are displayed by default.

By default, major gridlines are displayed only in 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; axisnum = 1; show = 1; ret = gpShowXAxisGridLines(&gp,framenum,axisnum,show);

SOURCE gp.src

SEE ALSO gpShowXAxis, gpShowXAxisMinorGridLines, gpSetXAxisGridLineColor

gpShowXAxisLabels

PURPOSE Activates or deactivates display of X-axis tick labels in a frame.

LIBRARY gaussplot

FORMAT ret = gpShowXAxisLabels(pgp, framenum, axisnum, showtl);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number. showtl scalar, one of the following: 0 do not display X-axis tick labels. 1 display X-axis tick labels.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

3-466 GAUSS C R Command Reference 3-467 , argument axisnum , axisnum framenum to link one or more line maps to an , pgp gpShowXAxisMinorGridLines 5, X-axis number. gpShowXAxisMinorGridLines ≤ axisnum ≤ gpSetLineMapAxes do not display X-axis minor gridlines. 0 pointer to a plot control structure. scalar, frame number. scalar, 1 scalar, one of the following: gpShowXAxisTicks , );  R = gpShowXAxisMinorGridLines( framenum = 1; axisnum = 1; show = 0; ret = gpShowXAxisLabels(&gp,framenum,axisnum,show); gp.src gpShowXAxis Activates or deactivates display of X-axis minor gridlines in a frame. gaussplot ret showgl pgp framenum axisnum showgl Line plots allow up to fivespecifies X which and X-axis Y the axes option incontain is a line set frame. plots. for, and The By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are By default, tick labels are displayed.  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpShowXAxisTicks

1 display X-axis minor gridlines.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which X-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional X axes, call gpSetLineMapAxes to link one or more line maps to an X-axis numbered greater than one. X axes that are added in this way are displayed by default.

By default, minor gridlines are not displayed.

EXAMPLE framenum = 1; axisnum = 1; show = 1; ret = gpShowXAxisMinorGridLines(&gp,framenum,axisnum,show);

SOURCE gp.src

SEE ALSO gpShowXAxis, gpShowXAxisGridLines, gpSetXAxisMinorGridLineColor

gpShowXAxisTicks

PURPOSE Activates or deactivates display of X-axis tick marks in a frame.

LIBRARY gaussplot

FORMAT ret = gpShowXAxisTicks(pgp, framenum, axisnum, showtm);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, X-axis number.

3-468 GAUSS C R Command Reference 3-469 argument gpShowYAxis gpShowYAxis ); axisnum showy , to link one or more line maps to an axisnum , framenum , gpSetLineMapAxes pgp display X-axis tick marks. do not display X-axis tick marks. pointer to a plot control structure. 1 scalar, one of the following: 0 scalar, return code, 0 if successful, otherwise an error code. gpShowXAxisLabels ,  R = gpShowYAxis( framenum = 1; axisnum = 1; show = 0; ret = gpShowXAxisTicks(&gp,framenum,axisnum,show); Activates or deactivates display of a Y-axis in a frame. gaussplot ret pgp gp.src gpShowXAxis showtm ret Line plots allow up to fivespecifies X which and X-axis Y the axes option incontain is a line set frame. plots. for, and The By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are By default, tick marks are displayed.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpShowYAxisGridLines

framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. showy scalar, one of the following: 0 do not display Y-axis. 1 display Y-axis.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

EXAMPLE framenum = 1; axisnum = 1; noshow = 0; ret = gpShowYAxis(&gp,framenum,axisnum,noshow);

SOURCE gp.src

SEE ALSO gpSetLineMapAxes, gpPositionYAxis, gpSetYAxisColor, gpSetYAxisTitle

gpShowYAxisGridLines

PURPOSE Activates or deactivates display of Y-axis major gridlines in a frame.

LIBRARY gaussplot

FORMAT ret = gpShowYAxisGridLines(pgp, framenum, axisnum, showgl);

3-470 GAUSS C R Command Reference 3-471 argument axisnum gpShowYAxisLabels gpShowYAxisLabels gpSetYAxisGridLineColor , to link one or more line maps to a 5, Y-axis number. ≤ axisnum ≤ gpSetLineMapAxes do not display Y-axis major gridlines. display Y-axis major gridlines. scalar, 1 scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar, frame number. gpShowYAxisMinorGridLines ,  R framenum = 1; axisnum = 1; show = 1; ret = gpShowYAxisGridLines(&gp,framenum,axisnum,show); gaussplot gp.src gpShowYAxis Activates or deactivates display of Y-axis tick labels in a frame. axisnum showgl ret Line plots allow up to five X and Y axes in a frame. The pgp framenum specifies which Y-axis the option iscontain set line for, plots. and By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are By default, major gridlines areplots. displayed only in 3D Cartesian and 3D Contour  C  INPUT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpShowYAxisMinorGridLines

FORMAT ret = gpShowYAxisLabels(pgp, framenum, axisnum, showtl);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. showtl scalar, one of the following: 0 do not display Y-axis tick labels. 1 display Y-axis tick labels.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

By default, tick labels are displayed.

EXAMPLE framenum = 1; axisnum = 1; show = 0; ret = gpShowYAxisLabels(&gp,framenum,axisnum,show);

SOURCE gp.src

SEE ALSO gpShowYAxis, gpShowYAxisTicks

gpShowYAxisMinorGridLines

PURPOSE Activates or deactivates display of Y-axis minor gridlines in a frame.

3-472 GAUSS C R Command Reference 3-473 , argument axisnum , axisnum gpShowYAxisTicks framenum to link one or more line maps to a , gpSetYAxisMinorGridLineColor , pgp 5, Y-axis number. ≤ axisnum ≤ gpSetLineMapAxes do not display Y-axis minor gridlines. display Y-axis minor gridlines. pointer to a plot control structure. scalar, frame number. scalar, 1 scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code. gpShowYAxisGridLines , );  R = gpShowYAxisMinorGridLines( framenum = 1; axisnum = 1; show = 1; ret = gpShowYAxisMinorGridLines(&gp,framenum,axisnum,show); gp.src gpShowYAxis gaussplot ret pgp framenum axisnum showgl ret Line plots allow up to fivespecifies X which and Y-axis the Y option axes is incontain set a line for, frame. plots. and The By it default, isadditional one used Y X-axis only axes, and by call one frames Y-axis that areY-axis numbered used. greater To than display one. Ydisplayed axes by that default. are added in this way are By default, minor gridlines are not displayed. showgl  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpShowYAxisTicks

gpShowYAxisTicks

PURPOSE Activates or deactivates display of Y-axis tick marks in a frame.

LIBRARY gaussplot

FORMAT ret = gpShowYAxisTicks(pgp, framenum, axisnum, showtm);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. showtm scalar, one of the following: 0 do not display Y-axis tick marks. 1 display Y-axis tick marks.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

By default, tick marks are displayed.

EXAMPLE framenum = 1; axisnum = 1; show = 0; ret = gpShowYAxisTicks(&gp,framenum,axisnum,show);

SOURCE gp.src

3-474 GAUSS C R Command Reference 3-475 gpShowZAxis gpShowZAxis ); gpShow3DOrientationAxis showz , , framenum , pgp gpSetZAxisTitle do not display Z-axis. display Z-axis. , pointer to a plot control structure. scalar, frame number. scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code. gpShowYAxisLabels ,  R = gpShowZAxis( framenum = 1; noshow = 0; ret = gpShowZAxis(&gp,framenum,noshow); By default, all axes are displayed.and 3D This Contour command plots. applies only to 3D Cartesian gp.src gpSetZAxisColor pgp framenum showz ret gpShowYAxis Activates or deactivates display of the Z-axis in a frame. gaussplot ret  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO SEE ALSO GAUSS gpShowZAxisLabels

gpShowZAxisGridLines

PURPOSE Activates or deactivates display of Z-axis major gridlines in a frame.

LIBRARY gaussplot

FORMAT ret = gpShowZAxisGridLines(pgp, framenum, showgl);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. showgl scalar, one of the following: 0 do not display Z-axis major gridlines. 1 display Z-axis major gridlines.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, major gridlines are displayed in 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; noshow = 0; ret = gpShowZAxisGridLines(&gp,framenum,show);

SOURCE gp.src

SEE ALSO gpShowZAxis, gpShowZAxisMinorGridLines, gpSetZAxisGridLineColor

gpShowZAxisLabels

PURPOSE Activates or deactivates display of Z-axis tick labels in a frame.

3-476 GAUSS C R Command Reference 3-477 ); showgl , ); showtl framenum , , gpShowZAxisMinorGridLines pgp gpShowZAxisMinorGridLines framenum , pgp do not display Z-axis tick labels. display Z-axis tick labels. pointer to a plot control structure. pointer to a plot control structure. scalar, frame number. scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code. gpShowZAxisTicks ,  R = gpShowZAxisMinorGridLines( = gpShowZAxisLabels( framenum = 1; show = 0; ret = gpShowZAxisLabels(&gp,framenum,show); Activates or deactivates display of Z-axis minor gridlines in a frame. gaussplot ret pgp By default, tick labels are displayed. gp.src gpShowZAxis gaussplot ret pgp framenum showtl ret  C  INPUT INPUT FORMAT FORMAT OUTPUT LIBRARY LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpShowZAxisTicks

framenum scalar, frame number. showgl scalar, one of the following: 0 do not display Z-axis minor gridlines. 1 display Z-axis minor gridlines.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, minor gridlines are not displayed.

EXAMPLE framenum = 1; show = 1; ret = gpShowZAxisMinorGridLines(&gp,framenum,show);

SOURCE gp.src

SEE ALSO gpShowZAxis, gpShowZAxisGridLines, gpSetZAxisMinorGridLineColor

gpShowZAxisTicks

PURPOSE Activates or deactivates display of Z-axis tick marks in a frame.

LIBRARY gaussplot

FORMAT ret = gpShowZAxisTicks(pgp, framenum, showtm);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. showtm scalar, one of the following: 0 do not display Z-axis tick marks. 1 display Z-axis tick marks.

3-478 GAUSS C R Command Reference 3-479 gpTile gpTile is a scalar, it places framesperrow creates N rows of frames in the . If ); gpTile framesperrow 1 vector, × framesperrow , 1 vector or scalar, number of frames in each row in the × is an N N scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. workspace. scalar, return code, 0 if successful, otherwise an error code. pgp gpShowZAxisLabels frames in each row, generating as many rows as are needed to fit ,  R = gpTile( framesperrow framenum = 1; show = 0; ret = gpShowZAxisTicks(&gp,framenum,show); framesperrow all of the frames inplaced the in graph. the The rows frames in are the resized order automatically, in and which are they are numbered. framesperrow ret If workspace, each containing the numbercorresponding of element frames of specified in the Tiles frames in the workspace. gaussplot ret pgp By default, tick marks are displayed. gp.src gpShowZAxis ret  C  INPUT FORMAT OUTPUT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS REMARKS SEE ALSO GAUSS gpUse3DPerspective

gpTile may be called only after all of the frames have been added to the graph with the appropriate gpAddPlotTypePlot commands.

By default, gpTile leaves 0.25 inch margins between the frames and the edges of the paper. Call gpSetTileMargins before gpTile to change those margins.

EXAMPLE framesperrow = { 3,2,3 }; ret = gpTile(&gp,framesperrow);

This example generates three rows of frames in the graph, placing three frames in the first and third rows and two frames in the second row. The example assumes that a total of 8 frames have been added to the graph.

SOURCE gp.src

SEE ALSO gpSetTileMargins, gpMoveFrame

gpUse3DPerspective

PURPOSE Activates 3D perspective in a frame so that the shape of the plotted data is dependent on the specified field of view angle.

LIBRARY gaussplot

FORMAT ret = gpUse3DPerspective(pgp, framenum, fieldview);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldview scalar, 0 or 5.72958e-9 ≤ fieldview ≤ 180, field of view angle.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

3-480 GAUSS C R Command Reference , 3-481 fieldzonenum , . They change the framenum is set to 0, then 3D , pgp fieldview ect for the contour layer in the specified ff gpUseFieldZoneContourLighting gpUseFieldZoneContourLighting gpSet3DViewerPosition gpSet3DViewerPosition or , pointer to a plot control structure. . );  R = gpUseFieldZoneContourLighting( framenum = 1; ret = gpUse3DPerspective(&gp,framenum,fieldviewangle); field zone(s). pgp gpfieldzone.src gpSet3DViewDistance Activates or deactivates the lighting e gaussplot ret activate By default, 3D perspective is notperspective is used. activated If with a defaultGAUSSplot field of view angle, which is calculated by As the field of view angledecrease, increases, and the as size the of fieldincrease. the of plot view To change angle in the decreases, the size the frame ofof size will the view of angle plot the (providing in plot that the will 3DgpSet3DViewDistance frame perspective without is changing activated), the call field apparent size of the plotviewer by and allowing the you plot. to specify the distance between the This command applies ONLY to 3D Cartesian and 3D Contour plots. fieldviewangle = 45;  C  INPUT FORMAT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpUseFieldZoneContourLighting

framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). activate scalar or N×1 vector of ones and zeros: 0 deactivate the lighting effect for the contour layer. 1 activate the lighting effect for the contour layer.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The lighting effect is controlled on two levels: in a frame and in each of the field zones in the frame. If the lighting effect is activated in a frame, then both contour and shade lighting are displayed in each field zone in the frame by default. If the lighting effect is not activated in a frame, then neither contour nor shade lighting are displayed in any of the field zones in the frame, regardless of their specific settings.

By default, the lighting effect is activated in frames containing 3D Cartesian and 3D Contour plots. Calling gpUseFieldZoneContourLighting activates the lighting effect in the frame indicated by framenum and then activates or deactivates contour lighting in the specified field zones depending on how activate is set. If activate is an N×1 vector, then each of the field zones in fieldzonenum will be set according to the corresponding element of activate.

The number of field zones in a frame is determined by the number of zones in the data file (see Section 1.3.1 for more information). The plot control structure contains information for only those field zones for which you have specified options; thus there may be fewer field zones in the plot control structure than in the frame. If you call gpUseFieldZoneContourLighting for a subset of the field zones in the frame with an activate argument set to a scalar one (or a vector of zeros and ones), then it will assume that you want contour lighting to be deactivated for all of the unspecified field zones in the frame. Therefore, it will deactivate contour lighting for all of the field zones that are contained in the plot control structure but not specified in the call to gpUseFieldZoneContourLighting.

If you call gpUseFieldZoneContourLighting for a subset of the field zones in the frame with an activate argument set to a scalar zero, then it will assume

3-482 GAUSS C R Command Reference , 3-483 ect for the ff fieldzonenum , , framenum , pgp ect is activated in a frame, both ff ect for the shade layer in the specified gpUseFieldZoneShadeLighting ff gpUseFieldZoneShadeLighting to activate or deactivate the lighting e gpUseFieldZoneShadeLighting , );  R gpUseLightingEffect = gpUseFieldZoneShadeLighting( framenum = 1; fieldzonenum = 2; activate = 0; ret = gpUseFieldZoneContourLighting(&gp,framenum,fieldzonenum,activate); field zone(s). Activates or deactivates the lighting e gaussplot ret gpfieldzone.src gpUseLightingEffect activate that you want contour lightingthe to frame. be activated In for this all case, ofbecause, it the by will other default, not field when set zones the any in contour lighting options and e for shade the lighting unspecified are field displayed zones in each field zoneBecause in it that is frame. possible thatare not contained all in of the the plot fieldto control zones specify structure, that for the will each safest appear field way inactivated to zone the or use in frame deactivated. this the command frame is whether contour lighting should be Call frame. This command applies ONLY to 3D Cartesian and 3D Contour plots. gpSetLightingEffect  C  FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpUseFieldZoneShadeLighting

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). activate scalar or N×1 vector of ones and zeros: 0 deactivate the lighting effect for the shade layer. 1 activate the lighting effect for the shade layer.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The lighting effect is controlled on two levels: in a frame and in each of the field zones in the frame. If the lighting effect is activated in a frame, then both contour and shade lighting are displayed in each field zone in the frame by default. If the lighting effect is not activated in a frame, then neither contour nor shade lighting are displayed in any of the field zones in the frame, regardless of their specific settings.

By default, the lighting effect is activated in frames containing 3D Cartesian and 3D Contour plots. Calling gpUseFieldZoneShadeLighting activates the lighting effect in the frame indicated by framenum and then activates or deactivates shade lighting in the specified field zones depending on how activate is set. If activate is an N×1 vector, then each of the field zones in fieldzonenum will be set according to the corresponding element of activate.

The number of field zones in a frame is determined by the number of zones in the data file (see Section 1.3.1 for more information). The plot control structure contains information for only those field zones for which you have specified options; thus there may be fewer field zones in the plot control structure than in the frame. If you call gpUseFieldZoneShadeLighting for a subset of the field zones in the frame with an activate argument set to a scalar one (or a vector of zeros and ones), then it will assume that you want shade lighting to be deactivated for all of the unspecified field zones in the frame. Therefore, it will deactivate shade lighting for all of the field zones that are contained in the plot control structure but not specified in the call to gpUseFieldZoneShadeLighting.

If you call gpUseFieldZoneShadeLighting for a subset of the field zones in the frame with an activate argument set to a scalar zero, then it will assume that

3-484 GAUSS C R Command Reference , 3-485 ect for the ff , fieldzonenum , framenum , ect for the specified field zone(s). ff pgp ect is activated in a frame, both gpUseFieldZoneTranslucency ff gpUseFieldZoneTranslucency to activate or deactivate the lighting e gpUseFieldZoneContourLighting , );  R gpUseLightingEffect = gpUseFieldZoneTranslucency( framenum = 1; fieldzonenum = 2; activate = 0; ret = gpUseFieldZoneShadeLighting(&gp,framenum,fieldzonenum,activate); Activates or deactivates the translucency e gaussplot ret gpfieldzone.src gpUseLightingEffect activate you want shade lighting toframe. be activated In for this all case, of it thebecause, will other by not field default, set zones when any in the options the contour lighting for and e the shade unspecified lighting field are zones displayed in each field zoneBecause in it that is frame. possible thatare not contained all in of the the plot fieldto control zones specify structure, that for the will each safest appear field way inactivated to zone the or use in frame deactivated. this the command frame is whether shade lighting should be Call frame. This command applies ONLY to 3D Cartesian and 3D Contour plots. gpSetLightingEffect  C  FORMAT LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpUseFieldZoneTranslucency

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. fieldzonenum scalar or N×1 vector, field zone number(s). activate scalar or N×1 vector of ones and zeros: 0 deactivate the translucency effect. 1 activate the translucency effect.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The translucency effect controls the translucency of shade and contour layers in a field zone. It is controlled on two levels: in a frame and in each of the field zones in the frame. If the translucency effect is activated in a frame, then it is displayed in each field zone in the frame by default. If the translucency effect is not activated in a frame, then it is not displayed in any of the field zones in the frame, regardless of their specific settings.

By default, the translucency effect is activated in frames containing 3D Cartesian and 3D Contour plots. Calling gpUseFieldZoneTranslucency activates the translucency effect in the frame indicated by framenum and then activates or deactivates the translucency effect in the specified field zones depending on how activate is set. If activate is an N×1 vector, then each of the field zones in fieldzonenum will be set according to the corresponding element of activate.

The number of field zones in a frame is determined by the number of zones in the data file (see Section 1.3.1 for more information). The plot control structure contains information for only those field zones for which you have specified options; thus there may be fewer field zones in the plot control structure than in the frame. If you call gpUseFieldZoneTranslucency for a subset of the field zones in the frame with an activate argument set to a scalar one (or a vector of zeros and ones), then it will assume that you want the translucency effect to be deactivated for all of the unspecified field zones in the frame. Therefore, it will deactivate the translucency effect for all of the field zones that are contained in the plot control structure but not specified in the call to gpUseFieldZoneTranslucency.

3-486 GAUSS C R Command Reference 3-487 ect ff gpUseGridAreaLighting ect is activated in a frame, it is for a subset of the field zones in gpUseGridAreaLighting ff ect in the second field zone in the ff to activate or deactivate the translucency gpSetTranslucency , ect to be activated for all of the other field zones in ff argument set to a scalar zero, then it will assume that activate gpUseFieldZoneTranslucency  R gpUseTranslucencyEffect ect for the frame. ff framenum = 1; fieldzonenum = {activate 1,2 = }; {ret 0,1 = }; gpUseFieldZoneTranslucency(&gp,framenum,fieldzonenum,activate); gpfieldzone.src gpUseTranslucencyEffect Activates or deactivates light source shading in the grid area of agaussplot frame. first frame. should be activated or deactivated. Call This example activates the translucency e displayed in each field zone in that frame. Because it is possible thatare not contained all in of the the plot fieldto control zones specify structure, that for the will each safest appear field way in to zone the use in frame this the command frame is whether the translucency e e This command applies ONLY to 3D Cartesian and 3D Contour plots. If you call the frame with an you want the translucency e the frame. In this case,because, it by will default, not when set the any translucency options e for the unspecified field zones  C  LIBRARY SOURCE EXAMPLE PURPOSE SEE ALSO GAUSS gpUseLightingEffect

FORMAT ret = gpUseGridAreaLighting(pgp, framenum, uselighting);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. uselighting scalar, one of the following: 0 use light source shading. 1 do not use light source shading.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS By default, light source shading is used in the grid areas of frames containing 3D Cartesian and 3D Contour plots.

Call gpFillGridArea if you do not want the grid area to be filled, or call gpSetGridAreaFillColor to change the fill color.

This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; uselighting = 0; ret = gpUseGridAreaLighting(&gp,framenum,uselighting);

SOURCE gp.src

SEE ALSO gpFillGridArea, gpSetGridAreaFillColor

gpUseLightingEffect

PURPOSE Activates or deactivates the lighting effect in the specified frame(s).

LIBRARY gaussplot

FORMAT ret = gpUseLightingEffect(pgp, framenum, activate);

3-488 GAUSS C R Command Reference . , 3-489 activates or deactivates the gpUseTranslucencyEffect ect. ff ect. ff gpUseFieldZoneShadeLighting gpUseFieldZoneShadeLighting or , ect is activated in a frame, then both ff 1 vector, frame number(s). × gpUseLightingEffect ect is activated in frames containing 3D Cartesian and ect is not activated in a frame, then neither contour nor ff ff deactivate the lighting e activate the lighting e scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code. pointer to a plot control structure. scalar or N ect is controlled on two levels: in a frame and in each of the field ff ect in the specified frame. To activate or deactivate shade or contour ff  R framenum = 1; activate = 0; ret = gpUseLightingEffect(&gp,framenum,activate); contour and shade lighting aredefault. displayed in If each the field lighting zone e in the frame by lighting e lighting for a subset ofgpUseFieldZoneContourLighting the field zones in a frame, call gpfieldzone.src gpUseFieldZoneContourLighting zones in the frame. If the lighting e shade lighting are displayed intheir any of specific the settings. field zones in the frame, regardless of By default the lighting e 3D Contour plots. Calling This command applies ONLY to 3D Cartesian and 3D Contour plots. gpSetLightingEffect activate ret The lighting e pgp framenum  C  INPUT OUTPUT SOURCE EXAMPLE REMARKS SEE ALSO GAUSS gpUseTranslucencyEffect

gpUseTranslucencyEffect

PURPOSE Activates or deactivates the translucency effect in the specified frame(s).

LIBRARY gaussplot

FORMAT ret = gpUseTranslucencyEffect(pgp, framenum, activate);

INPUT pgp pointer to a plot control structure. framenum scalar or N×1 vector, frame number(s). activate scalar, one of the following: 0 deactivate the translucency effect. 1 activate the translucency effect.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS The translucency effect controls the translucency of shade and contour layers in a field zone. It is controlled on two levels: in a frame and in each of the field zones in the frame. If the translucency effect is activated in a frame, then it is displayed in each field zone in the frame by default. If the translucency effect is not activated in a frame, then it is not displayed in any of the field zones in the frame, regardless of their specific settings.

By default the translucency effect is activated in frames containing 3D Cartesian and 3D Contour plots. Calling gpUseTranslucencyEffect activates or deactivates the translucency effect in the specified frame. To activate or deactivate the translucency effect for a subset of the field zones in a frame, call gpUseFieldZoneTranslucency.

This command applies ONLY to 3D Cartesian and 3D Contour plots.

EXAMPLE framenum = 1; activate = 1; ret = gpUseTranslucencyEffect(&gp,framenum,activate);

3-490 GAUSS C R Command Reference 3-491 ); argument activate , axisnum axisnum , gpUseXAxisLogScaling gpUseXAxisLogScaling to link one or more line maps to an framenum 5, X-axis number. , ≤ gpSetTranslucency pgp , axisnum ≤ gpSetLineMapAxes deactivate log scaling on the X-axis. activate log scaling on the X-axis. pointer to a plot control structure. scalar, frame number. scalar, 1 scalar, one of the following: 0 1 scalar, return code, 0 if successful, otherwise an error code.  R = gpUseXAxisLogScaling( framenum = 1; axisnum = 1; ret Line plots allow up to five X and Y axes in a frame. The pgp framenum axisnum activate ret gpfieldzone.src gpUseFieldZoneTranslucency Activates or deactivates log scaling on an X-axis. gaussplot specifies which X-axis the optioncontain is Line set plots. for, and By it default, isadditional one used X X-axis only axes, and call by one frames Y-axis areX-axis that used. numbered greater To display than one.displayed X by axes default. that are added in this way are By default, log scaling is deactivated.  C  INPUT FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpUseYAxisLogScaling

activate = 1; ret = gpUseXAxisLogScaling(&gp,framenum,axisnum,activate);

SOURCE gp.src

gpUseYAxisLogScaling

PURPOSE Activates or deactivates log scaling on a Y-axis.

LIBRARY gaussplot

FORMAT ret = gpUseYAxisLogScaling(pgp, framenum, axisnum, activate);

INPUT pgp pointer to a plot control structure. framenum scalar, frame number. axisnum scalar, 1 ≤ axisnum ≤ 5, Y-axis number. activate scalar, one of the following: 0 deactivate log scaling on the Y-axis. 1 activate log scaling on the Y-axis.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS Line plots allow up to five X and Y axes in a frame. The axisnum argument specifies which Y-axis the option is set for, and it is used only by frames that contain line plots. By default, one X-axis and one Y-axis are used. To display additional Y axes, call gpSetLineMapAxes to link one or more line maps to a Y-axis numbered greater than one. Y axes that are added in this way are displayed by default.

By default, log scaling is deactivated.

EXAMPLE framenum = 1;

3-492 GAUSS C R Command Reference 3-493 gpWait GAUSS gpWait ) return to 2.1.16 GUI. immediately. window has been closed to GUI or wait until the GAUSSplot GAUSS . plotting commands will return to GAUSSplot GAUSSplot GAUSS plotting commands (see Section GAUSSplot do not wait; return to wait until the return to ); pointer to a plot control structure. scalar, one of the following: 0 1 wait GAUSSplot window has been closed. , pgp immediately after initializing the  R wait = 1; gpWait(&gp,wait); axisnum = 1; activate = 1; ret = gpUseYAxisLogScaling(&gp,framenum,axisnum,activate); GAUSSplot By default, the gp.src gpPlot immediately after initializing the gaussplot gpWait( pgp wait GAUSS gp.src Specifies whether the  C  INPUT FORMAT LIBRARY SOURCE SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpWritePlotData

gpWritePlotData

PURPOSE Writes the data in a gpData structure to a .plt data file.

LIBRARY gaussplot

FORMAT ret = gpWritePlotData(pgdat, datafile);

INPUT pgdat pointer to a GAUSSplot data structure containing the data to be written. datafile the name of the data file to write.

OUTPUT ret scalar, return code, 0 if successful, otherwise an error code.

REMARKS If datafile does not have a .plt extension, then the extension will be appended to it.

In addition to writing the data file, gpWritePlotData saves the structure that pgdat is pointing at to a file with the same name as datafile, except with an .fsr extension instead of a .plt extension. This file is accessed by GAUSSplot commands that allow you to specify variables using variable names. These commands open the .fsr file to convert the input variable names to indices of the variables into the data file. If you want to specify variables using variable names in GAUSSplot commands, then you need to keep the .fsr structure file together with your .plt data file.

Call gpCleanUp after running your program to delete the structure and data files.

EXAMPLE library gaussplot; #include gp.sdf

p = pi; x = seqa(0,p/4,15);

3-494 GAUSS C R Command Reference . 3-495 erent gpPlot ff or contains one gpXYLinePlotCreate gpXYLinePlotCreate gpMakeXYLinePlot gpXYLinePlotCreate gpSetPlotData sets the plot type of the entire graph to XY , . gpAddZone , to plot a graph using either gp plot control structure with itsXY members Line set plot. to default values for an gpPlotCreate gpXYLinePlotCreate  R = gpXYLinePlotCreate; library gaussplot; #include gp.sdf y = sin(x); struct gpData gdat; string vnames =gdat { = "X", gpSetPlotData(x˜y,vnames); ret "Y" = }; gpWritePlotData(&gdat,"mydata.plt"); frame by default. Calling Line. To create a graph withtypes, multiple use frames that contain plots of di A plot control structure initialized with You may use Creates a plot control structurean and XY initializes Line its plot. members to default values for gaussplot gp gp gpwritedata.src gpInitPlotData  C  FORMAT OUTPUT LIBRARY SOURCE EXAMPLE PURPOSE REMARKS SEE ALSO GAUSS gpXYLinePlotCreate

x = seqa(0.2,0.2,20); y = log(x); string vnames = { "V1", "V2" };

struct gpPlotControl gp; gp = gpXYLinePlotCreate; ret = gpMakeXYLinePlot(&gp,x,y,vnames);

This example illustrates how you may create an XY Line plot with one line map, using defaults for all style and display options. The first variable (V1) will be associated with the X-axis, and the second variable (V2) will be associated with the Y-axis.

SOURCE gpxylineplot.src

SEE ALSO gpMakeXYLinePlot, gpPlot

3-496 GAUSS C R Command Reference A-1 A : GAUSSplot Character Table Following is a table that lists all of the available characters in GAUSSplot 8.0

r r e e t t c c x x x a a r x r e e e a e d d d a t d t d h d h In x e In x e In n C I C r e in r e in r f f d r e T e T e e d t e t e t e t e c h c h c d s D s D c d a i k a i k a n a r l e h r r l e h r r n t t e r a g e e a g e e a t a e r r t h n s h n s h x h x C E G Ma U C E G Ma U C E C E 32 (space) 80 P Π ∠ 160 208 Ð 33 ! ! ϒ 81 Q Θ ∇ 161 ¡ 209 Ñ 34 " ∀ ′ 82 R Ρ ® 162 ¢ 210 Ò 35 # # ≤ 83 S Σ © 163 £ 211 Ó 36 $ ∃ ⁄ 84 T Τ ™ 164 ¤ 212 Ô 37 % % ∞ 85 U Υ ∏ 165 ¥ 213 Õ 38 & & ƒ 86 V ς √ 166 ¦ 214 Ö 39 ’ ∋ ♣ 87 W Ω ⋅ 167 § 215 × 40 ( ( ♦ 88 X Ξ ¬ 168 ¨ 216 Ø 41 ) ) ♥ 89 Y Ψ ∧ 169 © 217 Ù 42 * ∗ ♠ 90 Z Ζ ∨ 170 ª 218 Ú 43 + + ↔ 91 [ [ ⇔ 171 « 219 Û 44 , , ← 92 \ ∴ ⇐ 172 ¬ 220 Ü 45 - − ↑ 93 ] ] ⇑ 173 - 221 Ý 46 . . → 94 ^ ⊥ ⇒ 174 ® 222 Þ 47 / / ↓ 95 _ _ ⇓ 175 ¯ 223 ß 48 0 0 ° 96 ‘ ⎯ ◊ 176 ° 224 à 49 1 1 ± 97 a α 〈 177 ± 225 á 50 2 2 ″ 98 b β ® 178 ² 226 â 51 3 3 ≥ 99 c χ © 179 ³ 227 ã 52 4 4 × 100 d δ ™ 180 ´ 228 ä 53 5 5 ∝ 101 e ε ∑ 181 µ 229 å 54 6 6 ∂ 102 f φ ⎛ 182 ¶ 230 æ 55 7 7 • 103 g γ ⎜ 183 · 231 ç 56 8 8 ÷ 104 h η ⎝ 184 ¸ 232 è 57 9 9 ≠ 105 i ι ⎡ 185 ¹ 233 é 58 : : ≡ 106 j ϕ ⎢ 186 º 234 ê 59 ; ; ≈ 107 k κ ⎣ 187 » 235 ë 60 < < … 108 l λ ⎧ 188 ¼ 236 ì 61 = = ⏐ 109 m µ ⎨ 189 ½ 237 í 62 > > ⎯ 110 n ν ⎩ 190 ¾ 238 î 63 ? ? ↵ 111 o ο ⎪ 191 ¿ 239 ï 64 @ ≅ ℵ 112 p π 192 À 240 ð 65 A Α ℑ 113 q θ 〉 193 Á 241 ñ 66 B Β ℜ 114 r ρ ∫ 194 Â 242 ò 67 C Χ ℘ 115 s σ ⌠ 195 Ã 243 ó 68 D ∆ ⊗ 116 t τ ⎮ 196 Ä 244 ô 69 E Ε ⊕ 117 u υ ⌡ 197 Å 245 õ 70 F Φ ∅ 118 v ϖ ⎞ 198 Æ 246 ö 71 G Γ ∩ 119 w ω ⎟ 199 Ç 247 ÷ 72 H Η ∪ 120 x ξ ⎠ 200 È 248 ø 73 I Ι ⊃ 121 y ψ ⎤ 201 É 249 ù 74 J ϑ ⊇ 122 z ζ ⎥ 202 Ê 250 ú 75 K Κ ⊄ 123 { { ⎦ 203 Ë 251 û 76 L Λ ⊂ 124 | | ⎫ 204 Ì 252 ü 77 M Μ ⊆ 125 } } ⎬ 205 Í 253 ý 78 N Ν ∈ 126 ~ ∼ ⎭ 206 Î 254 þ 79 O Ο ∉ 127 207 Ï 255 ÿ

Character indices in Tecplot. A-2 Command Reference in B-1 layers B for a description of layers). 1.5.2 Obsoleted Commands Obsoleted CommandgpShowFieldZoneBoundary gpShowFieldZoneBoundaryLayer gpShowFieldZoneContourgpShowFieldZoneMesh gpShowFieldZoneContourLayer ReplacementgpShowFieldZoneScatter Command gpShowFieldZoneShade gpShowFieldZoneScatterLayer gpShowFieldZoneMeshLayer gpShowFieldZoneVectorsgpShowLineMapBars gpShowFieldZoneShadeLayer gpShowFieldZoneVectorLayer gpShowLineMapErrorBarsgpShowLineMapLines gpShowLineMapErrorBarLayer gpShowLineMapSymbols gpShowLineMapBarLayer gpShowLineMapLineLayer gpShowLineMapSymbolLayer We chose to rename the commands, so it would be clear that these commands control the The obsoleted commands will stillreplacement work commands for in backwards compatibility, new but programs. you should use the field zones and line maps (see Section For the sake of clarity, we have renamed the following commands: GAUSSplot 8.0

The behavior has changed slightly from the obsoleted commands to their replacements. See the command reference pages for more information.

B-2 Index Index Index-1 , 3-1 , 3-4 , 3-2 , 3-5 , 3-6 curve fitting, 2-5 D data file, 1-8, 2-2 debugging, 2-35 drawing, 3-435 E error bar layer, 1-19, 2-7, 3-435 error handling, 3-83, 3-216 error messages, 2-34 exporting, 2-27 F field plot, 1-19, 1-23, 1-32,field 1-41 zone, 1-21, 1-22, 1-32,fonts, 2-9 2-32 frame, 1-5, 1-18, 1-32, 2-24 G geometries, 2-27 GP Tools, 1-8 gp2DCartesianPlotCreate gp2DContourPlotCreate gp3DCartesianPlotCreate gp3DContourPlotCreate gpAdd2DCartesianFrame

data file, 1-8

characters, 0-1 colors, 2-31 contour group, 1-33 contour layer, 1-21, 2-10, 3-433 C bar layer, 1-19, 2-6, 3-431 Bar plot, 1-23, 3-14, 3-60,boundary 3-102 layer, 1-21, 2-13, 3-432 Box plot, 1-23, 2-7, 3-16, 3-61, 3-104 B adding frames, 1-5, 2-3 animation, 2-24, 3-53, 3-55, 3-56 arrows, 2-26 axes, 2-15 A 3D Cartesian plot, 1-19, 1-23,3D 3-4, Contour 3-9, plot, 3-95 1-23, 3-5,3D 3-11, perspective, 3-96 2-23, 3-480 3D rotation, 2-23, 2-24, 3-53,3D 3-144 viewer position, 2-23, 3-150, 3-151 2D Cartesian plot, 1-19, 1-23,2D 3-1, Contour 3-6, plot, 3-91 1-23, 3-2, 3-8, 3-93 .plt Index Index gpAdd2DContourFrame, 3-8 gpCreateHistPData, 3-66 gpAdd3DCartesianFrame, 3-9 gpData structure, 1-9 gpAdd3DContourFrame, 3-11 gpExportBMP, 3-68 gpAddArrow, 3-13 gpExportEPS, 3-69 gpAddBarFrame, 3-14 gpExportHPGL, 3-70 gpAddBoxFrame, 3-16 gpExportHPGL2, 3-71 gpAddCircle, 3-18 gpExportJPEG, 3-72 gpAddContourLegend, 3-20 gpExportPNG, 3-73 gpAddEllipse, 3-21 gpExportPS, 3-74 gpAddFieldZoneLegendFrame, 3-23 gpExportRAS, 3-75 gpAddHistFFrame, 3-27 gpExportTIFF, 3-76 gpAddHistFrame, 3-25 gpExportWMF, 3-77 gpAddHistPFrame, 3-29 gpExportXWD, 3-78 gpAddLineLegend, 3-31 gpFillGeometry, 3-79 gpAddLineSegment, 3-32 gpFillGridArea, 3-81 gpAddLineSegment3D, 3-34 gpFramePause, 3-82 gpAddLogLogFrame, 3-35 gpGetErrorMessage, 3-83 gpAddLogXFrame, 3-37 gpHistFPlotCreate, 3-85 gpAddLogYFrame, 3-39 gpHistPlotCreate, 3-84 gpAddMacroFile, 3-40 gpHistPPlotCreate, 3-86 gpAddPolarLineFrame, 3-41 gpInitPlotData, 1-9, 3-87 gpAddRectangle, 3-43 gpLogLogPlotCreate, 3-88 gpAddSquare, 3-45 gpLogXPlotCreate, 3-89 gpAddTextObject, 3-46 gpLogYPlotCreate, 3-90 gpAddTextObject3D, 3-49 gpMake2DCartesianPlot, 3-91 gpAddXYLineFrame, 3-50 gpMake2DContourPlot, 3-93 gpAddZone, 1-9, 3-52 gpMake3DCartesianPlot, 3-95 gpAnimate3DRotation, 3-53 gpMake3DContourPlot, 3-96 gpAnimateFieldZones, 3-55 gpMakeAxesIndependent, 3-98 gpAnimateLineMaps, 3-56 gpMakeAxesXYDependent, 3-99 gpAnimateXAxisRotation, 3-57 gpMakeAxesXYZDependent, 3-101 gpAnimateYAxisRotation, 3-58 gpMakeBarPlot, 3-102 gpAnimateZAxisRotation, 3-59 gpMakeBoxPlot, 3-104 gpBarPlotCreate, 3-60 gpMakeHistFPlot, 3-108 gpBoxPlotCreate, 3-61 gpMakeHistPlot, 3-106 gpCleanUp, 3-62 gpMakeHistPPlot, 3-110 gpCreateHistData, 3-63 gpMakeLogLogPlot, 3-112

Index-2 Index , , Index , 3-175 , 3-186 , 3-188 , 3-183 , 3-198 Index-3 , 3-184 , 3-204 , 3-178 , 3-179 , 3-182 , 3-187 , 3-200 , 3-164 , 3-171 , 3-176 , 3-189 , 3-190 , 3-167 , 3-191 , 3-192 , 3-195 , 3-173 , 3-194 , 3-168 , 3-197 , 3-170 , 3-199 , 3-201 , 3-166 , 3-169 , 3-172 , 3-174 , 3-165 3-181 3-196 gpSetArrowLineThickness gpSetAxisMap gpSetBarColor gpSetBarLineThickness gpSetBarOrientation gpSetBarWidth gpSetBoundaryColor gpSetBoundaryThickness gpSetBoxColor gpSetBoxMinMaxMethod gpSetBoxWidth gpSetContourColorDistribution gpSetContourFloodGroup gpSetContourLegendBoxColor gpSetContourLegendBoxStyle gpSetContourLegendBoxThickness gpSetContourLegendBoxType gpSetContourLegendHeaderFont gpSetContourLegendLabelFont gpSetContourLegendLineSpacing gpSetContourLegendMargin gpSetContourLegendOrientation gpSetContourLegendSkip gpSetContourLegendView gpSetContourLineColor gpSetContourLineGroup gpSetContourVariable gpSetCurveFitDataFile gpSetCurveFitDependentVariable gpSetCurveFitPoints gpSetCurveFitPolynomialOrder gpSetCurveFitRange gpSetCurveFitSplineClamp gpSetCurveFitType gpSetCurveFitWeightVariable , 3-162 , 3-156 , 3-126 , 3-134 , 3-151 , 3-152 , 3-161 , 3-120 , 3-118 , 3-124 , 3-150 , 3-155 , 3-158 , 3-145 , 3-157 , 3-160 , 3-121 , 3-128 , 3-129 , 3-137 , 3-138 , 3-143 , 3-154 structure, 1-31 , 3-114 , 3-116 , 3-135 , 3-149 , 3-141 , 3-146 , 3-147 , 3-148 , 3-132 , 3-144 , 3-127 , 3-139 , 3-130 gpMakeLogXPlot gpMakeLogYPlot gpMakePolarLinePlot gpMakeVectorsTangent gpMakeXYLinePlot gpMoveContourLegend gpMoveFieldZoneLegend gpMoveFrame gpMoveLineLegend gpOpenLayoutFile gpPlot gpPlotControl gpPlotCreate gpPolarLinePlotCreate gpPositionGrid gpPositionXAxis gpPositionYAxis gpPrint gpPrintToFile gpRedefineColor gpRotateAxes gpRotateTextObject gpRotateXAxis gpRotateYAxis gpRotateZAxis gpRunMacroFile gpSet3DViewDistance gpSet3DViewerPosition gpSetActiveFieldZones gpSetArrowColor gpSetArrowHeadAngle gpSetArrowHeadAttachment gpSetArrowHeadSize gpSetArrowHeadStyle gpSetArrowHeadType gpSetArrowLinePattern gpSetArrowLinePatternLength Index

gpSetDataFile, 3-205 gpSetGeometryLinePatternLength, gpSetDataSetTitle, 3-206 3-244 gpSetDefaultTextFont, 3-207 gpSetGeometryLineThickness, 3-246 gpSetErrorBarColor, 3-208 gpSetGeometryNumSides, 3-247 gpSetErrorBarLineThickness, 3-210 gpSetGridAreaFillColor, 3-248 gpSetErrorBarSize, 3-211 gpSetIPlaneRange, 3-249 gpSetErrorBarSkip, 3-212 gpSetJPlaneRange, 3-250 gpSetErrorBarType, 3-213 gpSetKPlaneRange, 3-252 gpSetErrorBarVariable, 3-214 gpSetLightingEffect, 3-253 gpSetErrorLevel, 3-216 gpSetLineColor, 3-254 gpSetExportImageWidth, 3-217 gpSetLineLegendBoxColor, 3-255 gpSetLineLegendBoxStyle gpSetExportJPEGQuality, 3-218 , 3-256 gpSetLineLegendBoxThickness, 3-258 gpSetFieldZoneLegendBoxColor, 3-219 gpSetLineLegendBoxType, 3-259 gpSetFieldZoneLegendBoxStyle, 3-220 gpSetLineLegendFont, 3-260 gpSetFieldZoneLegendBoxThickness, gpSetLineLegendLineSpacing, 3-261 3-222 gpSetLineLegendMargin, 3-262 gpSetFieldZoneLegendBoxType, 3-223 gpSetLineMapAxes, 3-263 gpSetFieldZoneLegendFont, 3-224 gpSetLineMapNames, 3-264 gpSetFieldZoneLegendLineSpacing, gpSetLineMaps, 3-266 3-226 gpSetLineMapZone, 3-268 gpSetFieldZoneLegendLowerMargin, gpSetLinePattern, 3-269 3-227 gpSetLinePatternLength, 3-270 gpSetFieldZoneLegendTitle , 3-228 gpSetLineSegmentColor, 3-271 gpSetFieldZoneLegendTitleFont, 3-229 gpSetLineSegmentPattern, 3-272 gpSetFieldZoneLegendUpperMargin, gpSetLineSegmentPatternLength, 3-273 3-230 gpSetLineSegmentThickness, 3-275 gpSetFieldZoneNames, 3-232 gpSetLineThickness, 3-276 gpSetFrameBackgroundColor, 3-233 gpSetMacroFile, 3-277 gpSetFrameHeaderColor, 3-234 gpSetMagnification, 3-278 gpSetFrameHeaderText, 3-235 gpSetMeshColor, 3-279 gpSetFrameName, 3-236 gpSetMeshLinePattern, 3-280 gpSetFrameStyle, 3-237 gpSetMeshLinePatternLength, 3-281 gpSetGeneralCurveFitOptions, 3-238 gpSetMeshLineThickness, 3-282 gpSetGeometryColor, 3-240 gpSetMeshType, 3-283 gpSetGeometryFillColor, 3-241 gpSetPaperOrientation, 3-284 gpSetGeometryLinePattern, 3-243 gpSetPaperSize, 3-284

Index-4 Index Index , 3-355 Index-5 , 3-363 , 3-365 , 3-332 , 3-337 , 3-345 , 3-335 , 3-343 , 3-352 , 3-356 , 3-336 , 3-338 , 3-340 , 3-344 , 3-362 , 3-354 , 3-333 , 3-364 , 3-370 , 3-359 , 3-367 , 3-329 , 3-334 , 3-339 , 3-341 , 3-342 , 3-368 , 3-330 , 3-360 , 3-351 , 3-347 , 3-349 , 3-350 , 3-353 , 3-357 , 3-361 , 3-346 gpSetTextObjectMargin gpSetThetaAxisColor gpSetThetaAxisLabelColor gpSetThetaAxisLabelFont gpSetThetaAxisLabelOffset gpSetThetaAxisLabelSkip gpSetThetaAxisRange gpSetThetaAxisThickness gpSetThetaAxisTicks gpSetThetaAxisTitle gpSetThetaAxisTitleColor gpSetThetaAxisTitleFont gpSetThetaAxisTitleOffset gpSetThetaMode gpSetThetaPeriod gpSetTileMargins gpSetTranslation gpSetTranslucency gpSetVectorArrowHeadType gpSetVectorColor gpSetVectorLinePattern gpSetVectorLinePatternLength gpSetVectorLineThickness gpSetVectorType gpSetVectorVariables gpSetWorkspaceView gpSetXAxisColor gpSetXAxisGridLineColor gpSetXAxisGridLineThickness gpSetXAxisGridPattern gpSetXAxisGridPatternLength gpSetXAxisLabelColor gpSetXAxisLabelFont gpSetXAxisLabelOffset gpSetTextObjectColor gpSetTextObjectFont gpSetTextObjectLineSpacing , 3-322 , 3-327 , 3-306 , 3-316 , 3-323 , 3-325 , 3-308 , 3-328 , 3-294 , 3-302 , 3-318 , 3-288 , 3-292 , 3-300 , 3-304 , 3-293 , 3-295 , 3-297 , 3-301 , 3-312 , 3-315 , 3-290 , 3-303 , 3-307 , 3-289 , 3-310 , 3-314 , 3-317 , 3-291 , 3-296 , 3-298 , 3-299 , 3-311 , 3-320 , 3-321 , 1-9, 3-285 , 3-286 gpSetPlotData gpSetPlotFit gpSetPolarAxesTitles gpSetPrintFormat gpSetPrintPalette gpSetRAxisColor gpSetRAxisLabelColor gpSetRAxisLabelFont gpSetRAxisLabelOffset gpSetRAxisLabelSkip gpSetRAxisRange gpSetRAxisThickness gpSetRAxisTicks gpSetRAxisTitle gpSetRAxisTitleColor gpSetRAxisTitleFont gpSetRAxisTitleOffset gpSetScatterColor gpSetScatterFillMode gpSetScatterLineThickness gpSetScatterShape gpSetScatterShapeASCII gpSetScatterSize gpSetShadeColor gpSetSurfacesToPlot gpSetSymbolColor gpSetSymbolFillMode gpSetSymbolLineThickness gpSetSymbolShape gpSetSymbolShapeASCII gpSetSymbolSize gpSetSymbolSkip gpSetTextObjectAnchorLocation gpSetTextObjectBoxColor gpSetTextObjectBoxStyle gpSetTextObjectBoxThickness gpSetTextObjectBoxType Index

gpSetXAxisLabelSkip, 3-371 gpSetZAxisGridLineColor, 3-411 gpSetXAxisMinorGridLineColor, 3-372 gpSetZAxisGridLineThickness, 3-412 gpSetXAxisMinorGridLineThickness, gpSetZAxisGridPattern, 3-412 3-373 gpSetZAxisGridPatternLength, 3-414 gpSetXAxisMinorGridPattern, 3-374 gpSetZAxisLabelColor, 3-415 gpSetXAxisMinorGridPatternLength, gpSetZAxisLabelFont, 3-415 3-375 gpSetZAxisLabelOffset, 3-417 gpSetXAxisRange, 3-377 gpSetZAxisLabelSkip, 3-418 gpSetXAxisThickness, 3-378 gpSetZAxisMinorGridLineColor, 3-419 gpSetXAxisTicks, 3-379 gpSetZAxisMinorGridLineThickness, gpSetXAxisTitle, 3-380 3-420 gpSetXAxisTitleColor, 3-381 gpSetZAxisMinorGridPattern, 3-421 gpSetXAxisTitleFont, 3-382 gpSetZAxisMinorGridPatternLength, gpSetXAxisTitleOffset, 3-384 3-422 gpSetYAxisColor, 3-385 gpSetZAxisRange, 3-423 gpSetYAxisGridLineColor, 3-386 gpSetZAxisThickness, 3-424 gpSetYAxisGridLineThickness, 3-388 gpSetZAxisTicks, 3-425 gpSetYAxisGridPattern, 3-389 gpSetZAxisTitle, 3-426 gpSetYAxisGridPatternLength, 3-390 gpSetZAxisTitleColor, 3-427 gpSetYAxisLabelColor, 3-391 gpSetZAxisTitleFont, 3-427 gpSetYAxisLabelFont, 3-392 gpSetZAxisTitleOffset, 3-429 gpSetYAxisLabelOffset, 3-394 gpShow3DOrientationAxis, 3-430 gpSetYAxisLabelSkip, 3-395 gpShowBarLayer, 3-431 gpSetYAxisMinorGridLineColor, 3-397 gpShowBoundaryLayer, 3-432 gpSetYAxisMinorGridLineThickness, gpShowContourLayer, 3-433 3-398 gpShowDrawing, 3-435 gpSetYAxisMinorGridPattern, 3-399 gpShowErrorBarLayer, 3-435 gpSetYAxisMinorGridPatternLength, gpShowFieldZoneBoundaryLayer, 3-437 3-400 gpShowFieldZoneContourLayer, 3-439 gpSetYAxisRange, 3-401 gpShowFieldZoneMeshLayer, 3-441 gpSetYAxisThickness, 3-403 gpShowFieldZoneScatterLayer, 3-443 gpSetYAxisTicks, 3-404 gpShowFieldZoneShadeLayer, 3-445 gpSetYAxisTitle, 3-405 gpShowFieldZoneVectorLayer, 3-447 gpSetYAxisTitleColor, 3-406 gpShowLineLayer, 3-449 gpSetYAxisTitleFont, 3-407 gpShowLineMapBarLayer, 3-450 gpSetYAxisTitleOffset, 3-409 gpShowLineMapErrorBarLayer, 3-452 gpSetZAxisColor, 3-410 gpShowLineMapLineLayer, 3-454

Index-6 Index Index Index-7 ect, 2-13, 3-488 ff 3-106 3-110 line layer, 1-19, 2-4, 3-449 line map, 1-19, 1-32, 2-4 line patterns, 2-33 line plot, 1-19, 1-23, 1-32, 1-35 line segments, 2-26 LogLog plot, 1-23, 3-35, 3-88, 3-112 LogX plot, 1-23, 3-37, 3-89, 3-114 LogY plot, 1-23, 3-39, 3-90, 3-116 M obsoleted commands, 0-1 layers, 1-19 layout file, 1-7, 3-130 legend, contour, 3-20 legend, field zone, 2-14, 3-23 legend, line, 2-8, 3-31 lighting e macro file, 1-7, 3-40, 3-149, 3-277 mesh layer, 1-21, 2-9, 3-457 O H Hist plot, 1-23, 1-28, 2-3, 3-25, 3-63, 3-84, HistF plot, 1-23, 1-28, 3-27, 3-85,histograms, 3-108 1-28 HistP plot, 1-23, 1-28, 2-3, 3-29, 3-66, 3-86, L , 3-481 , 3-483 , 3-485 , 3-467 , 3-472 , 3-477 , 3-455 , 3-490 , 3-487 , 3-465 , 3-470 , 3-476 , 3-491 , 3-492 , 3-488 , 3-459 , 3-480 , 3-495 , 3-462 , 3-463 , 3-466 , 3-471 , 3-476 , 3-460 , 3-468 , 3-474 , 3-478 , 3-457 , 3-458 , 1-9, 3-494 , 3-464 , 3-469 , 3-475 , 3-479 , 3-493 gpShowLineMapSymbolLayer gpShowMeshLayer gpShowPolarAxes gpShowScatterLayer gpShowShadeLayer gpShowSymbolLayer gpShowVectorLayer gpShowXAxis gpShowXAxisGridLines gpShowXAxisLabels gpShowXAxisMinorGridLines gpShowXAxisTicks gpShowYAxis gpShowYAxisGridLines gpShowYAxisLabels gpShowYAxisMinorGridLines gpShowYAxisTicks gpShowZAxis gpShowZAxisGridLines gpShowZAxisLabels gpShowZAxisMinorGridLines gpShowZAxisTicks gpTile gpUse3DPerspective gpUseFieldZoneContourLighting gpUseFieldZoneShadeLighting gpUseFieldZoneTranslucency gpUseGridAreaLighting gpUseLightingEffect gpUseTranslucencyEffect gpUseXAxisLogScaling gpUseYAxisLogScaling gpWait gpWritePlotData gpXYLinePlotCreate Index

P X pause, 3-82 XY Line plot, 1-19, 1-23, 3-50, 3-121, 3-495 percentile box symbol, 2-7 plot types, 1-22 Z plot, field, 1-19, 1-23 zone, 1-8 plot, line, 1-19, 1-23 plotting, 2-29 polar axes, 2-21 Polar Line plot, 1-19, 1-23, 3-41, 3-118, 3-134 printing, 2-27 R rotation, 2-23, 2-24, 3-53, 3-144 S scatter layer, 1-21, 2-12, 3-459 shade layer, 1-21, 2-13, 3-460 structure file, 1-34 structure pointers, 1-33 surface plotting options, 2-15, 3-312 symbol layer, 1-19, 2-6, 3-462 symbols, 2-33 T text objects, 2-25 translucency effect, 2-14, 3-490 V vector layer, 1-21, 2-11, 3-463 volume plot, 2-15 W workspace, 1-18

Index-8