1i.modis.qc(1) Grass User's Manual i.modis.qc(1)
2
6 i.modis.qc - Extracts quality control parameters from MODIS QC layers.
7
9 imagery, imagery quality assessment, reflectance, land surface tempera‐
10 ture, vegetation, satellite, MODIS
11
13 i.modis.qc
14 i.modis.qc --help
15 i.modis.qc input=name output=name productname=string qcname=string
16 [band=string] [--overwrite] [--help] [--verbose] [--quiet] [--ui]
17 Flags:
19 --overwrite
20 Allow output files to overwrite existing files
21 --help
23 Print usage summary
24 --verbose
26 Verbose module output
27 --quiet
29 Quiet module output
30 --ui
32 Force launching GUI dialog
33 Parameters:
35 input=name [required]
36 Name of input surface reflectance QC layer [bit array]
37 output=name [required]
39 Name for output QC type classification layer
40 productname=string [required]
42 Name of MODIS product type
43 Options: mod09Q1, mod09A1, mod09A1s, mod09GA, mod09GAs, mod09CMG,
44 mod09CMGs, mod09CMGi, mod11A1, mod11A2, mod13A2, mcd43B2, mcd43B2q,
45 mod13Q1
46 mod09Q1: surf. refl. 250m 8-days
47 mod09A1: surf. refl. 500m 8-days
48 mod09A1s: surf. refl. 500m 8-days, State QA
49 mod09GA: surf. refl. 500m daily
50 mod09GAs: surf. refl. 500m daily, State QA
51 mod09CMG: surf. refl. 5000m daily
52 mod09CMGs: surf. refl. 5000m daily, State QA
53 mod09CMGi: surf. refl. 5000m daily, Internal Climatology
54 mod11A1: LST 1km daily (Day/Night)
55 mod11A2: LST 1km 8-days (Day/Night)
56 mod13A2: VI 1km 16-days
57 mcd43B2: Brdf-Albedo Quality (Ancillary SDS) 1km 8-days
58 mcd43B2q: Brdf-Albedo Quality (BRDF SDS) 1km 8-days
59 mod13Q1: VI 250m 16-days
60 qcname=string [required]
62 Name of QC type to extract
63 Options: adjcorr, atcorr, cloud, data_quality,
64 diff_orbit_from_500m, modland_qa, mandatory_qa_11A1, data_qual‐
65 ity_flag_11A1, emis_error_11A1, lst_error_11A1, data_qual‐
66 ity_flag_11A2, emis_error_11A2, mandatory_qa_11A2, lst_error_11A2,
67 aerosol_quantity, brdf_correction_performed, cirrus_detected,
68 cloud_shadow, cloud_state, internal_cloud_algorithm, inter‐
69 nal_fire_algorithm, internal_snow_mask, land_water, mod35_snow_ice,
70 pixel_adjacent_to_cloud, salt_pan, icm_cloudy, icm_clear,
71 icm_high_clouds, icm_low_clouds, icm_snow, icm_fire, icm_sun_glint,
72 icm_dust, icm_cloud_shadow, icm_pixel_is_adjacent_to_cloud,
73 icm_cirrus, icm_pan_flag, icm_criteria_for_aerosol_retrieval,
74 icm_aot_has_clim_val, modland_qa, vi_usefulness, aerosol_quantity,
75 pixel_adjacent_to_cloud, brdf_correction_performed, mixed_clouds,
76 land_water, possible_snow_ice, possible_shadow, platform,
77 land_water, sun_z_angle_at_local_noon, brdf_correction_performed,
78 modland_qa, vi_usefulness, aerosol_quantity, pixel_adja‐
79 cent_to_cloud, brdf_correction_performed, mixed_clouds, land_water,
80 possible_snow_ice, possible_shadow
81 adjcorr: mod09: Adjacency Correction
82 atcorr: mod09: Atmospheric Correction
83 cloud: mod09: Cloud State
84 data_quality: mod09: Band-Wise Data Quality Flag
85 diff_orbit_from_500m: mod09: 250m Band is at Different Orbit than
86 500m
87 modland_qa: mod13Q1: MODIS Land General Quality Assessment
88 mandatory_qa_11A1: mod11A1: MODIS Land General Quality Assessment
89 data_quality_flag_11A1: mod11A1: Detailed Quality Indications
90 emis_error_11A1: mod11A1: Average Emissivity Error Classes
91 lst_error_11A1: mod11A1: Average LST Error Classes
92 data_quality_flag_11A2: mod11A2: Detailed Quality Indications
93 emis_error_11A2: mod11A2: Average Emissivity Error Classes
94 mandatory_qa_11A2: mod11A2: MODIS Land General Quality Assessment
95 lst_error_11A2: mod11A2: Average LST Error Classes
96 aerosol_quantity: mod13Q1: Quantity range of Aerosol
97 brdf_correction_performed: mod13Q1: if BRDF correction performed
98 cirrus_detected: mod09*s: StateQA Cirrus Detected
99 cloud_shadow: mod09*s: StateQA Cloud Shadow
100 cloud_state: mod09*s: StateQA Cloud State
101 internal_cloud_algorithm: mod09*s: StateQA Internal Cloud Algorithm
102 internal_fire_algorithm: mod09*s: StateQA Internal Fire Algorithm
103 internal_snow_mask: mod09*s: StateQA Internal Snow Mask
104 land_water: mod13Q1: separate land from various water objects
105 mod35_snow_ice: mod09*s: StateQA mod35 Snow Ice
106 pixel_adjacent_to_cloud: mod13Q1: if pixel is a cloud neighbour
107 salt_pan: mod09*s: StateQA Salt Pan (mod09GAs)
108 icm_cloudy: mod09*i: Internal CM: Cloudy
109 icm_clear: mod09*i: Internal CM: Clear
110 icm_high_clouds: mod09*i: Internal CM: High Clouds
111 icm_low_clouds: mod09*i: Internal CM: Low Clouds
112 icm_snow: mod09*i: Internal CM: Snow
113 icm_fire: mod09*i: Internal CM: Fire
114 icm_sun_glint: mod09*i: Internal CM: Sun Glint
115 icm_dust: mod09*i: Internal CM: Dust
116 icm_cloud_shadow: mod09*i: Internal CM: Cloud Shadow
117 icm_pixel_is_adjacent_to_cloud: mod09*i: Internal CM: Pixel is
118 Adjacent to Cloud
119 icm_cirrus: mod09*i: Internal CM: Cirrus
120 icm_pan_flag: mod09*i: Internal CM: Pan Flag
121 icm_criteria_for_aerosol_retrieval: mod09*i: Internal CM: Criteria
122 for Aerosol Retrieval
123 icm_aot_has_clim_val: mod09*i: Internal CM: AOT (aerosol optical
124 depth) has clim. val.
125 vi_usefulness: mod13Q1: Quality estimation of the pixel
126 mixed_clouds: mod13Q1: if pixel mixed with clouds
127 possible_snow_ice: mod13Q1: if snow/ice present in pixel
128 possible_shadow: mod13Q1: if shadow is present in pixel
129 platform: mcd43B2: Quality of BRDF correction performed
130 sun_z_angle_at_local_noon: mcd43B2: Quality of BRDF correction per‐
131 formed
132 band=string
134 Band number of MODIS product
135 (mod09Q1=[1,2],mod09A1=[1-7],m[o/y]d09GA=[1-7],m[o/y]d09CMG=[1-7],
136 mcd43B2q=[1-7])
137 Options: 1, 2, 3, 4, 5, 6, 7
138 1: Band 1: Red
139 2: Band 2: NIR
140 3: Band 3: Blue
141 4: Band 4: Green
142 5: Band 5: SWIR 1
143 6: Band 6: SWIR 2
144 7: Band 7: SWIR 3
145
147 i.modis.qc extracts Requested Quality Assessment flags from the follow‐
148 ing MODIS products: MOD09A1, MOD09Q1, MOD11A1, MOD11A2, MOD13A2,
149 MOD13Q1, MCD43B2. This does include MOD09A1 QA_state_500m layer (see
150 Notes).
151 Added MOD09GA support in 2016, it follows MOD09A1 and its StateQA, but
152 does not have BRDF State QA, instead has Salt Pan State QA.
153 MOD09A1 and MOD09Q1
155 MOD09A1/Q1: MODLAND QA Bits. bits=[0-1]
156 · [00]= class 0: Corrected product produced at ideal quality --
158 all bands
159 · [01]= class 1: Corrected product produced at less than ideal
161 quality -- some or all bands
162 · [10]= class 2: Corrected product NOT produced due to cloud
164 effect -- all bands
165 · [11]= class 3: Corrected product NOT produced due to other rea‐
167 sons -- some or all bands maybe be fill value (Note that a
168 value of [11] overrides a value of [01])
169 MOD09Q1: Cloud State. bits=[2-3]
170 · [00]= class 0: Clear -- No clouds
172 · [01]= class 1: Cloudy
174 · [10]= class 2: Mixed
176 · [11]= class 3: Not Set ; Assumed Clear
178 MOD09Q1: Band-wise Data Quality 250m bits=[4-7][8-11]
179 MOD09A1: Band-wise Data Quality 500m bits=[2-5][6-9][10-13][14-17][18-21][22-25][26-29]
180 · [0000]= class 0: highest quality
182 · [0111]= class 1: noisy detector
184 · [1000]= class 2: dead detector; data interpolated in L1B
186 · [1001]= class 3: solar zenith ⥠86 degrees
188 · [1010]= class 4: solar zenith ⥠85 and < 86 degrees
190 · [1011]= class 5: missing input
192 · [1100]= class 6: internal constant used in place of climatolog‐
194 ical data for at least one atmospheric constant
195 · [1101]= class 7: correction out of bounds, pixel constrained to
197 extreme allowable value
198 · [1110]= class 8: L1B data faulty
200 · [1111]= class 9: not processed due to deep ocean or cloud
202 · Class 10-15: Combination of bits unused
204 MOD09A1/Q1: Atmospheric correction bit=[12]/[30]
205 · [0]= class 0: Not Corrected product
207 · [1]= class 1: Corrected product
209 MOD09A1/Q1: Adjacency correction bit=[13]/[31]
210 · [0]= class 0: Not Corrected product
212 · [1]= class 1: Corrected product
214 MOD09Q1: Different orbit from 500m product, bit=[14]
215 · [0]= class 0: same orbit as 500m
217 · [1]= class 1: different orbit from 500m
219 MOD09A1s: Cloud State bits=[0-1]
220 · [00]= class 0: clear
222 · [01]= class 1: cloudy
224 · [10]= class 2: mixed
226 · [11]= class 3: not set, assumed clear
228 MOD09A1s: Cloud shadow bits=[2]
229 · [0]= class 0: no
231 · [1]= class 1: yes
233 MOD09A1s: Land/Water Flag bits=[3-5]
234 · [000]= class 0: Shallow ocean
236 · [001]= class 1: Land
238 · [010]= class 2: Ocean coastlines and lake shorelines
240 · [011]= class 3: Shallow inland water
242 · [100]= class 4: Ephemeral water
244 · [101]= class 5: Deep inland water
246 · [110]= class 6: Continental/moderate ocean
248 · [111]= class 7: Deep ocean
250 MOD09A1s: Aerosol Quantity bits=[6-7]
251 · [00]= class 0: Climatology
253 · [01]= class 1: Low
255 · [10]= class 2: Average
257 · [11]= class 3: High
259 MOD09A1s: Cirrus detected bits=[8-9]
260 · [00]= class 0: None
262 · [01]= class 1: Small
264 · [10]= class 2: Average
266 · [11]= class 3: High
268 MOD09A1s: Internal Cloud Algorithm Flag bits=[10]
269 · [0]= class 0: No cloud
271 · [1]= class 1: Cloud
273 MOD09A1s: Internal Fire Algorithm Flag bits=[11]
274 · [0]= class 0: No fire
276 · [1]= class 1: Fire
278 MOD09A1s: MOD35 snow/ice flag bits=[12]
279 · [0]= class 0: No
281 · [1]= class 1: Yes
283 MOD09A1s: Pixel adjacent to cloud bits=[13]
284 · [0]= class 0: No
286 · [1]= class 1: Yes
288 MOD09A1s: BRDF correction performed bits=[14]
289 · [0]= class 0: No
291 · [1]= class 1: Yes
293 MOD09A1s: Internal Snow Mask bits=[15]
294 · [0]= class 0: No snow
296 · [1]= class 1: Snow
298 MOD11A1
300 MOD11A1: Mandatory QA Flags bits=[0-1]
301 · [00]= class 0: LST produced, good quality, not necessary to
303 examine more detailed QA
304 · [01]= class 1: LST produced, other quality, recommend examina‐
306 tion of more detailed QA
307 · [10]= class 2: LST not produced due to cloud effects
309 · [11]= class 3: LST not produced primarily due to reasons other
311 than cloud
312 MOD11A1: Data Quality Flag bits=[2-3]
313 · [00]= class 0: Good data quality of L1B in bands 31 and 32
315 · [01]= class 1: Other quality data
317 · [10]= class 2: TBD
319 · [11]= class 3: TBD
321 MOD11A1: Emis Error Flag bits=[4-5]
322 · [00]= class 0: Average emissivity error ⤠0.01
324 · [01]= class 1: Average emissivity error ⤠0.02
326 · [10]= class 2: Average emissivity error ⤠0.04
328 · [11]= class 3: Average emissivity error > 0.04
330 MOD11A1: LST Error Flag bits=[6-7]
331 · [00]= class 0: Average LST error ⤠1
333 · [01]= class 1: Average LST error ⤠2
335 · [10]= class 2: Average LST error ⤠3
337 · [11]= class 3: Average LST error > 3
339 MOD11A2
341 MOD11A2: Mandatory QA Flags bits=[0-1]
342 · [00]= class 0: LST produced, good quality, not necessary to
344 examine more detailed QA
345 · [01]= class 1: LST produced, other quality, recommend examina‐
347 tion of more detailed QA
348 · [10]= class 2: LST not produced due to cloud effects
350 · [11]= class 3: LST not produced primarily due to reasons other
352 than cloud
353 MOD11A2: Data Quality Flag bits=[2-3]
354 · [00]= class 0: Good data quality of L1B in 7 TIR bands
356 · [01]= class 1: Other quality data
358 · [10]= class 2: TBD
360 · [11]= class 3: TBD
362 MOD11A2: Emis Error Flag bits=[4-5]
363 · [00]= class 0: Average emissivity error ⤠0.01
365 · [01]= class 1: Average emissivity error ⤠0.02
367 · [10]= class 2: Average emissivity error ⤠0.04
369 · [11]= class 3: Average emissivity error > 0.04
371 MOD11A2: LST Error Flag bits=[6-7]
372 · [00]= class 0: Average LST error ⤠1
374 · [01]= class 1: Average LST error ⤠2
376 · [10]= class 2: Average LST error ⤠3
378 · [11]= class 3: Average LST error > 3
380 MOD13A2
382 MOD13A2: Mandatory QA Flags 1km bits[0-1]
383 · [00]= class 0: VI produced, good quality
385 · [01]= class 1: VI produced, but check other QA
387 · [10]= class 2: Pixel produced, but most probably cloud
389 · [11]= class 3: Pixel not produced due to other reasons than
391 clouds
392 MOD13A2: VI Usefulness Flag bits[2-5]
393 · [0000]= class 0: Highest quality
395 · [0001]= class 1: Lower quality
397 · [0010]= class 2: Decreasing quality
399 · [0100]= class 3: Decreasing quality
401 · [1000]= class 4: Decreasing quality
403 · [1001]= class 5: Decreasing quality
405 · [1010]= class 6: Decreasing quality
407 · [1100]= class 7: Lowest quality
409 · [1101]= class 8: Quality so low that it is not useful
411 · [1110]= class 9: L1B data faulty
413 · [1111]= class 10: Not useful for any other reason/not processed
415 MOD13A2: Aerosol quantity Flags 1km bits[6-7]
416 · [00]= class 0: Climatology
418 · [01]= class 1: Low
420 · [10]= class 2: Average
422 · [11]= class 3: High
424 MOD13A2: Adjacent cloud detected 1km bit[8]
425 · [00]= class 0: No
427 · [01]= class 1: Yes
429 MOD13A2: Atmosphere BRDF correction performed 1km bit[9]
430 · [00]= class 0: No
432 · [01]= class 1: Yes
434 MOD13A2: Mixed clouds 1km bit[10]
435 · [00]= class 0: No
437 · [01]= class 1: Yes
439 MOD13A2: Land/Water Flags 1km bits[11-13]
440 · [000]= class 0: Shallow Ocean
442 · [001]= class 1: Land (Nothing else but land)
444 · [010]= class 2: Ocean Coastlines and lake shorelines
446 · [011]= class 3: Shallow inland water
448 · [100]= class 4: Ephemeral water
450 · [101]= class 5: Deep inland water
452 · [110]= class 6: Moderate or continental ocean
454 · [111]= class 7: Deep ocean
456 MOD13A2: Possible Snow/Ice 1km bits[14]
457 · [0]= class 0: No
459 · [1]= class 1: Yes
461 MOD13A2: Possible Shadow 1km bits[15]
462 · [0]= class 0: No
464 · [1]= class 1: Yes
466 MOD13Q1
468 MOD13Q1: Mandatory QA Flags 250m bits[0-1]
469 · [00]= class 0: VI produced, good quality
471 · [01]= class 1: VI produced, but check other QA
473 · [10]= class 2: Pixel produced, but most probably cloud
475 · [11]= class 3: Pixel not produced due to other reasons than
477 clouds
478 MOD13Q1: VI Usefulness Flag 250m bits[2-5]
479 · [0000]= class 0: Highest quality
481 · [0001]= class 1: Lower quality
483 · [0010]= class 2: Decreasing quality
485 · [0100]= class 3: Decreasing quality
487 · [1000]= class 4: Decreasing quality
489 · [1001]= class 5: Decreasing quality
491 · [1010]= class 6: Decreasing quality
493 · [1100]= class 7: Lowest quality
495 · [1101]= class 8: Quality so low that it is not useful
497 · [1110]= class 9: L1B data faulty
499 · [1111]= class 10: Not useful for any other reason/not processed
501 MOD13Q1: Aerosol quantity Flags 250m bits[6-7]
502 · [00]= class 0: Climatology
504 · [01]= class 1: Low
506 · [10]= class 2: Average
508 · [11]= class 3: High
510 MOD13Q1: Adjacent cloud detected 250m bit[8]
511 · [00]= class 0: No
513 · [01]= class 1: Yes
515 MOD13Q1: Atmosphere BRDF correction performed 250m bit[9]
516 · [00]= class 0: No
518 · [01]= class 1: Yes
520 MOD13Q1: Mixed clouds 250m bit[10]
521 · [00]= class 0: No
523 · [01]= class 1: Yes
525 MOD13Q1: Land/Water Flags 250m bits[11-13]
526 · [000]= class 0: Shallow Ocean
528 · [001]= class 1: Land (Nothing else but land)
530 · [010]= class 2: Ocean Coastlines and lake shorelines
532 · [011]= class 3: Shallow inland water
534 · [100]= class 4: Ephemeral water
536 · [101]= class 5: Deep inland water
538 · [110]= class 6: Moderate or continental ocean
540 · [111]= class 7: Deep ocean
542 MOD13Q1: Possible Snow/Ice 250m bits[14]
543 · [0]= class 0: No
545 · [1]= class 1: Yes
547 MOD13Q1: Possible Shadow 250m bits[15]
548 · [0]= class 0: No
550 · [1]= class 1: Yes
552 MCD43B2
554 MCD43B2: Albedo Quality Ancillary Platform Data 1km bits[0-3]
555 SDS: BRDF_Albedo_Ancillary
556 · [0000]= class 0: Satellite Platform: Terra
558 · [0001]= class 1: Satellite Platform: Terrra/Aqua
560 · [0010]= class 2: Satellite Platform: Aqua
562 · [1111]= class 15: Fill Value
564 · Classes 3-14: Not used
566 MCD43B2: Albedo Quality Ancillary Land/Water Data 1km bits[4-7]
567 SDS: BRDF_Albedo_Ancillary
568 · [0000] class 0: Shallow Ocean
570 · [0001] class 1: Land (Nothing else but land)
572 · [0010] class 2: Ocean and lake shorelines
574 · [0011] class 3: Shallow inland water
576 · [0100] class 4: Ephemeral water
578 · [0101] class 5: Deep inland water
580 · [0110] class 6: Moderate or continental ocean
582 · [0111] class 7: Deep ocean
584 · [1111] class 15: Fill Value
586 · Classes 8-14: Not used
588 MCD43B2: Albedo Quality Ancillary Sun Zenith Angle at Local Solar Noon Data 1km bits[8-14]
589 SDS: BRDF_Albedo_Ancillary
590 Returns integer value [0-90], 127 is Fill Value
591 MCD43B2: Band-wise Albedo Quality Data 1km
592 SDS: BRDF_Albedo_Band_Quality
593 bits[0-3][4-7][8-11][12-15][16-19][20-23][24-27]
594 · [0000]= class 0: best quality, 75% or more with best full
596 inversions
597 · [0001]= class 1: good quality, 75% or more with full inversions
599 · [0010]= class 2: Mixed, 50% or less full inversions and 25% or
601 less fill values
602 · [0011]= class 3: All magnitude inversions or 50% or less fill
604 values
605 · [0100]= class 4: 75% or more fill values
607 · Classes 5-14: Not Used
609 · [1111]= class 15: Fill Value
611
613 In MOD09A1: It seems that cloud related info is not filled properly in
614 the standard QC (MOD09A1 in this module) since version 3, State-QA 500m
615 images (MOD09A1s in this module) should be used (see Vermote et al.,
616 2008). MOD11A2 quality control (QC) bands do not have a FillValue
617 (No-data) according to MODIS Land Products site. However, the metadata
618 of the QC bands (i.e.: gdalinfo QC_band) shows No-data=0. This value
619 is then transformed into GRASS NULLs when data is imported through
620 r.in.gdal. Applying i.modis.qc on those QC bands will not give the
621 expected range of values in the different QC bits. Therefore, before
622 using i.modis.qc, the user needs to set the NULL value in QC bands back
623 to zero (i.e.: r.null map=QC_band null=0) or just edit the metadata
624 with GDAL utilities before importing into GRASS GIS. This is a known
625 issue for MOD11A2 (8-day LST product), but other MODIS products might
626 be affected as well.
627
629 Add more daily products.
630
632 i.vi
633
635 · MODIS Products
636 · Vermote E.F., Kotchenova S.Y., Ray J.P. MODIS Surface
638 Reflectance User’s Guide. Version 1.2. June 2008. MODIS Land
639 Surface Reflectance Science Computing Facility. Homepage
640
642 Yann Chemin
643
645 Available at: i.modis.qc source code (history)
646 Main index | Imagery index | Topics index | Keywords index | Graphical
648 index | Full index
649 © 2003-2019 GRASS Development Team, GRASS GIS 7.8.2 Reference Manual
651GRASS 7.8.2 i.modis.qc(1)