docs/file_formats/bitmask_flag_description.rst

Fri, 19 Mar 2021 13:43:18 +0100

author
Giuseppe D'Amico <giuseppe.damico@imaa.cnr.it>
date
Fri, 19 Mar 2021 13:43:18 +0100
changeset 125
003aa42747f5
permissions
-rw-r--r--

Update part concerning SCC data product file format description. Added also general section on basic lidar equations.

giuseppe@125 1 SCC Bitmask/flag description
giuseppe@125 2 ----------------------------
giuseppe@125 3
giuseppe@125 4 In this section a description of all the SCC bitmask or flag fields is provided.
giuseppe@125 5
giuseppe@125 6 Bitmask fields
giuseppe@125 7 ###############
giuseppe@125 8
giuseppe@125 9 **Table A1:** SCC product type bitmask description
giuseppe@125 10
giuseppe@125 11 +-----+--------------------+
giuseppe@125 12 | Bit | Description |
giuseppe@125 13 +=====+====================+
giuseppe@125 14 | 1st | experimental |
giuseppe@125 15 +-----+--------------------+
giuseppe@125 16 | 2nd | operational |
giuseppe@125 17 +-----+--------------------+
giuseppe@125 18
giuseppe@125 19 **Table A2:** Range type bitmask description
giuseppe@125 20
giuseppe@125 21 +-----+--------------------+
giuseppe@125 22 | Bit | Description |
giuseppe@125 23 +=====+====================+
giuseppe@125 24 | 1st | ultra\_near\_range |
giuseppe@125 25 +-----+--------------------+
giuseppe@125 26 | 2nd | near\_range |
giuseppe@125 27 +-----+--------------------+
giuseppe@125 28 | 3rd | far\_range |
giuseppe@125 29 +-----+--------------------+
giuseppe@125 30
giuseppe@125 31 **Table A3:** Scatteters type bitmask description
giuseppe@125 32
giuseppe@125 33 +-----+--------------------+
giuseppe@125 34 | Bit | Description |
giuseppe@125 35 +=====+====================+
giuseppe@125 36 | 1st | particle |
giuseppe@125 37 +-----+--------------------+
giuseppe@125 38 | 2nd | nitrogen |
giuseppe@125 39 +-----+--------------------+
giuseppe@125 40 | 3rd | oxygen |
giuseppe@125 41 +-----+--------------------+
giuseppe@125 42 | 4th | water\_vapour |
giuseppe@125 43 +-----+--------------------+
giuseppe@125 44
giuseppe@125 45 **Table A4:** Detection mode bitmask description
giuseppe@125 46
giuseppe@125 47 +-----+--------------------+
giuseppe@125 48 | Bit | Description |
giuseppe@125 49 +=====+====================+
giuseppe@125 50 | 1st | analog |
giuseppe@125 51 +-----+--------------------+
giuseppe@125 52 | 2nd | photoncountin |
giuseppe@125 53 +-----+--------------------+
giuseppe@125 54
giuseppe@125 55 **Table A5:** Cloudmask bitmask description
giuseppe@125 56
giuseppe@125 57 +-----+--------------------+
giuseppe@125 58 | Bit | Description |
giuseppe@125 59 +=====+====================+
giuseppe@125 60 | 1st | unknown cloud |
giuseppe@125 61 +-----+--------------------+
giuseppe@125 62 | 2nd | cirrus |
giuseppe@125 63 +-----+--------------------+
giuseppe@125 64 | 3rd | mixed-phase cloud |
giuseppe@125 65 +-----+--------------------+
giuseppe@125 66
giuseppe@125 67 **Table A6:** Cloudmask type bitmask description
giuseppe@125 68
giuseppe@125 69 +-----+--------------------+
giuseppe@125 70 | Bit | Description |
giuseppe@125 71 +=====+====================+
giuseppe@125 72 | 1st | manual cloudmask |
giuseppe@125 73 +-----+--------------------+
giuseppe@125 74 | 2nd | automatic cloudmask|
giuseppe@125 75 +-----+--------------------+
giuseppe@125 76
giuseppe@125 77
giuseppe@125 78 **Table A.7:** Polarization channel geometry bitmask description
giuseppe@125 79
giuseppe@125 80 +-----+--------------------+
giuseppe@125 81 | Bit | Description |
giuseppe@125 82 +=====+====================+
giuseppe@125 83 | 1st | transmitted signal |
giuseppe@125 84 +-----+--------------------+
giuseppe@125 85 | 2nd | reflected signal |
giuseppe@125 86 +-----+--------------------+
giuseppe@125 87
giuseppe@125 88 **Table A.8:** Polarization channel configuration bitmask description
giuseppe@125 89
giuseppe@125 90 +-----+--------------------+
giuseppe@125 91 | Bit | Description |
giuseppe@125 92 +=====+====================+
giuseppe@125 93 | 1st | 0 degrees |
giuseppe@125 94 +-----+--------------------+
giuseppe@125 95 | 2nd | 90 degrees |
giuseppe@125 96 +-----+--------------------+
giuseppe@125 97 | 3rd | +45 degree |
giuseppe@125 98 +-----+--------------------+
giuseppe@125 99 | 4th | -45 degrees |
giuseppe@125 100 +-----+--------------------+
giuseppe@125 101
giuseppe@125 102 **Table A.9:** Polarization calibration type bitmask description
giuseppe@125 103
giuseppe@125 104 +-----+--------------------+
giuseppe@125 105 | Bit | Description |
giuseppe@125 106 +=====+====================+
giuseppe@125 107 | 1st | automatic |
giuseppe@125 108 +-----+--------------------+
giuseppe@125 109 | 2nd | manual |
giuseppe@125 110 +-----+--------------------+
giuseppe@125 111
giuseppe@125 112 **Table A.10:** User defind category bitmask description
giuseppe@125 113
giuseppe@125 114 +------+-----------------------+
giuseppe@125 115 | Bit | Description |
giuseppe@125 116 +======+=======================+
giuseppe@125 117 | 1st | cirrus |
giuseppe@125 118 +------+-----------------------+
giuseppe@125 119 | 2nd | climatol |
giuseppe@125 120 +------+-----------------------+
giuseppe@125 121 | 3rd | dicucles |
giuseppe@125 122 +------+-----------------------+
giuseppe@125 123 | 4th | volcanic |
giuseppe@125 124 +------+-----------------------+
giuseppe@125 125 | 5th | forfires |
giuseppe@125 126 +------+-----------------------+
giuseppe@125 127 | 6th | photosmog |
giuseppe@125 128 +------+-----------------------+
giuseppe@125 129 | 7th | rurban |
giuseppe@125 130 +------+-----------------------+
giuseppe@125 131 | 8th | sahadust |
giuseppe@125 132 +------+-----------------------+
giuseppe@125 133 | 9th | stratos |
giuseppe@125 134 +------+-----------------------+
giuseppe@125 135 | 10th | satallite\_overpasses |
giuseppe@125 136 +-----+------------------------+
giuseppe@125 137
giuseppe@125 138 Flag fields
giuseppe@125 139 ###########
giuseppe@125 140
giuseppe@125 141
giuseppe@125 142 **Table B.1:** Molecular calculation source flag description
giuseppe@125 143
giuseppe@125 144 +-------+--------------------------+
giuseppe@125 145 | Value | Description |
giuseppe@125 146 +=======+==========================+
giuseppe@125 147 | 0 | US standard atmosphere |
giuseppe@125 148 +-------+--------------------------+
giuseppe@125 149 | 1 | Radiosounding |
giuseppe@125 150 +-------+--------------------------+
giuseppe@125 151 | 2 | ECMWF forecast |
giuseppe@125 152 +-------+--------------------------+
giuseppe@125 153 | 3 | ICON-IGLO-12-13 forecast |
giuseppe@125 154 +-------+--------------------------+
giuseppe@125 155 | 4 | ICON-IGLO-24-25 forecast |
giuseppe@125 156 +-------+--------------------------+
giuseppe@125 157 | 5 | ICON-IGLO-36-47 forecast |
giuseppe@125 158 +-------+--------------------------+
giuseppe@125 159 | 6 | GDAS forecast |
giuseppe@125 160 +-------+--------------------------+
giuseppe@125 161 | 7 | ERA5-1-12 |
giuseppe@125 162 +-------+--------------------------+
giuseppe@125 163 | 8 | ERA5-7-18 |
giuseppe@125 164 +-------+--------------------------+
giuseppe@125 165
giuseppe@125 166 **Table B.2:** Cirrus contamination flag description
giuseppe@125 167
giuseppe@125 168 +-------+--------------------------+
giuseppe@125 169 | Value | Description |
giuseppe@125 170 +=======+==========================+
giuseppe@125 171 | 0 | not available |
giuseppe@125 172 +-------+--------------------------+
giuseppe@125 173 | 1 | no cirrus |
giuseppe@125 174 +-------+--------------------------+
giuseppe@125 175 | 2 | cirrus detecte |
giuseppe@125 176 +-------+--------------------------+
giuseppe@125 177
giuseppe@125 178 **Table B.3:** Cirrus contamination source flag description
giuseppe@125 179
giuseppe@125 180 +-------+--------------------------+
giuseppe@125 181 | Value | Description |
giuseppe@125 182 +=======+==========================+
giuseppe@125 183 | 0 | not available |
giuseppe@125 184 +-------+--------------------------+
giuseppe@125 185 | 1 | user provid |
giuseppe@125 186 +-------+--------------------------+
giuseppe@125 187 | 2 | automatic calculate |
giuseppe@125 188 +-------+--------------------------+
giuseppe@125 189
giuseppe@125 190 **Table B.4:** Error retrieval method flag description
giuseppe@125 191
giuseppe@125 192 +-------+----------------------------+
giuseppe@125 193 | Value | Description |
giuseppe@125 194 +=======+============================+
giuseppe@125 195 | 0 | Monte Carlo |
giuseppe@125 196 +-------+----------------------------+
giuseppe@125 197 | 1 | Standard error propagation |
giuseppe@125 198 +-------+----------------------------+
giuseppe@125 199 | 2 | automatic calculate |
giuseppe@125 200 +-------+----------------------------+
giuseppe@125 201
giuseppe@125 202 **Table B.5:** Backscatter evaluation method flag description
giuseppe@125 203
giuseppe@125 204 +-------+----------------------------+
giuseppe@125 205 | Value | Description |
giuseppe@125 206 +=======+============================+
giuseppe@125 207 | 0 | Raman |
giuseppe@125 208 +-------+----------------------------+
giuseppe@125 209 | 1 | Elastic |
giuseppe@125 210 +-------+----------------------------+
giuseppe@125 211
giuseppe@125 212 **Table B.6:** Elastic backscatter algorithm flag description
giuseppe@125 213
giuseppe@125 214 +-------+----------------------------+
giuseppe@125 215 | Value | Description |
giuseppe@125 216 +=======+============================+
giuseppe@125 217 | 0 | Klett-Fernald |
giuseppe@125 218 +-------+----------------------------+
giuseppe@125 219 | 1 | Iterative |
giuseppe@125 220 +-------+----------------------------+
giuseppe@125 221
giuseppe@125 222 **Table B.7:** Earlinet product type flag description
giuseppe@125 223
giuseppe@125 224 +-------+----------------------------+
giuseppe@125 225 | Value | Description |
giuseppe@125 226 +=======+============================+
giuseppe@125 227 | 1 | e0355 |
giuseppe@125 228 +-------+----------------------------+
giuseppe@125 229 | 2 | b0355 |
giuseppe@125 230 +-------+----------------------------+
giuseppe@125 231 | 3 | e0351 |
giuseppe@125 232 +-------+----------------------------+
giuseppe@125 233 | 4 | b0351 |
giuseppe@125 234 +-------+----------------------------+
giuseppe@125 235 | 5 | e0532 |
giuseppe@125 236 +-------+----------------------------+
giuseppe@125 237 | 6 | b0532 |
giuseppe@125 238 +-------+----------------------------+
giuseppe@125 239 | 7 | e1064 |
giuseppe@125 240 +-------+----------------------------+
giuseppe@125 241 | 8 | b1064 |
giuseppe@125 242 +-------+----------------------------+
giuseppe@125 243 | 9 | b0253 |
giuseppe@125 244 +-------+----------------------------+
giuseppe@125 245 | 10 | b0313 |
giuseppe@125 246 +-------+----------------------------+
giuseppe@125 247 | 11 | b0335 |
giuseppe@125 248 +-------+----------------------------+
giuseppe@125 249 | 12 | b0511 |
giuseppe@125 250 +-------+----------------------------+
giuseppe@125 251 | 13 | b0694 |
giuseppe@125 252 +-------+----------------------------+
giuseppe@125 253 | 14 | b0817 |
giuseppe@125 254 +-------+----------------------------+
giuseppe@125 255
giuseppe@125 256
giuseppe@125 257 **Table B.8:** Backscatter calibration range search algorithm flag description
giuseppe@125 258
giuseppe@125 259 +-------+----------------------------+
giuseppe@125 260 | Value | Description |
giuseppe@125 261 +=======+============================+
giuseppe@125 262 | 0 | minimum of signal ratio |
giuseppe@125 263 +-------+----------------------------+
giuseppe@125 264 | 1 | minimum of elastic signal |
giuseppe@125 265 +-------+----------------------------+
giuseppe@125 266 | 2 | Rayleigh fit |
giuseppe@125 267 +-------+----------------------------+
giuseppe@125 268
giuseppe@125 269 **Table B.9:** Raman backscatter algorithm flag description
giuseppe@125 270
giuseppe@125 271 +-------+----------------------------+
giuseppe@125 272 | Value | Description |
giuseppe@125 273 +=======+============================+
giuseppe@125 274 | 0 | Ansmann method |
giuseppe@125 275 +-------+----------------------------+
giuseppe@125 276 | 1 | via backscatter ratio |
giuseppe@125 277 +-------+----------------------------+
giuseppe@125 278
giuseppe@125 279 **Table B.10:** Extinction evaluation algorithm flag description
giuseppe@125 280
giuseppe@125 281 +-------+----------------------------+
giuseppe@125 282 | Value | Description |
giuseppe@125 283 +=======+============================+
giuseppe@125 284 | 0 | weighted linear fit |
giuseppe@125 285 +-------+----------------------------+
giuseppe@125 286 | 1 | non weighted linear fi |
giuseppe@125 287 +-------+----------------------------+
giuseppe@125 288

mercurial