File: gettingstarted.html

package info (click to toggle)
giza 1.5.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,352 kB
  • sloc: ansic: 13,252; sh: 4,205; f90: 3,003; lex: 437; perl: 330; makefile: 99
file content (122 lines) | stat: -rw-r--r-- 5,048 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html"; charset=utf-8" \>
    <title>giza - getting started</title>
    <link rel="stylesheet" href="../style.css" type="text/css" \>
  </head>

  <div class="header">
    <a href="/giza"><img alt="giza" src="../title.png"\></a>
  </div>

  <div id="menucontainer">
  <ul id="menulist">
    <li><a href="../news/">news</a></li>
    <li><a href="../download/">download</a></li>
    <li><a href="../documentation/">documentation</a></li>
    <li><a href="../contact/">contact</a></li>
    <li><a href="../samples/">samples</a></li>
  </ul>
  </div>

  <div id="content">
    <h1>Getting started</h1>
    <p>This tutorial will show you the basics of using giza to create scientific plots
    with a simple example. We will generate the following graph;</p>
    <table class="img">
      <tr><td><a href="images/Getting_Started.png"><img alt="sample1" src="images/Getting_Started.png"></a></td></tr>
    </table>
    <br>
    <p>Click <a href="gettingstarted.c">here</a> to get the source file, or read on for 
    a detailed description of the file. </p>

    <h2>Include the header</h2>
    <p>First things first include the giza header:</p>
    <div class="code">
      #include &lt;giza.h&gt;
    </div>

    <h2>Opening a device</h2>
    <p>Next, before attempting any drawing you must open a giza device:</p>
    <div class="code">
      error = giza_open_device ("?", "Getting_Started");
    </div>
    <p>The first argument to this function specifies which device to open. "?" tells giza
    to prompt the user for a device. Other available devices should be specified by
    "/png", "/pdf", "/xw" or "/null". The second argument specifies a name for the open device.
    This name will be the name given to the xwindow or file that will be drawn to. The function returns
    0 if no error has occurred.</p>

    <h2>Prepare the environment</h2>
    <p>To get the device ready for drawing you should make a call to giza_set_environment:</p>
    <div class="code">
      giza_set_environment (-10., 10., 0., 100., 0, 0);
    </div>
    <p>The first two arguments sets the range of the x-axis that will be displayed on the plot. The next two arguments
    set the range of the y-axis that will be displayed. The second last arguments will determine if the
    axes will be sized to give them equal scale. If set to 0 both axes will be made as large as possible, if
    set to 1 the axes will have equal scales. The last argument specifies the way in which the box around the
    plot area is drawn. Some of the options are -2 for no axis or box, -1 for only the box, 0 for a labeled box or 1
    for a box and axis with labels.<br>
    Now your ready to do your drawing.</p>

    <h2>Drawing a line</h2>
    <p>We will start by drawing a line:</p>
    <div class="code">
    <pre>
int i, n = 100;
double xpts[n], ypts[n];

for (i = 0; i &lt n; ++i)
  {
    xpts[i] = -10. + (double) i * 20. / (double) (n - 1);
    ytps[i] = xpts[i] * xpts[i];
  }

giza_line (n, xpts, ypts);
    </pre>
    </div>
    <p>The line is a series of points that are joined by straight segments. So first of all we set up an array of
    the x coordinates for these points and a matching array of y coordinates. Then we call giza_line which takes
    as arguments the number of points to be joined, then an array on the x coordinates followed by an array
    of y coordinates.</p>

    <h2>Labeling the axes</h2>
    <p>Next we will label the axes.</p>
    <div class="code">
    <pre>
giza_annotate ("B", 2.5, 0.5, 0.5, "Furlongs");
giza_annotate ("L", 2.5, 0.5, 0.5, "Parsecs");
    </pre>
    </div>
    <p>The first argument for annotate specifies which side of the box the text is positioned relative to. Some
    of the options are "B" for bottom, "L" for left, "T" for top and "R" for right. The next argument specifies
    how far outside of the box the text is drawn. It is specified in units of character height. The third argument
    specifies the position of the text along the specified edge of the box, as a fraction of the edge. The fourth
    argument specifies the justification of the text, 0.0 for left justified, 0.5 for centre justified and 1
    for right justified etc. The final argument specifies the string of text to be drawn.</p>

    <h2>Closing the device</h2>
    <p>Now last of all we close the gize device:</p>
    <div class="code">
      giza_close_device ();
    </div>

    <h2>Compiling the code</h2>
    <p>Open a terminal and change into the directory containing the gettingstarted.c file, then run the following
    commands to compile then run your code:</p>
    <div class="code">
    <pre>
gcc -o gettingstarted gettingstarted.c -lgiza
./gettingstarted
    </pre>
    </div>
    <p>If you installed giza to a non-standard directory you may need to also give gcc the path to this location.
    for example:</p>
    <div class="code">
    <pre>
gcc -o -gettingstarted gettingstarted.c -L/path/to/giza/installation -lgiza
    </pre>
    </div>
  </div>
</html>