eemont package

Submodules

eemont.image module

eemont.image.index(self, index='NDVI', G=2.5, C1=6.0, C2=7.5, L=1.0)[source]

Computes one or more spectral indices (indices are added as bands) for an image.

Args:
selfee.Image

Image to compute indices on. Must be scaled to [0,1].

indexstring | list[string], default = ‘NDVI’

Index or list of indices to compute. Available options:

  • ‘vegetation’ : Compute all vegetation indices.

  • ‘burn’ : Compute all burn indices.

  • ‘water’ : Compute all water indices.

  • ‘all’ : Compute all indices listed below.

Vegetation indices:

  • ‘BNDVI’ : Blue Normalized Difference Vegetation Index.

  • ‘CIG’ : Chlorophyll Index - Green.

  • ‘CVI’ : Chlorophyll Vegetation Index.

  • ‘EVI’ : Enhanced Vegetation Index.

  • ‘GNDVI’ : Green Normalized Difference Vegetation Index.

  • ‘NDVI’ : Normalized Difference Vegetation Index.

  • ‘NGRDI’ : Normalized Green Red Difference Index.

  • ‘SAVI’ : Soil-Adjusted Vegetation Index.

  • ‘SR’ : Simple Ratio.

Burn and fire indices:

  • ‘BAI’ : Burned Area Index.

  • ‘BAIS2’ : Burned Area Index for Sentinel 2.

  • ‘NBR’ : Normalized Burn Ratio.

Water indices:

  • ‘MNDWI’ : Modified Normalized Difference Water Index.

  • ‘NDWI’ : Normalized Difference Water Index.

Gfloat, default = 2.5

Gain factor. Used just for index = ‘EVI’.

C1float, default = 6.0

Coefficient 1 for the aerosol resistance term. Used just for index = ‘EVI’.

C2float, default = 7.5

Coefficient 2 for the aerosol resistance term. Used just for index = ‘EVI’.

Lfloat, default = 1.0

Canopy background adjustment. Used just for index = [‘EVI’,’SAVI’].

Returns:
ee.Image

Image with the computed spectral index, or indices, as new bands.

eemont.image.maskClouds(self, method='cloud_prob', prob=60, maskCirrus=True, maskShadows=True, scaledImage=False, dark=0.15, cloudDist=1000, buffer=250, cdi=None)[source]

Masks clouds and shadows in an image (valid just for Surface Reflectance products).

Args:
selfee.Image (this)

Image to mask. Accepted platforms:

  • Sentinel-2

  • Landsat 8

  • Landsat 7

  • Landsat 5

  • Landsat 4

methodstring, default = ‘cloud_prob’

  • ‘cloud_prob’ : Use cloud probability. Valid just for Sentinel-2.

  • ‘qa’ : Use Quality Assessment band. Valid just for Sentinel-2.

This parameter is ignored for Landsat products.

probnumeric [0, 100], default = 60

Cloud probability threshold. Valid just for method = ‘prob’. This parameter is ignored for Landsat products.

maskCirrusboolean, default = True

Whether to mask cirrus clouds. Valid just for method = ‘qa’. This parameter is ignored for Landsat products.

maskShadowsboolean, default = True

Whether to mask cloud shadows.

For more info see ‘Braaten, J. 2020. Sentinel-2 Cloud Masking with s2cloudless. Google Earth Engine, Community Tutorials’.

scaledImageboolean, default = False

Whether the pixel values are scaled to the range [0,1] (reflectance values). This parameter is ignored for Landsat products.

darkfloat [0,1], default = 0.15

NIR threshold. NIR values below this threshold are potential cloud shadows. This parameter is ignored for Landsat products.

cloudDistint, default = 1000

Maximum distance in meters (m) to look for cloud shadows from cloud edges. This parameter is ignored for Landsat products.

bufferint, default = 250

Distance in meters (m) to dilate cloud and cloud shadows objects. This parameter is ignored for Landsat products.

cdifloat [-1,1], default = None

Cloud Displacement Index threshold. Values below this threshold are considered potential clouds. A cdi = None means that the index is not used. For more info see ‘Frantz, D., HaS, E., Uhl, A., Stoffels, J., Hill, J. 2018. Improvement of the Fmask algorithm for Sentinel-2 images: Separating clouds from bright surfaces based on parallax effects. Remote Sensing of Environment 2015: 471-481’. This parameter is ignored for Landsat products.

Returns:
ee.Image

Cloud-shadow masked image.

eemont.image.scale(self)[source]

Scales reflectance bands on an image collection. This also scales temperature in Landsat images and derived bands in Sentinel-2 images (except for MSK_CLDPRB and MSK_SNWPRB bands

that are excluded from the image).

Args:
selfee.Image (this)

Image to scale. Accepted platforms:

  • Sentinel-2

  • Landsat 8

  • Landsat 7

  • Landsat 5

  • Landsat 4

Returns:
ee.Image

Scaled image.

eemont.imagecollection module

eemont.imagecollection.closest(self, date)[source]

Gets the closest image (or set of images if the collection intersects a region that requires multiple scenes) closest to the specified date.

Args:
selfee.ImageCollection (this)

Image Collection from which to get the closest image to the specified date.

