forked from fqqlsun/LEAF_production
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ImgSet.py
298 lines (231 loc) · 14.5 KB
/
ImgSet.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
######################################################################################################
# Description: most codes in this file were converted from JavaScript on 2021-Apr-09
######################################################################################################
import ee
import Image as Img
######################################################################################################
# Description: This function returns the last date of a specified month.
#
# Revision history: 2022-Aug-08 Lixin Sun Initial creation
#
######################################################################################################
def month_end(Month):
month = ee.Number(Month)
cond = month.eq(ee.Number(1)).Or(month.eq(ee.Number(3))).Or(month.eq(ee.Number(5))) \
.Or(month.eq(ee.Number(7))).Or(month.eq(ee.Number(8))).Or(month.eq(ee.Number(10))) \
.Or(month.eq(ee.Number(12)))
return ee.Algorithms.If(cond, ee.Number(31), ee.Algorithms.If(month.eq(ee.Number(2)), ee.Number(28), ee.Number(30)))
######################################################################################################
# Description: Creates the start and end date strings of a specified year and month
#
# Revision history: 2021-May-20 Lixin Sun Initial creation
# 2021-Oct-15 Lixin Sun Added a new case when "inMonth" is out of valid range
# (1 to 12), then the start and end dates of the peak season
# will be returned.
######################################################################################################
def month_range(Year, Month):
'''Creates the start and end date strings of a specified year and month
Args:
Year(int or ee.Number): A specified year;
Month(int or ee.Number): A specified month. When the value of this argument is out of range
(1 to 12), a time range for a peak season is returned. '''
year = ee.Number(Year)
month = ee.Number(Month)
year = ee.Algorithms.If(year.lt(ee.Number(1980)).Or(year.gt(ee.Number(2050))), ee.Number(2020), year)
month = ee.Algorithms.If(month.lt(ee.Number(1)).Or(month.gt(ee.Number(12))), ee.Number(7), month)
start_date = ee.Date.fromYMD(year, month, ee.Number(1))
stop_date = ee.Date.fromYMD(year, month, month_end(month))
return start_date, stop_date #Start and stop ee.Dates
######################################################################################################
# Description: This function creates starting and stoping ee.Dates for a summer
#
# Revision history: 2021-May-20 Lixin Sun Initial creation
#
######################################################################################################
def summer_range(Year):
'''Returns the stop date of growing peak season.
Arg:
Year(int): A regular pyhton integer, rather than a GEE object'''
start = ee.Date.fromYMD(2000, 6, 15)
stop = ee.Date.fromYMD(2000, 9, 15)
return start.update(Year), stop.update(Year)
######################################################################################################
# Description: This function creates a summer centre date string
######################################################################################################
def summer_centre(Year):
'''Returns the middle date of growing peak season.
Arg:
Year(int): A regular pyhton integer, rather than a GEE object'''
return ee.Date.fromYMD(Year, 7, 31)
######################################################################################################
# Description: This function returns the middle date of a given time period.
#
# Revision history: 2021-May-20 Lixin Sun Initial creation
#
######################################################################################################
def period_centre(StartDate, StopDate):
'''Returns the middle date of a given time period.
Arg:
Start(string or ee.Date): Start date string;
Stop(string or ee.Date): stop date string.'''
start = ee.Date(StartDate)
stop = ee.Date(StopDate)
return ee.Date(start.millis().add(stop.millis()).divide(ee.Number(2.0)))
######################################################################################################
# Description: This function creates a image collection acquired by a sensor over a geographical
# region during a period of time.
#
# Revision history: 2021-May-20 Lixin Sun Updated with newly developed function "GEE_catalog_name"
# 2021-Jun-09 Lixin Sun Modified by using "get_cloud_rate" to deteremine cloud
# coverage percentage.
# 2022-Nov-10 Lixin Sun Added a default input parameter called "CloudRate", which
# is an optional cloud coverage percentage/rate.
# 2023-Apr-14 Lixin Sun Added a case for "MODIS/061/MOD09A1", which does have any
# image property
######################################################################################################
def getCollection(SsrData, Region, StartDate, StopDate, CloudRate = -100):
'''Returns a image collection acquired by a sensor over a geographical region during a period of time
Arg:
SsrData(Dictionary): A Dictionary containing metadata associated with a sensor and data unit;
Region(ee.Geometry): A geospatial polygon of ROI;
start_date(string or ee.Date): The start acquisition date string (e.g., '2020-07-01');
stop_date(string or ee.Date): The stop acquisition date string (e.g., '2020-07-31');
CloudRate(float): a given cloud coverage rate.'''
# Cast the input parameters into proper formats
region = ee.Geometry(Region)
start = ee.Date(StartDate)
stop = ee.Date(StopDate)
#===================================================================================================
# Determine a cloud coverage percentage/rate
# Note: there are two ways to determine a cloud coverage percebtage/rate
# (1) based on sensor type and the centre of the given spatial region
# (2) a given cloud coverage percentage/rate (CloudRate)
#===================================================================================================
cloud_rate = Img.get_cloud_rate(SsrData, region) if CloudRate < 0 or CloudRate > 99.99 else CloudRate
#===================================================================================================
# "filterMetadata" Has been deprecated. But tried to use "ee.Filter.gte(property, value)", did
# not work neither.
#===================================================================================================
#cloud_up = 70
#cloud_dn = 30
CollName = SsrData['GEE_NAME']
ssr_code = SsrData['SSR_CODE']
if ssr_code == Img.MOD_sensor: # for MODIS data
coll = ee.ImageCollection(CollName).filterBounds(region).filterDate(start, stop)
elif ssr_code > Img.MAX_LS_CODE: # for Sentinel-2 data
coll = ee.ImageCollection(CollName).filterBounds(region).filterDate(start, stop) \
.filterMetadata(SsrData['CLOUD'], 'less_than', cloud_rate) \
.filterMetadata(SsrData['VAA'], 'greater_than', 0.0) \
.filterMetadata(SsrData['SAA'], 'greater_than', 0.0) \
.filterMetadata(SsrData['VZA'], 'greater_than', 0.0) \
.filterMetadata(SsrData['SZA'], 'greater_than', 0.0) \
#.limit(10000)
#.filterMetadata(SsrData['CLOUD'], 'less_than', cloud_up) \
#.filterMetadata(SsrData['CLOUD'], 'greater_than', cloud_dn) \
else: # for Landsat data
coll = ee.ImageCollection(CollName).filterBounds(region).filterDate(start, stop) #\
#.filterMetadata(SsrData['CLOUD'], 'less_than', cloud_rate) \
#.filterMetadata(SsrData['VAA'], 'greater_than', 0.0) \
#.filterMetadata(SsrData['SAA'], 'greater_than', 0.0)
print('\n<getCollection> The name of data catalog = ', CollName)
print('<getCollection> The number of images in selected image collection = ', coll.size().getInfo())
return coll
'''
coll = ee.ImageCollection(CollName) \
.filterBounds(polygon) \
.filterDate(start, stop) \
.filter(ee.Filter.gte(SSR_Property['Cloudcover'], cloud_rate)) \
.filter(ee.Filter.gte(SSR_Property['vza'], -0.01)) \
.filter(ee.Filter.gte(SSR_Property['sza'], -0.01)) \
.filter(ee.Filter.gte(SSR_Property['vaa'], -0.01)) \
.filter(ee.Filter.gte(SSR_Property['saa'], -0.01)) \
.limit(5000)
'''
######################################################################################################
# Description: Creates a collection of satellite images acquired during a summer.
#
# Revision history: 2021-Apr-09 Lixin Sun Converted from JavaScript
#
######################################################################################################
def peak_collection(SsrData, Year, Region, CloudRate):
'''Creates a collection of satellite images acquired during a summer.
Args:
SsrData(Dictionary): A Dictionary containing metadata associated with a sensor and data unit;
Year(int): A targeted year integer;
Region(ee.Geometry): The geospatial polygon of ROI;
CloudRate(float): A specified cloud coverage rate.'''
region = ee.Geometry(Region)
start, stop = summer_range(Year)
return ee.ImageCollection(getCollection(SsrData, region, start, stop, CloudRate))
######################################################################################################
# Description: This function return median blue mosaic band of a peak season
#
# Revision history: 2022-Jan-22 Lixin Sun Initial creation
# 2023-Mar-14 Lixin Sun It was found that even peak season median blue does not
# work well.
######################################################################################################
def peak_median_blue(SsrData, Year, Region, CloudRate):
peak_coll = peak_collection(SsrData, Year, Region, CloudRate)
blue_name = SsrData['BLU']
def get_blue(img) :
#valid_mask = eoImgMsk.ValidMask(img, ssr_code, data_unit).Not()
return img.select([blue_name]) #.updateMask(valid_mask) # Applying mask is important here
blue_coll = peak_coll.map(lambda image: get_blue(image))
return blue_coll.median()
###################################################################################################
# Description: This function creates a image collection acquired over the summer seasons of
# multiple years.
#
# Revision history: 2021-May-20 Lixin Sun Initial creation
#
###################################################################################################
def get_MultiSummers_Coll(SsrData, Region, SeasonStart, SeasonStop, StartYear, StopYear):
'''Creates a image collection acquired over the summer seasons of multiple years.
Arg:
SsrData(Dictionary): A Dictionary containing metadata associated with a sensor and data unit;
Region(ee.Geometry): A geospatial polygon of ROI;
season_start(string): The start date string (e.g., '06-15') of a season;
season_stop(string): The stop date string (e.g., '09-15') of a season;
start_year(int): A start year integer;
stop_year(int): A stop year integer.'''
#================================================================================================
# Cast the input parameters into proper types
#================================================================================================
region = ee.Geometry(Region)
startD = str(SeasonStart)
stopD = str(SeasonStop)
startY = int(StartYear)
stopY = int(StopYear)
season_start = ee.Date(str(startY) + '-' + startD)
season_stop = ee.Date(str(startY) + '-' + stopD)
#================================================================================================
# Create a raw image collection filtered only with region and cloud coverage
#================================================================================================
# Determine a cloud coverage percentage/rate based on sensor type and location
cloud_rate = Img.get_cloud_rate(SsrData, region)
# Determine the name of image collection and its property
CollName = SsrData['GEE_NAME']
# Create a raw image collection filtered with only boundary and cloud covereage
raw_coll = ee.ImageCollection(CollName) \
.filterBounds(region) \
.filterMetadata(SsrData['CLOUD'], 'less_than', cloud_rate)
print('<get_MultiSummers_Coll> nb of images in raw coll = ', raw_coll.size().getInfo())
#================================================================================================
# Define a function that can extract a annual image collection from raw image collection
#================================================================================================
def annual_coll(year, prev_coll):
ann_coll = raw_coll.filterDate(season_start.update(year), season_stop.update(year))
return ee.ImageCollection(prev_coll).merge(ann_coll)
#================================================================================================
# Create a list of years by generating a sequence from start and end years
#================================================================================================
years = ee.List.sequence(startY+1, stopY)
print('<get_MultiSummers_Coll> year list = ', years.getInfo())
#================================================================================================
# Generate annual image collection collected in summer season
#================================================================================================
start0 = str(startY) + '-' + startD
stop0 = str(startY) + '-' + stopD
init_coll = raw_coll.filterDate(start0, stop0)
print('\n<get_MultiSummers_Coll> nb of images in init coll = ', init_coll.size().getInfo())
return ee.ImageCollection(years.iterate(annual_coll, init_coll))