← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/docbook/src/plgriddata.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/plgriddata.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
7
7
    </TITLE
8
8
><META
9
9
NAME="GENERATOR"
10
 
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
 
10
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
11
11
REL="HOME"
12
12
TITLE="The PLplot Plotting Library"
13
13
HREF="index.html"><LINK
62
62
WIDTH="80%"
63
63
ALIGN="center"
64
64
VALIGN="bottom"
65
 
>Chapter 16. The Common API for PLplot</TD
 
65
>Chapter 17. The Common API for PLplot</TD
66
66
><TD
67
67
WIDTH="10%"
68
68
ALIGN="right"
95
95
><P
96
96
></P
97
97
><A
98
 
NAME="AEN4820"
 
98
NAME="AEN5508"
99
99
></A
100
100
><TABLE
101
101
CLASS="funcprototype"
117
117
>      Real world data is frequently irregularly sampled, but all PLplot 3D
118
118
      plots require data placed in a uniform grid. This function takes
119
119
      irregularly sampled data from three input arrays
120
 
      <VAR
121
 
CLASS="literal"
122
 
>x[npts]</VAR
123
 
>, <VAR
124
 
CLASS="literal"
125
 
>y[npts]</VAR
 
120
      <TT
 
121
CLASS="literal"
 
122
>x[npts]</TT
 
123
>, <TT
 
124
CLASS="literal"
 
125
>y[npts]</TT
126
126
>, and
127
 
      <VAR
 
127
      <TT
128
128
CLASS="literal"
129
 
>z[npts]</VAR
 
129
>z[npts]</TT
130
130
>, reads the desired grid location from
131
 
      input arrays <VAR
 
131
      input arrays <TT
132
132
CLASS="literal"
133
 
>xg[nptsx]</VAR
 
133
>xg[nptsx]</TT
134
134
> and
135
 
      <VAR
 
135
      <TT
136
136
CLASS="literal"
137
 
>yg[nptsy]</VAR
 
137
>yg[nptsy]</TT
138
138
>, and returns the gridded data into
139
 
      output array <VAR
 
139
      output array <TT
140
140
CLASS="literal"
141
 
>zg[nptsx][nptsy]</VAR
 
141
>zg[nptsx][nptsy]</TT
142
142
>.  The algorithm used
143
143
      to grid the data is specified with the argument
144
 
      <VAR
 
144
      <TT
145
145
CLASS="literal"
146
 
>type</VAR
 
146
>type</TT
147
147
> which can have one parameter specified in
148
 
      argument <VAR
 
148
      argument <TT
149
149
CLASS="literal"
150
 
>data</VAR
 
150
>data</TT
151
151
>.
152
152
    </P
153
153
><TABLE
156
156
><TD
157
157
><DL
158
158
><DT
159
 
><VAR
160
 
CLASS="parameter"
161
 
>x</VAR
162
 
>
163
 
          (<VAR
164
 
CLASS="literal"
165
 
>PLFLT *</VAR
166
 
>, input)</DT
167
 
><DD
168
 
><P
169
 
>           The input <VAR
170
 
CLASS="literal"
171
 
>x</VAR
172
 
> array.
173
 
          </P
174
 
></DD
175
 
><DT
176
 
><VAR
177
 
CLASS="parameter"
178
 
>y</VAR
179
 
>
180
 
          (<VAR
181
 
CLASS="literal"
182
 
>PLFLT *</VAR
183
 
>, input)</DT
184
 
><DD
185
 
><P
186
 
>           The input <VAR
187
 
CLASS="literal"
188
 
>y</VAR
189
 
> array.
190
 
          </P
191
 
></DD
192
 
><DT
193
 
><VAR
194
 
CLASS="parameter"
195
 
>z</VAR
196
 
>
197
 
          (<VAR
198
 
CLASS="literal"
199
 
>PLFLT *</VAR
200
 
>, input)</DT
201
 
><DD
202
 
><P
203
 