dateee.Date | string

Date of interest. The method will look for images closest to this date.

Returns:
ee.ImageCollection

Closest images to the specified date.

eemont.imagecollection.index(self, index='NDVI', G=2.5, C1=6.0, C2=7.5, L=1.0)[source]

Computes one or more spectral indices (indices are added as bands) for an image collection.

Args:
selfee.ImageCollection

Image collection to compute indices on. Must be scaled to [0,1].

indexstring | list[string], default = ‘NDVI’

Index or list of indices to compute. Available options:

  • ‘vegetation’ : Compute all vegetation indices.

  • ‘burn’ : Compute all burn indices.

  • ‘water’ : Compute all water indices.

  • ‘all’ : Compute all indices listed below.

Vegetation indices:

  • ‘BNDVI’ : Blue Normalized Difference Vegetation Index.

  • ‘CIG’ : Chlorophyll Index - Green.

  • ‘CVI’ : Chlorophyll Vegetation Index.

  • ‘EVI’ : Enhanced Vegetation Index.

  • ‘GNDVI’ : Green Normalized Difference Vegetation Index.

  • ‘NDVI’ : Normalized Difference Vegetation Index.

  • ‘NGRDI’ : Normalized Green Red Difference Index.

  • ‘SR’ : Simple Ratio.

  • ‘SAVI’ : Soil-Adjusted Vegetation Index.

Burn and fire indices:

  • ‘BAI’ : Burned Area Index.

  • ‘BAIS2’ : Burned Area Index for Sentinel 2.

  • ‘NBR’ : Normalized Burn Ratio.

Water indices:

  • ‘MNDWI’ : Modified Normalized Difference Water Index.

  • ‘NDWI’ : Normalized Difference Water Index.

Gfloat, default = 2.5

Gain factor. Used just for index = ‘EVI’.

C1float, default = 6.0

Coefficient 1 for the aerosol resistance term. Used just for index = ‘EVI’.

C2float, default = 7.5

Coefficient 2 for the aerosol resistance term. Used just for index = ‘EVI’.

Lfloat, default = 1.0

Canopy background adjustment. Used just for index = [‘EVI’,’SAVI’].

Returns:
ee.ImageCollection

Image collection with the computed spectral index, or indices, as new bands.

eemont.imagecollection.maskClouds(self, method='cloud_prob', prob=60, maskCirrus=True, maskShadows=True, scaledImage=False, dark=0.15, cloudDist=1000, buffer=250, cdi=None)[source]

Masks clouds and shadows in an image collection (valid just for Surface Reflectance products).

Args:
selfee.ImageCollection (this)

Image collection to mask. Accepted platforms:

  • Sentinel-2

  • Landsat 8

  • Landsat 7

  • Landsat 5

  • Landsat 4

methodstring, default = ‘cloud_prob’

  • ‘cloud_prob’ : Use cloud probability. Valid just for Sentinel-2.

  • ‘qa’ : Use Quality Assessment band. Valid just for Sentinel-2.

This parameter is ignored for Landsat products.

probnumeric [0, 100], default = 60

Cloud probability threshold. Valid just for method = ‘prob’. This parameter is ignored for Landsat products.

maskCirrusboolean, default = True

Whether to mask cirrus clouds. Valid just for method = ‘qa’. This parameter is ignored for Landsat products.

maskShadowsboolean, default = True

Whether to mask cloud shadows.

For more info see ‘Braaten, J. 2020. Sentinel-2 Cloud Masking with s2cloudless. Google Earth Engine, Community Tutorials’.

scaledImageboolean, default = False

Whether the pixel values are scaled to the range [0,1] (reflectance values). This parameter is ignored for Landsat products.

darkfloat [0,1], default = 0.15

NIR threshold. NIR values below this threshold are potential cloud shadows. This parameter is ignored for Landsat products.

cloudDistint, default = 1000

Maximum distance in meters (m) to look for cloud shadows from cloud edges. This parameter is ignored for Landsat products.

bufferint, default = 250

Distance in meters (m) to dilate cloud and cloud shadows objects. This parameter is ignored for Landsat products.

cdifloat [-1,1], default = None

Cloud Displacement Index threshold. Values below this threshold are considered potential clouds. A cdi = None means that the index is not used. For more info see ‘Frantz, D., HaS, E., Uhl, A., Stoffels, J., Hill, J. 2018. Improvement of the Fmask algorithm for Sentinel-2 images: Separating clouds from bright surfaces based on parallax effects. Remote Sensing of Environment 2015: 471-481’. This parameter is ignored for Landsat products.

Returns:
ee.ImageCollection

Cloud-shadow masked image collection.

eemont.imagecollection.scale(self)[source]

Scales reflectance bands on an image collection. This also scales temperature in Landsat images and derived bands in Sentinel-2 images (except for MSK_CLDPRB and MSK_SNWPRB bands that are excluded from the image collection).

Args:
selfee.ImageCollection (this)

Image collection to scale. Accepted platforms:

  • Sentinel-2

  • Landsat 8

  • Landsat 7

  • Landsat 5

  • Landsat 4

Returns:
ee.ImageCollection

Scaled image collection.

Module contents

The eemont python package.