← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/docbook/src/plshade1.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:
doc/docbook/src/plshade1.html
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="AEN7803"
 
96
NAME="AEN8662"
97
97
></A
98
98
><TABLE
99
99
CLASS="funcprototype"
188
188
><TD
189
189
><DL
190
190
><DT
191
 
><VAR
 
191
><CODE
192
192
CLASS="parameter"
193
 
>a</VAR
 
193
>a</CODE
194
194
>
195
 
          (<VAR
 
195
          (<TT
196
196
CLASS="literal"
197
 
>PLFLT *</VAR
 
197
>PLFLT *</TT
198
198
>, input)</DT
199
199
><DD
200
200
><P
203
203
          </P
204
204
></DD
205
205
><DT
206
 
><VAR
 
206
><CODE
207
207
CLASS="parameter"
208
 
>nx</VAR
 
208
>nx</CODE
209
209
>
210
 
          (<VAR
 
210
          (<TT
211
211
CLASS="literal"
212
 
>PLINT</VAR
 
212
>PLINT</TT
213
213
>, input)</DT
214
214
><DD
215
215
><P
217
217
          </P
218
218
></DD
219
219
><DT
220
 
><VAR
 
220
><CODE
221
221
CLASS="parameter"
222
 
>ny</VAR
 
222
>ny</CODE
223
223
>
224
 
          (<VAR
 
224
          (<TT
225
225
CLASS="literal"
226
 
>PLINT</VAR
 
226
>PLINT</TT
227
227
>, input)</DT
228
228
><DD
229
229
><P
231
231
          </P
232
232
></DD
233
233
><DT
234
 
><VAR
 
234
><CODE
235
235
CLASS="parameter"
236
 
>defined</VAR
 
236
>defined</CODE
237
237
>
238
 
          (<VAR
 
238
          (<TT
239
239
CLASS="literal"
240
 
>PLINT (*) (PLFLT, PLFLT)</VAR
 
240
>PLINT (*) (PLFLT, PLFLT)</TT
241
241
>, input)</DT
242
242
><DD
243
243
><P
249
249
          </P
250
250
></DD
251
251
><DT
252
 
><VAR
 
252
><CODE
253
253
CLASS="parameter"
254
 
>xmin</VAR
 
254
>xmin</CODE
255
255
>
256
 
          (<VAR
 
256
          (<TT
257
257
CLASS="literal"
258
 
>PLFLT</VAR
 
258
>PLFLT</TT
259
259
>, input)</DT
260
260
><DD
261
261
><P
265
265
          </P
266
266
></DD
267
267
><DT
268
 
><VAR
269
 
CLASS="parameter"
270
 
>xmax</VAR
271
 
>
272
 
          (<VAR
273
 
CLASS="literal"
274
 
>PLFLT</VAR
275
 
>, input)</DT
276
 
><DD
277
 
><P
278
 
>             Defines the "grid" coordinates.  The data a[0][0] has a
279
 
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
280
 
             and so on.
281
 
          </P
282
 
></DD
283
 
><DT
284
 
><VAR
285
 
CLASS="parameter"
286
 
>ymin</VAR
287
 
>
288
 
          (<VAR
289
 
CLASS="literal"
290
 
>PLFLT</VAR
291
 
>, input)</DT
292
 
><DD
293
 
><P
294
 
>             Defines the "grid" coordinates.  The data a[0][0] has a
295
 
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
296
 
             and so on.
297
 
          </P
298
 
></DD
299
 
><DT
300
 
><VAR
301
 
CLASS="parameter"
302
 
>ymax</VAR
303
 
>
304
 
          (<VAR
305
 
CLASS="literal"
306
 
>PLFLT</VAR
307
 
>, input)</DT
308
 
><DD
309
 
><P
310
 
>             Defines the "grid" coordinates.  The data a[0][0] has a
311
 
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
312
 
             and so on.
313
 
          </P
314
 
></DD
315
 
><DT
316
 
><VAR
317
 
CLASS="parameter"
318
 
>shade_min</VAR
319
 
>
320
 
          (<VAR
321
 
CLASS="literal"
322
 
>PLFLT</VAR
 
268
><CODE
 
269
CLASS="parameter"
 
270
>xmax</CODE
 
271
>
 
272
          (<TT
 
273
CLASS="literal"
 
274
>PLFLT</TT
 
275
>, input)</DT
 
276
><DD
 
277
><P
 
278
>             Defines the "grid" coordinates.  The data a[0][0] has a
 
279
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
 
280
             and so on.
 
281
          </P
 
282
></DD
 
283
><DT
 
284
><CODE
 
285
CLASS="parameter"
 
286
>ymin</CODE
 
287
>
 
288
          (<TT
 
289
CLASS="literal"
 
290
>PLFLT</TT
 
291
>, input)</DT
 
292
><DD
 
293
><P
 
294
>             Defines the "grid" coordinates.  The data a[0][0] has a
 
295
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
 
296
             and so on.
 
297
          </P
 
298
></DD
 
299
><DT
 
300
><CODE
 
301
CLASS="parameter"
 
302
>ymax</CODE
 
303
>
 
304
          (<TT
 
305
CLASS="literal"
 
306
>PLFLT</TT
 
307
>, input)</DT
 
308
><DD
 
309
><P
 
310
>             Defines the "grid" coordinates.  The data a[0][0] has a
 
311
             position of (xmin,ymin), a[nx-1][0] has a position at (xmax,ymin)
 
312
             and so on.
 
313
          </P
 
314
></DD
 
315
><DT
 
316
><CODE
 
317
CLASS="parameter"
 
318
>shade_min</CODE
 
319
>
 
320
          (<TT
 
321
CLASS="literal"
 
322
>PLFLT</TT
323
323
>, input)</DT
324
324
><DD
325
325
><P
334
334
          </P
335
335
></DD
336
336
><DT
337
 
><VAR
 
337
><CODE
338
338
CLASS="parameter"
339
 
>shade_max</VAR
 
339
>shade_max</CODE
340
340
>
341
 
          (<VAR
 
341
          (<TT
342
342
CLASS="literal"
343
 
>PLFLT</VAR
 
343
>PLFLT</TT
344
344
>, input)</DT
345
345
><DD
346
346
><P
356
356
          </P
357
357
></DD
358
358
><DT
359
 
><VAR
 
359
><CODE
360
360
CLASS="parameter"
361
 
>sh_cmap</VAR
 
361
>sh_cmap</CODE
362
362
>
363
 
          (<VAR
 
363
          (<TT
364
364
CLASS="literal"
365
 
>PLINT</VAR
 
365
>PLINT</TT
366
366
>, input)</DT
367
367
><DD
368
368
><P
370
370
          </P
371
371
></DD
372
372
><DT
373
 
><VAR
 
373
><CODE
374
374
CLASS="parameter"
375
 
>sh_color</VAR
 
375
>sh_color</CODE
376
376
>
377
 
          (<VAR
 
377
          (<TT
378
378
CLASS="literal"
379
 
>PLFLT</VAR
 
379
>PLFLT</TT
380
380
>, input)</DT
381
381
><DD
382
382
><P
385
385
          </P
386
386
></DD
387
387
><DT
388
 
><VAR
 
388
><CODE
389
389
CLASS="parameter"
390
 
>sh_width</VAR
 
390
>sh_width</CODE
391
391
>
392
 
          (<VAR
 
392
          (<TT
393
393
CLASS="literal"
394
 
>PLINT</VAR
 
394
>PLINT</TT
395
395
>, input)</DT
396
396
><DD
397
397
><P
399
399
          </P
400
400
></DD
401
401
><DT
402
 
><VAR
403
 
CLASS="parameter"
404
 
>min_color</VAR
405
 
>
406
 
          (<VAR
407
 
CLASS="literal"
408
 
>PLINT</VAR
409
 
>, input)</DT
410
 
><DD
411
 
><P
412
 
>            Defines pen color, width used by the boundary of shaded region.
413
 
            The min values are used for the shade_min boundary, and the max
414
 
            values are used on the shade_max boundary.  Set color and width
415
 
            to zero for no plotted boundaries.
416
 
          </P
417
 
></DD
418
 
><DT
419
 
><VAR
420
 
CLASS="parameter"
421
 
>min_width</VAR
422
 
>
423
 
          (<VAR
424
 
CLASS="literal"
425
 
>PLINT</VAR
426
 
>, input)</DT
427
 
><DD
428
 
><P
429
 
>            Defines pen color, width used by the boundary of shaded region.
430
 
            The min values are used for the shade_min boundary, and the max
431
 
            values are used on the shade_max boundary.  Set color and width
432
 
            to zero for no plotted boundaries.
433
 
          </P
434
 
></DD
435
 
><DT
436
 
><VAR
437
 
CLASS="parameter"
438
 
>max_color</VAR
439
 
>
440
 
          (<VAR
441
 
CLASS="literal"
442
 
>PLINT</VAR
443
 
>, input)</DT
444
 
><DD
445
 
><P
446
 
>            Defines pen color, width used by the boundary of shaded region.
447
 
            The min values are used for the shade_min boundary, and the max
448
 
            values are used on the shade_max boundary.  Set color and width
449
 
            to zero for no plotted boundaries.
450
 
          </P
451
 
></DD
452
 
><DT
453
 
><VAR
454
 
CLASS="parameter"
455
 
>max_width</VAR
456
 
>
457
 
          (<VAR
458
 
CLASS="literal"
459
 
>PLINT</VAR
460
 
>, input)</DT
461
 
><DD
462
 
><P
463
 
>            Defines pen color, width used by the boundary of shaded region.
464
 
            The min values are used for the shade_min boundary, and the max
465
 
            values are used on the shade_max boundary.  Set color and width
466
 
            to zero for no plotted boundaries.
467
 
          </P
468
 
></DD
469
 
><DT
470
 
><VAR
471
 
CLASS="parameter"
472
 
>fill</VAR
473
 
>
474
 
          (<VAR
475
 
CLASS="literal"
476
 
>void (*) (PLINT, PLFLT *, PLFLT *)</VAR
 
402
><CODE
 
403
CLASS="parameter"
 
404
>min_color</CODE
 
405
>
 
406
          (<TT
 
407
CLASS="literal"
 
408
>PLINT</TT
 
409
>, input)</DT
 
410
><DD
 
411
><P
 
412
>            Defines pen color, width used by the boundary of shaded region.
 
413
            The min values are used for the shade_min boundary, and the max
 
414
            values are used on the shade_max boundary.  Set color and width
 
415
            to zero for no plotted boundaries.
 
416
          </P
 
417
></DD
 
418
><DT
 
419
><CODE
 
420
CLASS="parameter"
 
421
>min_width</CODE
 
422
>
 
423
          (<TT
 
424
CLASS="literal"
 
425
>PLINT</TT
 
426
>, input)</DT
 
427
><DD
 
428
><P
 
429
>            Defines pen color, width used by the boundary of shaded region.
 
430
            The min values are used for the shade_min boundary, and the max
 
431
            values are used on the shade_max boundary.  Set color and width
 
432
            to zero for no plotted boundaries.
 
433
          </P
 
434
></DD
 
435
><DT
 
436
><CODE
 
437
CLASS="parameter"
 
438
>max_color</CODE
 
439
>
 
440
          (<TT
 
441
CLASS="literal"
 
442
>PLINT</TT
 
443
>, input)</DT
 
444
><DD
 
445
><P
 
446
>            Defines pen color, width used by the boundary of shaded region.
 
447
            The min values are used for the shade_min boundary, and the max
 
448
            values are used on the shade_max boundary.  Set color and width
 
449
            to zero for no plotted boundaries.
 
450
          </P
 
451
></DD
 
452
><DT
 
453
><CODE
 
454
CLASS="parameter"
 
455
>max_width</CODE
 
456
>
 
457
          (<TT
 
458
CLASS="literal"
 
459
>PLINT</TT
 
460
>, input)</DT
 
461
><DD
 
462
><P
 
463
>            Defines pen color, width used by the boundary of shaded region.
 
464
            The min values are used for the shade_min boundary, and the max
 
465
            values are used on the shade_max boundary.  Set color and width
 
466
            to zero for no plotted boundaries.
 
467
          </P
 
468
></DD
 
469
><DT
 
470
><CODE
 
471
CLASS="parameter"
 
472
>fill</CODE
 
473
>
 
474
          (<TT
 
475
CLASS="literal"
 
476
>void (*) (PLINT, PLFLT *, PLFLT *)</TT
477
477
>, input)</DT
478
478
><DD
479
479
><P
488
488
          </P
489
489
></DD
490
490
><DT
491
 
><VAR
 
491
><CODE
492
492
CLASS="parameter"
493
 
>rectangular</VAR
 
493
>rectangular</CODE
494
494
>
495
 
          (<VAR
 
495
          (<TT
496
496
CLASS="literal"
497
 
>PLINT</VAR
 
497
>PLBOOL</TT
498
498
>, input)</DT
499
499
><DD
500
500
><P
501
 
>         Set <VAR
 
501
>         Set <TT
502
502
CLASS="literal"
503
 
><VAR
 
503
><CODE
504
504
CLASS="parameter"
505
 
>rectangular</VAR
506
 
></VAR
507
 
> to 1
 
505
>rectangular</CODE
 
506
></TT
 
507
> to true
508
508
          if rectangles map to rectangles after coordinate transformation
509
 
          with <VAR
 
509
          with <TT
510
510
CLASS="literal"
511
 
><VAR
 
511
><CODE
512
512
CLASS="parameter"
513
 
>pltrl</VAR
514
 
></VAR
 
513
>pltrl</CODE
 
514
></TT
515
515
>.  Otherwise,
516
 
          set <VAR
517
 
CLASS="literal"
518
 
><VAR
519
 
CLASS="parameter"
520
 
>rectangular</VAR
521
 
></VAR
522
 
> to 0.
523
 
          If <VAR
524
 
CLASS="literal"
525
 
><VAR
526
 
CLASS="parameter"
527
 
>rectangular</VAR
528
 
></VAR
 
516
          set <TT
 
517
CLASS="literal"
 
518
><CODE
 
519
CLASS="parameter"
 
520
>rectangular</CODE
 
521
></TT
 
522
> to false.
 
523
          If <TT
 
524
CLASS="literal"
 
525
><CODE
 
526
CLASS="parameter"
 
527
>rectangular</CODE
 
528
></TT
529
529
>
530
 
          is set to 1, plshade tries to save time by
 
530
          is set to true, plshade tries to save time by
531
531
          filling large rectangles.  This optimization fails if
532
532
          the coordinate transformation distorts the shape of rectangles.
533
 
          For example a plot in polor coordinates has to have rectangular
534
 
          set to 0.
 
533
          For example a plot in polor coordinates has to have
 
534
          <TT
 
535
CLASS="literal"
 
536
><CODE
 
537
CLASS="parameter"
 
538
>rectangular</CODE
 
539
></TT
 
540
>
 
541
          set to false.
535
542
          </P
536
543
></DD
537
544
><DT
538
 
><VAR
 
545
><CODE
539
546
CLASS="parameter"
540
 
>pltr</VAR
 
547
>pltr</CODE
541
548
>
542
 
          (<VAR
 
549
          (<TT
543
550
CLASS="literal"
544
551
>void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer)
545
 
           </VAR
 
552
           </TT
546
553
>, input)</DT
547
554
><DD
548
555
><P
549
556
>           Pointer to function that defines transformation between indices
550
 
            in array <VAR
 
557
            in array <TT
551
558
CLASS="literal"
552
 
><VAR
 
559
><CODE
553
560
CLASS="parameter"
554
 
>z</VAR
555
 
></VAR
 
561
>z</CODE
 
562
></TT
556
563
> and the
557
564
            world coordinates (C only).  Transformation functions are
558
565
            provided in the PLplot library:
608
615
          </P
609
616
></DD
610
617
><DT
611
 
><VAR
 
618
><CODE
612
619
CLASS="parameter"
613
 
>pltr_data</VAR
 
620
>pltr_data</CODE
614
621
>
615
 
          (<VAR
 
622
          (<TT
616
623
CLASS="literal"
617
 
>PLPointer</VAR
 
624
>PLPointer</TT
618
625
>, input)</DT
619
626
><DD
620
627
><P