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)
`HoCalcAlgorithm2`(image)	Applies an algal detection algorithm based on: Matthews, M.
`HoCalcGreenness`(img)
`RefinedLee`(img)	Applies the Refined Lee speckle filter to a Sentinel-1 image.
`addAbsDiff`(inCollection, qualityBand, ...)
`addDateBand`(img[, maskTime])	Adds a date band to an image.
`addFullYearJulianDayBand`(img)	Adds a full year Julian day band to an image.
`addIndices`(img)	Adds various spectral indices to an image.
`addJulianDayBand`(img)	Adds a Julian day band to an image.
`addSAVIandEVI`(img)	Adds SAVI and EVI indices to an image.
`addSensorBand`(img, whichProgram, toaOrSR)	Adds a sensor band to an image.
`addSoilIndices`(img)	Adds soil-related indices to an image.
`addTCAngles`(image)	Adds Tasseled Cap angles and distances to an image.
`addYearBand`(img)	Adds a year band to an image.
`addYearFractionBand`(img)	Adds a year fraction band to an image.
`addYearJulianDayBand`(img)	Adds a year and Julian day band to an image.
`addYearYearFractionBand`(img)	Adds a year and year fraction band to an image.
`addZenithAzimuth`(img, toaOrSR[, zenithDict, ...])	Adds solar zenith and azimuth angles in radians to an image.
`applyBitMask`(img, bit[, bitMaskBandName])	Applies a bitmask to an image.
`applyCloudScoreAlgorithm`(collection, ...[, ...])	Applies a cloud score algorithm to an image collection.
`applyScaleFactors`(image, ...)
`cFmask`(img, fmaskClass[, bitMaskBandName])	Applies the CFMask algorithm to 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])
`coRegisterGroups`(imgs[, fieldName, ...])
`collectionToImage`(collection)	Deprecated - use .toBands().
`compositeDates`(images, composite[, bandNames])	Finds the dates corresponding to bands in a composite image.
`compositeTimeSeries`(ls, startYear, endYear, ...)	Creates composites for each year within a specified date range.
`customQualityMosaic`(inCollection, ...)
`dailyMosaics`(imgs)	Creates daily mosaics from an image collection.
`defringeLandsat`(img)	Defringes a Landsat 7 image.
`despikeCollection`(c, absoluteSpike, bandNo)
`dir0Regression`(img, slopes, intercepts)
`dir1Regression`(img, slopes, intercepts)
`exportCollection`(exportPathRoot, outputName, ...)
`exportCompositeCollection`(collection, ...[, ...])
`exportToAssetWrapper`(imageForExport, ...[, ...])	Exports an image to an Earth Engine asset.
`exportToCloudStorageWrapper`(imageForExport, ...)	Exports an image to Google Cloud Storage.
`exportToDriveWrapper`(imageForExport, ...[, ...])	Exports an image to Google Drive.
`fillEmptyCollections`(inCollection, dummyImage)	Fills empty image collections with a dummy image.
`formatArgs`(args)	Formats arguments as strings for setting as image properties.
`getAreaUnderCurve`(harmCoeffs[, t0, t1])
`getClimateWrapper`(collectionName, studyArea, ...)	Wrapper function to retrieve and process climate data from various Earth Engine collections.
`getDateStack`(startYear, endYear, ...)
`getHarmonicCoefficientsAndFit`(allImages, ...)
`getHarmonicList`(yearDateImg, ...)
`getHarmonics2`(collection, transformBandName, ...)
`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`(...[, ...])
`getLandsatWrapper`(studyArea, startYear, ...)
`getModisData`(startYear, endYear, ...[, ...])	Retrieves MODIS imagery from Earth Engine for a specified period.
`getPeakDate`(coeffs[, peakDirection])
`getPhaseAmplitudePeak`(coeffs[, t0, t1])
`getPrecomputedCloudScoreOffsets`([cloudScorePctl])
`getPrecomputedTDOMStats`()
`getProcessedLandsatAndSentinel2Scenes`(...[, ...])
`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, ...)
`getQABits`(image, start, end, name)	Extracts specific bits from a QA band.
`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, ...)
`getTasseledCap`(image)	Computes the Tasseled Cap transformation for an image using the Crist 1985 coefficients.
`harmonizationChastain`(img, fromSensor, toSensor)	Harmonizes Landsat images 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)
`joinCollections`(c1, c2[, maskAnyNullValues, ...])
`joinFeatureCollections`(primary, secondary, ...)
`landsatCloudScore`(img)	Computes a cloud score for a Landsat image and adds a band that represents the cloud mask.
`maskCloudsWQA`(image)
`maskEmptyPixels`(image)	Masks pixels without observations in an image.
`maskS2clouds`(image)	Masks clouds in a Sentinel-2 image using the QA60 band.
`medoidMosaicMSD`(inCollection[, ...])	Creates a medoid mosaic using the Mean Squared Difference (MSD) (euclidean distance) method.
`modisCloudScore`(img)
`nDayComposites`(images, startYear, endYear, ...)
`newPredict`(coeffs, harmonics)
`newRobustMultipleLinear2`(dependentsIndependents)
`offsetImageDate`(img, n, unit)	Offsets the date of an image.
`printEE`(eeObject[, message])
`projectShadows`(cloudMask, image, ...[, yMult])
`projectShadowsWrapper`(img[, cloudThresh, ...])
`rescale`(img, thresholds)	Rescales pixel values in an image using a min-max normalization.
`sentinel2CloudScore`(img)
`sentinel2SnowMask`(img[, dilatePixels])
`setNoData`(image, noDataValue)	Sets null values for an image.
`sieve`(image, mmu)	Performs clumping and elimination on an image.
`simpleAddIndices`(in_image)	Adds common spectral indices to an image.
`simpleAddTCAngles`(image)	Adds the Tasseled Cap brightness-greenness angle to an image as in Powell et al 2009.
`simpleGetTasseledCap`(image)	Computes the Tasseled Cap transformation for an image, including only brightness, greenness, and wetness using the Crist 1985 coefficients.
`simpleTDOM2`(collection[, zScoreThresh, ...])	Applies a simple temporal dark object differencing (TDOM) algorithm to an image collection.
`simpleWaterMask`(img[, contractPixels, ...])	Performs a basic on-the-fly water masking for TOA reflectance imagery.
`smartJoin`(primary, secondary, hourDiff)
`spatioTemporalJoin`(primary, secondary[, ...])
`superSimpleGetS2`(studyArea, startDate, endDate)	This function retrieves Sentinel-2 satellite imagery from Earth Engine for a specified study area and date range.
`synthImage`(coeffs, dateImage, indexNames, ...)
`toDB`(img)	Converts a Sentinel-1 image from natural units to dB.
`toNatural`(img)	Converts a Sentinel-1 image from dB to natural units.
`uniqueValues`(collection, field)	Finds unique values of a field in an image collection.
`wrapDates`(startJulian, endJulian)	Wraps dates when the startJulian is greater than the endJulian.