comparison: docs/file_formats/cloudscreen_product_format.rst
docs/file_formats/cloudscreen_product_format.rst
- changeset 125
- 003aa42747f5
equal
deleted
inserted
replaced
| 124:becb9de86607 | 125:003aa42747f5 |
|---|---|
| 1 CloudScreen Products | |
| 2 -------------------- | |
| 3 | |
| 4 This section describe the structure of CloudScreen products. | |
| 5 | |
| 6 | |
| 7 CloudScreen Products: dimensions | |
| 8 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 9 | |
| 10 The following dimensions are defined in CloudScreen products: | |
| 11 | |
| 12 - time | |
| 13 - level | |
| 14 - nv | |
| 15 | |
| 16 The dimension *time* (mandatory) specifies the number of cloudmask vertical profiles reported in the products. | |
| 17 | |
| 18 The dimension *level* (mandatory) represents the number of rangebins characterizing | |
| 19 each cloudmask verical profile. | |
| 20 | |
| 21 The dimension *nv* (mandatory) is ancillary and it is always set to 2. | |
| 22 | |
| 23 | |
| 24 | |
| 25 CloudScreen Products: variables | |
| 26 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 27 | |
| 28 latitude | |
| 29 :Type: *double* | |
| 30 :Dimensions: -- | |
| 31 :Variable\_Type: Mandatory | |
| 32 :Description: measurement site latitude | |
| 33 :Units: degrees_north | |
| 34 :Definition: *double latitude* | |
| 35 | |
| 36 longitude | |
| 37 :Type: *double* | |
| 38 :Dimensions: -- | |
| 39 :Variable\_Type: Mandatory | |
| 40 :Description: measurement site longitude | |
| 41 :Units: degrees_east | |
| 42 :Definition: *double longitude* | |
| 43 | |
| 44 station\_altitude | |
| 45 :Type: *double* | |
| 46 :Dimensions: -- | |
| 47 :Variable\_Type: Mandatory | |
| 48 :Description: station altitude above see level | |
| 49 :Units: m | |
| 50 :Definition: *double station\_altitude* | |
| 51 | |
| 52 altitude | |
| 53 :Type: *double* | |
| 54 :Dimensions: *time, level* | |
| 55 :Variable\_Type: Mandatory | |
| 56 :Description: altitude above see level | |
| 57 :Units: m | |
| 58 :Definition: *double altitude(time, level)* | |
| 59 | |
| 60 scc\_product\_type | |
| 61 :Type: *byte* | |
| 62 :Dimensions: -- | |
| 63 :Variable\_Type: Mandatory | |
| 64 :Description: Bitmask describing the SCC product type | |
| 65 :Units: -- | |
| 66 :Definition: *byte scc\_product\_type* | |
| 67 | |
| 68 time | |
| 69 :Type: *double* | |
| 70 :Dimensions: *time* | |
| 71 :Variable\_Type: Mandatory | |
| 72 :Description: seconds since 1970-01-01T00:00:00Z | |
| 73 :Units: -- | |
| 74 :Definition: *double time(time)* | |
| 75 | |
| 76 time\_bounds | |
| 77 :Type: *double* | |
| 78 :Dimensions: *time, nv* | |
| 79 :Variable\_Type: Mandatory | |
| 80 :Description: seconds since 1970-01-01T00:00:00Z | |
| 81 :Units: -- | |
| 82 :Definition: *double time\_bounds(time,nv)* | |
| 83 | |
| 84 automatic\_cloud\_mask | |
| 85 :Type: *byte* | |
| 86 :Dimensions: *time, level* | |
| 87 :Variable\_Type: Mandatory | |
| 88 :Description: Automatic cloudmask | |
| 89 :Units: -- | |
| 90 :Definition: *byte automatic\_cloud\_mask(time, level)* | |
| 91 | |
| 92 manual\_cloud\_mask | |
| 93 :Type: *byte* | |
| 94 :Dimensions: *time, level* | |
| 95 :Variable\_Type: Optional | |
| 96 :Description: Manual cloudmask | |
| 97 :Units: -- | |
| 98 :Definition: *byte manual\_cloud\_mask(time, level)* | |
| 99 | |
| 100 | |
| 101 CloudScreen Products: global attributes | |
| 102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 103 | |
| 104 Conventions | |
| 105 :Type: *string* | |
| 106 :Global\_Attribute\_Type: Mandatory | |
| 107 :Description: List of the conventions the product is compliant to | |
| 108 | |
| 109 | |
| 110 title | |
| 111 :Type: *string* | |
| 112 :Global\_Attribute\_Type: Mandatory | |
| 113 :Description: Product title | |
| 114 | |
| 115 source | |
| 116 :Type: *string* | |
| 117 :Global\_Attribute\_Type: Mandatory | |
| 118 :Description: String describing the source used to generate the product | |
| 119 | |
| 120 references | |
| 121 :Type: *string* | |
| 122 :Global\_Attribute\_Type: Mandatory | |
| 123 :Description: Reference(s) for data processing | |
| 124 location | |
| 125 :Type: *string* | |
| 126 :Global\_Attribute\_Type: Mandatory | |
| 127 :Description: Measurement site location | |
| 128 | |
| 129 station_ID | |
| 130 :Type: *string* | |
| 131 :Global\_Attribute\_Type: Mandatory | |
| 132 :Description: Unique 3 digit code identifying SCC station | |
| 133 | |
| 134 PI | |
| 135 :Type: *string* | |
| 136 :Global\_Attribute\_Type: Mandatory | |
| 137 :Description: PI full name | |
| 138 | |
| 139 PI\_affiliation | |
| 140 :Type: *string* | |
| 141 :Global\_Attribute\_Type: Mandatory | |
| 142 :Description: PI complete affiliation | |
| 143 | |
| 144 PI\_affiliation_acronym | |
| 145 :Type: *string* | |
| 146 :Global\_Attribute\_Type: Mandatory | |
| 147 :Description: PI affiliation acronym | |
| 148 | |
| 149 PI\_address | |
| 150 :Type: *string* | |
| 151 :Global\_Attribute\_Type: Optional | |
| 152 :Description: PI address | |
| 153 | |
| 154 PI\_phone | |
| 155 :Type: *string* | |
| 156 :Global\_Attribute\_Type: Optional | |
| 157 :Description: PI phone number | |
| 158 | |
| 159 PI\_email | |
| 160 :Type: *string* | |
| 161 :Global\_Attribute\_Type: Mandatory | |
| 162 :Description: PI e-mail | |
| 163 | |
| 164 Data\_Originator | |
| 165 :Type: *string* | |
| 166 :Global\_Attribute\_Type: Mandatory | |
| 167 :Description: Data originator full name | |
| 168 | |
| 169 Data\_Originator\_affiliation | |
| 170 :Type: *string* | |
| 171 :Global\_Attribute\_Type: Mandatory | |
| 172 :Description: Data originator complete affiliation | |
| 173 | |
| 174 Data\_Originator\_affiliation\_acronym | |
| 175 :Type: *string* | |
| 176 :Global\_Attribute\_Type: Mandatory | |
| 177 :Description: Data originator affiliation acronym | |
| 178 | |
| 179 Data\_Originator\_address | |
| 180 :Type: *string* | |
| 181 :Global\_Attribute\_Type: Optional | |
| 182 :Description: Data originator complete address | |
| 183 | |
| 184 Data\_Originator\_phone | |
| 185 :Type: *string* | |
| 186 :Global\_Attribute\_Type: Optional | |
| 187 :Description: Data originator phone number | |
| 188 | |
| 189 Data\_Originator\_email | |
| 190 :Type: *string* | |
| 191 :Global\_Attribute\_Type: Mandatory | |
| 192 :Description: Data originator e-mail address | |
| 193 | |
| 194 institution | |
| 195 :Type: *string* | |
| 196 :Global\_Attribute\_Type: Mandatory | |
| 197 :Description: Istitution the product belong to | |
| 198 | |
| 199 system | |
| 200 :Type: *string* | |
| 201 :Global\_Attribute\_Type: Mandatory | |
| 202 :Description: Name of the measuring instrument (lidar) | |
| 203 | |
| 204 hoi\_system\_ID | |
| 205 :Type: *int* | |
| 206 :Global\_Attribute\_Type: Mandatory | |
| 207 :Description: Numeric ID identifying the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) | |
| 208 | |
| 209 hoi\_configuration\_ID; | |
| 210 :Type: *int* | |
| 211 :Global\_Attribute\_Type: Mandatory | |
| 212 :Description: Numeric ID identifying the configuration of the measuring system in the ACTRIS/EARLINET Handbook Of Instrument (HOI) | |
| 213 | |
| 214 measurement\_ID; | |
| 215 :Type: *string* | |
| 216 :Global\_Attribute\_Type: Mandatory | |
| 217 :Description: Alphanumeric identifier for the raw data measurements use to generate the product | |
| 218 | |
| 219 measurement\_start\_datetime | |
| 220 :Type: *string* | |
| 221 :Global\_Attribute\_Type: Mandatory | |
| 222 :Description: Measurement start datetime YYYY-mm-ddTHH:MM:SSZ | |
| 223 | |
| 224 measurement\_stop\_datetime | |
| 225 :Type: *string* | |
| 226 :Global\_Attribute\_Type: Mandatory | |
| 227 :Description: Measruement stop datetime YYYY-mm-ddTHH:MM:SSZ | |
| 228 | |
| 229 comment | |
| 230 :Type: *string* | |
| 231 :Global\_Attribute\_Type: Optional | |
| 232 :Description: Any product comments | |
| 233 | |
| 234 scc\_version\_description | |
| 235 :Type: *string* | |
| 236 :Global\_Attribute\_Type: Mandatory | |
| 237 :Description: Extended SCC version description | |
| 238 | |
| 239 scc\_version | |
| 240 :Type: *string* | |
| 241 :Global\_Attribute\_Type: Mandatory | |
| 242 :Description: SCC version number | |
| 243 | |
| 244 processor\_name | |
| 245 :Type: *string* | |
| 246 :Global\_Attribute\_Type: Mandatory | |
| 247 :Description: Name of the processor used to generate the product | |
| 248 | |
| 249 processor\_algorithm | |
| 250 :Type: *string* | |
| 251 :Global\_Attribute\_Type: Mandatory | |
| 252 :Description: Name of the cloudmask algorithm | |
| 253 | |
| 254 processor\_version | |
| 255 :Type: *string* | |
| 256 :Global\_Attribute\_Type: Mandatory | |
| 257 :Description: Version of the processor used to generate the product | |
| 258 | |
| 259 history | |
| 260 :Type: *string* | |
| 261 :Global\_Attribute\_Type: Mandatory | |
| 262 :Description: Field describing the history of the product | |
| 263 | |
| 264 \_\_file\_format_version | |
| 265 :Type: *string* | |
| 266 :Global\_Attribute\_Type: Mandatory | |
| 267 :Description: Version of the product file format | |
| 268 | |
| 269 data\_processing\_institution | |
| 270 :Type: *string* | |
| 271 :Global\_Attribute\_Type: Mandatory | |
| 272 :Description: Instituion responsible for data processing | |
| 273 | |
| 274 input\_file | |
| 275 :Type: *string* | |
| 276 :Global\_Attribute\_Type: Mandatory | |
| 277 :Description: Filename of the input data product used to generate the current product | |
| 278 | |
| 279 automatic\_mask\_channels | |
| 280 :Type: *string* | |
| 281 :Global\_Attribute\_Type: Mandatory | |
| 282 :Description: Channels used to generate the cloumask (SCC channel names) |
