API Reference

Extended Earth Engine Object Classes

Here you can find the reference of the new methods for each one of the Earth Engine classes:

ee.Feature

BBoxFromQuery(query[, geocoder])

Constructs an ee.Feature describing a bounding box from a query submitted to a geodocer using the geopy package.

PointFromQuery(query[, geocoder])

Constructs an ee.Feature describing a point from a query submitted to a geodocer using the geopy package.

ee.FeatureCollection

MultiPointFromQuery(query[, geocoder])

Constructs an ee.Feature describing a point from a query submitted to a geodocer using the geopy package.

ee.Geometry

BBoxFromQuery(query[, geocoder])

Constructs an ee.Geometry describing a bounding box from a query submitted to a geodocer using the geopy package.

PointFromQuery(query[, geocoder])

Constructs an ee.Geometry describing a point from a query submitted to a geodocer using the geopy package.

MultiPointFromQuery(query[, geocoder])

Constructs an ee.Geometry describing a multi-point from a query submitted to a geodocer using the geopy package.

ee.Image

getCitation(self)

Gets the citation of the image, if available.

getDOI(self)

Gets the DOI of the image, if available.

getOffsetParams(self)

Gets the offset parameters for each band of the image.

getScaleParams(self)

Gets the scale parameters for each band of the image.

getSTAC(self)

Gets the STAC of the image.

index(self[, index, G, C1, C2, L, cexp, …])

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

maskClouds(self[, method, prob, maskCirrus, …])

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

preprocess(self, **kwargs)

Pre-processes the image: masks clouds and shadows, and scales and offsets the image.

scale(self)

Scales bands on an image.

scaleAndOffset(self)

Scales bands on an image according to their scale and offset parameters.

spectralIndices(self[, index, G, C1, C2, L, …])

Computes one or more spectral indices (indices are added as bands) for an image from the Awesome List of Spectral Indices.

ee.ImageCollection

closest(self, date[, tolerance, unit])

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

getCitation(self)

Gets the citation of the image collection, if available.

getDOI(self)

Gets the DOI of the image collection, if available.

getOffsetParams(self)

Gets the offset parameters for each band of the image collection.

getScaleParams(self)

Gets the scale parameters for each band of the image collection.

getSTAC(self)

Gets the STAC of the image collection.

getTimeSeriesByRegion(self, reducer[, …])

Gets the time series by region for the given image collection and geometry (feature or feature collection are also supported) according to the specified reducer (or reducers).

getTimeSeriesByRegions(self, reducer, collection)

Gets the time series by regions for the given image collection and feature collection according to the specified reducer (or reducers).

index(self[, index, G, C1, C2, L, cexp, …])

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

maskClouds(self[, method, prob, maskCirrus, …])

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

preprocess(self, **kwargs)

Pre-processes the image collection: masks clouds and shadows, and scales and offsets the image collection.

scale(self)

Scales bands on an image collection.

scaleAndOffset(self)

Scales bands on an image collection according to their scale and offset parameters.

spectralIndices(self[, index, G, C1, C2, L, …])

Computes one or more spectral indices (indices are added as bands) for an image collection from the Awesome List of Spectral Indices.

Extended Non-Earth Engine Object Classes

Non-Earth Engine classes such as pd.DataFrame are also extended:

pd.DataFrame

toEEFeatureCollection(self[, latitude, …])

Converts a pd.DataFrame object into an ee.FeatureCollection object.

Additional Modules

Functions of additional modules:

Common

indices([online])

Gets the dictionary of available indices as a Box object.

listIndices([online])

Gets the list of available indices.