>           The input <VAR
204
 
CLASS="literal"
205
 
>z</VAR
 
159
><CODE
 
160
CLASS="parameter"
 
161
>x</CODE
 
162
>
 
163
          (<TT
 
164
CLASS="literal"
 
165
>PLFLT *</TT
 
166
>, input)</DT
 
167
><DD
 
168
><P
 
169
>           The input <TT
 
170
CLASS="literal"
 
171
>x</TT
 
172
> array.
 
173
          </P
 
174
></DD
 
175
><DT
 
176
><CODE
 
177
CLASS="parameter"
 
178
>y</CODE
 
179
>
 
180
          (<TT
 
181
CLASS="literal"
 
182
>PLFLT *</TT
 
183
>, input)</DT
 
184
><DD
 
185
><P
 
186
>           The input <TT
 
187
CLASS="literal"
 
188
>y</TT
 
189
> array.
 
190
          </P
 
191
></DD
 
192
><DT
 
193
><CODE
 
194
CLASS="parameter"
 
195
>z</CODE
 
196
>
 
197
          (<TT
 
198
CLASS="literal"
 
199
>PLFLT *</TT
 
200
>, input)</DT
 
201
><DD
 
202
><P
 
203
>           The input <TT
 
204
CLASS="literal"
 
205
>z</TT
206
206
> array. Each triple
207
 
            <VAR
208
 
CLASS="literal"
209
 
>x[i]</VAR
210
 
>, <VAR
211
 
CLASS="literal"
212
 
>y[i]</VAR
 
207
            <TT
 
208
CLASS="literal"
 
209
>x[i]</TT
 
210
>, <TT
 
211
CLASS="literal"
 
212
>y[i]</TT
213
213
>,
214
 
            <VAR
 
214
            <TT
215
215
CLASS="literal"
216
 
>z[i]</VAR
 
216
>z[i]</TT
217
217
> represents one data sample coordinates.
218
218
          </P
219
219
></DD
220
220
><DT
221
 
><VAR
 
221
><CODE
222
222
CLASS="parameter"
223
 
>npts</VAR
 
