Merge pull request #22 from Open-ET/cloud-masking

Updated cloud masking support
Open-ET · Mar 23, 2024 · c3182f3 · c3182f3
2 parents 62c2692 + cad9b1f
commit c3182f3
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 25 deletions.
diff --git a/openet/sims/image.py b/openet/sims/image.py
@@ -419,18 +419,24 @@ def from_landsat_c2_sr(cls, sr_image, cloudmask_args={}, **kwargs):
 
  # Rename bands to generic names
  input_bands = ee.Dictionary({
- 'LANDSAT_4': ['SR_B1', 'SR_B2', 'SR_B3', 'SR_B4', 'SR_B5', 'SR_B7', 'ST_B6', 'QA_PIXEL'],
- 'LANDSAT_5': ['SR_B1', 'SR_B2', 'SR_B3', 'SR_B4', 'SR_B5', 'SR_B7', 'ST_B6', 'QA_PIXEL'],
- 'LANDSAT_7': ['SR_B1', 'SR_B2', 'SR_B3', 'SR_B4', 'SR_B5', 'SR_B7', 'ST_B6', 'QA_PIXEL'],
- 'LANDSAT_8': ['SR_B2', 'SR_B3', 'SR_B4', 'SR_B5', 'SR_B6', 'SR_B7', 'ST_B10', 'QA_PIXEL'],
- 'LANDSAT_9': ['SR_B2', 'SR_B3', 'SR_B4', 'SR_B5', 'SR_B6', 'SR_B7', 'ST_B10', 'QA_PIXEL'],
+ 'LANDSAT_4': ['SR_B1', 'SR_B2', 'SR_B3', 'SR_B4', 'SR_B5', 'SR_B7',
+ 'ST_B6', 'QA_PIXEL', 'QA_RADSAT'],
+ 'LANDSAT_5': ['SR_B1', 'SR_B2', 'SR_B3', 'SR_B4', 'SR_B5', 'SR_B7',
+ 'ST_B6', 'QA_PIXEL', 'QA_RADSAT'],
+ 'LANDSAT_7': ['SR_B1', 'SR_B2', 'SR_B3', 'SR_B4', 'SR_B5', 'SR_B7',
+ 'ST_B6', 'QA_PIXEL', 'QA_RADSAT'],
+ 'LANDSAT_8': ['SR_B2', 'SR_B3', 'SR_B4', 'SR_B5', 'SR_B6', 'SR_B7',
+ 'ST_B10', 'QA_PIXEL', 'QA_RADSAT'],
+ 'LANDSAT_9': ['SR_B2', 'SR_B3', 'SR_B4', 'SR_B5', 'SR_B6', 'SR_B7',
+ 'ST_B10', 'QA_PIXEL', 'QA_RADSAT'],
  })
- output_bands = ['blue', 'green', 'red', 'nir', 'swir1', 'swir2', 'tir', 'QA_PIXEL']
+ output_bands = ['blue', 'green', 'red', 'nir', 'swir1', 'swir2',
+ 'lst', 'QA_PIXEL', 'QA_RADSAT']
  prep_image = (
  sr_image
  .select(input_bands.get(spacecraft_id), output_bands)
- .multiply([0.0000275, 0.0000275, 0.0000275, 0.0000275, 0.0000275, 0.0000275, 0.00341802, 1])
- .add([-0.2, -0.2, -0.2, -0.2, -0.2, -0.2, 149.0, 0])
+ .multiply([0.0000275, 0.0000275, 0.0000275, 0.0000275, 0.0000275, 0.0000275, 0.00341802, 1, 1])
+ .add([-0.2, -0.2, -0.2, -0.2, -0.2, -0.2, 149.0, 0, 0])
  )
 
  # Default the cloudmask flags to True if they were not
@@ -449,9 +455,8 @@ def from_landsat_c2_sr(cls, sr_image, cloudmask_args={}, **kwargs):
  cloudmask_args['cloud_score_pct'] = 100
  if 'filter_flag' not in cloudmask_args.keys():
  cloudmask_args['filter_flag'] = False
