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
|
<!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>Bitmask</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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BM.html#ga7bfe7f2b1229f511d0d66bffc9a5b8cc">epr_read_bitmask_raster</a> (<a class="el" href="structEPR__ProductId.html">EPR_SProductId</a> *product_id, const char *bm_expr, 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">Calculates a bit-mask, composed of flags of the given product and combined as described in the given bit-mask expression, for the a certain dimension and sub-sampling as defined in the given raster. <a href="#ga7bfe7f2b1229f511d0d66bffc9a5b8cc"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7bfe7f2b1229f511d0d66bffc9a5b8cc"></a><!-- doxytag: member="epr_api.h::epr_read_bitmask_raster" ref="ga7bfe7f2b1229f511d0d66bffc9a5b8cc" args="(EPR_SProductId *product_id, const char *bm_expr, 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_bitmask_raster </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>bm_expr</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>Calculates a bit-mask, composed of flags of the given product and combined as described in the given bit-mask expression, for the a certain dimension and sub-sampling as defined in the given 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>product_id</em> </td><td>Identifier of the ENVISAT product for which the bit-mask shall be created. This is used by the function to retreive the needed flags. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bm_expr</em> </td><td>A string holding the logical expression for the defintion of the bit-mask. In a bit-mask expression, any number of the flag-names (found in the DDDB) can be composed with "(", ")", "NOT", "AND", "OR". Valid bit-mask expression are for example: <br/>
"flags.LAND OR flags.CLOUD" or "NOT flags.WATER AND flags.TURBID_S". </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset_x</em> </td><td>across-track 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 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 raster for the bit-mask. The data type of the raster must be either e_tid_uchar or e_tid_char.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero for success, an error code otherwise</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>create_band_raster </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>
|
