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
|
<!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_Raster Struct Reference</h1><!-- doxytag: class="EPR_Raster" -->
<p>Represents a raster in which data will be stored.
<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__Raster.html#a6715e463dcd4f31fb463677ea37e3056">magic</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The magic number for this structure. <a href="#a6715e463dcd4f31fb463677ea37e3056"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a6d49712ee5ebd1df9b9a69a037a97996">EPR_EDataTypeId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__Raster.html#a6aeee6210eca9ce4d33dbe96c1838ee9">data_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The data type of the band's pixel values. <a href="#a6aeee6210eca9ce4d33dbe96c1838ee9"></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__Raster.html#acc6498259e6a6bde713d6623007cc2eb">elem_size</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The size in byte of a single element (sample) of this raster's buffer. <a href="#acc6498259e6a6bde713d6623007cc2eb"></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__Raster.html#a5f68d114e6429424639f20366c12cd83">source_width</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The width of the source . <a href="#a5f68d114e6429424639f20366c12cd83"></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__Raster.html#acedf355b3742fce08e9ca5d6550413ae">source_height</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The height of the source. <a href="#acedf355b3742fce08e9ca5d6550413ae"></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__Raster.html#aa69017da828a24a68271ebfa1543f40b">source_step_x</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sub-sampling for the across-track direction in pixel. <a href="#aa69017da828a24a68271ebfa1543f40b"></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__Raster.html#a6b939ae6f540d6b2f07674391ae0e997">source_step_y</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sub-sampling for the along-track direction in pixel. <a href="#a6b939ae6f540d6b2f07674391ae0e997"></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__Raster.html#a42eed886a7aae1ecab4a5498e837bbdc">raster_width</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The width of the raster in pixel. <a href="#a42eed886a7aae1ecab4a5498e837bbdc"></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__Raster.html#ada6943370ce19d41f969be3dce8c52e6">raster_height</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The height of the raster in pixel. <a href="#ada6943370ce19d41f969be3dce8c52e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__Raster.html#a4470dc1bf31f87c880b6363057df3af0">buffer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The elements of this raster. <a href="#a4470dc1bf31f87c880b6363057df3af0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Represents a raster in which data will be stored. </p>
<p>All 'size' parameter are in PIXEL. </p>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a6715e463dcd4f31fb463677ea37e3056"></a><!-- doxytag: member="EPR_Raster::magic" ref="a6715e463dcd4f31fb463677ea37e3056" 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__Raster.html#a6715e463dcd4f31fb463677ea37e3056">EPR_Raster::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="a6aeee6210eca9ce4d33dbe96c1838ee9"></a><!-- doxytag: member="EPR_Raster::data_type" ref="a6aeee6210eca9ce4d33dbe96c1838ee9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a6d49712ee5ebd1df9b9a69a037a97996">EPR_EDataTypeId</a> <a class="el" href="structEPR__Raster.html#a6aeee6210eca9ce4d33dbe96c1838ee9">EPR_Raster::data_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The data type of the band's pixel values. </p>
<p><br/>
All corresponding with EPR_DataTypeId types are possible </p>
</div>
</div>
<a class="anchor" id="acc6498259e6a6bde713d6623007cc2eb"></a><!-- doxytag: member="EPR_Raster::elem_size" ref="acc6498259e6a6bde713d6623007cc2eb" 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__Raster.html#acc6498259e6a6bde713d6623007cc2eb">EPR_Raster::elem_size</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The size in byte of a single element (sample) of this raster's buffer. </p>
</div>
</div>
<a class="anchor" id="a5f68d114e6429424639f20366c12cd83"></a><!-- doxytag: member="EPR_Raster::source_width" ref="a5f68d114e6429424639f20366c12cd83" 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__Raster.html#a5f68d114e6429424639f20366c12cd83">EPR_Raster::source_width</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The width of the source . </p>
</div>
</div>
<a class="anchor" id="acedf355b3742fce08e9ca5d6550413ae"></a><!-- doxytag: member="EPR_Raster::source_height" ref="acedf355b3742fce08e9ca5d6550413ae" 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__Raster.html#acedf355b3742fce08e9ca5d6550413ae">EPR_Raster::source_height</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The height of the source. </p>
</div>
</div>
<a class="anchor" id="aa69017da828a24a68271ebfa1543f40b"></a><!-- doxytag: member="EPR_Raster::source_step_x" ref="aa69017da828a24a68271ebfa1543f40b" 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__Raster.html#aa69017da828a24a68271ebfa1543f40b">EPR_Raster::source_step_x</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The sub-sampling for the across-track direction in pixel. </p>
</div>
</div>
<a class="anchor" id="a6b939ae6f540d6b2f07674391ae0e997"></a><!-- doxytag: member="EPR_Raster::source_step_y" ref="a6b939ae6f540d6b2f07674391ae0e997" 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__Raster.html#a6b939ae6f540d6b2f07674391ae0e997">EPR_Raster::source_step_y</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The sub-sampling for the along-track direction in pixel. </p>
</div>
</div>
<a class="anchor" id="a42eed886a7aae1ecab4a5498e837bbdc"></a><!-- doxytag: member="EPR_Raster::raster_width" ref="a42eed886a7aae1ecab4a5498e837bbdc" 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__Raster.html#a42eed886a7aae1ecab4a5498e837bbdc">EPR_Raster::raster_width</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The width of the raster in pixel. </p>
<p><br/>
raster_width = (source_width - 1) / source_step_x + 1 </p>
</div>
</div>
<a class="anchor" id="ada6943370ce19d41f969be3dce8c52e6"></a><!-- doxytag: member="EPR_Raster::raster_height" ref="ada6943370ce19d41f969be3dce8c52e6" 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__Raster.html#ada6943370ce19d41f969be3dce8c52e6">EPR_Raster::raster_height</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The height of the raster in pixel. </p>
<p><br/>
raster_height = (source_height - 1) / source_step_y + 1 </p>
</div>
</div>
<a class="anchor" id="a4470dc1bf31f87c880b6363057df3af0"></a><!-- doxytag: member="EPR_Raster::buffer" ref="a4470dc1bf31f87c880b6363057df3af0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="structEPR__Raster.html#a4470dc1bf31f87c880b6363057df3af0">EPR_Raster::buffer</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The elements of this raster. </p>
<p><br/>
Its volume is <b>raster_width * raster_height * sizeof(data_type) in bytes</b>. </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>
|