- # QA_RADSAT band will need to be added above if applying saturated masking
- # if 'saturated_flag' not in cloudmask_args.keys():
- # cloudmask_args['saturated_flag'] = False
+ if 'saturated_flag' not in cloudmask_args.keys():
+ cloudmask_args['saturated_flag'] = False
 
  cloud_mask = openet.core.common.landsat_c2_sr_cloud_mask(sr_image, **cloudmask_args)
 

diff --git a/openet/sims/tests/test_a_utils.py b/openet/sims/tests/test_a_utils.py
@@ -42,29 +42,34 @@ def test_constant_image_value_multiband_bands(expected=10.123456789, tol=0.00000
 @pytest.mark.parametrize(
  'image_id, xy, scale, expected, tol',
  [
- ['USGS/NED', [-106.03249, 37.17777], 10, 2364.351, 0.001],
- ['USGS/NED', [-106.03249, 37.17777], 1, 2364.351, 0.001],
+ ['USGS/3DEP/10m', [-106.03249, 37.17777], 30, 2364.169, 0.001],
+ ['USGS/3DEP/10m', [-106.03249, 37.17777], 10, 2364.138, 0.001],
+ ['USGS/3DEP/10m', [-106.03249, 37.17777], 1, 2364.138, 0.001],
+ ['NASA/NASADEM_HGT/001', [-106.03249, 37.17777], 30, 2361, 0.001],
  ]
 )
 def test_point_image_value(image_id, xy, scale, expected, tol):
- output = utils.point_image_value(ee.Image(image_id).rename('output'), xy)
+ output = utils.point_image_value(
+ ee.Image(image_id).select(['elevation'], ['output']), xy, scale
+ )
  assert abs(output['output'] - expected) <= tol
 
 
 @pytest.mark.parametrize(
  'image_id, image_date, xy, scale, expected, tol',
  [
- # CGM - This test stopped working for a scale of 1 and returns a different
- # value for a scale of 10 than the point_image_value() function above.
- # This function uses getRegion() instead of a reduceRegion() call,
- # so there might have been some sort of change in getRegion().
- ['USGS/NED', '2012-04-04', [-106.03249, 37.17777], 10, 2364.286, 0.001],
- # CGM - The default scale of 1 now returns None/Null for some reason
- # ['USGS/NED', '2012-04-04', [-106.03249, 37.17777], 1, 2364.351, 0.001],
+ ['USGS/3DEP/10m', '2012-04-04', [-106.03249, 37.17777], 30, 2364.169, 0.001],
+ ['USGS/3DEP/10m', '2012-04-04', [-106.03249, 37.17777], 10, 2364.097, 0.001],
+ ['USGS/3DEP/10m', '2012-04-04', [-106.03249, 37.17777], 1, 2364.138, 0.001],
+ ['NASA/NASADEM_HGT/001', '2012-04-04', [-106.03249, 37.17777], 30, 2361, 0.001],
  ]
 )
 def test_point_coll_value(image_id, image_date, xy, scale, expected, tol):
- input_img = ee.Image(image_id).rename(['output'])
+ # The image must have a system:time_start for this function to work correctly
+ input_img = (
+ ee.Image(image_id).select(['elevation'], ['output'])
+ .set({'system:time_start': ee.Date(image_date).millis()})
+ )
  output = utils.point_coll_value(ee.ImageCollection([input_img]), xy, scale)
  assert abs(output['output'][image_date] - expected) <= tol
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "openet-sims"
-version = "0.2.0"
+version = "0.2.1"
 authors = [
  { name = "Alberto Guzman", email = "aguzman@csumb.edu" },
 ]
@@ -16,8 +16,8 @@ classifiers = [
  "Operating System :: OS Independent",
 ]
 dependencies = [
- "earthengine-api>=0.1.364",
- "openet-core>=0.4.0",
+ "earthengine-api >= 0.1.364",
+ "openet-core >= 0.4.0",
 ]
 
 [project.urls]