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
|
<!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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>EPR_ProductId Struct Reference</h1><!-- doxytag: class="EPR_ProductId" -->
<p>The <code><a class="el" href="structEPR__ProductId.html" title="The EPR_ProductId structure contains information about an ENVISAT product file which...">EPR_ProductId</a></code> structure contains information about an ENVISAT product file which has been opened with the <code><a class="el" href="group__ProductIO.html#ga53b5258027c1b3d7ea3cdd221686eb53" title="Opens the ENVISAT product file with the given file path, reads MPH, SPH and all...">epr_open_product()</a></code> function.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="epr__api_8h_source.html">epr_api.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#aabba722c6276921eb7ff4095db12ddd0">EPR_Magic</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#a89ad8e220a4a7a858628686c7e8b364c">magic</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The magic number for this structure. <a href="#a89ad8e220a4a7a858628686c7e8b364c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#a78427c9fabfc721f3accde8e6c5b1638">file_path</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The file's path including the file name. <a href="#a78427c9fabfc721f3accde8e6c5b1638"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FILE * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#a4d96661c8d085dd9621546e9c9fb8d28">istream</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The input stream as returned by the ANSI C <code>fopen</code> function for the given file path. <a href="#a4d96661c8d085dd9621546e9c9fb8d28"></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="structEPR__ProductId.html#a5f7265a28784ada8d03fb8f877ab2156">tot_size</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The total size in bytes of the product file. <a href="#a5f7265a28784ada8d03fb8f877ab2156"></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="structEPR__ProductId.html#a85ee662d97d34bed133db291a6b66e13">scene_width</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The total width of product's scene raster in pixels. <a href="#a85ee662d97d34bed133db291a6b66e13"></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="structEPR__ProductId.html#a6deae60c64f893f7497cf31a975165b5">scene_height</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The total height of product's scene raster in pixels. <a href="#a6deae60c64f893f7497cf31a975165b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#a5bc2b932620d7aade40da091cbd65feb">id_string</a> [EPR_PRODUCT_ID_STRLEN+1]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The product identifier string obtained from the MPH parameter 'PRODUCT'. <a href="#a5bc2b932620d7aade40da091cbd65feb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEPR__Record.html">EPR_SRecord</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#ac8116f82e51604ba8bde3e490a55f3c3">mph_record</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The record representing the main product header (MPH). <a href="#ac8116f82e51604ba8bde3e490a55f3c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEPR__Record.html">EPR_SRecord</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#ab35d4c1ff4bf299e5c3c0b1be719d950">sph_record</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The record representing the specific product header (SPH). <a href="#ab35d4c1ff4bf299e5c3c0b1be719d950"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EPR_SPtrArray * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#ae6dd6a7e8d728c4d2ab7a538121b6d44">dsd_array</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An array containing all (!) DSDs read from the product's specific product header (SPH). <a href="#ae6dd6a7e8d728c4d2ab7a538121b6d44"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EPR_SPtrArray * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#a8d03e33302e13aa2428f1e98dd217efe">record_info_cache</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cache for record infos. <a href="#a8d03e33302e13aa2428f1e98dd217efe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EPR_SPtrArray * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#abd9e537a748bfe27ef4f0ff22f106ee1">param_table</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A table containing dynamic field info parameters. <a href="#abd9e537a748bfe27ef4f0ff22f106ee1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EPR_SPtrArray * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#aee3e2de8df58932a5edb8b0fdb8d12e9">dataset_ids</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contains and array of all dataset IDs for the product (type EPR_SDatasetId*). <a href="#aee3e2de8df58932a5edb8b0fdb8d12e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EPR_SPtrArray * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#a4c6e95b184f4eae3cf15650b1ffb86c4">band_ids</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contains and array of all band IDs for the product (type EPR_SBandId*). <a href="#a4c6e95b184f4eae3cf15650b1ffb86c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__ProductId.html#a4f32a5e525ba5a7bd29317825ae3e4d5">meris_iodd_version</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For MERIS L1b and RR and FR to provide backward compatibility. <a href="#a4f32a5e525ba5a7bd29317825ae3e4d5"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <code><a class="el" href="structEPR__ProductId.html" title="The EPR_ProductId structure contains information about an ENVISAT product file which...">EPR_ProductId</a></code> structure contains information about an ENVISAT product file which has been opened with the <code><a class="el" href="group__ProductIO.html#ga53b5258027c1b3d7ea3cdd221686eb53" title="Opens the ENVISAT product file with the given file path, reads MPH, SPH and all...">epr_open_product()</a></code> function. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ProductIO.html#ga53b5258027c1b3d7ea3cdd221686eb53" title="Opens the ENVISAT product file with the given file path, reads MPH, SPH and all...">epr_open_product</a> </dd></dl>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a89ad8e220a4a7a858628686c7e8b364c"></a><!-- doxytag: member="EPR_ProductId::magic" ref="a89ad8e220a4a7a858628686c7e8b364c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#aabba722c6276921eb7ff4095db12ddd0">EPR_Magic</a> <a class="el" href="structEPR__ProductId.html#a89ad8e220a4a7a858628686c7e8b364c">EPR_ProductId::magic</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The magic number for this structure. </p>
<p>IMPORTANT: This must always be the first member of this structure. </p>
</div>
</div>
<a class="anchor" id="a78427c9fabfc721f3accde8e6c5b1638"></a><!-- doxytag: member="EPR_ProductId::file_path" ref="a78427c9fabfc721f3accde8e6c5b1638" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structEPR__ProductId.html#a78427c9fabfc721f3accde8e6c5b1638">EPR_ProductId::file_path</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The file's path including the file name. </p>
</div>
</div>
<a class="anchor" id="a4d96661c8d085dd9621546e9c9fb8d28"></a><!-- doxytag: member="EPR_ProductId::istream" ref="a4d96661c8d085dd9621546e9c9fb8d28" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FILE* <a class="el" href="structEPR__ProductId.html#a4d96661c8d085dd9621546e9c9fb8d28">EPR_ProductId::istream</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The input stream as returned by the ANSI C <code>fopen</code> function for the given file path. </p>
</div>
</div>
<a class="anchor" id="a5f7265a28784ada8d03fb8f877ab2156"></a><!-- doxytag: member="EPR_ProductId::tot_size" ref="a5f7265a28784ada8d03fb8f877ab2156" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> <a class="el" href="structEPR__ProductId.html#a5f7265a28784ada8d03fb8f877ab2156">EPR_ProductId::tot_size</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The total size in bytes of the product file. </p>
</div>
</div>
<a class="anchor" id="a85ee662d97d34bed133db291a6b66e13"></a><!-- doxytag: member="EPR_ProductId::scene_width" ref="a85ee662d97d34bed133db291a6b66e13" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> <a class="el" href="structEPR__ProductId.html#a85ee662d97d34bed133db291a6b66e13">EPR_ProductId::scene_width</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The total width of product's scene raster in pixels. </p>
</div>
</div>
<a class="anchor" id="a6deae60c64f893f7497cf31a975165b5"></a><!-- doxytag: member="EPR_ProductId::scene_height" ref="a6deae60c64f893f7497cf31a975165b5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> <a class="el" href="structEPR__ProductId.html#a6deae60c64f893f7497cf31a975165b5">EPR_ProductId::scene_height</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The total height of product's scene raster in pixels. </p>
</div>
</div>
<a class="anchor" id="a5bc2b932620d7aade40da091cbd65feb"></a><!-- doxytag: member="EPR_ProductId::id_string" ref="a5bc2b932620d7aade40da091cbd65feb" args="[EPR_PRODUCT_ID_STRLEN+1]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char <a class="el" href="structEPR__ProductId.html#a5bc2b932620d7aade40da091cbd65feb">EPR_ProductId::id_string</a>[EPR_PRODUCT_ID_STRLEN+1]</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The product identifier string obtained from the MPH parameter 'PRODUCT'. </p>
<p>The first 10 characters of this string identify the the product type, e.g. "MER_1P__FR" for a MERIS Level 1b full resolution product. The rest of the string decodes product instance properties. </p>
</div>
</div>
<a class="anchor" id="ac8116f82e51604ba8bde3e490a55f3c3"></a><!-- doxytag: member="EPR_ProductId::mph_record" ref="ac8116f82e51604ba8bde3e490a55f3c3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structEPR__Record.html">EPR_SRecord</a>* <a class="el" href="structEPR__ProductId.html#ac8116f82e51604ba8bde3e490a55f3c3">EPR_ProductId::mph_record</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The record representing the main product header (MPH). </p>
</div>
</div>
<a class="anchor" id="ab35d4c1ff4bf299e5c3c0b1be719d950"></a><!-- doxytag: member="EPR_ProductId::sph_record" ref="ab35d4c1ff4bf299e5c3c0b1be719d950" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structEPR__Record.html">EPR_SRecord</a>* <a class="el" href="structEPR__ProductId.html#ab35d4c1ff4bf299e5c3c0b1be719d950">EPR_ProductId::sph_record</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The record representing the specific product header (SPH). </p>
</div>
</div>
<a class="anchor" id="ae6dd6a7e8d728c4d2ab7a538121b6d44"></a><!-- doxytag: member="EPR_ProductId::dsd_array" ref="ae6dd6a7e8d728c4d2ab7a538121b6d44" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EPR_SPtrArray* <a class="el" href="structEPR__ProductId.html#ae6dd6a7e8d728c4d2ab7a538121b6d44">EPR_ProductId::dsd_array</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An array containing all (!) DSDs read from the product's specific product header (SPH). </p>
</div>
</div>
<a class="anchor" id="a8d03e33302e13aa2428f1e98dd217efe"></a><!-- doxytag: member="EPR_ProductId::record_info_cache" ref="a8d03e33302e13aa2428f1e98dd217efe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EPR_SPtrArray* <a class="el" href="structEPR__ProductId.html#a8d03e33302e13aa2428f1e98dd217efe">EPR_ProductId::record_info_cache</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cache for record infos. </p>
<p>Contains all record infos read from the database for this file so far.</p>
<p>The reason for caching record infos on a per-file-base is that a some record infos instances can contain file related content such as the number of pixels in a measurecment dataset record (MDSR). </p>
</div>
</div>
<a class="anchor" id="abd9e537a748bfe27ef4f0ff22f106ee1"></a><!-- doxytag: member="EPR_ProductId::param_table" ref="abd9e537a748bfe27ef4f0ff22f106ee1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EPR_SPtrArray* <a class="el" href="structEPR__ProductId.html#abd9e537a748bfe27ef4f0ff22f106ee1">EPR_ProductId::param_table</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A table containing dynamic field info parameters. </p>
<p>Dynamic field info parameters are created at runtime because the are derived from the product file contents and can not be staically stored in the record info database. </p>
</div>
</div>
<a class="anchor" id="aee3e2de8df58932a5edb8b0fdb8d12e9"></a><!-- doxytag: member="EPR_ProductId::dataset_ids" ref="aee3e2de8df58932a5edb8b0fdb8d12e9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EPR_SPtrArray* <a class="el" href="structEPR__ProductId.html#aee3e2de8df58932a5edb8b0fdb8d12e9">EPR_ProductId::dataset_ids</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Contains and array of all dataset IDs for the product (type EPR_SDatasetId*). </p>
</div>
</div>
<a class="anchor" id="a4c6e95b184f4eae3cf15650b1ffb86c4"></a><!-- doxytag: member="EPR_ProductId::band_ids" ref="a4c6e95b184f4eae3cf15650b1ffb86c4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EPR_SPtrArray* <a class="el" href="structEPR__ProductId.html#a4c6e95b184f4eae3cf15650b1ffb86c4">EPR_ProductId::band_ids</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Contains and array of all band IDs for the product (type EPR_SBandId*). </p>
</div>
</div>
<a class="anchor" id="a4f32a5e525ba5a7bd29317825ae3e4d5"></a><!-- doxytag: member="EPR_ProductId::meris_iodd_version" ref="a4f32a5e525ba5a7bd29317825ae3e4d5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structEPR__ProductId.html#a4f32a5e525ba5a7bd29317825ae3e4d5">EPR_ProductId::meris_iodd_version</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>For MERIS L1b and RR and FR to provide backward compatibility. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="epr__api_8h_source.html">epr_api.h</a></li>
</ul>
</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>
|