223
>npts</CODE
224
224
>
225
 
          (<VAR
 
225
          (<TT
226
226
CLASS="literal"
227
 
>PLINT</VAR
 
227
>PLINT</TT
228
228
>, input)</DT
229
229
><DD
230
230
><P
231
 
>           The number of data samples in the <VAR
 
231
>           The number of data samples in the <TT
232
232
CLASS="literal"
233
 
>x</VAR
 
233
>x</TT
234
234
>,
235
 
            <VAR
236
 
CLASS="literal"
237
 
>y</VAR
238
 
> and <VAR
239
 
CLASS="literal"
240
 
>z</VAR
 
235
            <TT
 
236
CLASS="literal"
 
237
>y</TT
 
238
> and <TT
 
239
CLASS="literal"
 
240
>z</TT
241
241
> arrays.
242
242
          </P
243
243
></DD
244
244
><DT
245
 
><VAR
 
245
><CODE
246
246
CLASS="parameter"
247
 
>xg</VAR
 
247
>xg</CODE
248
248
>
249
 
          (<VAR
 
249
          (<TT
250
250
CLASS="literal"
251
 
>PLFLT *</VAR
 
251
>PLFLT *</TT
252
252
>, input)</DT
253
253
><DD
254
254
><P
255
255
>           The input array that specifies the grid spacing in the x
256
 
            direction. Usually <VAR
 
256
            direction. Usually <TT
257
257
CLASS="literal"
258
 
>xg</VAR
 
258
>xg</TT
259
259
> has
260
 
            <VAR
 
260
            <TT
261
261
CLASS="literal"
262
 
>nptsx</VAR
 
262
>nptsx</TT
263
263
> equaly spaced values from the mininum
264
 
            to the maximum values of the <VAR
 
264
            to the maximum values of the <TT
265
265
CLASS="literal"
266
 
>x</VAR
 
266
>x</TT
267
267
> input array.
268
268
          </P
269
269
></DD
270
270
><DT
271
 
><VAR
 
271
><CODE
272
272
CLASS="parameter"
273
 
>nptsx</VAR
 
273
>nptsx</CODE
274
274
>
275
 
          (<VAR
 
275
          (<TT
276
276
CLASS="literal"
277
 
>PLINT</VAR
 
277
>PLINT</TT
278
278
>, input)</DT
279
279
><DD
280
280
><P
281
 
>           The number of points in the <VAR
 
281
>           The number of points in the <TT
282
282
CLASS="literal"
283
 
>xg</VAR
 
283
>xg</TT
284
284
> array.
285
285
          </P
286
286
></DD
287
287
><DT
288
 
><VAR
 
288
><CODE
289
289
CLASS="parameter"
290
 
>yg</VAR
 
290
>yg</CODE
291
291
>
292
 
          (<VAR
 
292
          (<TT
293
293
CLASS="literal"
294
 
>PLFLT *</VAR
 
294
>PLFLT *</TT
295
295
>, input)</DT
296
296
><DD
297
297
><P
298
298
>           The input array that specifies the grid spacing in the y
299
 
            direction. Similar to the <VAR
 
299
            direction. Similar to the <TT
300
300
CLASS="literal"
301
 
>xg</VAR
 
301
>xg</TT
302
302
> parameter.
303
303
          </P
304
304
></DD
305
305
><DT
306
 
><VAR
 
306
><CODE
307
307
CLASS="parameter"
308
 
>nptsy</VAR
 
308
>nptsy</CODE
309
309
>
310
 
          (<VAR
 
310
          (<TT
311
311
CLASS="literal"
312
 
>PLINT</VAR
 
312
>PLINT</TT
313
313
>, input)</DT
314
314
><DD
315
315
><P
316
 
>           The number of points in the <VAR
 
316
>           The number of points in the <TT
317
317
CLASS="literal"
318
 
>yg</VAR
 
318
>yg</TT
319
319
> array.
320
320
          </P
321
321
></DD
322
322
><DT
323
 
><VAR
 
323
><CODE
324
324
CLASS="parameter"
325
 
>sg</VAR
 
325
>sg</CODE
326
326
>
327
 
          (<VAR
 
327
          (<TT
328
328
CLASS="literal"
329
 
>PLFLT **</VAR
 
329
>PLFLT **</TT
330
330
>, output)</DT
331
331
><DD
332
332
><P
333
333
>           The output array, where data lies in the regular grid
334
 
            specified by <VAR
335
 
CLASS="literal"
336
 
>xg</VAR
337
 
> and <VAR
338
 
CLASS="literal"
339
 
>yg.</VAR
 
334
            specified by <TT
 
335
CLASS="literal"
 
336
>xg</TT
 
337
> and <TT
 
338
CLASS="literal"
 
339
>yg.</TT
340
340
>
341
 
            the <VAR
 
341
            the <TT
342
342
CLASS="literal"
343
 
>zg</VAR
 
343
>zg</TT
344
344
> array must exists or be allocated by
345
345
            the user prior to the calling, and must have dimension
346
 
            <VAR
 
346
            <TT
347
347
CLASS="literal"
348
 
>zg[nptsx][xptsy]</VAR
 
348
>zg[nptsx][xptsy]</TT
349
349
>.
350
350
          </P
351
351
></DD
352
352
><DT
353
 
><VAR
 
353
><CODE
354
354
CLASS="parameter"
355
 
>type</VAR
 
355
>type</CODE
356
356
>
357
 
          (<VAR
 
357
          (<TT
358
358
CLASS="literal"
359
 
>PLINT</VAR
 
359
>PLINT</TT
360
360
>, input)</DT
361
361
><DD
362
362
><P
367
367
><UL
368
368
><LI
369
369
><P
370
 
>                <VAR
 
370
>                <TT
371
371
CLASS="literal"
372
 
>GRID_CSA</VAR
 
372
>GRID_CSA</TT
373
373
>: Bivariate Cubic Spline
374
374
                approximation
375
375
              </P
376
376
></LI
377
377
><LI
378
378
><P
379
 
>                <VAR
 
379
>                <TT
380
380
CLASS="literal"
381
 
>GRID_DTLI</VAR
 
381
>GRID_DTLI</TT
382
382
>: Delaunay Triangulation Linear
383
383
                Interpolation
384
384
              </P
385
385
></LI
386
386
><LI
387
387
><P
388
 
>                <VAR
 
388
>                <TT
389
389
CLASS="literal"
390
 
>GRID_NNI</VAR
 
390
>GRID_NNI</TT
391
391
>: Natural Neighbors Interpolation
392
392
              </P
393
393
></LI
394
394
><LI
395
395
><P
396
 
>                <VAR
 
396
>                <TT
397
397
CLASS="literal"
398
 
>GRID_NNIDW</VAR
 
398
>GRID_NNIDW</TT
399
399
>: Nearest Neighbors Inverse
400
400
                Distance Weighted
401
401
              </P
402
402
></LI
403
403
><LI
404
404
><P
405
 
>                <VAR
 
405
>                <TT
406
406
CLASS="literal"
407
 
>GRID_NNLI</VAR
 
407
>GRID_NNLI</TT
408
408
>: Nearest Neighbors Linear
409
409
                Interpolation
410
410
              </P
411
411
></LI
412
412
><LI
413
413
><P
414
 
>                <VAR
 
414
>                <TT
415
415
CLASS="literal"
416
 
>GRID_NNAIDW</VAR
 
416
>GRID_NNAIDW</TT
417
417
>:  Nearest Neighbors Around
418
418
                Inverse Distance Weighted
419
419
              </P
428
428
          </P
429
429
></DD
430
430
><DT
431
 
><VAR
 
431
><CODE
432
432
CLASS="parameter"
433
 
>data</VAR
 
433
>data</CODE
434
434
>
435
 
          (<VAR
 
435
          (<TT
436
436
CLASS="literal"
437
 
>PLFLT</VAR
 
437
>PLFLT</TT
438
438
>, input)</DT
439
439
><DD
440
440
><P
446
446
><UL
447
447
><LI
448
448
><P
449
 
>                <VAR
450
 
CLASS="literal"
451
 
>GRID_NNIDW</VAR
452
 
>, <VAR
453
 
CLASS="literal"
454
 
>data</VAR
 
449
>                <TT
 
450
CLASS="literal"
 
451
>GRID_NNIDW</TT
 
452
>, <TT
 
453
CLASS="literal"
 
454
>data</TT
455
455
>
456
456
                specifies the number of neighbors to use, the lower the
457
457
                value, the noisier (more local) the approximation is.
459
459
></LI
460
460
><LI
461
461
><P
462
 
>                <VAR
463
 
CLASS="literal"
464
 
>GRID_NNLI</VAR
465
 
>, <VAR
466
 
CLASS="literal"
467
 
>data</VAR
 
462
>                <TT
 
463
CLASS="literal"
 
464
>GRID_NNLI</TT
 
465
>, <TT
 
466
CLASS="literal"
 
467
>data</TT
468
468
>
469
469
                specifies what a thin triangle is, in the range
470
470
                [1. .. 2.]. High values enable the usage of very thin
474
474
></LI
475
475
><LI
476
476
><P
477
 
>                <VAR
 
477
>                <TT
478
478
CLASS="literal"
479
 
>GRID_NNI</VAR
 
479
>GRID_NNI</TT
480
480
>, only weights greater than
481
 
                <VAR
 
481
                <TT
482
482
CLASS="literal"
483
 
>data</VAR
 
483
>data</TT
484
484
> will be accepted. If 0, all weigths
485
485
                will be accepted.
486
486
              </P