Skip to content

earthlib.BurnPVSoil

Methods for running Burned / Photosynthetic Vegetation / Soil (BVS) unmixing.

ASTER(img, bands=getBands('ASTER'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix an ASTER image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('ASTER')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
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
def ASTER(
    img: ee.Image,
    bands: list = getBands("ASTER"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix an ASTER image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "ASTER"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

AVNIR2(img, bands=getBands('AVNIR2'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix an AVNIR2 image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('AVNIR2')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
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
def AVNIR2(
    img: ee.Image,
    bands: list = getBands("AVNIR2"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix an AVNIR2 image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "AVNIR2"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

DoveR(img, bands=getBands('DoveR'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a Landsat8 image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('DoveR')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
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
def DoveR(
    img: ee.Image,
    bands: list = getBands("DoveR"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a Landsat8 image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "DoveR"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

Landsat457(img, bands=getBands('Landsat7'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a Landsat4 image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('Landsat7')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
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
def Landsat457(
    img: ee.Image,
    bands: list = getBands("Landsat7"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a Landsat4 image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "Landsat7"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

Landsat8(img, bands=getBands('Landsat8'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a Landsat8 image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('Landsat8')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
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
def Landsat8(
    img: ee.Image,
    bands: list = getBands("Landsat8"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a Landsat8 image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "Landsat8"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

MODIS(img, bands=getBands('MODIS'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a MODIS image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('MODIS')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
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
def MODIS(
    img: ee.Image,
    bands: list = getBands("MODIS"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a MODIS image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "MODIS"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

NEON(img, bands=getBands('NEON'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a NEON image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('NEON')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
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
def NEON(
    img: ee.Image,
    bands: list = getBands("NEON"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a NEON image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "NEON"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

PlanetScope(img, bands=getBands('PlanetScope'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a PlanetScope image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('PlanetScope')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
def PlanetScope(
    img: ee.Image,
    bands: list = getBands("PlanetScope"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a PlanetScope image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "PlanetScope"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

Sentinel2(img, bands=getBands('Sentinel2'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a Sentinel2 image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('Sentinel2')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
def Sentinel2(
    img: ee.Image,
    bands: list = getBands("Sentinel2"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a Sentinel2 image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "Sentinel2"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

SuperDove(img, bands=getBands('SuperDove'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a SuperDove image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('SuperDove')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
def SuperDove(
    img: ee.Image,
    bands: list = getBands("SuperDove"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a SuperDove image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "SuperDove"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

VIIRS(img, bands=getBands('VIIRS'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a VIIRS image with burned, pv, soil endmembers.

Parameters:

Name Type Description Default
img Image

the ee.Image to unmix

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

getBands('VIIRS')
n int

the number of iterations for unmixing.

N_ITERATIONS
shade_normalize bool

apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.

SHADE_NORMALIZE

Returns:

Name Type Description
unmixed Image

a 3-band image with bands (%burned, %pv, %soil).

Source code in earthlib/BurnPVSoil.py
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
def VIIRS(
    img: ee.Image,
    bands: list = getBands("VIIRS"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a VIIRS image with burned, pv, soil endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%burned, %pv, %soil).
    """
    sensor = "VIIRS"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

bySensor(sensor)

Returns the appropriate scaling function to use by sensor type.

Parameters:

Name Type Description Default
sensor str

string with the sensor name to return (e.g. "Landsat8", "Sentinel2").

required

Returns:

Type Description
Callable

the scale function associated with a sensor to pass to an ee .map() call

Source code in earthlib/BurnPVSoil.py
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
def bySensor(sensor: str) -> Callable:
    """Returns the appropriate scaling function to use by sensor type.

    Args:
        sensor: string with the sensor name to return (e.g. "Landsat8", "Sentinel2").

    Returns:
        the scale function associated with a sensor to pass to an ee .map() call
    """
    lookup = {
        "ASTER": ASTER,
        "AVNIR2": AVNIR2,
        "DoveR": DoveR,
        "Landsat4": Landsat457,
        "Landsat5": Landsat457,
        "Landsat7": Landsat457,
        "Landsat8": Landsat8,
        "MODIS": MODIS,
        "NEON": NEON,
        "PlanetScope": PlanetScope,
        "Sentinel2": Sentinel2,
        "SuperDove": SuperDove,
        "VIIRS": VIIRS,
    }
    try:
        function = lookup[sensor]
        return function
    except KeyError:
        supported = ", ".join(lookup.keys())
        raise SensorError(
            f"Scaling adjustment not supported for '{sensor}'. Supported: {supported}"
        )

getEndmembers(sensor, bands, n=N_ITERATIONS)

Get a series of ee.List objects with the BVS endmembers.

Parameters:

Name Type Description Default
sensor str

the name of the sensor (from earthlib.listSensors()).

required
bands list

a list of bands to select (from earthlib.getBands(sensor)).

required
n int

the number of iterations for unmixing.

N_ITERATIONS

Returns:

Type Description
Tuple[list]

(soil, pv, urban) endmembers

Source code in earthlib/BurnPVSoil.py
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def getEndmembers(sensor: str, bands: list, n: int = N_ITERATIONS) -> Tuple[list]:
    """Get a series of ee.List objects with the BVS endmembers.

    Args:
        sensor: the name of the sensor (from earthlib.listSensors()).
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.

    Returns:
        (soil, pv, urban) endmembers
    """
    soil_list = selectSpectra("bare", sensor, n, bands)
    pv_list = selectSpectra("vegetation", sensor, n, bands)
    burned_list = selectSpectra("burn", sensor, n, bands)
    soil = [ee.List(soil_spectra.tolist()) for soil_spectra in soil_list]
    pv = [ee.List(pv_spectra.tolist()) for pv_spectra in pv_list]
    burn = [ee.List(burn_spectra.tolist()) for burn_spectra in burned_list]

    return burn, pv, soil