~ubuntu-branches/ubuntu/intrepid/plplot/intrepid

« back to all changes in this revision

Viewing changes to doc/docbook/src/plshades.html

  • Committer: Bazaar Package Importer
  • Author(s): Rafael Laboissiere
  • Date: 2006-11-04 10:19:34 UTC
  • mfrom: (2.1.8 edgy)
  • Revision ID: james.westby@ubuntu.com-20061104101934-mlirvdg4gpwi6i5q
Tags: 5.6.1-10
* Orphaning the package
* debian/control: Changed the maintainer to the Debian QA Group

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
2
2
<HTML
3
3
><HEAD
4
4
><TITLE
6
6
    </TITLE
7
7
><META
8
8
NAME="GENERATOR"
9
 
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
 
9
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
10
10
REL="HOME"
11
11
TITLE="The PLplot Plotting Library"
12
12
HREF="index.html"><LINK
61
61
WIDTH="80%"
62
62
ALIGN="center"
63
63
VALIGN="bottom"
64
 
>Chapter 16. The Common API for PLplot</TD
 
64
>Chapter 17. The Common API for PLplot</TD
65
65
><TD
66
66
WIDTH="10%"
67
67
ALIGN="right"
93
93
><P
94
94
></P
95
95
><A
96
 
NAME="AEN7432"
 
96
NAME="AEN8289"
97
97
></A
98
98
><TABLE
99
99
CLASS="funcprototype"
147
147
><TD
148
148
><DL
149
149
><DT
150
 
><VAR
 
150
><CODE
151
151
CLASS="parameter"
152
 
>a</VAR
 
