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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ENVISAT Product Reader C API: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="custom.css" rel="stylesheet" type="text/css">
</head><body>
<table class="header">
<tr class="header">
<td class="header">
ENVISAT Product Reader API for C
</td>
<td class="header" align="right">
<a href="http://www.brockmann-consult.de/beam">
<img src="../images/beam_header.gif" width="227" height="29" border="0">
</a>
</td>
</tr>
</table>
<br>
<!--<div class="navigation">-->
<!--<div class="tabs">-->
<!--<ul>-->
<!--<li class="current"><a href="index.html"><span>API Details</span></a></li>-->
<!--<li><a href="overview_custom.html"><span>API Overview</span></a></li>-->
<!--</ul>-->
<!--</div>-->
<!--</div>-->
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Raster Data Access<br/>
<small>
[<a class="el" href="group__GDA.html">Geopysical Data Access</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#ga4d12c454b238e7e411933bfdae1f37e8">epr_create_compatible_raster</a> (<a class="el" href="structEPR__BandId.html">EPR_SBandId</a> *band_id, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_width, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_height, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_step_x, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_step_y)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a raster which is compatible with the data type contained in the band identified by band_id. <a href="#ga4d12c454b238e7e411933bfdae1f37e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#gaac51a43901e95ee9f128a727289bcc45">epr_create_raster</a> (<a class="el" href="epr__api_8h.html#a6d49712ee5ebd1df9b9a69a037a97996">EPR_EDataTypeId</a> data_type, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_width, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_height, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_step_x, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_step_y)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a raster of the specified data type. <a href="#gaac51a43901e95ee9f128a727289bcc45"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#ga4db9f8cbd8d73adca343a2125118ebcc">epr_create_bitmask_raster</a> (<a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_width, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_height, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_step_x, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> source_step_y)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a raster to be used for reading bitmasks. <a href="#ga4db9f8cbd8d73adca343a2125118ebcc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#ga4f8e0dd2bf6ef35ebc0efdfc69896936">epr_read_band_raster</a> (<a class="el" href="structEPR__BandId.html">EPR_SBandId</a> *band_id, int offset_x, int offset_y, <a class="el" href="structEPR__Raster.html">EPR_SRaster</a> *raster)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads (geo-)physical values of the given band of the specified source-region. <a href="#ga4f8e0dd2bf6ef35ebc0efdfc69896936"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#gab03b98803f34f41a39b8c2dd602b4899">epr_get_raster_elem_size</a> (const <a class="el" href="structEPR__Raster.html">EPR_SRaster</a> *raster)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#gae33e001cb7148ab5f084ff69849cf215">epr_get_raster_elem_addr</a> (const <a class="el" href="structEPR__Raster.html">EPR_SRaster</a> *raster, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> offset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#ga8c82097a22e62d1881cdbfc867a3bc43">epr_get_raster_pixel_addr</a> (const <a class="el" href="structEPR__Raster.html">EPR_SRaster</a> *raster, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> x, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#gada55c890825656056cc11145af96dc24">epr_get_raster_line_addr</a> (const <a class="el" href="structEPR__Raster.html">EPR_SRaster</a> *raster, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#gad2e88c74731d001052ef55a371fee803">epr_get_raster_width</a> (<a class="el" href="structEPR__Raster.html">EPR_SRaster</a> *raster)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the raster's scene width in pixels. <a href="#gad2e88c74731d001052ef55a371fee803"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#gab6514b5aaf0db663acd5d9eb69b28308">epr_get_raster_height</a> (<a class="el" href="structEPR__Raster.html">EPR_SRaster</a> *raster)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the raster's scene height in pixels. <a href="#gab6514b5aaf0db663acd5d9eb69b28308"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#gaaff344f35a51a69375c147427659b7b8">epr_get_num_bands</a> (<a class="el" href="structEPR__ProductId.html">EPR_SProductId</a> *product_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of all bands contained in a product. <a href="#gaaff344f35a51a69375c147427659b7b8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEPR__BandId.html">EPR_SBandId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#ga0592b6aff9a40850d7bd100c233eccff">epr_get_band_id_at</a> (<a class="el" href="structEPR__ProductId.html">EPR_SProductId</a> *product_id, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the band ID at the specified position within the product. <a href="#ga0592b6aff9a40850d7bd100c233eccff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEPR__BandId.html">EPR_SBandId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#ga552a45c4db0381957867fd19b1034a6a">epr_get_band_id</a> (<a class="el" href="structEPR__ProductId.html">EPR_SProductId</a> *product_id, const char *band_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the band ID corresponding to the specified name. <a href="#ga552a45c4db0381957867fd19b1034a6a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#gae26e00868ca3106b28abaf82bbe22f58">epr_get_band_name</a> (<a class="el" href="structEPR__BandId.html">EPR_SBandId</a> *band_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of the band for the given band ID. <a href="#gae26e00868ca3106b28abaf82bbe22f58"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RASTER.html#ga5cf052e10e0aaa39999126309d14de73">epr_free_raster</a> (<a class="el" href="structEPR__Raster.html">EPR_SRaster</a> *raster)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release the memory allocated through a raster. <a href="#ga5cf052e10e0aaa39999126309d14de73"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga4d12c454b238e7e411933bfdae1f37e8"></a><!-- doxytag: member="epr_api.h::epr_create_compatible_raster" ref="ga4d12c454b238e7e411933bfdae1f37e8" args="(EPR_SBandId *band_id, uint source_width, uint source_height, uint source_step_x, uint source_step_y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structEPR__Raster.html">EPR_SRaster</a>* epr_create_compatible_raster </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEPR__BandId.html">EPR_SBandId</a> * </td>
<td class="paramname"> <em>band_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_step_x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_step_y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a raster which is compatible with the data type contained in the band identified by band_id. </p>
<p>The created raster is used to read the data in it (see epr_read_band_raster). </p>
<p>The raster is defined on the grid of the product, from which the data are read. Spatial subsets and undersampling are possible) through the parameter of the function. </p>
<p>The concept of defining the raster is such: A certain portion of the ENVISAT product will be read into the raster. This is called the source. The complete ENVISAT product can be much greater than the source. One can move the raster over the complete ENVISAT product and read in turn different parts - always of the size of the source - of it into the raster. The source is specified by the parameter source_height and source_width. </p>
<p>A typical example is a processing in blocks. Lets say, a block has 64x32 pixel. Then, my source has a width of 64 pixel and a height of 32 pixel. Another example is a processing of complete image lines. Then, my source has a widths of the complete product (for example 1121 for a MERIS RR product), and a height of 1). One can loop over all blocks read into the raster and process it. </p>
<p>In addition, it is possible to defined a subsampling step for a raster. This means, that the source is not read 1:1 into the raster, but that only every 2nd or 3rd pixel is read. This step can be set differently for the across track (source_step_x) and along track (source_step_y) directions.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>band_id</em> </td><td>the band identifier. The raster will be compatible with the data type of that band; must not be <code>NULL</code> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_width</em> </td><td>the width (across track dimension) of the source to be read into the raster. See text above. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_height</em> </td><td>the height (along track dimension) of the source to be read into the raster. See text above. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_step_x</em> </td><td>the subsampling step across track of the source when reading into the raster. See text above. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_step_y</em> </td><td>the subsampling step along track of the source when reading into the raster. See text above.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the new raster instance or <code>NULL</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="gaac51a43901e95ee9f128a727289bcc45"></a><!-- doxytag: member="epr_api.h::epr_create_raster" ref="gaac51a43901e95ee9f128a727289bcc45" args="(EPR_EDataTypeId data_type, uint source_width, uint source_height, uint source_step_x, uint source_step_y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structEPR__Raster.html">EPR_SRaster</a>* epr_create_raster </td>
<td>(</td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a6d49712ee5ebd1df9b9a69a037a97996">EPR_EDataTypeId</a> </td>
<td class="paramname"> <em>data_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_step_x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_step_y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a raster of the specified data type. </p>
<p>This function can be used to create any type of raster, e.g. for later use as a bit-mask.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data_type</em> </td><td>the type of the data to stored in the raster, must not be <code>NULL</code> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_width</em> </td><td>the width (across track dimension) of the source to be read into the raster. See description of epr_create_compatible_raster. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_height</em> </td><td>the height (along track dimension) of the source to be read into the raster. See description of epr_create_compatible_raster. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_step_x</em> </td><td>the subsampling step across track of the source when reading into the raster. See description of epr_create_compatible_raster. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_step_y</em> </td><td>the subsampling step along track of the source when reading into the raster. See description of epr_create_compatible_raster. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the new raster instance or <code>NULL</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4db9f8cbd8d73adca343a2125118ebcc"></a><!-- doxytag: member="epr_api.h::epr_create_bitmask_raster" ref="ga4db9f8cbd8d73adca343a2125118ebcc" args="(uint source_width, uint source_height, uint source_step_x, uint source_step_y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structEPR__Raster.html">EPR_SRaster</a>* epr_create_bitmask_raster </td>
<td>(</td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_step_x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>source_step_y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a raster to be used for reading bitmasks. </p>
<p>The raster returned always is of type <code>byte</code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source_width</em> </td><td>the width (across track dimension) of the source to be read into the raster. See description of epr_create_compatible_raster. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_height</em> </td><td>the height (along track dimension) of the source to be read into the raster. See description of epr_create_compatible_raster. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_step_x</em> </td><td>the subsampling step across track of the source when reading into the raster. See description of epr_create_compatible_raster. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>source_step_y</em> </td><td>the subsampling step along track of the source when reading into the raster. See description of epr_create_compatible_raster. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the new raster instance or <code>NULL</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4f8e0dd2bf6ef35ebc0efdfc69896936"></a><!-- doxytag: member="epr_api.h::epr_read_band_raster" ref="ga4f8e0dd2bf6ef35ebc0efdfc69896936" args="(EPR_SBandId *band_id, int offset_x, int offset_y, EPR_SRaster *raster)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int epr_read_band_raster </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEPR__BandId.html">EPR_SBandId</a> * </td>
<td class="paramname"> <em>band_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>offset_x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>offset_y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td>
<td class="paramname"> <em>raster</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads (geo-)physical values of the given band of the specified source-region. </p>
<p>The source-region is a defined part of the whole ENVISAT product image, which shall be read into a raster. In this routine the co-ordinates are specified, where the source-region to be read starts. The dimension of the region and the sub-sampling are attributes of the raster into which the data are read.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>band_id</em> </td><td>the identified of the band to be read into the raster. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset_x</em> </td><td>across-track source co-ordinate in pixel co-ordinates (zero-based) of the upper right corner of the source-region </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset_y</em> </td><td>along-track source co-ordinate in pixel co-ordinates (zero-based) of the upper right corner of the source-region </td></tr>
<tr><td valign="top"></td><td valign="top"><em>raster</em> </td><td>the identifier to given raster information and raster buffer</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero for success, and error code otherwise</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__RASTER.html#ga4d12c454b238e7e411933bfdae1f37e8" title="Creates a raster which is compatible with the data type contained in the band identified...">epr_create_compatible_raster</a> </dd>
<dd>
epr_create_rater </dd></dl>
</div>
</div>
<a class="anchor" id="gab03b98803f34f41a39b8c2dd602b4899"></a><!-- doxytag: member="epr_api.h::epr_get_raster_elem_size" ref="gab03b98803f34f41a39b8c2dd602b4899" args="(const EPR_SRaster *raster)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> epr_get_raster_elem_size </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td>
<td class="paramname"> <em>raster</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="gae33e001cb7148ab5f084ff69849cf215"></a><!-- doxytag: member="epr_api.h::epr_get_raster_elem_addr" ref="gae33e001cb7148ab5f084ff69849cf215" args="(const EPR_SRaster *raster, uint offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* epr_get_raster_elem_addr </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td>
<td class="paramname"> <em>raster</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>offset</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga8c82097a22e62d1881cdbfc867a3bc43"></a><!-- doxytag: member="epr_api.h::epr_get_raster_pixel_addr" ref="ga8c82097a22e62d1881cdbfc867a3bc43" args="(const EPR_SRaster *raster, uint x, uint y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* epr_get_raster_pixel_addr </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td>
<td class="paramname"> <em>raster</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="gada55c890825656056cc11145af96dc24"></a><!-- doxytag: member="epr_api.h::epr_get_raster_line_addr" ref="gada55c890825656056cc11145af96dc24" args="(const EPR_SRaster *raster, uint y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* epr_get_raster_line_addr </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td>
<td class="paramname"> <em>raster</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="gad2e88c74731d001052ef55a371fee803"></a><!-- doxytag: member="epr_api.h::epr_get_raster_width" ref="gad2e88c74731d001052ef55a371fee803" args="(EPR_SRaster *raster)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> epr_get_raster_width </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td>
<td class="paramname"> <em>raster</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the raster's scene width in pixels. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>raster</em> </td><td>the raster identifier, must not be <code>NULL</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the raster's total scene width in pixels, or <code>0</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="gab6514b5aaf0db663acd5d9eb69b28308"></a><!-- doxytag: member="epr_api.h::epr_get_raster_height" ref="gab6514b5aaf0db663acd5d9eb69b28308" args="(EPR_SRaster *raster)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> epr_get_raster_height </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td>
<td class="paramname"> <em>raster</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the raster's scene height in pixels. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>raster</em> </td><td>the product identifier, must not be <code>NULL</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the raster's total scene height in pixels, or <code>0</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="gaaff344f35a51a69375c147427659b7b8"></a><!-- doxytag: member="epr_api.h::epr_get_num_bands" ref="gaaff344f35a51a69375c147427659b7b8" args="(EPR_SProductId *product_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> epr_get_num_bands </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEPR__ProductId.html">EPR_SProductId</a> * </td>
<td class="paramname"> <em>product_id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the number of all bands contained in a product. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>product_id</em> </td><td>the source product ID, must not be <code>NULL</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number off all bands </dd></dl>
</div>
</div>
<a class="anchor" id="ga0592b6aff9a40850d7bd100c233eccff"></a><!-- doxytag: member="epr_api.h::epr_get_band_id_at" ref="ga0592b6aff9a40850d7bd100c233eccff" args="(EPR_SProductId *product_id, uint index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structEPR__BandId.html">EPR_SBandId</a>* epr_get_band_id_at </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEPR__ProductId.html">EPR_SProductId</a> * </td>
<td class="paramname"> <em>product_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>index</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the band ID at the specified position within the product. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>product_id</em> </td><td>the source product ID, must not be <code>NULL</code> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>the index identifying the position of the band, starting with 0, must not be negative </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the requested band ID, or <code>NULL</code> if not found </dd></dl>
</div>
</div>
<a class="anchor" id="ga552a45c4db0381957867fd19b1034a6a"></a><!-- doxytag: member="epr_api.h::epr_get_band_id" ref="ga552a45c4db0381957867fd19b1034a6a" args="(EPR_SProductId *product_id, const char *band_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structEPR__BandId.html">EPR_SBandId</a>* epr_get_band_id </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEPR__ProductId.html">EPR_SProductId</a> * </td>
<td class="paramname"> <em>product_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>band_name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the band ID corresponding to the specified name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>product_id</em> </td><td>the source product ID, must not be <code>NULL</code> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>band_name</em> </td><td>the name of the band, must not be <code>NULL</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the requested band ID, or <code>NULL</code> if not found </dd></dl>
</div>
</div>
<a class="anchor" id="gae26e00868ca3106b28abaf82bbe22f58"></a><!-- doxytag: member="epr_api.h::epr_get_band_name" ref="gae26e00868ca3106b28abaf82bbe22f58" args="(EPR_SBandId *band_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* epr_get_band_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEPR__BandId.html">EPR_SBandId</a> * </td>
<td class="paramname"> <em>band_id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the name of the band for the given band ID. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>band_id</em> </td><td>the band identifier, must not be <code>NULL</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the name of the band. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5cf052e10e0aaa39999126309d14de73"></a><!-- doxytag: member="epr_api.h::epr_free_raster" ref="ga5cf052e10e0aaa39999126309d14de73" args="(EPR_SRaster *raster)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void epr_free_raster </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structEPR__Raster.html">EPR_SRaster</a> * </td>
<td class="paramname"> <em>raster</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release the memory allocated through a raster. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>raster</em> </td><td>the raster to be released. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr>
<div align="center">
<address>
<p>Generated on Mon Aug 2 15:24:00 2010
<p>ENVISAT Product Reader C API
<p>Written by
<a href="mailto:info@brockmann-consult.de">Brockmann Consult</a>,
© 2002
<a href="http://www.brockmann-consult.de/">
<img src="../images/bc_logo.gif" alt="Brockmann Consult" align="bottom" border=0 width=18 height=18>
</a>
<a href="http://envisat.esa.int/">
<img src="../images/esa_logo.gif" alt="Eropean Space Agency" align="bottom" border=0 width=50 height=18>
</a>
</address>
</div>
</body>
</html>
|
