API Reference

Welcome to the eeExtra API Reference!

Extra.Image

minvalue(x[, scale])	Get a minimum value.
maxvalue(x[, scale])	Get a maximum value.

Extra.ImageCollection

closest(x, 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.

Extra.JavaScript

install(x[, update, quiet])	Install an Earth Engine modue and its dependencies.
uninstall(x[, quiet])	Uninstall an Earth Engine JavaScript module.

ee_js_to_py(in_file, out_file[, black])	Convert an EE JavaScript file to an EE Python file.
ee_require(x)	Requires a JavaScript module as a python module.
ee_translate(x)	Translate a EE Js module to a Python script.

Extra.QA

maskClouds(x[, method, prob, maskCirrus, ...])

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

preprocess(x, **kwargs)

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

listMetrics()	Get the name and class of all QA metrics.
getMetrics(names)	Take one or more metric names and return a list of matching QA metrics.
MSE(original, modified[, reproject])	Calculate band-wise Mean Squared Error (MSE) between an original and modified image with the same bands.
RMSE(original, modified[, reproject])	Calculate band-wise Root-Mean Squared Error (RMSE) between an original and modified image with the same bands.
RASE(original, modified[, reproject])	Calculate image-wise Relative Average Spectral Error (RASE) between an original and modified image with the same bands.
ERGAS(original, modified[, reproject])	Calculate image-wise Dimensionless Global Relative Error of Synthesis (ERGAS) between an original and modified image with the same bands.
DIV(original, modified[, reproject])	Calculate band-wise Difference in Variance (DIV) between an original and modified image with the same bands.
bias(original, modified[, reproject])	Calculate band-wise bias between an original and modified image with the same bands.
CC(original, modified[, reproject])	Calculate band-wise correlation coefficient (CC) between an original and modified image with the same bands.
CML(original, modified[, reproject])	Calculate band-wise change in mean luminance (CML) between an original and modified image with the same bands.
CMC(original, modified[, reproject])	Calculate band-wise change in mean contrast (CMC) between an original and modified image with the same bands.
UIQI(original, modified[, reproject])	Calculate band-wise Universal Image Quality Index (UIQI) between an original and modified image with the same bands.

Extra.Spectral

indices([online])	Gets the dictionary of available indices.
listIndices([online])	Gets the list of available indices.
spectralIndices(x[, index, G, C1, C2, L, ...])	Computes one or more spectral indices (indices are added as bands) for an image or image collection.
tasseledCap(x)	Calculates tasseled cap brightness, wetness, and greenness components for an image or image collection.

Extra.STAC

getCitation(x)	Gets the citation of the specified platform, if available.
getDOI(x)	Gets the DOI of the specified platform, if available.
getOffsetParams(x)	Gets the offset parameters for each band of the image or image collection.
getScaleParams(x)	Gets the scale parameters for each band of the image or image collection.
getSTAC(x)	Gets the STAC of the specified platform.
listDatasets()	Returns all datasets from the GEE STAC as a list.
scaleAndOffset(x)	Scales and offsets bands on an Image or Image Collection.

Extra.TimeSeries

getTimeSeriesByRegion(x, reducer[, bands, ...])	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(x, reducer, collection)	Gets the time series by regions for the given image collection and feature collection according to the specified reducer (or reducers).

Extra.Algorithms

panSharpen(img[, method, qa, prefix])

Apply panchromatic sharpening to an Image or ImageCollection.

listSharpeners()	Get the name and class of all pan-sharpening algorithms.
getSharpener(name)	Return a pan-sharpening algorithm that matches a name.
SFIM(img, pan, **kwargs)	The Smoothing Filter-based Intensity Modulation (SFIM) sharpener.
HPFA(img, pan, **kwargs)	The High Pass Filter Addition (HPFA) sharpener.
PCS(img, pan, **kwargs)	The Principal Component Substitution (PCS) sharpener.
SM(img, pan, **kwargs)	The Simple Mean (SM) sharpener.