docs/file_formats/bitmask_flag_description.rst

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

mercurial