152
>a</CODE
153
153
>
154
 
          (<VAR
 
154
          (<TT
155
155
CLASS="literal"
156
 
>PLFLT **</VAR
 
156
>PLFLT **</TT
157
157
>, input)</DT
158
158
><DD
159
159
><P
162
162
          </P
163
163
></DD
164
164
><DT
165
 
><VAR
 
165
><CODE
166
166
CLASS="parameter"
167
 
>nx</VAR
 
167
>nx</CODE
168
168
>
169
 
          (<VAR
 
169
          (<TT
170
170
CLASS="literal"
171
 
>PLINT</VAR
 
171
>PLINT</TT
172
172
>, input)</DT
173
173
><DD
174
174
><P
176
176
          </P
177
177
></DD
178
178
><DT
179
 
><VAR
 
179
><CODE
180
180
CLASS="parameter"
181
 
>ny</VAR
 
181
>ny</CODE
182
182
>
183
 
          (<VAR
 
183
          (<TT
184
184
CLASS="literal"
185
 
>PLINT</VAR
 
185
>PLINT</TT
186
186
>, input)</DT
187
187
><DD
188
188
><P
190
190
          </P
191
191
></DD
192
192
><DT
193
 
><VAR
 
193
><CODE
194
194
CLASS="parameter"
195
 
>defined</VAR
 
195
>defined</CODE
196
196
>
197
 
          (<VAR
 
197
          (<TT
198
198
CLASS="literal"
199
 
>PLINT (*) (PLFLT, PLFLT)</VAR
 
199
>PLINT (*) (PLFLT, PLFLT)</TT
200
200
>, input)</DT
201
201
><DD
202
202
><P
208
208
          </P
209
209
></DD
210
210
><DT
211
 
><VAR
 
211
><CODE
212
212
CLASS="parameter"
213
 
>xmin</VAR
 
213
>xmin</CODE
214
214
>
215
 
          (<VAR
 
215
          (<TT
216
216
CLASS="literal"
217
 
>PLFLT</VAR
 
217
>PLFLT</TT
218
218
>, input)</DT
219
219
><DD
220
220
><P
225
225
          </P
226
226
></DD
227
227
><DT
228
 
><VAR
229
 
CLASS="parameter"
230
 
>xmax</VAR
231
 
>
232
 
          (<VAR
233
 
CLASS="literal"
234
 
>PLFLT</VAR
235
 
>, input)</DT
236
 
><DD
237
 
><P
238
 
>             Defines the "grid" coordinates.  The data a[0][0] has a
239
 
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
240
 
             and so on.
241
 
          </P
242
 
></DD
243
 
><DT
244
 
><VAR
245
 
CLASS="parameter"
246
 
>ymin</VAR
247
 
>
248
 
          (<VAR
249
 
CLASS="literal"
250
 
>PLFLT</VAR
251
 
>, input)</DT
252
 
><DD
253
 
><P
254
 
>             Defines the "grid" coordinates.  The data a[0][0] has a
255
 
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
256
 
             and so on.
257
 
          </P
258
 
></DD
259
 
><DT
260
 
><VAR
261
 
CLASS="parameter"
262
 
>ymax</VAR
263
 
>
264
 
          (<VAR
265
 
CLASS="literal"
266
 
>PLFLT</VAR
267
 
>, input)</DT
268
 
><DD
269
 
><P
270
 
>             Defines the "grid" coordinates.  The data a[0][0] has a
271
 
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
272
 
             and so on.
273
 
          </P
274
 
></DD
275
 
><DT
276
 
><VAR
277
 
CLASS="parameter"
278
 
>clevel</VAR
279
 
>
280
 
          (<VAR
281
 
CLASS="literal"
282
 
>PLFLT *</VAR
 
228
><CODE
 
229
CLASS="parameter"
 
230
>xmax</CODE
 
231
>
 
232
          (<TT
 
233
CLASS="literal"
 
234
>PLFLT</TT
 
235
>, input)</DT
 
236
><DD
 
237
><P
 
238
>             Defines the "grid" coordinates.  The data a[0][0] has a
 
239
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
 
240
             and so on.
 
241
          </P
 
242
></DD
 
243
><DT
 
244
><CODE
 
245
CLASS="parameter"
 
246
>ymin</CODE
 
247
>
 
248
          (<TT
 
249
CLASS="literal"
 
250
>PLFLT</TT
 
251
>, input)</DT
 
252
><DD
 
253
><P
 
254
>             Defines the "grid" coordinates.  The data a[0][0] has a
 
255
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
 
256
             and so on.
 
257
          </P
 
258
></DD
 
259
><DT
 
260
><CODE
 
261
CLASS="parameter"
 
262
>ymax</CODE
 
263
>
 
264
          (<TT
 
265
CLASS="literal"
 
266
>PLFLT</TT
 
267
>, input)</DT
 
268
><DD
 
269
><P
 
270
>             Defines the "grid" coordinates.  The data a[0][0] has a
 
271
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
 
272
             and so on.
 
273
          </P
 
274
></DD
 
275
><DT
 
276
><CODE
 
277
CLASS="parameter"
 
278
>clevel</CODE
 
279
>
 
280
          (<TT
 
281
CLASS="literal"
 
282
>PLFLT *</TT
283
283
>, input)</DT
284
284
><DD
285
285
><P
289
289
          </P
290
290
></DD
291
291
><DT
292
 
><VAR
 
292
><CODE
293
293
CLASS="parameter"
294
 
>nlevel</VAR
 
294
>nlevel</CODE
295
295
>
296
 
          (<VAR
 
296
          (<TT
297
297
CLASS="literal"
298
 
>PLINT</VAR
 
298
>PLINT</TT
299
299
>, input)</DT
300
300
><DD
301
301
><P
302
302
>            Number of shades plus 1 (i.e., the number of shade edge values
303
 
            in <VAR
 
303
            in <TT
304
304
CLASS="literal"
305
 
><VAR
 
305
><CODE
306
306
CLASS="parameter"
307
 
>clevel</VAR
308
 
></VAR
 
307
>clevel</CODE
 
308
></TT
309
309
>).
310
310
          </P
311
311
></DD
312
312
><DT
313
 
><VAR
 
313
><CODE
314
314
CLASS="parameter"
315
 
>fill_width</VAR
 
315
>fill_width</CODE
316
316
>
317
 
          (<VAR
 
317
          (<TT
318
318
CLASS="literal"
319
 
>PLINT</VAR
 
319
>PLINT</TT
320
320
>, input)</DT
321
321
><DD
322
322
><P
324
324
          </P
325
325
></DD
326
326
><DT
327
 
><VAR
 
327
><CODE
328
328
CLASS="parameter"
329
 
>cont_color</VAR
 
329
>cont_color</CODE
330
330
>
331
 
          (<VAR
 
331
          (<TT
332
332
CLASS="literal"
333
 
>PLINT</VAR
 
333
>PLINT</TT
334
334
>, input)</DT
335
335
><DD
336
336
><P
340
340
          </P
341
341
></DD
342
342
><DT
343
 
><VAR
 
343
><CODE
344
344
CLASS="parameter"
345
 
>cont_width</VAR
 
345
>cont_width</CODE
346
346
>
347
 
          (<VAR
 
347
          (<TT
348
348
CLASS="literal"
349
 
>PLINT</VAR
 
349
>PLINT</TT
350
350
>, input)</DT
351
351
><DD
352
352
><P
357
357
          </P
358
358
></DD
359
359
><DT
360
 
><VAR
 
360
><CODE
361
361
CLASS="parameter"
362
 
>fill</VAR
 
362
>fill</CODE
363
363
>
364
 
          (<VAR
 
364
          (<TT
365
365
CLASS="literal"
366
 
>void (*) (PLINT, PLFLT *, PLFLT *)</VAR
 
366
>void (*) (PLINT, PLFLT *, PLFLT *)</TT
367
367
>, input)</DT
368
368
><DD
369
369
><P
378
378
          </P
379
379
></DD
380
380
><DT
381
 
><VAR
 
381
><CODE
382
382
CLASS="parameter"
383
 
>rectangular</VAR
 
383
>rectangular</CODE
384
384
>
385
 
          (<VAR
 
385
          (<TT
386
386
CLASS="literal"
387
 
>PLINT</VAR
 
387
>PLBOOL</TT
388
388
>, input)</DT
389
389
><DD
390
390
><P
391
 
>         Set <VAR
 
391
>         Set <TT
392
392
CLASS="literal"
393
 
><VAR
 
393
><CODE
394
394
CLASS="parameter"
395
 
>rectangular</VAR
396
 
></VAR
397
 
> to 1
 
395
>rectangular</CODE
 
396
></TT
 
397
> to true
398
398
          if rectangles map to rectangles after coordinate transformation
399
 
          with <VAR
 
399
          with <TT
400
400
CLASS="literal"
401
 
><VAR
 
401
><CODE
402
402
CLASS="parameter"
403
 
>pltrl</VAR
404
 
></VAR
 
403
>pltrl</CODE
 
404
></TT
405
405
>.  Otherwise,
406
 
          set <VAR
407
 
CLASS="literal"
408
 
><VAR
409
 
CLASS="parameter"
410
 
>rectangular</VAR
411
 
></VAR
412
 
> to 0.
413
 
          If <VAR
414
 
CLASS="literal"
415
 
><VAR
416
 
CLASS="parameter"
417
 
>rectangular</VAR
418
 
></VAR
 
406
          set <TT
 
407
CLASS="literal"
 
408
><CODE
 
409
CLASS="parameter"
 
410
>rectangular</CODE
 
411
></TT
 
412
> to false.
 
413
          If <TT
 
414
CLASS="literal"
 
415
><CODE
 
416
CLASS="parameter"
 
417
>rectangular</CODE
 
418
></TT
419
419
>
420
 
          is set to 1, plshade tries to save time by
 
420
          is set to true, plshade tries to save time by
421
421
          filling large rectangles.  This optimization fails if
422
422
          the coordinate transformation distorts the shape of rectangles.
423
 
          For example a plot in polor coordinates has to have rectangular
424
 
          set to 0.
 
423
          For example a plot in polor coordinates has to have 
 
424
          <TT
 
425
CLASS="literal"
 
426
><CODE
 
427
CLASS="parameter"
 
428
>rectangular</CODE
 
429
></TT
 
430
>
 
431
          set to false.
425
432
          </P
426
433
></DD
427
434
><DT
428
 
><VAR
 
435
><CODE
429
436
CLASS="parameter"
430
 
>pltr</VAR
 
437
>pltr</CODE
431
438
>
432
 
          (<VAR
 
439
          (<TT
433
440
CLASS="literal"
434
441
>void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer)
435
 
           </VAR
 
442
           </TT
436
443
>, input)</DT
437
444
><DD
438
445
><P
439
446
>           Pointer to function that defines transformation between indices
440
 
            in array <VAR
 
447
            in array <TT
441
448
CLASS="literal"
442
 
><VAR
 
449
><CODE
443
450
CLASS="parameter"
444
 
>z</VAR
445
 
></VAR
 
451
>z</CODE
 
452
></TT
446
453
> and the
447
454
            world coordinates (C only).  Transformation functions are
448
455
            provided in the PLplot library:
498
505
          </P
499
506
></DD
500
507
><DT
501
 
><VAR
 
508
><CODE
502
509
CLASS="parameter"
503
 
>pltr_data</VAR
 
510
>pltr_data</CODE
504
511
>
505
 
          (<VAR
 
512
          (<TT
506
513
CLASS="literal"
507
 
>PLPointer</VAR
 
514
>PLPointer</TT
508
515
>, input)</DT
509
516
><DD
510
517
><P