comparison: docs/file_formats/eldec_product_format.rst
docs/file_formats/eldec_product_format.rst
- changeset 125
- 003aa42747f5
- child 142
- 5367b3cad3fb
equal
deleted
inserted
replaced
| 124:becb9de86607 | 125:003aa42747f5 |
|---|---|
| 1 ELDEC Products | |
| 2 -------------- | |
| 3 | |
| 4 This section describe the structure of ELDEC products. | |
| 5 | |
| 6 | |
| 7 ELDEC Products: dimensions | |
| 8 ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 9 | |
| 10 The following dimensions are defined in ELDEC products: | |
| 11 | |
| 12 - time | |
| 13 - altitude | |
| 14 - ratio | |
| 15 - calibration | |
| 16 - nv | |
| 17 | |
| 18 The dimension *time* (mandatory) specifies the number of calibration performed at different times. | |
| 19 | |
| 20 The dimension *altitude* (mandatory) represents the number of rangebins characterizing | |
| 21 the reflected to transmitted polarization calibration ratio. | |
| 22 | |
| 23 The dimension *ratio* (mandatory) indicates the number reflected to transmitted ratios included in the product. | |
| 24 | |
| 25 The dimension *calibration* indicates the number of calibrations provided by the product. | |
| 26 | |
| 27 The dimension *nv* (mandatory) is ancillary and it is always set to 2. | |
| 28 | |
| 29 | |
| 30 | |
| 31 ELDEC Products: variables | |
| 32 ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 33 | |
| 34 latitude | |
| 35 :Type: *double* | |
| 36 :Dimensions: -- | |
| 37 :Variable\_Type: Mandatory | |
| 38 :Description: measurement site latitude | |
| 39 :Units: degrees_north | |
| 40 :Definition: *double latitude* | |
| 41 | |
| 42 longitude | |
| 43 :Type: *double* | |
| 44 :Dimensions: -- | |
| 45 :Variable\_Type: Mandatory | |
| 46 :Description: measurement site longitude | |
| 47 :Units: degrees_east | |
| 48 :Definition: *double longitude* | |
| 49 | |
| 50 station\_altitude | |
| 51 :Type: *double* | |
| 52 :Dimensions: -- | |
| 53 :Variable\_Type: Mandatory | |
| 54 :Description: station altitude above see level | |
| 55 :Units: m | |
| 56 :Definition: *double station\_altitude* | |
| 57 | |
| 58 altitude | |
| 59 :Type: *double* | |
| 60 :Dimensions: *altitude* | |
| 61 :Variable\_Type: Mandatory | |
| 62 :Description: altitude above see level | |
| 63 :Units: m | |
| 64 :Definition: *double altitude(altitude)* | |
| 65 | |
| 66 range | |
| 67 :Type: *double* | |
| 68 :Dimensions: *altitude* | |
| 69 :Variable\_Type: Mandatory | |
| 70 :Description: lidar range scale | |
| 71 :Units: m | |
| 72 :Definition: *double range(altitude)* | |
| 73 | |
| 74 shots | |
| 75 :Type: *int* | |
| 76 :Dimensions: *time* | |
| 77 :Variable\_Type: Mandatory | |
| 78 :Description: accumulated laser shots | |
| 79 :Units: -- | |
| 80 :Definition: *int shots(time)* | |
| 81 | |
| 82 time | |
| 83 :Type: *double* | |
| 84 :Dimensions: *time* | |
| 85 :Variable\_Type: Mandatory | |
| 86 :Description: seconds since 1970-01-01T00:00:00Z | |
| 87 :Units: -- | |
| 88 :Definition: *double time(time)* | |
| 89 | |
| 90 time\_bounds | |
| 91 :Type: *double* | |
| 92 :Dimensions: *time, nv* | |
| 93 :Variable\_Type: Mandatory | |
| 94 :Description: seconds since 1970-01-01T00:00:00Z | |
| 95 :Units: -- | |
| 96 :Definition: *double time\_bounds(time,nv)* | |
| 97 | |
| 98 scc\_product\_type | |
| 99 :Type: *byte* | |
| 100 :Dimensions: -- | |
| 101 :Variable\_Type: Mandatory | |
| 102 :Description: Bitmask describing the SCC product type | |
| 103 :Units: -- | |
| 104 :Definition: *byte scc\_product\_type* | |
| 105 | |
| 106 polarization\_calibration\_ratio\_emission\_wavelength | |
| 107 :Type: *double* | |
| 108 :Dimensions: *ratio* | |
| 109 :Variable\_Type: Mandatory | |
| 110 :Description: Emission wavelength of the reflected to transmitted polarization calibration | |
| 111 :Units: *nm* | |
| 112 :Definition: *double polarization\_calibration\_ratio\_emission\_wavelength(ratio)* | |
| 113 | |
| 114 polarization\_calibration\_ratio\_detection\_wavelength | |
| 115 :Type: *double* | |
| 116 :Dimensions: *ratio* | |
| 117 :Variable\_Type: Mandatory | |
| 118 :Description: Detection wavelength of the reflected to transmitted polarization calibration | |
| 119 :Units: *nm* | |
| 120 :Definition: *double polarization\_calibration\_ratio\_detection\_wavelength(ratio)* | |
| 121 | |
| 122 polarization\_calibration\_ratio\_range | |
| 123 :Type: *byte* | |
| 124 :Dimensions: *ratio* | |
| 125 :Variable\_Type: Mandatory | |
| 126 :Description: Bitmask to identify the reflected to transmitted polarization calibration ratio range type | |
| 127 :Units: -- | |
| 128 :Definition: *byte polarization\_calibration\_ratio\_range(ratio)* | |
| 129 | |
| 130 polarization\_calibration\_ratio\_configuration | |
| 131 :Type: *byte* | |
| 132 :Dimensions: *ratio* | |
| 133 :Variable\_Type: Mandatory | |
| 134 :Description: Bitmask to identify the reflected to transmitted polarization calibration ratio configuration type | |
| 135 :Units: -- | |
| 136 :Definition: *byte polarization\_calibration\_ratio\_configuration(ratio)* | |
| 137 | |
| 138 polarization\_calibration\_ratio | |
| 139 :Type: *double* | |
| 140 :Dimensions: *ratio, time, altitude* | |
| 141 :Variable\_Type: Mandatory | |
| 142 :Description: Uncalibrated reflected to transmitted polarization calibration ratio | |
| 143 :Units: -- | |
| 144 :Definition: *double polarization\_calibration\_ratio(ratio, time, altitude)* | |
| 145 | |
| 146 polarization\_calibration\_ratio\_statistical\_error | |
| 147 :Type: *double* | |
| 148 :Dimensions: *ratio, time, altitude* | |
| 149 :Variable\_Type: Mandatory | |
| 150 :Description: Statistical error (uncertainty) on uncalibrated reflected to transmitted polarization calibration ratio | |
| 151 :Units: -- | |
| 152 :Definition: *double polarization\_calibration\_ratio\_statistical\_error(ratio, time, altitude)* | |
| 153 | |
| 154 polarization\_calibration\_ratio\_systematic\_error | |
| 155 :Type: *double* | |
| 156 :Dimensions: *ratio, time, altitude* | |
| 157 :Variable\_Type: Optional | |
| 158 :Description: Systematic error (uncertainty) on uncalibrated reflected to transmitted polarization calibration ratio | |
| 159 :Units: -- | |
| 160 :Definition: *double polarization\_calibration\_ratio\_statistical\_error(ratio, time, altitude)* | |
| 161 | |
| 162 polarization\_calibration\_minimum\_range | |
| 163 :Type: *double* | |
| 164 :Dimensions: *ratio* | |
| 165 :Variable\_Type: Mandatory | |
| 166 :Description: Minimum altitude to consider for polarization calibration | |
| 167 :Units: *m* | |
| 168 :Definition: *double polarization\_calibration\_minimum\_range(ratio)* | |
| 169 | |
| 170 | |
| 171 polarization\_calibration\_maximum\_range | |
| 172 :Type: *double* | |
| 173 :Dimensions: *ratio* | |
| 174 :Variable\_Type: Mandatory | |
| 175 :Description: Maximum altitude to consider for polarization calibration | |
| 176 :Units: *m* | |
| 177 :Definition: *double polarization\_calibration\_maximum\_range(ratio)* | |
| 178 | |
| 179 polarization\_calibration\_ratio\_average | |
| 180 :Type: *double* | |
| 181 :Dimensions: *ratio, time* | |
| 182 :Variable\_Type: Mandatory | |
| 183 :Description: Average of the polarization calibration ratio within the calibration range | |
| 184 :Units: -- | |
| 185 :Definition: *double polarization\_calibration\_ratio\_average(ratio, time)* | |
| 186 | |
| 187 polarization\_calibration\_ratio\_average\_statistical_error | |
| 188 :Type: *double* | |
| 189 :Dimensions: *ratio, time* | |
| 190 :Variable\_Type: Mandatory | |
| 191 :Description: Statistical error (uncertainty) on the average of the polarization calibration ratio within the calibration range | |
| 192 :Units: -- | |
| 193 :Definition: *double polarization\_calibration\_ratio\_average\_statistical\_error(ratio, time)* | |
| 194 | |
| 195 polarization\_calibration\_ratio\_average\_systematic_error | |
| 196 :Type: *double* | |
| 197 :Dimensions: *ratio, time* | |
| 198 :Variable\_Type: Optional | |
| 199 :Description: Systematic error (uncertainty) on the average of the polarization calibration ratio within the calibration range | |
| 200 :Units: -- | |
| 201 :Definition: *double polarization\_calibration\_ratio\_average\_systematic\_error(ratio, time)* | |
| 202 | |
| 203 polarization\_gain\_factor\_wavelength | |
| 204 :Type: *double* | |
| 205 :Dimensions: *calibration* | |
| 206 :Variable\_Type: Mandatory | |
| 207 :Description: Polarization gain factor wavelength | |
| 208 :Units: *nm* | |
| 209 :Definition: *double polarization\_gain\_factor\_wavelength(calibration)* | |
| 210 | |
| 211 polarization\_gain\_factor\_range | |
| 212 :Type: *byte* | |
| 213 :Dimensions: *calibration* | |
| 214 :Variable\_Type: Mandatory | |
| 215 :Description: Bitmask to describe the polarization gain factor range type | |
| 216 :Units: -- | |
| 217 :Definition: *byte polarization\_gain\_factor\_range(calibration)* | |
| 218 | |
| 219 | |
| 220 polarization\_gain\_factor | |
| 221 :Type: *double* | |
| 222 :Dimensions: *calibration, time* | |
| 223 :Variable\_Type: Mandatory | |
| 224 :Description: Polarization gain factor (eta*) | |
| 225 :Units: -- | |
| 226 :Definition: *double polarization\_gain\_factor(calibration, time)* | |
| 227 | |
| 228 polarization\_gain\_factor\_statistical\_error | |
| 229 :Type: *double* | |
| 230 :Dimensions: *calibration, time* | |
| 231 :Variable\_Type: Mandatory | |
| 232 :Description: Statistical error (uncertainty) on polarization gain factor (eta*) | |
| 233 :Units: -- | |
| 234 :Definition: *double polarization\_gain\_factor\_statistical\_error(calibration, time)* | |
| 235 | |
| 236 polarization\_gain\_factor\_systematic\_error | |
| 237 :Type: *double* | |
| 238 :Dimensions: *calibration, time* | |
| 239 :Variable\_Type: Optional | |
| 240 :Description: Systematic error (uncertainty) on polarization gain factor (eta*) | |
| 241 :Units: -- | |
| 242 :Definition: *double polarization\_gain\_factor\_systematic\_error(calibration, time)* | |
| 243 | |
| 244 | |
| 245 ELDEC Products: global attributes | |
| 246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 247 | |
| 248 Conventions | |
| 249 :Type: *string* | |
| 250 :Global\_Attribute\_Type: Mandatory | |
| 251 :Description: List of the conventions the product is compliant to | |
| 252 | |
| 253 | |
| 254 title | |
| 255 :Type: *string* | |
| 256 :Global\_Attribute\_Type: Mandatory | |
| 257 :Description: Product title | |
| 258 | |
| 259 source | |
| 260 :Type: *string* | |
| 261 :Global\_Attribute\_Type: Mandatory | |
| 262 :Description: String describing the source used to generate the product | |
| 263 | |
| 264 references | |
| 265 :Type: *string* | |
| 266 :Global\_Attribute\_Type: Mandatory | |
| 267 :Description: Reference(s) for data processing | |
| 268 location | |
| 269 :Type: *string* | |
| 270 :Global\_Attribute\_Type: Mandatory | |
| 271 :Description: Measurement site location | |
| 272 | |
| 273 station_ID | |
| 274 :Type: *string* | |
| 275 :Global\_Attribute\_Type: Mandatory | |
| 276 :Description: Unique 3 digit code identifying SCC station | |
| 277 | |
| 278 PI | |
| 279 :Type: *string* | |
| 280 :Global\_Attribute\_Type: Mandatory | |
| 281 :Description: PI full name | |
| 282 | |
| 283 PI\_affiliation | |
| 284 :Type: *string* | |
| 285 :Global\_Attribute\_Type: Mandatory | |
| 286 :Description: PI complete affiliation | |
| 287 | |
| 288 PI\_affiliation_acronym | |
| 289 :Type: *string* | |
| 290 :Global\_Attribute\_Type: Mandatory | |
| 291 :Description: PI affiliation acronym | |
| 292 | |
| 293 PI\_address | |
| 294 :Type: *string* | |
| 295 :Global\_Attribute\_Type: Optional | |
| 296 :Description: PI address | |
| 297 | |
| 298 PI\_phone | |
| 299 :Type: *string* | |
| 300 :Global\_Attribute\_Type: Optional | |
| 301 :Description: PI phone number | |
| 302 | |
| 303 PI\_email | |
| 304 :Type: *string* | |
| 305 :Global\_Attribute\_Type: Mandatory | |
| 306 :Description: PI e-mail | |
| 307 | |
| 308 Data\_Originator | |
| 309 :Type: *string* | |
| 310 :Global\_Attribute\_Type: Mandatory | |
| 311 :Description: Data originator full name | |
| 312 | |
| 313 Data\_Originator\_affiliation | |
| 314 :Type: *string* | |
| 315 :Global\_Attribute\_Type: Mandatory | |
| 316 :Description: Data originator complete affiliation | |
| 317 | |
| 318 Data\_Originator\_affiliation\_acronym | |
| 319 :Type: *string* | |
| 320 :Global\_Attribute\_Type: Mandatory | |
| 321 :Description: Data originator affiliation acronym | |
| 322 | |
| 323 Data\_Originator\_address | |
| 324 :Type: *string* | |
| 325 :Global\_Attribute\_Type: Optional | |
| 326 :Description: Data originator complete address | |
| 327 | |
| 328 Data\_Originator\_phone | |
| 329 :Type: *string* | |
| 330 :Global\_Attribute\_Type: Optional | |
| 331 :Description: Data originator phone number | |
| 332 | |
| 333 Data\_Originator\_email | |
| 334 :Type: *string* | |
| 335 :Global\_Attribute\_Type: Mandatory | |
| 336 :Description: Data originator e-mail address | |
| 337 | |
| 338 institution | |
| 339 :Type: *string* | |
| 340 :Global\_Attribute\_Type: Mandatory | |
| 341 :Description: Istitution the product belong to | |
| 342 | |
| 343 system | |
| 344 :Type: *string* | |
| 345 :Global\_Attribute\_Type: Mandatory | |
| 346 :Description: Name of the measuring instrument (lidar) | |
| 347 | |
| 348 hoi\_system\_ID | |
| 349 :Type: *int* | |
| 350 :Global\_Attribute\_Type: Mandatory | |
| 351 :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) | |
| 352 | |
| 353 hoi\_configuration\_ID; | |
| 354 :Type: *int* | |
| 355 :Global\_Attribute\_Type: Mandatory | |
| 356 :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) | |
| 357 | |
| 358 measurement\_ID; | |
| 359 :Type: *string* | |
| 360 :Global\_Attribute\_Type: Mandatory | |
| 361 :Description: Alphanumeric identifier for the raw data measurements use to generate the product | |
| 362 | |
| 363 measurement\_start\_datetime | |
| 364 :Type: *string* | |
| 365 :Global\_Attribute\_Type: Mandatory | |
| 366 :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ | |
| 367 | |
| 368 measurement\_stop\_datetime | |
| 369 :Type: *string* | |
| 370 :Global\_Attribute\_Type: Mandatory | |
| 371 :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ | |
| 372 | |
| 373 comment | |
| 374 :Type: *string* | |
| 375 :Global\_Attribute\_Type: Optional | |
| 376 :Description: Any product comments | |
| 377 | |
| 378 scc\_version\_description | |
| 379 :Type: *string* | |
| 380 :Global\_Attribute\_Type: Mandatory | |
| 381 :Description: Extended SCC version description | |
| 382 | |
| 383 scc\_version | |
| 384 :Type: *string* | |
| 385 :Global\_Attribute\_Type: Mandatory | |
| 386 :Description: SCC version number | |
| 387 | |
| 388 processor\_name | |
| 389 :Type: *string* | |
| 390 :Global\_Attribute\_Type: Mandatory | |
| 391 :Description: Name of the processor used to generate the product | |
| 392 | |
| 393 processor\_version | |
| 394 :Type: *string* | |
| 395 :Global\_Attribute\_Type: Mandatory | |
| 396 :Description: Version of the processor used to generate the product | |
| 397 | |
| 398 history | |
| 399 :Type: *string* | |
| 400 :Global\_Attribute\_Type: Mandatory | |
| 401 :Description: Field describing the history of the product | |
| 402 | |
| 403 \_\_file\_format_version | |
| 404 :Type: *string* | |
| 405 :Global\_Attribute\_Type: Mandatory | |
| 406 :Description: Version of the product file format | |
| 407 | |
| 408 data\_processing\_institution | |
| 409 :Type: *string* | |
| 410 :Global\_Attribute\_Type: Mandatory | |
| 411 :Description: Instituion responsible for data processing | |
| 412 | |
| 413 input\_file | |
| 414 :Type: *string* | |
| 415 :Global\_Attribute\_Type: Mandatory | |
| 416 :Description: Filename of the input data product used to generate the current product |
