Debian Codegraph @

doc/html/ingestions/S4-L2-CLD.html

raw
1 <!DOCTYPE html>
2 <html class="writer-html5" lang="en">
3 <head>
4 <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
5
6 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7 <title>S4-L2-CLD &mdash; HARP 1.29 documentation</title>
8 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
9 <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
10 <link rel="stylesheet" type="text/css" href="../_static/custom.css" />
11
12
13 <!--[if lt IE 9]>
14 <script src="../_static/js/html5shiv.min.js"></script>
15 <![endif]-->
16
17 <script src="../_static/jquery.js"></script>
18 <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
19 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
20 <script src="../_static/doctools.js"></script>
21 <script src="../_static/sphinx_highlight.js"></script>
22 <script src="../_static/js/theme.js"></script>
23 <link rel="index" title="Index" href="../genindex.html" />
24 </head>
25
26 <body class="wy-body-for-nav">
27 <div class="wy-grid-for-nav">
28 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
29 <div class="wy-side-scroll">
30 <div class="wy-side-nav-search" >
31
32
33
34 <a href="../index.html" class="icon icon-home">
35 HARP
36 </a>
37 <div class="version">
38 1.29
39 </div>
40 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
41 <ul>
42 <li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
43 <li class="toctree-l1"><a class="reference internal" href="../conventions/index.html">Conventions</a></li>
44 <li class="toctree-l1"><a class="reference internal" href="../algorithms/index.html">Algorithms</a></li>
45 <li class="toctree-l1"><a class="reference internal" href="../operations.html">Operations</a></li>
46 <li class="toctree-l1"><a class="reference internal" href="index.html">Ingestion definitions</a></li>
47 <li class="toctree-l1"><a class="reference internal" href="../libharp.html">C library</a></li>
48 <li class="toctree-l1"><a class="reference internal" href="../idl.html">IDL interface</a></li>
49 <li class="toctree-l1"><a class="reference internal" href="../matlab.html">MATLAB interface</a></li>
50 <li class="toctree-l1"><a class="reference internal" href="../python.html">Python interface</a></li>
51 <li class="toctree-l1"><a class="reference internal" href="../R.html">R interface</a></li>
52 <li class="toctree-l1"><a class="reference internal" href="../tools.html">Command line tools</a></li>
53 </ul>
54
55 </div>
56 </div>
57 </nav>
58
59 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
60 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
61 <a href="../index.html">HARP</a>
62 </nav>
63
64 <div class="wy-nav-content">
65 <div class="rst-content">
66 <div role="navigation" aria-label="Page navigation">
67 <ul class="wy-breadcrumbs">
68 <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
69 <li class="breadcrumb-item active">S4-L2-CLD</li>
70 <li class="wy-breadcrumbs-aside">
71 </li>
72 </ul>
73 <hr/>
74 </div>
75 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
76 <div itemprop="articleBody">
77
78 <section id="s4-l2-cld">
79 <h1>S4-L2-CLD</h1>
80 <section id="variables">
81 <h2>Variables</h2>
82 <p>The table below lists the variables that are present in the HARP product that results from an ingestion of <code class="docutils literal notranslate"><span class="pre">S4-L2-CLD</span></code> data.</p>
83 <table class="docutils align-default">
84 <colgroup>
85 <col style="width: 25.0%" />
86 <col style="width: 5.0%" />
87 <col style="width: 15.0%" />
88 <col style="width: 15.0%" />
89 <col style="width: 40.0%" />
90 </colgroup>
91 <thead>
92 <tr class="row-odd"><th class="head"><p>field name</p></th>
93 <th class="head"><p>type</p></th>
94 <th class="head"><p>dimensions</p></th>
95 <th class="head"><p>unit</p></th>
96 <th class="head"><p>description</p></th>
97 </tr>
98 </thead>
99 <tbody>
100 <tr class="row-even"><td><p><strong>datetime</strong></p></td>
101 <td><p>double</p></td>
102 <td><p>{<em>time</em>}</p></td>
103 <td><p>[seconds since 2000-01-01]</p></td>
104 <td><p>time of the measurement</p></td>
105 </tr>
106 <tr class="row-odd"><td><p><strong>datetime_length</strong></p></td>
107 <td><p>double</p></td>
108 <td></td>
109 <td><p>[s]</p></td>
110 <td><p>measurement duration</p></td>
111 </tr>
112 <tr class="row-even"><td><p><strong>latitude</strong></p></td>
113 <td><p>float</p></td>
114 <td><p>{<em>time</em>}</p></td>
115 <td><p>[degree_north]</p></td>
116 <td><p>pixel center latitude</p></td>
117 </tr>
118 <tr class="row-odd"><td><p><strong>longitude</strong></p></td>
119 <td><p>float</p></td>
120 <td><p>{<em>time</em>}</p></td>
121 <td><p>[degree_east]</p></td>
122 <td><p>pixel center longitude</p></td>
123 </tr>
124 <tr class="row-even"><td><p><strong>latitude_bounds</strong></p></td>
125 <td><p>float</p></td>
126 <td><p>{<em>time</em>, 4}</p></td>
127 <td><p>[degree_north]</p></td>
128 <td><p>latitudes of pixel boundary</p></td>
129 </tr>
130 <tr class="row-odd"><td><p><strong>longitude_bounds</strong></p></td>
131 <td><p>float</p></td>
132 <td><p>{<em>time</em>, 4}</p></td>
133 <td><p>[degree_north]</p></td>
134 <td><p>latitudes of pixel boundary</p></td>
135 </tr>
136 <tr class="row-even"><td><p><strong>validity</strong></p></td>
137 <td><p>int8</p></td>
138 <td><p>{<em>time</em>}</p></td>
139 <td></td>
140 <td><p>continuous quality descriptor, varying between 0 (no data) and 100 (full quality data)</p></td>
141 </tr>
142 <tr class="row-odd"><td><p><strong>cloud_base_height</strong></p></td>
143 <td><p>float</p></td>
144 <td><p>{<em>time</em>}</p></td>
145 <td><p>[m]</p></td>
146 <td><p>cloud base height</p></td>
147 </tr>
148 <tr class="row-even"><td><p><strong>cloud_base_height_uncertainty</strong></p></td>
149 <td><p>float</p></td>
150 <td><p>{<em>time</em>}</p></td>
151 <td><p>[m]</p></td>
152 <td><p>standard error of cloud base height</p></td>
153 </tr>
154 <tr class="row-odd"><td><p><strong>cloud_base_pressure</strong></p></td>
155 <td><p>float</p></td>
156 <td><p>{<em>time</em>}</p></td>
157 <td><p>[Pa]</p></td>
158 <td><p>cloud base pressure</p></td>
159 </tr>
160 <tr class="row-even"><td><p><strong>cloud_base_pressure_uncertainty</strong></p></td>
161 <td><p>float</p></td>
162 <td><p>{<em>time</em>}</p></td>
163 <td><p>[Pa]</p></td>
164 <td><p>standard error of cloud base pressure</p></td>
165 </tr>
166 <tr class="row-odd"><td><p><strong>cloud_fraction</strong></p></td>
167 <td><p>float</p></td>
168 <td><p>{<em>time</em>}</p></td>
169 <td><p>[]</p></td>
170 <td><p>cloud fraction</p></td>
171 </tr>
172 <tr class="row-even"><td><p><strong>cloud_fraction_uncertainty</strong></p></td>
173 <td><p>float</p></td>
174 <td><p>{<em>time</em>}</p></td>
175 <td><p>[]</p></td>
176 <td><p>standard error of cloud fraction</p></td>
177 </tr>
178 <tr class="row-odd"><td><p><strong>cloud_optical_depth</strong></p></td>
179 <td><p>float</p></td>
180 <td><p>{<em>time</em>}</p></td>
181 <td><p>[]</p></td>
182 <td><p>cloud optical thickness</p></td>
183 </tr>
184 <tr class="row-even"><td><p><strong>cloud_optical_depth_uncertainty</strong></p></td>
185 <td><p>float</p></td>
186 <td><p>{<em>time</em>}</p></td>
187 <td><p>[]</p></td>
188 <td><p>standard error of cloud optical thickness</p></td>
189 </tr>
190 <tr class="row-odd"><td><p><strong>cloud_top_height</strong></p></td>
191 <td><p>float</p></td>
192 <td><p>{<em>time</em>}</p></td>
193 <td><p>[m]</p></td>
194 <td><p>cloud top height</p></td>
195 </tr>
196 <tr class="row-even"><td><p><strong>cloud_top_height_uncertainty</strong></p></td>
197 <td><p>float</p></td>
198 <td><p>{<em>time</em>}</p></td>
199 <td><p>[m]</p></td>
200 <td><p>standard error of cloud top height</p></td>
201 </tr>
202 <tr class="row-odd"><td><p><strong>cloud_top_pressure</strong></p></td>
203 <td><p>float</p></td>
204 <td><p>{<em>time</em>}</p></td>
205 <td><p>[Pa]</p></td>
206 <td><p>cloud top pressure</p></td>
207 </tr>
208 <tr class="row-even"><td><p><strong>cloud_top_pressure_uncertainty</strong></p></td>
209 <td><p>float</p></td>
210 <td><p>{<em>time</em>}</p></td>
211 <td><p>[Pa]</p></td>
212 <td><p>standard error of cloud top pressure</p></td>
213 </tr>
214 <tr class="row-odd"><td><p><strong>index</strong></p></td>
215 <td><p>int32</p></td>
216 <td><p>{<em>time</em>}</p></td>
217 <td></td>
218 <td><p>zero-based index of the sample within the source product</p></td>
219 </tr>
220 </tbody>
221 </table>
222 </section>
223 <section id="ingestion-options">
224 <h2>Ingestion options</h2>
225 <p>The table below lists the available ingestion options for <code class="docutils literal notranslate"><span class="pre">S4-L2-CLD</span></code> products.</p>
226 <table class="docutils align-default">
227 <colgroup>
228 <col style="width: 15.0%" />
229 <col style="width: 25.0%" />
230 <col style="width: 60.0%" />
231 </colgroup>
232 <thead>
233 <tr class="row-odd"><th class="head"><p>option name</p></th>
234 <th class="head"><p>legal values</p></th>
235 <th class="head"><p>description</p></th>
236 </tr>
237 </thead>
238 <tbody>
239 <tr class="row-even"><td><p>band</p></td>
240 <td><p>NIR</p></td>
241 <td><p>ingest cloud properties in the UV/VIS (default) or NIR (band=NIR)</p></td>
242 </tr>
243 </tbody>
244 </table>
245 </section>
246 <section id="mapping-description">
247 <h2>Mapping description</h2>
248 <p>The table below details where and how each variable was retrieved from the input product.</p>
249 <table class="docutils align-default">
250 <thead>
251 <tr class="row-odd"><th class="head"><p>field name</p></th>
252 <th class="head" colspan="2"><p>mapping description</p></th>
253 </tr>
254 </thead>
255 <tbody>
256 <tr class="row-even"><td rowspan="2"><p><strong>datetime</strong></p></td>
257 <td><p><em>path</em></p></td>
258 <td><p><strong>/&#64;time_reference_days_since_1950, /PRODUCT/delta_time[]</strong></p></td>
259 </tr>
260 <tr class="row-odd"><td><p><em>description</em></p></td>
261 <td><p>time reference converted from days since 1950-01-01 to seconds since 2020-01-01 (using 86400 seconds per day) and delta_time added</p></td>
262 </tr>
263 <tr class="row-even"><td rowspan="2"><p><strong>datetime_length</strong></p></td>
264 <td><p><em>path</em></p></td>
265 <td><p><strong>/PRODUCT/delta_time[]</strong></p></td>
266 </tr>
267 <tr class="row-odd"><td><p><em>description</em></p></td>
268 <td><p>delta_time[num_ground_pixels] - delta_time[0]</p></td>
269 </tr>
270 <tr class="row-even"><td><p><strong>latitude</strong></p></td>
271 <td><p><em>path</em></p></td>
272 <td><p><strong>/PRODUCT/latitude[]</strong></p></td>
273 </tr>
274 <tr class="row-odd"><td><p><strong>longitude</strong></p></td>
275 <td><p><em>path</em></p></td>
276 <td><p><strong>/PRODUCT/longitude[]</strong></p></td>
277 </tr>
278 <tr class="row-even"><td><p><strong>latitude_bounds</strong></p></td>
279 <td><p><em>path</em></p></td>
280 <td><p><strong>/PRODUCT/SUPPORT_DATA/GEOLOCATIONS/latitude_bounds[]</strong></p></td>
281 </tr>
282 <tr class="row-odd"><td><p><strong>longitude_bounds</strong></p></td>
283 <td><p><em>path</em></p></td>
284 <td><p><strong>/PRODUCT/SUPPORT_DATA/GEOLOCATIONS/longitude_bounds[]</strong></p></td>
285 </tr>
286 <tr class="row-even"><td><p><strong>validity</strong></p></td>
287 <td><p><em>path</em></p></td>
288 <td><p><strong>/PRODUCT/qa_value</strong></p></td>
289 </tr>
290 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_base_height</strong></p></td>
291 <td><p><em>condition</em></p></td>
292 <td><p>band unset</p></td>
293 </tr>
294 <tr class="row-even"><td><p><em>path</em></p></td>
295 <td><p><strong>/PRODUCT/cloud_base_height[]</strong></p></td>
296 </tr>
297 <tr class="row-odd"><td><p><em>condition</em></p></td>
298 <td><p>band=NIR</p></td>
299 </tr>
300 <tr class="row-even"><td><p><em>path</em></p></td>
301 <td><p><strong>/PRODUCT_NIR/cloud_base_height[]</strong></p></td>
302 </tr>
303 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_base_height_uncertainty</strong></p></td>
304 <td><p><em>condition</em></p></td>
305 <td><p>band unset</p></td>
306 </tr>
307 <tr class="row-even"><td><p><em>path</em></p></td>
308 <td><p><strong>/PRODUCT/cloud_base_height_precision[]</strong></p></td>
309 </tr>
310 <tr class="row-odd"><td><p><em>condition</em></p></td>
311 <td><p>band=NIR</p></td>
312 </tr>
313 <tr class="row-even"><td><p><em>path</em></p></td>
314 <td><p><strong>/PRODUCT_NIR/cloud_base_height_precision[]</strong></p></td>
315 </tr>
316 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_base_pressure</strong></p></td>
317 <td><p><em>condition</em></p></td>
318 <td><p>band unset</p></td>
319 </tr>
320 <tr class="row-even"><td><p><em>path</em></p></td>
321 <td><p><strong>/PRODUCT/cloud_base_pressure[]</strong></p></td>
322 </tr>
323 <tr class="row-odd"><td><p><em>condition</em></p></td>
324 <td><p>band=NIR</p></td>
325 </tr>
326 <tr class="row-even"><td><p><em>path</em></p></td>
327 <td><p><strong>/PRODUCT_NIR/cloud_base_pressure[]</strong></p></td>
328 </tr>
329 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_base_pressure_uncertainty</strong></p></td>
330 <td><p><em>condition</em></p></td>
331 <td><p>band unset</p></td>
332 </tr>
333 <tr class="row-even"><td><p><em>path</em></p></td>
334 <td><p><strong>/PRODUCT/cloud_base_pressure_precision[]</strong></p></td>
335 </tr>
336 <tr class="row-odd"><td><p><em>condition</em></p></td>
337 <td><p>band=NIR</p></td>
338 </tr>
339 <tr class="row-even"><td><p><em>path</em></p></td>
340 <td><p><strong>/PRODUCT_NIR/cloud_base_pressure_precision[]</strong></p></td>
341 </tr>
342 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_fraction</strong></p></td>
343 <td><p><em>condition</em></p></td>
344 <td><p>band unset</p></td>
345 </tr>
346 <tr class="row-even"><td><p><em>path</em></p></td>
347 <td><p><strong>/PRODUCT/cloud_fraction[]</strong></p></td>
348 </tr>
349 <tr class="row-odd"><td><p><em>condition</em></p></td>
350 <td><p>band=NIR</p></td>
351 </tr>
352 <tr class="row-even"><td><p><em>path</em></p></td>
353 <td><p><strong>/PRODUCT_NIR/cloud_fraction[]</strong></p></td>
354 </tr>
355 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_fraction_uncertainty</strong></p></td>
356 <td><p><em>condition</em></p></td>
357 <td><p>band unset</p></td>
358 </tr>
359 <tr class="row-even"><td><p><em>path</em></p></td>
360 <td><p><strong>/PRODUCT/cloud_fraction_precision[]</strong></p></td>
361 </tr>
362 <tr class="row-odd"><td><p><em>condition</em></p></td>
363 <td><p>band=NIR</p></td>
364 </tr>
365 <tr class="row-even"><td><p><em>path</em></p></td>
366 <td><p><strong>/PRODUCT_NIR/cloud_fraction_precision[]</strong></p></td>
367 </tr>
368 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_optical_depth</strong></p></td>
369 <td><p><em>condition</em></p></td>
370 <td><p>band unset</p></td>
371 </tr>
372 <tr class="row-even"><td><p><em>path</em></p></td>
373 <td><p><strong>/PRODUCT/cloud_optical_thickness[]</strong></p></td>
374 </tr>
375 <tr class="row-odd"><td><p><em>condition</em></p></td>
376 <td><p>band=NIR</p></td>
377 </tr>
378 <tr class="row-even"><td><p><em>path</em></p></td>
379 <td><p><strong>/PRODUCT_NIR/cloud_optical_thickness[]</strong></p></td>
380 </tr>
381 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_optical_depth_uncertainty</strong></p></td>
382 <td><p><em>condition</em></p></td>
383 <td><p>band unset</p></td>
384 </tr>
385 <tr class="row-even"><td><p><em>path</em></p></td>
386 <td><p><strong>/PRODUCT/cloud_optical_thickness_precision[]</strong></p></td>
387 </tr>
388 <tr class="row-odd"><td><p><em>condition</em></p></td>
389 <td><p>band=NIR</p></td>
390 </tr>
391 <tr class="row-even"><td><p><em>path</em></p></td>
392 <td><p><strong>/PRODUCT_NIR/cloud_optical_thickness_precision[]</strong></p></td>
393 </tr>
394 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_top_height</strong></p></td>
395 <td><p><em>condition</em></p></td>
396 <td><p>band unset</p></td>
397 </tr>
398 <tr class="row-even"><td><p><em>path</em></p></td>
399 <td><p><strong>/PRODUCT/cloud_top_height[]</strong></p></td>
400 </tr>
401 <tr class="row-odd"><td><p><em>condition</em></p></td>
402 <td><p>band=NIR</p></td>
403 </tr>
404 <tr class="row-even"><td><p><em>path</em></p></td>
405 <td><p><strong>/PRODUCT_NIR/cloud_top_height[]</strong></p></td>
406 </tr>
407 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_top_height_uncertainty</strong></p></td>
408 <td><p><em>condition</em></p></td>
409 <td><p>band unset</p></td>
410 </tr>
411 <tr class="row-even"><td><p><em>path</em></p></td>
412 <td><p><strong>/PRODUCT/cloud_top_height_precision[]</strong></p></td>
413 </tr>
414 <tr class="row-odd"><td><p><em>condition</em></p></td>
415 <td><p>band=NIR</p></td>
416 </tr>
417 <tr class="row-even"><td><p><em>path</em></p></td>
418 <td><p><strong>/PRODUCT_NIR/cloud_top_height_precision[]</strong></p></td>
419 </tr>
420 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_top_pressure</strong></p></td>
421 <td><p><em>condition</em></p></td>
422 <td><p>band unset</p></td>
423 </tr>
424 <tr class="row-even"><td><p><em>path</em></p></td>
425 <td><p><strong>/PRODUCT/cloud_top_pressure[]</strong></p></td>
426 </tr>
427 <tr class="row-odd"><td><p><em>condition</em></p></td>
428 <td><p>band=NIR</p></td>
429 </tr>
430 <tr class="row-even"><td><p><em>path</em></p></td>
431 <td><p><strong>/PRODUCT_NIR/cloud_top_pressure[]</strong></p></td>
432 </tr>
433 <tr class="row-odd"><td rowspan="4"><p><strong>cloud_top_pressure_uncertainty</strong></p></td>
434 <td><p><em>condition</em></p></td>
435 <td><p>band unset</p></td>
436 </tr>
437 <tr class="row-even"><td><p><em>path</em></p></td>
438 <td><p><strong>/PRODUCT/cloud_top_pressure_precision[]</strong></p></td>
439 </tr>
440 <tr class="row-odd"><td><p><em>condition</em></p></td>
441 <td><p>band=NIR</p></td>
442 </tr>
443 <tr class="row-even"><td><p><em>path</em></p></td>
444 <td><p><strong>/PRODUCT_NIR/cloud_top_pressure_precision[]</strong></p></td>
445 </tr>
446 </tbody>
447 </table>
448 </section>
449 </section>
450
451
452 </div>
453 </div>
454 <footer>
455
456 <hr/>
457
458 <div role="contentinfo">
459 <p>&#169; Copyright 2015-2026 S[&amp;]T, The Netherlands.</p>
460 </div>
461
462
463
464 </footer>
465 </div>
466 </div>
467 </section>
468 </div>
469 <script>
470 jQuery(function () {
471 SphinxRtdTheme.Navigation.enable(true);
472 });
473 </script>
474
475 </body>
476 </html>