docs/file_formats/hirelpp_product_format.rst

changeset 125
003aa42747f5
child 143
5358586fe387
equal deleted inserted replaced
124:becb9de86607 125:003aa42747f5
1 HiRELPP Products
2 ----------------
3
4 This section describe the structure of HiRELPP products.
5
6
7 HiRELPP Products: dimensions
8 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9
10 The following dimensions are defined in HiRELPP products:
11
12 - time
13 - level
14 - channel
15 - depolarization
16 - angle
17 - nv
18 - nc
19
20 The dimension *time* (mandatory) specifies the number of RCS (for each channel)
21 composing all the pre-processed time-series reported in the products.
22
23 The dimension *level* (mandatory) represents the number of rangebins characterizing
24 the pre-processed RCS.
25
26 The dimension *channel* (mandatory) indicates the number channels at which the RCS
27 time-series included in the product refer to.
28
29 The dimension *depolarization* (optional) indicates how many volume depolarization time-series are included in the products.
30
31 The dimension *angle* (mandatory) takes into account how many zenith scan angles have been used to measure the RCS time-series reported into the products.
32
33 The dimension *nv* (mandatory) is ancillary and it is always set to 2.
34
35 The dimension *nc* (optional) is ancillary and provides the number of channels involved in the calculation of RCS or volume depolarization time-series.
36
37
38 HiRELPP Products: variables
39 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
40
41 latitude
42 :Type: *double*
43 :Dimensions: --
44 :Variable\_Type: Mandatory
45 :Description: measurement site latitude
46 :Units: degrees_north
47 :Definition: *double latitude*
48
49 longitude
50 :Type: *double*
51 :Dimensions: --
52 :Variable\_Type: Mandatory
53 :Description: measurement site longitude
54 :Units: degrees_east
55 :Definition: *double longitude*
56
57 station\_altitude
58 :Type: *double*
59 :Dimensions: --
60 :Variable\_Type: Mandatory
61 :Description: station altitude above see level
62 :Units: m
63 :Definition: *double station\_altitude*
64
65 altitude
66 :Type: *double*
67 :Dimensions: *time, level*
68 :Variable\_Type: Mandatory
69 :Description: altitude above see level
70 :Units: m
71 :Definition: *double altitude(time, level)*
72
73 range
74 :Type: *double*
75 :Dimensions: *level*
76 :Variable\_Type: Mandatory
77 :Description: lidar range scale
78 :Units: m
79 :Definition: *double range(level)*
80
81 laser\_pointing\_angle
82 :Type: *double*
83 :Dimensions: *angle*
84 :Variable\_Type: Mandatory
85 :Description: laser pointing angle with respect to the zenith
86 :Units: degrees
87 :Definition: *double laser\_pointing\_angle(angle)*
88
89 laser\_pointing\_angle\_of\_profile
90 :Type: *int*
91 :Dimensions: *angle*
92 :Variable\_Type: Mandatory
93 :Description: index of scan angle at which each single raw profile has been detected
94 :Units: --
95 :Definition: *int laser\_pointing\_angle\_of\_profile(angle)*
96
97 shots
98 :Type: *int*
99 :Dimensions: *time*
100 :Variable\_Type: Mandatory
101 :Description: accumulated laser shots
102 :Units: --
103 :Definition: *int shots(time)*
104
105 time
106 :Type: *double*
107 :Dimensions: *time*
108 :Variable\_Type: Mandatory
109 :Description: seconds since 1970-01-01T00:00:00Z
110 :Units: --
111 :Definition: *double time(time)*
112
113 time\_bounds
114 :Type: *double*
115 :Dimensions: *time, nv*
116 :Variable\_Type: Mandatory
117 :Description: seconds since 1970-01-01T00:00:00Z
118 :Units: --
119 :Definition: *double time\_bounds(time,nv)*
120
121 scc\_product\_type
122 :Type: *byte*
123 :Dimensions: --
124 :Variable\_Type: Mandatory
125 :Description: Bitmask describing the SCC product type
126 :Units: --
127 :Definition: *byte scc\_product\_type*
128
129
130
131
132 range\_corrected\_signal\_channel\_id
133 :Type: *int*
134 :Dimensions: *channel, nc*
135 :Variable\_Type: Optional
136 :Description: SCC channel ID list involved in the calculation of the range corrected signal total timeseries
137 :Units: --
138 :Definition: *int range\_corrected\_signal\_channel\_id(channel, nc)*
139
140
141 range\_corrected\_signal\_channel\_name
142 :Type: *string*
143 :Dimensions: *channel*
144 :Variable\_Type: Mandatory
145 :Description: Channel name for the range corrected signal timeseries
146 :Units: --
147 :Definition: *string range\_corrected\_signal\_channel\_name(channel)*
148
149
150 range\_corrected\_signal\_emission\_wavelength
151 :Type: *double*
152 :Dimensions: *channel*
153 :Variable\_Type: Mandatory
154 :Description: Emission wavelength used to measure the range corrected signal timeseries
155 :Units: *nm*
156 :Definition: *double range\_corrected\_signal\_emission\_wavelength(channel)*
157
158
159 range\_corrected\_signal\_detection\_wavelength
160 :Type: *double*
161 :Dimensions: *channel*
162 :Variable\_Type: Mandatory
163 :Description: Detection wavelength used to measure the range corrected signal timeseries
164 :Units: *nm*
165 :Definition: *double range\_corrected\_signal\_detection\_wavelength(channel)*
166
167
168 range\_corrected\_signal\_range
169 :Type: *byte*
170 :Dimensions: *channel*
171 :Variable\_Type: Mandatory
172 :Description: Bitmask to identify range corrected signal range type
173 :Units: --
174 :Definition: *byte range\_corrected\_signal\_range(channel)*
175
176
177
178
179 range\_corrected\_signal\_scatterers
180 :Type: *byte*
181 :Dimensions: *channel*
182 :Variable\_Type: Mandatory
183 :Description: Bitmask to identify range corrected signal scatterer type
184 :Units: --
185 :Definition: *byte range\_corrected\_signal\_scatterers(channel)*
186
187
188
189
190
191 range\_corrected\_signal\_detection\_mode
192 :Type: *byte*
193 :Dimensions: *channel*
194 :Variable\_Type: Mandatory
195 :Description: Bitmask to identify range corrected signal detection mode
196 :Units: --
197 :Definition: *byte range\_corrected\_signal\_detection\_mode(channel)*
198
199
200 near\_range\_glueing\_region\_minimum
201 :Type: *double*
202 :Dimensions: *channel, time*
203 :Variable\_Type: Optional
204 :Description: Mininum altitude of glueing region for the near range and far range signals
205 :Units: *m*
206 :Definition: *double near\_range\_glueing\_region\_minimum(channel, time)*
207
208 near\_range\_glueing\_region\_maximum
209 :Type: *double*
210 :Dimensions: *channel, time*
211 :Variable\_Type: Optional
212 :Description: Mininum altitude of glueing region for the near range and far range signals
213 :Units: *m*
214 :Definition: *double near_range_glueing_region_maximum(channel, time)*
215
216 ultra\_near\_range\_glueing\_region\_minimum
217 :Type: *double*
218 :Dimensions: *channel, time*
219 :Variable\_Type: Optional
220 :Description: Mininum altitude of glueing region for the ultra near range and near range signals
221 :Units: *m*
222 :Definition: *double ultra\_near\_range\_glueing\_region\_minimum(channel, time)*
223
224 ultra\_near\_range\_glueing\_region\_maximum
225 :Type: *double*
226 :Dimensions: *channel, time*
227 :Variable\_Type: Optional
228 :Description: Maximum altitude of glueing region for the ultra near range and near range signals
229 :Units: *m*
230 :Definition: *double ultra\_near_range_glueing_region_maximum(channel, time)*
231
232
233 range\_corrected\_signal
234 :Type: *double*
235 :Dimensions: *channel, time, level*
236 :Variable\_Type: Mandatory
237 :Description: Range corrected signal timeseries
238 :Units: --
239 :Definition: *double range\_corrected\_signal(channel, time, level)*
240
241 range\_corrected\_signal\_statistical\_error
242 :Type: *double*
243 :Dimensions: *channel, time, level*
244 :Variable\_Type: Mandatory
245 :Description: Statistical error (uncertainty) on range corrected signal timeseries
246 :Units: --
247 :Definition: *double range\_corrected\_signal\_statistical\_error(channel, time, level)*
248
249
250 range\_corrected\_signal\_systematic\_error
251 :Type: *double*
252 :Dimensions: *channel, time, level*
253 :Variable\_Type: Optional
254 :Description: Systematic error (uncertainty) on range corrected signal timeseries
255 :Units: --
256 :Definition: *double range\_corrected\_signal\_statistical\_error(channel, time, level)*
257
258
259
260 atmospheric\_background
261 :Type: *double*
262 :Dimensions: *channel, time*
263 :Variable\_Type: Mandatory
264 :Description: Mean uncalibrated atmospheric background calculated from lidar signal
265 :Units: --
266 :Definition: *double atmospheric\_background(channel, time)*
267
268 atmospheric\_background\_stdev
269 :Type: *double*
270 :Dimensions: *channel, time*
271 :Variable\_Type: Mandatory
272 :Description: Standard deviation of uncalibrated atmospheric background calculated from lidar signal
273 :Units: --
274 :Definition: *double atmospheric\_background\_stdev(channel, time)*
275
276 atmospheric\_background\_sterr
277 :Type: *double*
278 :Dimensions: *channel, time*
279 :Variable\_Type: Mandatory
280 :Description: Standard error of uncalibrated atmospheric background calculated from lidar signal
281 :Units: --
282 :Definition: *double atmospheric\_background\_sterr(channel, time)*
283
284 atmospheric\_background\_min
285 :Type: *double*
286 :Dimensions: *channel, time*
287 :Variable\_Type: Mandatory
288 :Description: Minimum uncalibrated atmospheric background calculated from lidar signal
289 :Units: --
290 :Definition: *double atmospheric\_background\_min(channel, time)*
291
292 atmospheric\_background\_max
293 :Type: *double*
294 :Dimensions: *channel, time*
295 :Variable\_Type: Mandatory
296 :Description: Maximum uncalibrated atmospheric background calculated from lidar signal
297 :Units: --
298 :Definition: *double atmospheric\_background\_max(channel, time)*
299
300 polarization\_gain\_factor\_measurementid
301 :Type: *string*
302 :Dimensions: *depolarization*
303 :Variable\_Type: Optional
304 :Description: Measurement ID corresponding to the polarization measurements used to calibrate polarization channels
305 :Units: --
306 :Definition: *string polarization\_gain\_factor\_measurementid(depolarization)*
307
308 polarization\_gain\_factor
309 :Type: *double*
310 :Dimensions: *depolarization*
311 :Variable\_Type: Optional
312 :Description: Reflected to transmitted polarization channel gain factor (eta*)
313 :Units: --
314 :Definition: *double polarization\_gain\_factor(depolarization)*
315
316 polarization\_gain\_factor\_statistical\_error
317 :Type: *double*
318 :Dimensions: *depolarization*
319 :Variable\_Type: Optional
320 :Description: Statistical error (uncertainty) on reflected to transmitted polarization channel gain factor
321 :Units: --
322 :Definition: *double polarization\_gain\_factor\_statistical\_error(depolarization)*
323
324 polarization\_gain\_factor\_systematic\_error
325 :Type: *double*
326 :Dimensions: *depolarization*
327 :Variable\_Type: Optional
328 :Description: Systamatic error (uncertainty) on reflected to transmitted polarization channel gain factor
329 :Units: --
330 :Definition: *double polarization\_gain\_factor\_systematic\_error(depolarization)*
331
332
333 polarization\_gain\_factor\_start\_datetime
334 :Type: *double*
335 :Dimensions: *depolarization*
336 :Variable\_Type: Optional
337 :Description: Polarization gain factor measurement start datetime
338 :Units: seconds since 1970-01-01T00:00:00Z
339 :Definition: *double polarization\_gain\_factor\_start\_datetime(depolarization)*
340
341 polarization\_gain\_factor\_stop\_datetime
342 :Type: *double*
343 :Dimensions: *depolarization*
344 :Variable\_Type: Optional
345 :Description: Polarization gain factor measurement stop datetime
346 :Units: seconds since 1970-01-01T00:00:00Z
347 :Definition: *double polarization\_gain\_factor\_stop\_datetime(depolarization)*
348
349
350 polarization\_gain\_factor\_correction
351 :Type: *double*
352 :Dimensions: *depolarization*
353 :Variable\_Type: Optional
354 :Description: Reflected to transmitted polarization channel gain correction factor (K)
355 :Units: --
356 :Definition: *double polarization\_gain\_factor\_correction(depolarization)*
357
358 polarization\_gain\_factor\_correction\_statistical\_error
359 :Type: *double*
360 :Dimensions: *depolarization*
361 :Variable\_Type: Optional
362 :Description: Statistical error (uncertainty) on reflected to transmitted polarization channel gain correction factor
363 :Units: --
364 :Definition: *double polarization\_gain\_factor\_correction\_statistical_error(depolarization)*
365
366 polarization\_gain\_factor\_correction\_systematic\_error
367 :Type: *double*
368 :Dimensions: *depolarization*
369 :Variable\_Type: Optional
370 :Description: Systamatic error (uncertainty) on reflected to transmitted polarization channel gain correction factor
371 :Units: --
372 :Definition: *double polarization\_gain\_factor\_correction\_systematic\_error(depolarization)*
373
374
375 polarization\_gain\_factor\_correction\_start\_datetime
376 :Type: *double*
377 :Dimensions: *depolarization*
378 :Variable\_Type: Optional
379 :Description: Polarization gain corrrection factor measurement start datetime
380 :Units: seconds since 1970-01-01T00:00:00Z
381 :Definition: *double polarization\_gain\_factor\_correction\_start\_datetime(depolarization)*
382
383 polarization\_gain\_factor\_correction\_stop\_datetime
384 :Type: *double*
385 :Dimensions: *depolarization*
386 :Variable\_Type: Optional
387 :Description: Polarization gain correction factor measurement stop datetime
388 :Units: seconds since 1970-01-01T00:00:00Z
389 :Definition: *double polarization\_gain\_factor\_correction\_stop\_datetime(depolarization)*
390
391
392 volume\_linear\_depolarization\_ratio\_channel\_id
393 :Type: *int*
394 :Dimensions: *depolarization, nc*
395 :Variable\_Type: Optional
396 :Description: SCC channel ID list involved in the calculation of the volume linear depolarization ratio timeseries
397 :Units: --
398 :Definition: *int volume\_linear\_depolarization\_ratio\_channel\_id(depolarization, nc)*
399
400
401 volume\_linear\_depolarization\_ratio\_channel\_name
402 :Type: *string*
403 :Dimensions: *depolarization*
404 :Variable\_Type: Optional
405 :Description: Channel name for volume linear depolarization ration timeseries
406 :Units: --
407 :Definition: *string volume\_linear\_depolarization\_ratio\_channel\_name(depolarization)*
408
409
410 volume\_linear\_depolarization\_ratio\_wavelength
411 :Type: *double*
412 :Dimensions: *depolarization*
413 :Variable\_Type: Optional
414 :Description: Wavelength at which the volume linear depolarization ratio is calculated
415 :Units: *nm*
416 :Definition: *double volume\_linear\_depolarization\_ratio\_wavelength(depolarization)*
417
418
419 volume\_linear\_depolarization\_ratio\_range
420 :Type: *byte*
421 :Dimensions: *depolarization*
422 :Variable\_Type: Optional
423 :Description: Bitmask field indicating the volume linear depolarization range type
424 :Units: --
425 :Definition: *byte volume\_linear\_depolarization\_ratio\_range(depolarization)*
426
427
428
429 volume\_linear\_depolarization\_ratio\_scatterers
430 :Type: *byte*
431 :Dimensions: *depolarization*
432 :Variable\_Type: Optional
433 :Description: Bitmask field indicating the volume linear depolarization scatteter type
434 :Units: --
435 :Definition: *byte volume\_linear\_depolarization\_ratio\_scatterers(depolarization)*
436
437
438 volume\_linear\_depolarization\_ratio
439 :Type: *double*
440 :Dimensions: *depolarization, time, level*
441 :Variable\_Type: Optional
442 :Description: Volume linear depolarization ratio timeseries
443 :Units: --
444 :Definition: *double volume\_linear\_depolarization\_ratio(depolarization, time, level)*
445
446 volume\_linear\_depolarization\_ratio\_statistical\_error
447 :Type: *double*
448 :Dimensions: *depolarization, time, level*
449 :Variable\_Type: Optional
450 :Description: Statistical error (uncertanity) on volume linear depolarization ratio timeseries
451 :Units: --
452 :Definition: *double volume\_linear\_depolarization\_ratio\_statistical\_error(depolarization, time, level)*
453
454 volume\_linear\_depolarization\_ratio\_systematic\_error
455 :Type: *double*
456 :Dimensions: *depolarization, time, level*
457 :Variable\_Type: Optional
458 :Description: Systematic error (uncertanity) on volume linear depolarization ratio timeseries
459 :Units: --
460 :Definition: *double volume\_linear\_depolarization\_ratio\_systematic\_error(depolarization, time, level)*
461
462
463 HiRELPP Products: global attributes
464 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
465
466 Conventions
467 :Type: *string*
468 :Global\_Attribute\_Type: Mandatory
469 :Description: List of the conventions the product is compliant to
470
471
472 title
473 :Type: *string*
474 :Global\_Attribute\_Type: Mandatory
475 :Description: Product title
476
477 source
478 :Type: *string*
479 :Global\_Attribute\_Type: Mandatory
480 :Description: String describing the source used to generate the product
481
482 references
483 :Type: *string*
484 :Global\_Attribute\_Type: Mandatory
485 :Description: Reference(s) for data processing
486 location
487 :Type: *string*
488 :Global\_Attribute\_Type: Mandatory
489 :Description: Measurement site location
490
491 station_ID
492 :Type: *string*
493 :Global\_Attribute\_Type: Mandatory
494 :Description: Unique 3 digit code identifying SCC station
495
496 PI
497 :Type: *string*
498 :Global\_Attribute\_Type: Mandatory
499 :Description: PI full name
500
501 PI\_affiliation
502 :Type: *string*
503 :Global\_Attribute\_Type: Mandatory
504 :Description: PI complete affiliation
505
506 PI\_affiliation_acronym
507 :Type: *string*
508 :Global\_Attribute\_Type: Mandatory
509 :Description: PI affiliation acronym
510
511 PI\_address
512 :Type: *string*
513 :Global\_Attribute\_Type: Optional
514 :Description: PI address
515
516 PI\_phone
517 :Type: *string*
518 :Global\_Attribute\_Type: Optional
519 :Description: PI phone number
520
521 PI\_email
522 :Type: *string*
523 :Global\_Attribute\_Type: Mandatory
524 :Description: PI e-mail
525
526 Data\_Originator
527 :Type: *string*
528 :Global\_Attribute\_Type: Mandatory
529 :Description: Data originator full name
530
531 Data\_Originator\_affiliation
532 :Type: *string*
533 :Global\_Attribute\_Type: Mandatory
534 :Description: Data originator complete affiliation
535
536 Data\_Originator\_affiliation\_acronym
537 :Type: *string*
538 :Global\_Attribute\_Type: Mandatory
539 :Description: Data originator affiliation acronym
540
541 Data\_Originator\_address
542 :Type: *string*
543 :Global\_Attribute\_Type: Optional
544 :Description: Data originator complete address
545
546 Data\_Originator\_phone
547 :Type: *string*
548 :Global\_Attribute\_Type: Optional
549 :Description: Data originator phone number
550
551 Data\_Originator\_email
552 :Type: *string*
553 :Global\_Attribute\_Type: Mandatory
554 :Description: Data originator e-mail address
555
556 institution
557 :Type: *string*
558 :Global\_Attribute\_Type: Mandatory
559 :Description: Istitution the product belong to
560
561 system
562 :Type: *string*
563 :Global\_Attribute\_Type: Mandatory
564 :Description: Name of the measuring instrument (lidar)
565
566 hoi\_system\_ID
567 :Type: *int*
568 :Global\_Attribute\_Type: Mandatory
569 :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI)
570
571 hoi\_configuration\_ID;
572 :Type: *int*
573 :Global\_Attribute\_Type: Mandatory
574 :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI)
575
576 measurement\_ID;
577 :Type: *string*
578 :Global\_Attribute\_Type: Mandatory
579 :Description: Alphanumeric identifier for the raw data measurements use to generate the product
580
581 measurement\_start\_datetime
582 :Type: *string*
583 :Global\_Attribute\_Type: Mandatory
584 :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ
585
586 measurement\_stop\_datetime
587 :Type: *string*
588 :Global\_Attribute\_Type: Mandatory
589 :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ
590
591 comment
592 :Type: *string*
593 :Global\_Attribute\_Type: Optional
594 :Description: Any product comments
595
596 scc\_version\_description
597 :Type: *string*
598 :Global\_Attribute\_Type: Mandatory
599 :Description: Extended SCC version description
600
601 scc\_version
602 :Type: *string*
603 :Global\_Attribute\_Type: Mandatory
604 :Description: SCC version number
605
606 processor\_name
607 :Type: *string*
608 :Global\_Attribute\_Type: Mandatory
609 :Description: Name of the processor used to generate the product
610
611 processor\_version
612 :Type: *string*
613 :Global\_Attribute\_Type: Mandatory
614 :Description: Version of the processor used to generate the product
615
616 history
617 :Type: *string*
618 :Global\_Attribute\_Type: Mandatory
619 :Description: Field describing the history of the product
620
621 \_\_file\_format_version
622 :Type: *string*
623 :Global\_Attribute\_Type: Mandatory
624 :Description: Version of the product file format
625
626 data\_processing\_institution
627 :Type: *string*
628 :Global\_Attribute\_Type: Mandatory
629 :Description: Instituion responsible for data processing
630
631 input\_file
632 :Type: *string*
633 :Global\_Attribute\_Type: Mandatory
634 :Description: Filename of the input data product used to generate the current product
635

mercurial