geeViz.getImagesLib

Get images and organize them so they are easier to work with

geeViz.getImagesLib is the core module for setting up various imageCollections from GEE. Notably, it facilitates Landsat, Sentinel-2, and MODIS data organization. This module helps avoid many common mistakes in GEE. Most functions ease matching band names, ensuring resampling methods are properly set, date wrapping, and helping with cloud and cloud shadow masking.

Functions

HoCalcAlgorithm1(image)	Apply the Ho et al. algal bloom detection algorithm to a satellite image.
HoCalcAlgorithm2(image)	Applies an algal bloom detection algorithm to an image.
HoCalcGreenness(img)	Compute the hue component for algal bloom greenness detection.
RefinedLee(img)	Applies the Refined Lee speckle filter to a Sentinel-1 image.
addAbsDiff(inCollection, qualityBand, ...)	Add a band with the absolute difference from a percentile-based quality target.
addDateBand(img[, maskTime])	Adds a "year" band containing the fractional year (year + day-of-year fraction).
addFullYearJulianDayBand(img)	Adds a "yearJulian" band encoding the full 4-digit year and Julian day (YYYYDD).
addIndices(img)	Adds a comprehensive set of spectral indices to an image.
addJulianDayBand(img)	Adds a "julianDay" band containing the day of the year (1--366).
addSAVIandEVI(img)	Adds SAVI, EVI, and NIRv vegetation indices to an image.
addSensorBand(img, whichProgram, toaOrSR)	Adds a band encoding the satellite sensor as a numeric value.
addSoilIndices(img)	Adds soil-related spectral indices to an image.
addTCAngles(image)	Adds Tasseled Cap angles and distances to an image.
addYearBand(img)	Adds a "year" band containing the integer year of the image acquisition.
addYearFractionBand(img)	Adds a "year" band containing only the fractional part of the year (0 to 1).
addYearJulianDayBand(img)	Adds a "yearJulian" band encoding the 2-digit year and Julian day (YYDD).
addYearYearFractionBand(img)	Adds a "year" band containing the full fractional year (year + fraction).
addZenithAzimuth(img, toaOrSR[, zenithDict, ...])	Adds solar zenith and azimuth angles in radians as bands to an image.
applyBitMask(img, bit[, bitMaskBandName])	Masks pixels where a specific bit is set in a QA bitmask band.
applyCloudScoreAlgorithm(collection, ...[, ...])	Applies a cloud score algorithm to an image collection and masks cloudy pixels.
applyScaleFactors(image, ...)	Rescales Landsat reflectance bands to 0-1 and thermal bands to Kelvin.
cFmask(img, fmaskClass[, bitMaskBandName])	Applies the CFMask algorithm to mask a specific class in a Landsat image.
cFmaskCloud(img, landsatCollectionVersion[, ...])	Applies the CFMask cloud mask to a Landsat image.
cFmaskCloudShadow(img, landsatCollectionVersion)	Applies the CFMask cloud shadow mask to a Landsat image.
coRegisterCollection(images[, referenceBands])	Co-register all images in a collection to the first image.
coRegisterGroups(imgs[, fieldName, ...])	Co-register images within groups defined by a metadata field.
collectionToImage(collection)	Converts an image collection to a single multiband image.
compositeDates(images, composite[, bandNames])	Finds the acquisition dates corresponding to each band in a composite image.
compositeTimeSeries(ls, startYear, endYear, ...)	Creates annual composites from an image collection over a year range.
customQualityMosaic(inCollection, ...)	Create a quality mosaic using a specified percentile rather than the max.
dailyMosaics(imgs)	Creates daily mosaics from an image collection grouped by date and orbit.
defringeLandsat(img)	Defringes a Landsat 7 image by masking fringe pixels with insufficient valid neighbors.
despikeCollection(c, absoluteSpike, bandNo)	Removes spike artifacts from a time series image collection.
dir0Regression(img, slopes, intercepts)	Applies a forward linear regression model: corrected = img * slopes + intercepts.
dir1Regression(img, slopes, intercepts)	Applies an inverse linear regression model: corrected = (img - intercepts) / slopes.
exportCollection(exportPathRoot, outputName, ...)	Exports yearly composites from an image collection to EE assets or Cloud Storage.
exportCompositeCollection(collection, ...[, ...])	Exports yearly composites to Earth Engine assets with scaled integer values.
exportToAssetWrapper(imageForExport, ...[, ...])	Exports an image to an Earth Engine asset with overwrite handling.
exportToCloudStorageWrapper(imageForExport, ...)	Exports an image to Google Cloud Storage with overwrite handling.
exportToDriveWrapper(imageForExport, ...[, ...])	Exports an image to Google Drive as a GeoTIFF.
fillEmptyCollections(inCollection, dummyImage)	Fills empty image collections with a fully-masked dummy image.
formatArgs(args)	Formats arguments as strings for setting as Earth Engine image properties.
getAreaUnderCurve(harmCoeffs[, t0, t1])	Compute the definite integral (area under curve) of a single-harmonic model.
getClimateWrapper(collectionName, studyArea, ...)	Wrapper function to retrieve and process climate data from various Earth Engine collections.
getDateStack(startYear, endYear, ...)	Generate a synthetic date image stack for predicting harmonic time series.
getHarmonicCoefficientsAndFit(allImages, ...)	Fit harmonic regression to an ImageCollection and return coefficients and fitted values.
getHarmonicList(yearDateImg, ...)	Compute sin and cos harmonic predictor bands for a year-fraction image.
getHarmonics2(collection, transformBandName, ...)	Prepare an ImageCollection with harmonic predictor bands for regression.
getImageCollection(studyArea, startDate, endDate)	Retrieves Landsat imagery for a specified study area and date range.
getLandsat(studyArea, startDate, endDate[, ...])	Retrieves Landsat imagery for a specified study area and date range.
getLandsatAndSentinel2HybridWrapper(...[, ...])	Get annual Landsat + Sentinel-2 hybrid composites.
getLandsatWrapper(studyArea, startYear, ...)	Retrieve cloud-masked Landsat annual composites for a study area and date range.
getModisData(startYear, endYear, ...[, ...])	Retrieves MODIS imagery from Earth Engine for a specified period.
getPeakDate(coeffs[, peakDirection])	Compute the Julian day, month, and day-of-month of peak vegetation vigor.
getPhaseAmplitudePeak(coeffs[, t0, t1])	Extract phase, amplitude, peak date, and AUC from harmonic regression coefficients.
getPrecomputedCloudScoreOffsets([cloudScorePctl])	Retrieves precomputed cloud score offset images for Landsat and Sentinel-2.
getPrecomputedTDOMStats()	Retrieves precomputed TDOM (Temporal Dark Outlier Mask) statistics for Landsat and Sentinel-2.
getProcessedLandsatAndSentinel2Scenes(...[, ...])	Get cloud/shadow-masked Landsat + Sentinel-2 scenes merged together.
getProcessedLandsatScenes(studyArea, ...[, ...])	Retrieves, processes, and filters Landsat scenes for a specified area and time period.
getProcessedModis(startYear, endYear, ...[, ...])	Retrieves, processes, and filters MODIS imagery for a specified period.
getProcessedSentinel2Scenes(studyArea, ...)	Get cloud/shadow-masked Sentinel-2 scenes for a date range.
getQABits(image, start, end, name)	Extracts a range of bits from a QA band image.
getS1(studyArea, startYear, endYear, ...[, ...])	Loads Sentinel-1 GRD data for a given area and time period.
getS2(studyArea, startDate, endDate[, ...])	Loads Sentinel-2 data for a given area and time period and joins cloud score information.
getSentinel2(studyArea, startDate, endDate)	Loads Sentinel-2 data for a given area and time period and joins cloud score information.
getSentinel2Wrapper(studyArea, startYear, ...)	Get annual Sentinel-2 composites with cloud/shadow masking.
getTasseledCap(image)	Computes the Tasseled Cap transformation using Crist 1985 coefficients.
getUTMEpsg(location[, datum])	Return the EPSG code string for a UTM zone given a location and datum.
getUTMZone(longitude)	Return the UTM zone number (1-60) for a given longitude.
harmonizationChastain(img, fromSensor, toSensor)	Harmonizes cross-sensor reflectance using Chastain et al. (2018) coefficients.
harmonizationRoy(oli)	Harmonizes Landsat 8 OLI to Landsat 7 ETM+ using Roy et al. (2016) coefficients.
illuminationCorrection(img, scale, studyArea)	Applies SCSc topographic correction to specified bands of an image.
joinCollections(c1, c2[, maskAnyNullValues, ...])	Joins two image collections by a shared property using an inner join.
joinFeatureCollections(primary, secondary, ...)	Joins two feature collections by matching property values using an inner join.
landsatCloudScore(img)	Computes a cloud score for a Landsat image based on spectral indicators.
maskCloudsWQA(image)	Masks cloudy pixels using the MODIS state_1km QA band.
maskEmptyPixels(image)	Masks pixels that have zero observations in a MODIS-style image.
maskS2clouds(image)	Masks clouds and cirrus in a Sentinel-2 image using the QA60 band.
medoidMosaicMSD(inCollection[, ...])	Creates a medoid mosaic using the Mean Squared Difference (MSD) method.
modisCloudScore(img)	Computes a cloud score (0-100) for a MODIS image.
nDayComposites(images, startYear, endYear, ...)	Creates median composites at regular n-day intervals from an image collection.
newPredict(coeffs, harmonics)	Apply harmonic regression coefficients to predict values for each image.
newRobustMultipleLinear2(dependentsIndependents)	Fit a linear regression model across an ImageCollection with labeled bands.
offsetImageDate(img, n, unit)	Offsets the system:time_start property of an image by a specified amount.
printEE(eeObject[, message])	Asynchronously prints an Earth Engine object by fetching its value in a background thread.
projectShadows(cloudMask, image, ...[, yMult])	Projects cloud shadows based on solar geometry and masks them along with clouds.
projectShadowsWrapper(img[, cloudThresh, ...])	Wrapper that computes a cloud mask and projects cloud shadows for a Sentinel-2 image.
rescale(img, thresholds)	Rescales pixel values in an image using min-max normalization.
sentinel2CloudScore(img)	Computes a cloud score (0-100) for a Sentinel-2 image.
sentinel2SnowMask(img[, dilatePixels])	Masks snow-covered pixels in a Sentinel-2 image using NDSI thresholds.
setNoData(image, noDataValue)	Sets null values for an image, replacing masked pixels with a constant.
sieve(image, mmu)	Performs clumping and elimination (sieving) on a classified image.
simpleAddIndices(in_image)	Adds common spectral indices (NDVI, NBR, NDMI, NDSI) to an image.
simpleAddTCAngles(image)	Adds the Tasseled Cap brightness-greenness angle as in Powell et al. (2009).
simpleGetTasseledCap(image)	Computes a simplified Tasseled Cap with brightness, greenness, and wetness only.
simpleTDOM2(collection[, zScoreThresh, ...])	Applies Temporal Dark Outlier Mask (TDOM) to detect and mask cloud shadows.
simpleWaterMask(img[, contractPixels, ...])	Performs a basic on-the-fly water masking for TOA reflectance imagery.
smartJoin(primary, secondary, hourDiff)	Joins two image collections by closest timestamp within a time window.
spatioTemporalJoin(primary, secondary[, ...])	Joins two image collections by spatial intersection and closest timestamp.
superSimpleGetS2(studyArea, startDate, endDate)	Retrieve cloud-masked Sentinel-2 imagery — preferred S2 function.
synthImage(coeffs, dateImage, indexNames, ...)	Predict band values at a single date using harmonic regression coefficients.
toDB(img)	Converts a Sentinel-1 image from natural (linear power) units to dB.
toNatural(img)	Converts a Sentinel-1 image from dB to natural (linear power) units.
uniqueValues(collection, field)	Finds unique values of a field in an image collection.
wrapDates(startJulian, endJulian)	Computes date-wrapping parameters when startJulian > endJulian.