API

ee.Algorithms.CannyEdgeDetector

Applies the Canny edge detection algorithm to an image. The output is an image whose bands have the same names as the input bands, and in which non-zero values indicate edges, and the magnitude of the value is the gradient magnitude.

UsageReturns
ee.Algorithms.CannyEdgeDetector(image, threshold, sigma)Image
ArgumentTypeDetails
imageImage

The image on which to apply edge detection.

thresholdFloat

Threshold value. The pixel is only considered for edge detection if the gradient magnitude is higher than this threshold.

sigmaFloat, default: 1

Sigma value for a gaussian filter applied before edge detection. 0 means apply no filtering.

ee.Algorithms.Collection

Returns a Collection containing the specified features.

UsageReturns
ee.Algorithms.Collection(features)FeatureCollection
ArgumentTypeDetails
featuresList

The features comprising the collection.

ee.Algorithms.CrossCorrelation

Gives information on the quality of image registration between two (theoretically) co-registered images. The input is two images with the same number of bands. This function outputs an image composed of four bands of information. The first three are distances: the deltaX, deltaY, and the Euclidean distance for each pixel in imageA to the pixel which has the highest corresponding correlation coefficient in imageB. The fourth band is the value of the correlation coefficient for that pixel [-1 : +1].

UsageReturns
ee.Algorithms.CrossCorrelation(imageA, imageB, maxGap, windowSize, maxMaskedFrac)Image
ArgumentTypeDetails
imageAImage

First image, with N bands.

imageBImage

Second image, must have the same number of bands as imageA.

maxGapInteger

The greatest distance a pixel may shift in either X or Y.

windowSizeInteger

Size of the window to be compared.

maxMaskedFracFloat, default: 0

The maximum fraction of pixels within the correlation window that are allowed to be masked. This test is applied at each offset location within the search region. For each offset, the overlapping image patches are compared and a correlation score computed. A pixel within these overlapping patches is considered masked if either of the patches is masked there. If the test fails at any single location in the search region, the ouput pixel for which the correlation is being computed is considered invalid, and will be masked.

ee.Algorithms.Date

Creates a Date.

UsageReturns
ee.Algorithms.Date(value, timeZone)Date
ArgumentTypeDetails
valueObject

A number (interpreted as milliseconds since 1970-01-01T00:00:00Z), or string such as '1996-01-01' or '1996-001' or '1996-01-01T08:00'.

timeZoneString, default: null

The time zone (e.g. 'America/Los_Angeles'); defaults to UTC.

ee.Algorithms.Describe

Describes an object using a simple JSON-compatible structure.

UsageReturns
ee.Algorithms.Describe(input)Object
ArgumentTypeDetails
inputObject

The object to describe.

ee.Algorithms.Dictionary

Constructs a dictionary.

UsageReturns
ee.Algorithms.Dictionary(input)Dictionary
ArgumentTypeDetails
inputObject, default: null

An object to convert to a dictionary. Either a JSON dictionary or a list of alternating key/value pairs. Keys must be strings.

ee.Algorithms.FMask.fillMinima

Fills local minima. Only works on INT types.

UsageReturns
ee.Algorithms.FMask.fillMinima(image, borderValue, neighborhood)Image
ArgumentTypeDetails
imageImage

The image to fill.

borderValueLong, default: null

The border value.

neighborhoodInteger, default: 50

The size of the neighborhood to compute over.

ee.Algorithms.FMask.matchClouds

Runs the FMask cloud and shadow matching. Outputs a single band ('csm'), containing the computed cloud and shadow masks.

UsageReturns
ee.Algorithms.FMask.matchClouds(input, cloud, shadow, btemp, sceneLow, sceneHigh, neighborhood)Image
ArgumentTypeDetails
inputImage

The scene for which to compute cloud and shadow masks.

cloudImage

Potential cloud mask image. Expected to contain 1s for cloudy pixels and masked pixels everywhere else.

shadowImage

Potential shadow mask image. Expected to contain 1s for shadow pixels and masked pixels everywhere else.

btempImage

Brightness temperature image, in Celsius.

sceneLowFloat

The 0.175 percentile brightness temperature of the scene.

sceneHighFloat

The 0.825 percentile brightness temperature of the scene.

neighborhoodInteger, default: 50

The neighborhood to pad around each tile.

ee.Algorithms.Feature

Returns a Feature composed of the given geometry and metadata.

UsageReturns
ee.Algorithms.Feature(geometry, metadata, geometryKey)Feature
ArgumentTypeDetails
geometryGeometry, default: null

The geometry of the feature.

metadataDictionary, default: {}

The properties of the feature.

geometryKeyString, default: null

Obsolete; has no effect.

ee.Algorithms.GeometryConstructors.LineString

Constructs a LineString from the given coordinates.

UsageReturns
ee.Algorithms.GeometryConstructors.LineString(coordinates, crs, geodesic)Geometry
ArgumentTypeDetails
coordinatesList

The list of Points or pairs of Numbers in x,y order.

crsProjection, default: null

The coordinate reference system of the coordinates. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesicBoolean, default: null

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

ee.Algorithms.GeometryConstructors.LinearRing

Constructs a LinearRing from the given coordinates, automatically adding the first point at the end if the ring is not explicitly closed.

UsageReturns
ee.Algorithms.GeometryConstructors.LinearRing(coordinates, crs, geodesic)Geometry
ArgumentTypeDetails
coordinatesList

The list of Points or pairs of Numbers in x,y order.

crsProjection, default: null

The coordinate reference system of the coordinates. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesicBoolean, default: null

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

ee.Algorithms.GeometryConstructors.MultiGeometry

Constructs a MultiGeometry from the given list of geometry elements.

UsageReturns
ee.Algorithms.GeometryConstructors.MultiGeometry(geometries, crs, geodesic, maxError)Geometry
ArgumentTypeDetails
geometriesList

The list of geometries for the MultiGeometry.

crsProjection, default: null

The coordinate reference system of the coordinates. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesicBoolean, default: null

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

maxErrorErrorMargin, default: null

Max error when input geometry must be reprojected to an explicitly requested result projection or geodesic state.

ee.Algorithms.GeometryConstructors.MultiLineString

Constructs a MultiLineString from the given coordinates.

UsageReturns
ee.Algorithms.GeometryConstructors.MultiLineString(coordinates, crs, geodesic, maxError)Geometry
ArgumentTypeDetails
coordinatesList

The list of LineStrings, or to wrap a single LineString, the list of Points or pairs of Numbers in x,y order.

crsProjection, default: null

The coordinate reference system of the coordinates. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesicBoolean, default: null

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

maxErrorErrorMargin, default: null

Max error when input geometry must be reprojected to an explicitly requested result projection or geodesic state.

ee.Algorithms.GeometryConstructors.MultiPoint

Constructs a MultiPoint from the given coordinates.

UsageReturns
ee.Algorithms.GeometryConstructors.MultiPoint(coordinates, crs)Geometry
ArgumentTypeDetails
coordinatesList

The list of Points or pairs of Numbers in x,y order.

crsProjection, default: null

The coordinate reference system of the coordinates. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

ee.Algorithms.GeometryConstructors.MultiPolygon

Constructs a MultiPolygon from the given coordinates.

UsageReturns
ee.Algorithms.GeometryConstructors.MultiPolygon(coordinates, crs, geodesic, maxError, evenOdd)Geometry
ArgumentTypeDetails
coordinatesList

A list of Polygons, or for one simple polygon, a list of Points or pairs of Numbers in x,y order.

crsProjection, default: null

The coordinate reference system of the coordinates. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesicBoolean, default: null

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

maxErrorErrorMargin, default: null

Max error when input geometry must be reprojected to an explicitly requested result projection or geodesic state.

evenOddBoolean, default: true

If true, polygon interiors will be determined by the even/odd rule, where a point is inside if it crosses an odd number of edges to reach a point at infinity. Otherwise polygons use the left-inside rule, where interiors are on the left side of the shell's edges when walking the vertices in the given order.

ee.Algorithms.GeometryConstructors.Point

Constructs a new Point from the given x,y coordinates.

UsageReturns
ee.Algorithms.GeometryConstructors.Point(coordinates, crs)Geometry
ArgumentTypeDetails
coordinatesList

The coordinates of this Point in x,y order.

crsProjection, default: null

The coordinate reference system of the coordinates. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

ee.Algorithms.GeometryConstructors.Polygon

Constructs a Polygon from the given coordinates.

UsageReturns
ee.Algorithms.GeometryConstructors.Polygon(coordinates, crs, geodesic, maxError, evenOdd)Geometry
ArgumentTypeDetails
coordinatesList

A list of LinearRings where the first is the shell and the rest are holes, or for a simple polygon, a list of Points or pairs of Numbers in x,y order.

crsProjection, default: null

The coordinate reference system of the coordinates. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesicBoolean, default: null

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

maxErrorErrorMargin, default: null

Max error when input geometry must be reprojected to an explicitly requested result projection or geodesic state.

evenOddBoolean, default: true

If true, polygon interiors will be determined by the even/odd rule, where a point is inside if it crosses an odd number of edges to reach a point at infinity. Otherwise polygons use the left-inside rule, where interiors are on the left side of the shell's edges when walking the vertices in the given order.

ee.Algorithms.GeometryConstructors.Rectangle

Constructs a rectangular polygon from the given corner points.

UsageReturns
ee.Algorithms.GeometryConstructors.Rectangle(coordinates, crs, geodesic, evenOdd)Geometry
ArgumentTypeDetails
coordinatesList

The low and then high corners of the Rectangle, as a list of Points or pairs of Numbers in x,y order.

crsProjection, default: null

The coordinate reference system of the coordinates. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesicBoolean, default: null

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

evenOddBoolean, default: true

If true, polygon interiors will be determined by the even/odd rule, where a point is inside if it crosses an odd number of edges to reach a point at infinity. Otherwise polygons use the left-inside rule, where interiors are on the left side of the shell's edges when walking the vertices in the given order.

ee.Algorithms.HillShadow

Creates a shadow band, with output 1 where pixels are illumunated and 0 where they are shadowed. Takes as input an elevation band, azimuth and zenith of the light source in degrees, a neighborhood size, and whether or not to apply hysteresis when a shadow appears. Currently, this algorithm only works for Mercator projections, in which light rays are parallel.

UsageReturns
ee.Algorithms.HillShadow(image, azimuth, zenith, neighborhoodSize, hysteresis)Image
ArgumentTypeDetails
imageImage

The image to which to apply the shadow algorithm, in whicheach pixel should represent an elevation in meters.

azimuthFloat

Azimuth in degrees.

zenithFloat

Zenith in degrees.

neighborhoodSizeInteger, default: 0

Neighborhood size.

hysteresisBoolean, default: false

Use hysteresis. Less physically accurate, but may generate better images.

ee.Algorithms.HoughTransform

Applies the Hough transform to an image. For every input band, outputs a band where lines are detected by thresholding the Hough transform with a value of lineThreshold. The output band is named [input]_lines, where [input] is the name of the original band. The defaults provided for the parameters are intended as a starting point for use with UINT8 images.

UsageReturns
ee.Algorithms.HoughTransform(image, gridSize, inputThreshold, lineThreshold, smooth)Image
ArgumentTypeDetails
imageImage

The image to which to apply the transform.

gridSizeInteger, default: 256

Grid size.

inputThresholdFloat, default: 64

Value threshold for input image. Pixels equal to or above this value are considered active.

lineThresholdFloat, default: 72

Threshold for line detection. Values equal to or above this threshold on the Hough transform are considered to be detected lines.

smoothBoolean, default: true

Whether to smooth the Hough transform before line detection.

ee.Algorithms.If

Selects one of its inputs based on a condition, similar to an if-then-else construct.

UsageReturns
ee.Algorithms.If(condition, trueCase, falseCase)Object
ArgumentTypeDetails
conditionObject, default: null

The condition that determines which result is returned. If this is not a boolean, it is interpreted as a boolean by the following rules:

  - Numbers that are equal to 0 or a NaN are false.

  - Empty strings, lists and dictionaries are false.

  - Null is false.

  - Everything else is true.

trueCaseObject, default: null

The result to return if the condition is true.

falseCaseObject, default: null

The result to return if the condition is false.

ee.Algorithms.IsEqual

Returns whether two objects are equal.

UsageReturns
ee.Algorithms.IsEqual(left, right)Boolean
ArgumentTypeDetails
leftObject, default: null

rightObject, default: null

ee.Algorithms.Landsat.TOA

Calibrates Landsat DN to TOA reflectance and brightness temperature for Landsat and similar data. For recently-acquired scenes calibration coefficients are extracted from the image metadata; for older scenes the coefficients are derived from:

 Chander, Gyanesh, Brian L. Markham, and Dennis L. Helder. "Summary of current radiometric calibration coefficients for Landsat MSS, TM, ETM+, and EO-1 ALI sensors." Remote sensing of environment 113.5 (2009): 893-903.

UsageReturns
ee.Algorithms.Landsat.TOA(input)Image
ArgumentTypeDetails
inputImage

The Landsat image to process.

ee.Algorithms.Landsat.calibratedRadiance

Calibrates each band of an image by applying linear transformation with slope RADIANCE_MULT_BAND_N and y-intercept RADIANCE_ADD_BAND_N; these values are extracted from the image metadata.

UsageReturns
ee.Algorithms.Landsat.calibratedRadiance(image)Image
ArgumentTypeDetails
imageImage

The input Landsat image.

ee.Algorithms.Landsat.pathRowLimit

Limits requests to an ImageCollection of Landsat scenes to return a controllable number of the best scenes for each request. This is intended for use with statistical algorithms like median composites that need a certain amount of good data to perform well, but that do not benefit substantially from additional data beyond that while becoming needlessly expensive. The default arguments select approximately one year's worth of good data.

Note that in rare circumstances, when the tile boundary aligns with a Landsat WRS cell bounadry, queries for adjacent tiles may yield conflicting results. This is why it is important that this algorithm only be used with statistical methods that can tolerate these inconsistencies.

UsageReturns
ee.Algorithms.Landsat.pathRowLimit(collection, maxScenesPerPathRow, maxScenesTotal)ImageCollection
ArgumentTypeDetails
collectionImageCollection

The Landsat ImageCollection to limit.

maxScenesPerPathRowInteger, default: 25

The max number of scenes to return per path/row.

maxScenesTotalInteger, default: 100

The max number of scenes to return per request total.

ee.Algorithms.Landsat.simpleCloudScore

Computes a simple cloud-likelihood score in the range [0,100] using a combination of brightness, temperature, and NDSI. This is not a robust cloud detector, and is intended mainly to compare multiple looks at the same point for *relative* cloud likelihood.

UsageReturns
ee.Algorithms.Landsat.simpleCloudScore(image)Image
ArgumentTypeDetails
imageImage

The Landsat TOA image to process.

ee.Algorithms.Landsat.simpleComposite

Computes a Landsat TOA composite from a collection of raw Landsat scenes. It applies standard TOA calibration and then assigns a cloud score to each pixel using the SimpleLandsatCloudScore algorithm. It selects the lowest possible range of cloud scores at each point and then computes per-band percentile values from the accepted pixels. This algorithm also uses the LandsatPathRowLimit algorithm to select only the least-cloudy scenes in regions where more than maxDepth input scenes are available.

UsageReturns
ee.Algorithms.Landsat.simpleComposite(collection, percentile, cloudScoreRange, maxDepth, asFloat)Image
ArgumentTypeDetails
collectionImageCollection

The raw Landsat ImageCollection to composite.

percentileInteger, default: 50

The percentile value to use when compositing each band.

cloudScoreRangeInteger, default: 10

The size of the range of cloud scores to accept per pixel.

maxDepthInteger, default: 40

An approximate limit on the maximum number of scenes used to compute each pixel.

asFloatBoolean, default: false

If true, output bands are in the same units as the Landsat.TOA algorithm; if false, TOA values are converted to uint8 by multiplying by 255 (reflective bands) or subtracting 100 (thermal bands) and rounding to the nearest integer.

ee.Algorithms.ProjectionTransform

Transforms the geometry of a feature to a specific projection.

UsageReturns
ee.Algorithms.ProjectionTransform(feature, proj, maxError)Feature
ArgumentTypeDetails
featureElement

The feature the geometry of which is being converted.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Algorithms.String

Converts the input to a string.

UsageReturns
ee.Algorithms.String(input)String
ArgumentTypeDetails
inputObject

The object to convert.

ee.Algorithms.Terrain

Calculates slope, aspect, and a simple hillshade from a terrain DEM.

Expects an image containing either a single band of elevation, measured in meters, or if there's more than one band, one named 'elevation'. Adds output bands named 'slope' and 'aspect' measured in degrees plus an unsigned byte output band named 'hillshade' for visualization. All other bands and metadata are copied from the input image. The local gradient is computed using the 4-connected neighbors of each pixel, so missing values will occur around the edges of an image.

UsageReturns
ee.Algorithms.Terrain(input)Image
ArgumentTypeDetails
inputImage

An elevation image, in meters.

ee.Array

Returns an array with the given coordinates.

UsageReturns
ee.Array(values, pixelType)Array
ArgumentTypeDetails
valuesObject

An existing array to cast, or a number/list of numbers/nested list of numbers of any depth to create an array from. For nested lists, all inner arrays at the same depth must have the same length, and numbers may only be present at the deepest level.

pixelTypePixelType, default: null

The type of each number in the values argument. If the pixel type is not provided, it will be inferred from the numbers in 'values'. If there aren't any numbers in 'values', this type must be provided.

ee.Array.abs

On an element-wise basis, computes the absolute value of the input.

UsageReturns
Array.abs()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.accum

Accumulates elements of an array along the given axis, by setting each element of the result to the reduction of elements along that axis up to and including the current position. May be used to make a cumulative sum, a monotonically increasing sequence, etc.

UsageReturns
Array.accum(axis, reducer)Array
ArgumentTypeDetails
this: arrayArray

Array to accumulate.

axisInteger

Axis along which to perform the accumulation.

reducerReducer, default: null

Reducer to accumulate values. Default is SUM, to produce the cumulative sum of each vector along the given axis.

ee.Array.acos

On an element-wise basis, computes the arc cosine in radians of the input.

UsageReturns
Array.acos()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.add

On an element-wise basis, adds the first value to the second.

UsageReturns
Array.add(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.and

On an element-wise basis, returns 1 iff both values are non-zero.

UsageReturns
Array.and(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.asin

On an element-wise basis, computes the arc sine in radians of the input.

UsageReturns
Array.asin()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.atan

On an element-wise basis, computes the arc tangent in radians of the input.

UsageReturns
Array.atan()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.atan2

On an element-wise basis, calculates the angle formed by the 2D vector [x, y].

UsageReturns
Array.atan2(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.bitCount

On an element-wise basis, calculates the number of one-bits in the 64-bit two's complement binary representation of the input.

UsageReturns
Array.bitCount()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.bitsToArray

Convert the bits of an integer to an Array. The array has as many elements as the position of the highest set bit, or a single 0 for a value of 0.

UsageReturns
ee.Array.bitsToArray(input)Array
ArgumentTypeDetails
inputNumber

ee.Array.bitwiseAnd

On an element-wise basis, calculates the bitwise AND of the input values.

UsageReturns
Array.bitwiseAnd(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.bitwiseNot

On an element-wise basis, calculates the bitwise NOT of the input, in the smallest signed integer type that can hold the input.

UsageReturns
Array.bitwiseNot()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.bitwiseOr

On an element-wise basis, calculates the bitwise OR of the input values.

UsageReturns
Array.bitwiseOr(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.bitwiseXor

On an element-wise basis, calculates the bitwise XOR of the input values.

UsageReturns
Array.bitwiseXor(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.bitwise_and

On an element-wise basis, calculates the bitwise AND of the input values.

UsageReturns
Array.bitwise_and(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.bitwise_not

On an element-wise basis, calculates the bitwise NOT of the input, in the smallest signed integer type that can hold the input.

UsageReturns
Array.bitwise_not()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.bitwise_or

On an element-wise basis, calculates the bitwise OR of the input values.

UsageReturns
Array.bitwise_or(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.bitwise_xor

On an element-wise basis, calculates the bitwise XOR of the input values.

UsageReturns
Array.bitwise_xor(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.byte

On an element-wise basis, casts the input value to an unsigned 8-bit integer.

UsageReturns
Array.byte()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.cat

Concatenates multiple arrays into a single array along the given axis. Each array must have the same dimensionality and the same length on all axes except the concatenation axis.

UsageReturns
ee.Array.cat(arrays, axis)Array
ArgumentTypeDetails
arraysList

Arrays to concatenate.

axisInteger, default: 0

Axis to concatenate along.

ee.Array.cbrt

On an element-wise basis, computes the cubic root of the input.

UsageReturns
Array.cbrt()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.ceil

On an element-wise basis, computes the smallest integer greater than or equal to the input.

UsageReturns
Array.ceil()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.cos

On an element-wise basis, computes the cosine of the input in radians.

UsageReturns
Array.cos()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.cosh

On an element-wise basis, computes the hyperbolic cosine of the input.

UsageReturns
Array.cosh()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.cut

Cut an array along one or more axes.

UsageReturns
Array.cut(position)Array
ArgumentTypeDetails
this: arrayArray

The array to cut.

positionList

Cut an array along one or more axes. The positions args specifies either a single value for each axis of the array, or -1, indicating the whole axis. The output will be an array that has the same dimensions as the input, with a length of 1 on each axis that was not -1 in the positions array.

ee.Array.digamma

On an element-wise basis, computes the digamma function of the input.

UsageReturns
Array.digamma()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.divide

On an element-wise basis, divides the first value by the second, returning 0 for division by 0.

UsageReturns
Array.divide(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.dotProduct

Compute the dot product between two 1-D arrays.

UsageReturns
Array.dotProduct(array2)Number
ArgumentTypeDetails
this: array1Array

The first 1-D array.

array2Array

The second 1-D array.

ee.Array.double

On an element-wise basis, casts the input value to a 64-bit float.

UsageReturns
Array.double()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.eigen

Computes the real eigenvectors and eigenvalues of a square 2D array of A rows and A columns. Returns an array with A rows and A+1 columns, where each row contains an eigenvalue in the first column, and the corresponding eigenvector in the remaining A columns. The rows are sorted by eigenvalue, in descending order.

UsageReturns
Array.eigen()Array
ArgumentTypeDetails
this: inputArray

A square, 2D array from which to compute the eigenvalue decomposition.

ee.Array.eq

On an element-wise basis, returns 1 iff the first value is equal to the second.

UsageReturns
Array.eq(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.erf

On an element-wise basis, computes the error function of the input.

UsageReturns
Array.erf()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.erfInv

On an element-wise basis, computes the inverse error function of the input.

UsageReturns
Array.erfInv()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.erfc

On an element-wise basis, computes the complementary error function of the input.

UsageReturns
Array.erfc()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.erfcInv

On an element-wise basis, computes the inverse complementary error function of the input.

UsageReturns
Array.erfcInv()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.exp

On an element-wise basis, computes the Euler's number e raised to the power of the input.

UsageReturns
Array.exp()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.first

On an element-wise basis, selects the value of the first value.

UsageReturns
Array.first(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.firstNonZero

On an element-wise basis, selects the first value if it is non-zero, and the second value otherwise.

UsageReturns
Array.firstNonZero(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.first_nonzero

On an element-wise basis, selects the first value if it is non-zero, and the second value otherwise.

UsageReturns
Array.first_nonzero(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.float

On an element-wise basis, casts the input value to a 32-bit float.

UsageReturns
Array.float()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.floor

On an element-wise basis, computes the largest integer less than or equal to the input.

UsageReturns
Array.floor()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.gamma

On an element-wise basis, computes the gamma function of the input.

UsageReturns
Array.gamma()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.gammainc

On an element-wise basis, calculates the regularized lower incomplete Gamma function (γ(x,a).

UsageReturns
Array.gammainc(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.get

Extracts the value at the given position from the input array.

UsageReturns
Array.get(position)Number
ArgumentTypeDetails
this: arrayArray

The array to extract from.

positionList

The coordinates of the element to get.

ee.Array.gt

On an element-wise basis, returns 1 iff the first value is greater than the second.

UsageReturns
Array.gt(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.gte

On an element-wise basis, returns 1 iff the first value is greater than or equal to the second.

UsageReturns
Array.gte(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.hypot

On an element-wise basis, calculates the magnitude of the 2D vector [x, y].

UsageReturns
Array.hypot(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.identity

Creates a 2D identity matrix of the given size.

UsageReturns
ee.Array.identity(size)Array
ArgumentTypeDetails
sizeInteger

The length of each axis.

ee.Array.int

On an element-wise basis, casts the input value to a signed 32-bit integer.

UsageReturns
Array.int()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.int16

On an element-wise basis, casts the input value to a signed 16-bit integer.

UsageReturns
Array.int16()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.int32

On an element-wise basis, casts the input value to a signed 32-bit integer.

UsageReturns
Array.int32()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.int64

On an element-wise basis, casts the input value to a signed 64-bit integer.

UsageReturns
Array.int64()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.int8

On an element-wise basis, casts the input value to a signed 8-bit integer.

UsageReturns
Array.int8()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.lanczos

On an element-wise basis, computes the Lanczos approximation of the input.

UsageReturns
Array.lanczos()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.leftShift

On an element-wise basis, calculates the left shift of v1 by v2 bits.

UsageReturns
Array.leftShift(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.left_shift

On an element-wise basis, calculates the left shift of v1 by v2 bits.

UsageReturns
Array.left_shift(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.length

Returns a 1-D EEArray containing the length of each dimension of the given EEArray.

UsageReturns
Array.length()Array
ArgumentTypeDetails
this: arrayArray

The array from which to extract the axis lengths.

ee.Array.log

On an element-wise basis, computes the natural logarithm of the input.

UsageReturns
Array.log()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.log10

On an element-wise basis, computes the base-10 logarithm of the input.

UsageReturns
Array.log10()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.long

On an element-wise basis, casts the input value to a signed 64-bit integer.

UsageReturns
Array.long()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.lt

On an element-wise basis, returns 1 iff the first value is less than the second.

UsageReturns
Array.lt(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.lte

On an element-wise basis, returns 1 iff the first value is less than or equal to the second.

UsageReturns
Array.lte(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.mask

Creates a subarray by slicing out each position in an input array that is parallel to a non-zero element of the given mask array.

UsageReturns
Array.mask(mask)Array
ArgumentTypeDetails
this: inputArray

Array to mask.

maskArray

Mask array.

ee.Array.matrixCholeskyDecomposition

Calculates the Cholesky decomposition of a matrix. The Cholesky decomposition is a decomposition into the form L*L' where L is a lower triangular matrix. The input must be a symmetric positive-definite matrix. Returns a dictionary with 1 entry named 'L'.

UsageReturns
Array.matrixCholeskyDecomposition()Dictionary
ArgumentTypeDetails
this: arrayArray

The array to decompose.

ee.Array.matrixDeterminant

Computes the determinant of the matrix.

UsageReturns
Array.matrixDeterminant()Number
ArgumentTypeDetails
this: inputArray

The array to compute on.

ee.Array.matrixDiagonal

Computes the diagonal of the matrix in a single column.

UsageReturns
Array.matrixDiagonal()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.matrixFnorm

Computes the Frobenius norm of the matrix.

UsageReturns
Array.matrixFnorm()Number
ArgumentTypeDetails
this: inputArray

The array to compute on.

ee.Array.matrixInverse

Computes the inverse of the matrix.

UsageReturns
Array.matrixInverse()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.matrixLUDecomposition

Calculates the LU matrix decomposition such that P×input=L×U, where L is lower triangular (with unit diagonal terms), U is upper triangular and P is a partial pivot permutation matrix. The input matrix must be square. Returns a dictionary with entries named 'L', 'U' and 'P'.

UsageReturns
Array.matrixLUDecomposition()Dictionary
ArgumentTypeDetails
this: arrayArray

The array to decompose.

ee.Array.matrixMultiply

Returns the matrix multiplication A*B.

UsageReturns
Array.matrixMultiply(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.matrixPseudoInverse

Computes the Moore-Penrose pseudoinverse of the matrix.

UsageReturns
Array.matrixPseudoInverse()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.matrixQRDecomposition

Calculates the QR-decomposition of a matrix into two matrices Q and R such that input = QR, where Q is orthogonal, and R is upper triangular. Returns a dictionary with entries named 'Q' and 'R'.

UsageReturns
Array.matrixQRDecomposition()Dictionary
ArgumentTypeDetails
this: arrayArray

The array to decompose.

ee.Array.matrixSingularValueDecomposition

Calculates the Singular Value Decomposition of the input matrix into U×S×V', such that U and V are orthogonal and S is diagonal. Returns a dictionary with entries named 'U', 'S' and 'V'.

UsageReturns
Array.matrixSingularValueDecomposition()Dictionary
ArgumentTypeDetails
this: arrayArray

The array to decompose.

ee.Array.matrixSolve

Solves for x in the matrix equation A*x=B, finding a least-squares solution if A is overdetermined.

UsageReturns
Array.matrixSolve(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.matrixToDiag

Computes a square diagonal matrix from a single column matrix.

UsageReturns
Array.matrixToDiag()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.matrixTrace

Computes the trace of the matrix.

UsageReturns
Array.matrixTrace()Number
ArgumentTypeDetails
this: inputArray

The array to compute on.

ee.Array.matrixTranspose

Transposes two dimensions of an array.

UsageReturns
Array.matrixTranspose(axis1, axis2)Array
ArgumentTypeDetails
this: arrayArray

Array to transpose.

axis1Integer, default: 0

First axis to swap.

axis2Integer, default: 1

Second axis to swap.

ee.Array.max

On an element-wise basis, selects the maximum of the first and second values.

UsageReturns
Array.max(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.min

On an element-wise basis, selects the minimum of the first and second values.

UsageReturns
Array.min(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.mod

On an element-wise basis, calculates the remainder of the first value divided by the second.

UsageReturns
Array.mod(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.multiply

On an element-wise basis, multiplies the first value by the second.

UsageReturns
Array.multiply(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.neq

On an element-wise basis, returns 1 iff the first value is not equal to the second.

UsageReturns
Array.neq(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.not

On an element-wise basis, returns 0 if the input is non-zero, and 1 otherwise.

UsageReturns
Array.not()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.or

On an element-wise basis, returns 1 iff either input value is non-zero.

UsageReturns
Array.or(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.pow

On an element-wise basis, raises the first value to the power of the second.

UsageReturns
Array.pow(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.project

Projects an array to a lower dimensional space by specifying the axes to retain. Dropped axes must be at most length 1.

UsageReturns
Array.project(axes)Array
ArgumentTypeDetails
this: arrayArray

Array to project.

axesList

The axes to project onto. Other axes will be discarded, and must be at most length 1.

ee.Array.reduce

Apply a reducer to an array by collapsing all the input values along each specified axis into a single output value computed by the reducer.

UsageReturns
Array.reduce(reducer, axes, fieldAxis)Array
ArgumentTypeDetails
this: arrayArray

The array.

reducerReducer

The reducer to apply

axesList

The list of axes over which to reduce. The output will have a length of 1 in all these axes.

fieldAxisInteger, default: null

The axis for the reducer's input and output fields. Only required if the reducer has multiple inputs or outputs.

ee.Array.repeat

Repeats the array along the given axis. The result will have the shape of the input, except length along the repeated axis will be multiplied by the given number of copies.

UsageReturns
Array.repeat(axis, copies)Array
ArgumentTypeDetails
this: arrayArray

Array to repeat.

axisInteger, default: 0

The axis along which to repeat the array.

copiesInteger, default: 2

The number of copies of this array to concatenate along the given axis.

ee.Array.rightShift

On an element-wise basis, calculates the signed right shift of v1 by v2 bits.

UsageReturns
Array.rightShift(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.right_shift

On an element-wise basis, calculates the signed right shift of v1 by v2 bits.

UsageReturns
Array.right_shift(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.round

On an element-wise basis, computes the integer nearest to the input.

UsageReturns
Array.round()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.short

On an element-wise basis, casts the input value to a signed 16-bit integer.

UsageReturns
Array.short()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.sin

On an element-wise basis, computes the sine of the input in radians.

UsageReturns
Array.sin()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.sinh

On an element-wise basis, computes the hyperbolic sine of the input.

UsageReturns
Array.sinh()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.slice

Creates a subarray by slicing out each position along the given axis from the 'start' (inclusive) to 'end' (exclusive) by increments of 'step'. The result will have as many dimensions as the input, and the same length in all directions except the slicing axis, where the length will be the number of positions from 'start' to 'end' by 'step' that are in range of the input array's length along 'axis'. This means the result can be length 0 along the given axis if start=end, or if the start or end values are entirely out of range.

UsageReturns
Array.slice(axis, start, end, step)Array
ArgumentTypeDetails
this: arrayArray

Array to slice.

axisInteger, default: 0

The axis to slice on.

startInteger, default: 0

The coordinate of the first slice (inclusive) along 'axis'. Negative numbers are used to position the start of slicing relative to the end of the array, where -1 starts at the last position on the axis, -2 starts at the next to last position, etc.

endInteger, default: null

The coordinate (exclusive) at which to stop taking slices. By default this will be the length of the given axis. Negative numbers are used to position the end of slicing relative to the end of the array, where -1 will exclude the last position, -2 will exclude the last two positions, etc.

stepInteger, default: 1

The separation between slices along 'axis'; a slice will be taken at each whole multiple of 'step' from 'start' (inclusive) to 'end' (exclusive). Must be positive.

ee.Array.sort

Sorts elements of the array along one axis.

UsageReturns
Array.sort(keys)Array
ArgumentTypeDetails
this: arrayArray

Array image to sort.

keysArray, default: null

Optional keys to sort by. If not provided, the values are used as the keys. The keys can only have multiple elements along one axis, which determines the direction to sort in.

ee.Array.sqrt

On an element-wise basis, computes the square root of the input.

UsageReturns
Array.sqrt()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.subtract

On an element-wise basis, subtracts the second value from the first.

UsageReturns
Array.subtract(right)Array
ArgumentTypeDetails
this: leftArray

The left-hand value.

rightArray

The right-hand value.

ee.Array.tan

On an element-wise basis, computes the tangent of the input in radians.

UsageReturns
Array.tan()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.tanh

On an element-wise basis, computes the hyperbolic tangent of the input.

UsageReturns
Array.tanh()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toByte

On an element-wise basis, casts the input value to an unsigned 8-bit integer.

UsageReturns
Array.toByte()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toDouble

On an element-wise basis, casts the input value to a 64-bit float.

UsageReturns
Array.toDouble()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toFloat

On an element-wise basis, casts the input value to a 32-bit float.

UsageReturns
Array.toFloat()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toInt

On an element-wise basis, casts the input value to a signed 32-bit integer.

UsageReturns
Array.toInt()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toInt16

On an element-wise basis, casts the input value to a signed 16-bit integer.

UsageReturns
Array.toInt16()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toInt32

On an element-wise basis, casts the input value to a signed 32-bit integer.

UsageReturns
Array.toInt32()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toInt64

On an element-wise basis, casts the input value to a signed 64-bit integer.

UsageReturns
Array.toInt64()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toInt8

On an element-wise basis, casts the input value to a signed 8-bit integer.

UsageReturns
Array.toInt8()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toList

Turns an Array into a list of lists of numbers.

UsageReturns
Array.toList()List
ArgumentTypeDetails
this: arrayArray

Array to convert.

ee.Array.toLong

On an element-wise basis, casts the input value to a signed 64-bit integer.

UsageReturns
Array.toLong()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toShort

On an element-wise basis, casts the input value to a signed 16-bit integer.

UsageReturns
Array.toShort()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toUint16

On an element-wise basis, casts the input value to an unsigned 16-bit integer.

UsageReturns
Array.toUint16()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toUint32

On an element-wise basis, casts the input value to an unsigned 32-bit integer.

UsageReturns
Array.toUint32()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.toUint8

On an element-wise basis, casts the input value to an unsigned 8-bit integer.

UsageReturns
Array.toUint8()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.transpose

Transposes two dimensions of an array.

UsageReturns
Array.transpose(axis1, axis2)Array
ArgumentTypeDetails
this: arrayArray

Array to transpose.

axis1Integer, default: 0

First axis to swap.

axis2Integer, default: 1

Second axis to swap.

ee.Array.trigamma

On an element-wise basis, computes the trigamma function of the input.

UsageReturns
Array.trigamma()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.uint16

On an element-wise basis, casts the input value to an unsigned 16-bit integer.

UsageReturns
Array.uint16()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.uint32

On an element-wise basis, casts the input value to an unsigned 32-bit integer.

UsageReturns
Array.uint32()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Array.uint8

On an element-wise basis, casts the input value to an unsigned 8-bit integer.

UsageReturns
Array.uint8()Array
ArgumentTypeDetails
this: inputArray

The input array.

ee.Blob

Loads a Blob from a Google Cloud Storage URL.

UsageReturns
ee.Blob(url)Blob
ArgumentTypeDetails
urlString

The Blob's Google Cloud Storage URL.

ee.Blob.string

Returns the contents of the blob as a String.

UsageReturns
Blob.string(encoding)String
ArgumentTypeDetails
this: blobBlob

encodingString, default: null

ee.Blob.url

Returns the Blob's Google Cloud Storage URL.

UsageReturns
Blob.url()String
ArgumentTypeDetails
this: blobBlob

ee.Classifier.cart

Creates an empty CART classifier. See:

  "Classification and Regression Trees,"

  L. Breiman, J. Friedman, R. Olshen, C. Stone

  Chapman and Hall, 1984.

UsageReturns
ee.Classifier.cart(crossvalidationFactor, maxDepth, minLeafPopulation, minSplitPoplulation, minSplitCost, prune, pruneErrorTolerance, quantizationResolution, quantizationMargin, randomSeed)Classifier
ArgumentTypeDetails
crossvalidationFactorInteger, default: 10

The cross-validation factor for pruning.

maxDepthInteger, default: 10

Do not grow initial tree deeper than this many levels.

minLeafPopulationInteger, default: 1

Only create nodes whose training set contains at least this many points.

minSplitPoplulationInteger, default: 1

Do not split unless node has at least this many points.

minSplitCostFloat, default: 1e-10

Do not split if training set cost less than this.

pruneBoolean, default: false

Whether to skip pruning; i.e., only impose stopping criteria while growing the tree.

pruneErrorToleranceFloat, default: 0.5

The standard error threshold to use in determining the simplest tree whose accuracy is comparable to the minimum cost-complexity tree.

quantizationResolutionInteger, default: 100

The quantization resolution for numerical features.

quantizationMarginFloat, default: 0.1

The margin reserved by quantizer to avoid overload, as a fraction of the range observed in the training data.

randomSeedInteger, default: 0

The randomization seed.

ee.Classifier.confusionMatrix

Computes a 2D confusion matrix for a classifier based on its training data. Axis 1 (the rows) of the matrix correspond to the input classes, and Axis 0 (the columns) to the output classes.

UsageReturns
Classifier.confusionMatrix()ConfusionMatrix
ArgumentTypeDetails
this: classifierClassifier

The classifier to use.

ee.Classifier.continuousNaiveBayes

Creates an empty Continuous Naive Bayes classifier.

UsageReturns
ee.Classifier.continuousNaiveBayes(lambda)Classifier
ArgumentTypeDetails
lambdaFloat, default: 0.001

A smoothing lambda. Used to avoid assigning zero probability to classes not seen during training, instead using lambda / (lambda * nFeatures).

ee.Classifier.decisionTree

Creates a classifier that applies the given decision tree.

UsageReturns
ee.Classifier.decisionTree(treeString)Classifier
ArgumentTypeDetails
treeStringString

The decision tree, specified in the text format generated by R and other similar tools.

ee.Classifier.explain

Describe the results of a trained classifier.

UsageReturns
Classifier.explain()Dictionary
ArgumentTypeDetails
this: classifierClassifier

The classifier to describe.

ee.Classifier.gmoLinearRegression

Creates an empty linear regression. This regression supports L1 and L2 regularization as well as a smoothed L1 regularization using a logistic loss function. Note that the model used by this regression does not include a bias by default and a constant value should be included if a bias is required (it is suggested). This classifier only supports REGRESSION mode.

UsageReturns
ee.Classifier.gmoLinearRegression(weight1, weight2, epsilon, maxIterations, smooth)Classifier
ArgumentTypeDetails
weight1Float, default: 0

The weight for L1 regularization. Larger weight leads to heavier regularization.

weight2Float, default: 0

The weight for L2 regularization. Larger weight leads to heavier regularization.

epsilonFloat, default: 0.00001

The epsilon for stopping optimization.

maxIterationsInteger, default: 100

The maximum number of iterations.

smoothBoolean, default: false

Use a logistic loss function for the L1 regularization.

ee.Classifier.gmoMaxEnt

Creates an empty GMO Maximum Entropy classifier. See:

  "Efficient Large-Scale Distributed Training of Conditional Maximum Entropy Models,"

  G. Mann, R. McDonald, M. Mohri, N. Silberman, D. Walker.

UsageReturns
ee.Classifier.gmoMaxEnt(weight1, weight2, epsilon, minIterations, maxIterations)Classifier
ArgumentTypeDetails
weight1Float, default: 0

The weight for L1 regularization.

weight2Float, default: 0.00001

The weight for L2 regularization.

epsilonFloat, default: 0.00001

The epsilon for stopping optimization.

minIterationsInteger, default: 0

The minimum number of iterations of optimizer.

maxIterationsInteger, default: 100

The maximum number of iterations of optimizer.

ee.Classifier.ikpamir

Creates an IKPAMIR (Intersection Kernel Passive-Aggressive Method for Information Retrieval) classifier. See:

  "Classification using Intersection Kernel Support Vector Machinesis Efficient"

  S. Maji, A. Berg, J. Malik

UsageReturns
ee.Classifier.ikpamir(numBins, learningRate, epochs)Classifier
ArgumentTypeDetails
numBinsInteger, default: 10

The number of histogram bins per dimension.

learningRateFloat, default: 0.1

The rate of learning from each example.

epochsInteger, default: 5

The maximum number of epochs.

ee.Classifier.minimumDistance

Creates a minimum distance classifier for the given distance metric.

UsageReturns
ee.Classifier.minimumDistance(metric)Classifier
ArgumentTypeDetails
metricString, default: "euclidean"

The distance metric to use. Options are:

  'euclidean' - euclidean distance from the unnormalized class mean.

  'cosine' - spectral angle from the unnormalized class mean.

  'mahalanobis' - Mahalanobis distance from the class mean.

ee.Classifier.mode

Returns the classifier mode: CLASSIFICATION, REGRESSION or PROBABILITY.

UsageReturns
Classifier.mode()String
ArgumentTypeDetails
this: classifierClassifier

ee.Classifier.naiveBayes

Creates an empty Fast Naive Bayes classifier.

UsageReturns
ee.Classifier.naiveBayes(lambda)Classifier
ArgumentTypeDetails
lambdaFloat, default: 0.000001

A smoothing lambda. Used to avoid assigning zero probability to classes not seen during training, instead using lambda / (lambda * nFeatures).

ee.Classifier.pegasosGaussian

Creates an empty gaussian Pegasos classifier. See:

  "Pegasos (Primal Estimated sub-GrAdient SOlver for SVM)"

  S. Shalev-Shwartz, Y. Singer, N. Srebro, A. Cotter

UsageReturns
ee.Classifier.pegasosGaussian(rbfGamma, lossFunction, lambda, iterations, subsetSize, regularizationNorm, multiGamma)Classifier
ArgumentTypeDetails
rbfGammaFloat, default: 1

The gamma value of the Gaussian kernel.

lossFunctionString, default: "HingeSum"

The loss function to use. Valid values are: 'HingeSum', 'HingeMax', 'LogSum' and 'LogMax'

lambdaFloat, default: 0.001

The regularization parameter of SVM (λ).

iterationsInteger, default: 0

The number of iterations (T). When set to 0 (default), the number of training iterations is automatically set to 5 * training data size (~5 epochs).

subsetSizeInteger, default: 1

The subset size (k), i.e. the number of random samples to process on each iteration.

regularizationNormFloat, default: 1

The norm of w for regularization.

multiGammaFloat, default: 0.01

The gamma value for the loss function in multi-class classification.

ee.Classifier.pegasosLinear

Creates an empty linear Pegasos classifier. See:

  "Pegasos (Primal Estimated sub-GrAdient SOlver for SVM)"

  S. Shalev-Shwartz, Y. Singer, N. Srebro, A. Cotter

UsageReturns
ee.Classifier.pegasosLinear(useExponentiated, lossFunction, lambda, iterations, subsetSize, regularizationNorm, multiGamma)Classifier
ArgumentTypeDetails
useExponentiatedBoolean, default: false

Whether to use exponentiated update.

lossFunctionString, default: "HingeSum"

The loss function to use. Valid values are: 'HingeSum', 'HingeMax', 'LogSum' and 'LogMax'

lambdaFloat, default: 0.001

The regularization parameter of SVM (λ).

iterationsInteger, default: 0

The number of iterations (T). When set to 0 (default), the number of training iterations is automatically set to 5 * training data size (~5 epochs).

subsetSizeInteger, default: 1

The subset size (k), i.e. the number of random samples to process on each iteration.

regularizationNormFloat, default: 1

The norm of w for regularization.

multiGammaFloat, default: 0.01

The gamma value for the loss function in multi-class classification.

ee.Classifier.pegasosPolynomial

Creates an empty polynomial Pegasos classifier. See:

  "Pegasos (Primal Estimated sub-GrAdient SOlver for SVM)"

  S. Shalev-Shwartz, Y. Singer, N. Srebro, A. Cotter

UsageReturns
ee.Classifier.pegasosPolynomial(polyDegree, polyBias, lossFunction, lambda, iterations, subsetSize, regularizationNorm, multiGamma)Classifier
ArgumentTypeDetails
polyDegreeInteger, default: 3

The degree of the Polynomial kernel.

polyBiasFloat, default: 1

The bias of the Polynomial kernel.

lossFunctionString, default: "HingeSum"

The loss function to use. Valid values are: 'HingeSum', 'HingeMax', 'LogSum' and 'LogMax'

lambdaFloat, default: 0.001

The regularization parameter of SVM (λ).

iterationsInteger, default: 0

The number of iterations (T). When set to 0 (default), the number of training iterations is automatically set to 5 * training data size (~5 epochs).

subsetSizeInteger, default: 1

The subset size (k), i.e. the number of random samples to process on each iteration.

regularizationNormFloat, default: 1

The norm of w for regularization.

multiGammaFloat, default: 0.01

The gamma value for the loss function in multi-class classification.

ee.Classifier.perceptron

Creates an empty Perceptron classifier. See:

  "Practical Structured Learning Techniques for Natural Language Processing"

  H. Daume III, pp. 9-10

UsageReturns
ee.Classifier.perceptron(epochs, averaged)Classifier
ArgumentTypeDetails
epochsInteger, default: 10

The number of training epochs.

averagedBoolean, default: true

Whether to use an averaged perceptron.

ee.Classifier.randomForest

Creates an empty Rifle Serial classifier, which uses the Random Forest algorithm.

UsageReturns
ee.Classifier.randomForest(numberOfTrees, variablesPerSplit, minLeafPopulation, bagFraction, outOfBagMode, seed)Classifier
ArgumentTypeDetails
numberOfTreesInteger, default: 1

The number of Rifle decision trees to create per class.

variablesPerSplitInteger, default: 0

The number of variables per split. If set to 0 (default), defaults to the square root of the number of variables.

minLeafPopulationInteger, default: 1

The minimum size of a terminal node.

bagFractionFloat, default: 0.5

The fraction of input to bag per tree.

outOfBagModeBoolean, default: false

Whether the classifier should run in out-of-bag mode.

seedInteger, default: 0

Random seed.

ee.Classifier.schema

Returns the names of the inputs used by this classifier, or null if this classifier has not had any training data added yet.

UsageReturns
Classifier.schema()List
ArgumentTypeDetails
this: classifierClassifier

ee.Classifier.setOutputMode

Sets the output mode.

UsageReturns
Classifier.setOutputMode(mode)Classifier
ArgumentTypeDetails
this: classifierClassifier

An input classifier.

modeString

The output mode. One of:

  - CLASSIFICATION (default): The output is the class number.

  - REGRESSION: The output is the result of standard regression.

  - PROBABILITY: The output is the probability that the classification is correct.

Not all classifier types support REGRESSION and PROBABILITY modes.

ee.Classifier.spectralRegion

Creates a classifier that tests if its inputs lie within a polygon defined by a set of coordinates in an arbitrary 2D coordinate system. Each input to be classified must have 2 values (e.g.: images must have 2 bands). The result will be 1 wherever the input values are contained within the given polygon and 0 otherwise.

UsageReturns
ee.Classifier.spectralRegion(coordinates, schema)Classifier
ArgumentTypeDetails
coordinatesList

The coordinates of the polygon, as a list of rings. Each ring is a list of coordinate pairs (e.g.: [u1, v1, u2, v2, ..., uN, vN]). No edge may intersect any other edge. The resulting classification will be a 1 wherever the input values are within the interior of the given polygon, that is, an odd number of polygon edges must be crossed to get outside the polygon and 0 otherwise.

schemaList, default: null

The classifier's schema. A list of band or property names that the classifier will operate on. Since this classifier doesn't undergo a training step, these have to be specified manually. Defaults to ['u', 'v'].

ee.Classifier.svm

Creates a Support Vector Machine classifier.

UsageReturns
ee.Classifier.svm(decisionProcedure, svmType, kernelType, shrinking, degree, gamma, coef0, cost, nu, terminationEpsilon, lossEpsilon)Classifier
ArgumentTypeDetails
decisionProcedureString, default: "Voting"

The decision procedure to use. Either 'Voting' or 'Margin'.

svmTypeString, default: "C_SVC"

The SVM type. One of C_SVC, NU_SVC, ONE_CLASS, EPSILON_SVR or NU_SVR.

kernelTypeString, default: "LINEAR"

The kernel type. One of LINEAR (u′×v), POLY ((γ×u′×v + coef₀)ᵈᵉᵍʳᵉᵉ), RBF (exp(-γ×|u-v|²)) or SIGMOID (tanh(γ×u′×v + coef₀)).

shrinkingBoolean, default: true

Whether to use shrinking heuristics.

degreeInteger, default: null

The degree of polynomial. Valid for POLY kernels.

gammaFloat, default: null

The gamma value in the kernel function. Defaults to the reciprocal of the number of features. Valid for POLY, RBF and SIGMOID kernels.

coef0Float, default: null

The coef₀ value in the kernel function. Defaults to 0. Valid for POLY and SIGMOID kernels.

costFloat, default: null

The cost (C) parameter. Defaults to 1. Only valid for C-SVC, epsilon-SVR, and nu-SVR.

nuFloat, default: null

The nu parameter. Defaults to 0.5. Only valid for of nu-SVC, one-class SVM, and nu-SVR.

terminationEpsilonFloat, default: null

The termination criterion tolerance (e). Defaults to 0.001. Only valid for epsilon-SVR.

lossEpsilonFloat, default: null

The epsilon in the loss function (p). Defaults to 0.1. Only valid for epsilon-SVR.

ee.Classifier.train

Trains the classifier on a collection of features, using the specified numeric properties of each feature as training data. The geometry of the features is ignored.

UsageReturns
Classifier.train(features, classProperty, inputProperties, subsampling, subsamplingSeed)Classifier
ArgumentTypeDetails
this: classifierClassifier

An input classifier.

featuresFeatureCollection

The collection to train on.

classPropertyString

The name of the property containing the class value. Each feature must have this property, and its value must be numeric.

inputPropertiesList, default: null

The list of property names to include as training data. Each feature must have all these properties, and their values must be numeric. This argument is optional if the input collection contains a 'band_order' property, (as produced by Image.sample).

subsamplingFloat, default: 1

An optional subsampling factor, within (0, 1].

subsamplingSeedInteger, default: 0

A randomization seed to use for subsampling.

ee.Classifier.winnow

Creates an empty Winnow classifier. Uses an updating rule similar to the one described in:

  "Automatically categorizing written texts by author gender"

  M. Koppel, S. Argamon, A. Shimoni

  Literary and Linguistic Computing 17(4), November 2002, pp. 401-412.

UsageReturns
ee.Classifier.winnow(epochs, learningRate, biasLearningRate, margin)Classifier
ArgumentTypeDetails
epochsInteger, default: 5

The number of training epochs.

learningRateFloat, default: 0.1

The learning rate.

biasLearningRateFloat, default: 0.1

The learning rate for updating bias weights.

marginFloat, default: 0.2

The "wide-margin" (or "thick"-separator) size. If this is nonzero, the classifier updates the weights even when it just barely got the answer right. See "Mistake-Driven Learning in Text Categorization" by I. Dagan, Y. Karov, and D. Roth.

ee.Clusterer.schema

Returns the names of the inputs used by this Clusterer, or null if this Clusterer has not had any training data added yet.

UsageReturns
Clusterer.schema()List
ArgumentTypeDetails
this: clustererClusterer

ee.Clusterer.train

Trains the Clusterer on a collection of features, using the specified numeric properties of each feature as training data. The geometry of the features is ignored.

UsageReturns
Clusterer.train(features, inputProperties, subsampling, subsamplingSeed)Clusterer
ArgumentTypeDetails
this: clustererClusterer

An input Clusterer.

featuresFeatureCollection

The collection to train on.

inputPropertiesList, default: null

The list of property names to include as training data. Each feature must have all these properties, and their values must be numeric. This argument is optional if the input collection contains a 'band_order' property, (as produced by Image.sample).

subsamplingFloat, default: 1

An optional subsampling factor, within (0, 1].

subsamplingSeedInteger, default: 0

A randomization seed to use for subsampling.

ee.Clusterer.wekaCascadeKMeans

Cascade simple k-means, selects the best k according to calinski-harabasz criterion. For more information see:

Calinski, T. and J. Harabasz. 1974. A dendrite method for cluster analysis. Commun. Stat. 3: 1-27.

UsageReturns
ee.Clusterer.wekaCascadeKMeans(minClusters, maxClusters, restarts, manual, init, distanceFunction, maxIterations)Clusterer
ArgumentTypeDetails
minClustersInteger, default: 2

Min number of clusters.

maxClustersInteger, default: 10

Max number of clusters.

restartsInteger, default: 10

Number of restarts.

manualBoolean, default: false

Manually select the number of clusters.

initBoolean, default: false

Set whether to initialize using the probabilistic farthest first like method of the k-means++ algorithm (rather than the standard random selection of initial cluster centers).

distanceFunctionString, default: "Euclidean"

Distance function to use. Options are: Euclidean & Manhattan

maxIterationsInteger, default: null

Maximum number of iterations for k-means.

ee.Clusterer.wekaCobweb

Implementation of the Cobweb clustering algorithm. For more information see:

D. Fisher (1987). Knowledge acquisition via incremental conceptual clustering. Machine Learning. 2(2):139-172. and J. H. Gennari, P. Langley, D. Fisher (1990). Models of incremental concept formation. Artificial Intelligence. 40:11-61.

UsageReturns
ee.Clusterer.wekaCobweb(acuity, cutoff, seed)Clusterer
ArgumentTypeDetails
acuityFloat, default: 1

Acuity (minimum standard deviation).

cutoffFloat, default: 0.002

Cutoff (minimum category utility).

seedInteger, default: 42

Random number seed.

ee.Clusterer.wekaKMeans

Cluster data using the k means algorithm. Can use either the Euclidean distance (default) or the Manhattan distance. If the Manhattan distance is used, then centroids are computed as the component-wise median rather than mean. For more information see:

D. Arthur, S. Vassilvitskii: k-means++: the advantages of carefull seeding. In: Proceedings of the eighteenth annual ACM-SIAM symposium on Discrete algorithms, 1027-1035, 2007.

UsageReturns
ee.Clusterer.wekaKMeans(nClusters, init, canopies, maxCandidates, periodicPruning, minDensity, t1, t2, distanceFunction, maxIterations, preserveOrder, fast, seed)Clusterer
ArgumentTypeDetails
nClustersInteger

Number of clusters.

initInteger, default: 0

Initialization method to use.0 = random, 1 = k-means++, 2 = canopy, 3 = farthest first.

canopiesBoolean, default: false

Use canopies to reduce the number of distance calculations.

maxCandidatesInteger, default: 100

Maximum number of candidate canopies to retain in memory at any one time when using canopy clustering. T2 distance plus, data characteristics, will determine how many candidate canopies are formed before periodic and final pruning are performed, which might result in exceess memory consumption. This setting avoids large numbers of candidate canopies consuming memory.

periodicPruningInteger, default: 10000

How often to prune low density canopies when using canopy clustering.

minDensityInteger, default: 2

Minimum canopy density, when using canopy clustering, below which a canopy will be pruned during periodic pruning.

t1Float, default: -1.5

The T1 distance to use when using canopy clustering. A value < 0 is taken as a positive multiplier for T2.

t2Float, default: -1

The T2 distance to use when using canopy clustering. Values < 0 cause a heuristic based on attribute std. deviation to be used.

distanceFunctionString, default: "Euclidean"

Distance function to use. Options are: Euclidean & Manhattan

maxIterationsInteger, default: null

Maximum number of iterations.

preserveOrderBoolean, default: false

Preserve order of instances.

fastBoolean, default: false

Enables faster distance calculations, using cut-off values. Disables the calculation/output of squared errors/distances

seedInteger, default: 10

The randomization seed.

ee.Clusterer.wekaLVQ

A Clusterer that implements the Learning Vector Quantization algorithm. For more details, see:

T. Kohonen, "Learning Vector Quantization", The Handbook of Brain Theory and Neural Networks, 2nd Edition, MIT Press, 2003, pp. 631-634.

UsageReturns
ee.Clusterer.wekaLVQ(numClusters, learningRate, epochs, normalizeInput)Clusterer
ArgumentTypeDetails
numClustersInteger, default: 7

The number of clusters.

learningRateFloat, default: 1

The learning rate for the training algorithm. (Value should be greaterthan 0 and less or equal to 1).

epochsInteger, default: 1000

Number of training epochs. (Value should be greater than or equal to 1).

normalizeInputBoolean, default: false

Skip normalizing the attributes.

ee.Clusterer.wekaXMeans

X-Means is K-Means with an efficient estimation of the number of clusters. For more information see:

Dan Pelleg, Andrew W. Moore: X-means: Extending K-means with Efficient Estimation of the Number of Clusters. In: Seventeenth International Conference on Machine Learning, 727-734, 2000.

UsageReturns
ee.Clusterer.wekaXMeans(minClusters, maxClusters, maxIterations, maxKMeans, maxForChildren, useKD, cutoffFactor, distanceFunction, seed)Clusterer
ArgumentTypeDetails
minClustersInteger, default: 2

Minimum number of clusters.

maxClustersInteger, default: 8

Maximum number of clusters.

maxIterationsInteger, default: 3

Maximum number of overall iterations.

maxKMeansInteger, default: 1000

The maximum number of iterations to perform in KMeans.

maxForChildrenInteger, default: 1000

The maximum number of iterations in KMeans that is performed on the child centers.

useKDBoolean, default: false

Use a KDTree.

cutoffFactorFloat, default: 0

Takes the given percentage of the splitted centroids if none of the children win.

distanceFunctionString, default: "Euclidean"

Distance function to use. Options are: Chebyshev, Euclidean & Manhattan.

seedInteger, default: 10

The randomization seed.

ee.ConfusionMatrix

Creates a confusion matrix. Axis 1 (the rows) of the matrix correspond to the actual values, and Axis 0 (the columns) to the predicted values.

UsageReturns
ee.ConfusionMatrix(array, order)ConfusionMatrix
ArgumentTypeDetails
arrayObject

A square, 2D array of integers, representing the confusion matrix.

orderList, default: null

The row and column size and order, for non-contiguous or non-zero based matrices.

ee.ConfusionMatrix.accuracy

Computes the overall accuracy of a confusion matrix defined as correct / total.

UsageReturns
ConfusionMatrix.accuracy()Float
ArgumentTypeDetails
this: confusionMatrixConfusionMatrix

ee.ConfusionMatrix.array

Returns a confusion matrix as an Array.

UsageReturns
ConfusionMatrix.array()Array
ArgumentTypeDetails
this: confusionMatrixConfusionMatrix

ee.ConfusionMatrix.consumersAccuracy

Computes the consumer's accuracy (reliability) of a confusion matrix defined as (correct / total) for each row.

UsageReturns
ConfusionMatrix.consumersAccuracy()Array
ArgumentTypeDetails
this: confusionMatrixConfusionMatrix

ee.ConfusionMatrix.kappa

Computes the Kappa statistic for the confusion matrix.

UsageReturns
ConfusionMatrix.kappa()Float
ArgumentTypeDetails
this: confusionMatrixConfusionMatrix

ee.ConfusionMatrix.order

Returns the name and order of the rows and columns of the matrix.

UsageReturns
ConfusionMatrix.order()List
ArgumentTypeDetails
this: confusionMatrixConfusionMatrix

ee.ConfusionMatrix.producersAccuracy

Computes the producer's accuracy of a confusion matrix defined as (correct / total) for each column.

UsageReturns
ConfusionMatrix.producersAccuracy()Array
ArgumentTypeDetails
this: confusionMatrixConfusionMatrix

ee.Date

Constructs a new Date object.

UsageReturns
ee.Date(date, tz)Date
ArgumentTypeDetails
dateComputedObject|Date|Number|String

The date to convert, one of: a number (number of milliseconds since the epoch), an ISO Date string, a JavaScript Date or a ComputedObject.

tzString, optional

An optional timezone only to be used with a string date.

ee.Date.advance

Create a new Date by adding the specified units to the given Date.

UsageReturns
Date.advance(delta, unit, timeZone)Date
ArgumentTypeDetails
this: dateDate

deltaFloat

unitString

One of 'year', 'month' 'week', 'day', 'hour', 'minute', or 'second'.

timeZoneString, default: null

The time zone (e.g. 'America/Los_Angeles'); defaults to UTC.

ee.Date.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
Date.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Date.difference

Returns the difference between two Dates in the specified units; the result is floating-point and based on the average length of the unit.

UsageReturns
Date.difference(start, unit)Float
ArgumentTypeDetails
this: dateDate

startDate

unitString

One of 'year', 'month' 'week', 'day', 'hour', 'minute', or 'second'.

ee.Date.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
Date.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Date.format

Convert a date to string.

UsageReturns
Date.format(format, timeZone)String
ArgumentTypeDetails
this: dateDate

formatString, default: null

A pattern, as described at http://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html; if omitted will use ISO standard date formatting.

timeZoneString, default: null

The time zone (e.g. 'America/Los_Angeles'); defaults to UTC.

ee.Date.fromYMD

Returns a Date given year, month, day.

UsageReturns
ee.Date.fromYMD(year, month, day, timeZone)Date
ArgumentTypeDetails
yearInteger

monthInteger

dayInteger

timeZoneString, default: null

The time zone (e.g. 'America/Los_Angeles'); defaults to UTC.

ee.Date.get

Returns the specified unit of this date.

UsageReturns
Date.get(unit, timeZone)Long
ArgumentTypeDetails
this: dateDate

unitString

One of 'year', 'month' (returns 1-12), 'week' (1-53), 'day' (1-31), 'hour' (0-23), 'minute' (0-59), or 'second' (0-59).

timeZoneString, default: null

The time zone (e.g. 'America/Los_Angeles'); defaults to UTC.

ee.Date.getFraction

Returns this date's elapsed fraction of the specified unit (between 0 and 1).

UsageReturns
Date.getFraction(unit, timeZone)Float
ArgumentTypeDetails
this: dateDate

unitString

One of 'year', 'month' 'week', 'day', 'hour', 'minute', or 'second'.

timeZoneString, default: null

The time zone (e.g. 'America/Los_Angeles'); defaults to UTC.

ee.Date.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
Date.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Date.getRange

Returns a DateRange covering the unit of the specified type that contains this date, e.g. Date('2013-3-15').getRange('year') returns DateRange('2013-1-1', '2014-1-1').

UsageReturns
Date.getRange(unit, timeZone)DateRange
ArgumentTypeDetails
this: dateDate

unitString

One of 'year', 'month' 'week', 'day', 'hour', 'minute', or 'second'.

timeZoneString, default: null

The time zone (e.g. 'America/Los_Angeles'); defaults to UTC.

ee.Date.getRelative

Returns the specified (0-based) unit of this date relative to a larger unit, e.g. getRelative('day', 'year') returns a value between 0 and 365.

UsageReturns
Date.getRelative(unit, inUnit, timeZone)Long
ArgumentTypeDetails
this: dateDate

unitString

One of 'month' 'week', 'day', 'hour', 'minute', or 'second'.

inUnitString

One of 'year', 'month' 'week', 'day', 'hour', or 'minute'.

timeZoneString, default: null

The time zone (e.g. 'America/Los_Angeles'); defaults to UTC.

ee.Date.millis

The number of milliseconds since 1970-01-01T00:00:00Z.

UsageReturns
Date.millis()Long
ArgumentTypeDetails
this: dateDate

ee.Date.parse

Parse a date string, given a string describing its format.

UsageReturns
ee.Date.parse(format, date, timeZone)Date
ArgumentTypeDetails
formatString

A pattern, as described at http://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html.

dateString

A string matching the given pattern.

timeZoneString, default: null

The time zone (e.g. 'America/Los_Angeles'); defaults to UTC.

ee.Date.serialize

Returns the serialized representation of this object.

UsageReturns
Date.serialize()String
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

ee.Date.unitRatio

Returns the ratio of the length of one unit to the length of another, e.g. unitRatio('day', 'minute') returns 1440. Valid units are 'year', 'month' 'week', 'day', 'hour', 'minute', and 'second'.

UsageReturns
ee.Date.unitRatio(numerator, denominator)Float
ArgumentTypeDetails
numeratorString

denominatorString

ee.Date.update

Create a new Date by setting one or more of the units of the given Date to a new value. If a timeZone is given the new value(s) is interpreted in that zone.

UsageReturns
Date.update(year, month, day, hour, minute, second, timeZone)Date
ArgumentTypeDetails
this: dateDate

yearInteger, default: null

monthInteger, default: null

dayInteger, default: null

hourInteger, default: null

minuteInteger, default: null

secondInteger, default: null

timeZoneString, default: null

The time zone (e.g. 'America/Los_Angeles'); defaults to UTC.

ee.DateRange

Creates a DateRange with the given start (inclusive) and end (exclusive), which may be Dates, numbers (interpreted as milliseconds since 1970-01-01T00:00:00Z), or strings (such as '1996-01-01T08:00'). If 'end' is not specified, a 1-millisecond range starting at 'start' is created.

UsageReturns
ee.DateRange(start, end, timeZone)DateRange
ArgumentTypeDetails
startObject

endObject, default: null

timeZoneString, default: null

If start and/or end are provided as strings, the time zone in which to interpret them; defaults to UTC.

ee.DateRange.contains

Returns true if the given Date or DateRange is within this DateRange.

UsageReturns
DateRange.contains(other)Boolean
ArgumentTypeDetails
this: dateRangeDateRange

otherObject

ee.DateRange.end

Returns the (exclusive) end of this DateRange.

UsageReturns
DateRange.end()Date
ArgumentTypeDetails
this: dateRangeDateRange

ee.DateRange.intersection

Returns a DateRange that contains all points in the intersection of this DateRange and another.

UsageReturns
DateRange.intersection(other)DateRange
ArgumentTypeDetails
this: dateRangeDateRange

otherDateRange

ee.DateRange.intersects

Returns true if the given DateRange has at least one point in common with this DateRange.

UsageReturns
DateRange.intersects(other)Boolean
ArgumentTypeDetails
this: dateRangeDateRange

otherDateRange

ee.DateRange.isEmpty

Returns true if this DateRange contains no dates (i.e. start >= end).

UsageReturns
DateRange.isEmpty()Boolean
ArgumentTypeDetails
this: dateRangeDateRange

ee.DateRange.isUnbounded

Returns true if this DateRange contains all dates.

UsageReturns
DateRange.isUnbounded()Boolean
ArgumentTypeDetails
this: dateRangeDateRange

ee.DateRange.start

Returns the (inclusive) start of this DateRange.

UsageReturns
DateRange.start()Date
ArgumentTypeDetails
this: dateRangeDateRange

ee.DateRange.unbounded

Returns a DateRange that includes all possible dates.

UsageReturns
ee.DateRange.unbounded()DateRange

No arguments.

ee.DateRange.union

Returns a DateRange that contains all points in the union of this DateRange and another.

UsageReturns
DateRange.union(other)DateRange
ArgumentTypeDetails
this: dateRangeDateRange

otherDateRange

ee.Dictionary

Constructs a new Dictionary.

UsageReturns
ee.Dictionary(dict)Dictionary
ArgumentTypeDetails
dictComputedObject|Object, optional

An object to convert to a dictionary. This constructor accepts the following types: 1) Another dictionary. 2) A list of key/value pairs. 3) A null or no argument (producing an empty dictionary)

ee.Dictionary.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
Dictionary.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Dictionary.combine

Combines two dictionaries. In the case of duplicate names, the output will contain the value of the second dictionary unless overwrite is false. Null values in both dictionaries are ignored / removed.

UsageReturns
Dictionary.combine(second, overwrite)Dictionary
ArgumentTypeDetails
this: firstDictionary

secondDictionary

overwriteBoolean, default: true

ee.Dictionary.contains

Returns true if the dictionary contains the given key.

UsageReturns
Dictionary.contains(key)Boolean
ArgumentTypeDetails
this: dictionaryDictionary

keyString, default: null

ee.Dictionary.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
Dictionary.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Dictionary.fromLists

Construct a dictionary from two parallel lists of keys and values.

UsageReturns
ee.Dictionary.fromLists(keys, values)Dictionary
ArgumentTypeDetails
keysList

valuesList

ee.Dictionary.get

Extracts a named value from a dictionary.

UsageReturns
Dictionary.get(key)Object
ArgumentTypeDetails
this: dictionaryDictionary

keyString

ee.Dictionary.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
Dictionary.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Dictionary.keys

Retrieve the keys of a dictionary as a list. The keys will be sorted in natural order.

UsageReturns
Dictionary.keys()List
ArgumentTypeDetails
this: dictionaryDictionary

ee.Dictionary.map

Map an algorithm over a dictionary. The algorithm is expected to take 2 arguments, a key from the existing dictionary and the value it corresponds to, and return a new value for the given key. If the algorithm returns null, the key is dropped.

UsageReturns
Dictionary.map(baseAlgorithm)Dictionary
ArgumentTypeDetails
this: dictionaryDictionary

baseAlgorithmAlgorithm

ee.Dictionary.remove

Returns a dictionary with the specified keys removed.

UsageReturns
Dictionary.remove(selectors, ignoreMissing)Dictionary
ArgumentTypeDetails
this: dictionaryDictionary

selectorsList

A list of keys names or regular expressions of key names to remove.

ignoreMissingBoolean, default: false

Ignore selectors that don't match at least 1 key.

ee.Dictionary.rename

Rename elements in a dictionary.

UsageReturns
Dictionary.rename(from, to, overwrite)Dictionary
ArgumentTypeDetails
this: dictionaryDictionary

fromList

A list of keys to be renamed.

toList

A list of the new names for the keys listed in the 'from' parameter. Must have the same length as the 'from' list.

overwriteBoolean, default: false

Allow overwriting existing properties with the same name.

ee.Dictionary.select

Returns a dictionary with only the specified keys.

UsageReturns
Dictionary.select(selectors, ignoreMissing)Dictionary
ArgumentTypeDetails
this: dictionaryDictionary

selectorsList

A list of keys or regular expressions to select.

ignoreMissingBoolean, default: false

Ignore selectors that don't match at least 1 key.

ee.Dictionary.serialize

Returns the serialized representation of this object.

UsageReturns
Dictionary.serialize()String
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

ee.Dictionary.set

Set a value in a dictionary.

UsageReturns
Dictionary.set(key, value)Object
ArgumentTypeDetails
this: dictionaryDictionary

keyString

valueObject

ee.Dictionary.size

Returns the number of entries in a dictionary.

UsageReturns
Dictionary.size()Integer
ArgumentTypeDetails
this: dictionaryDictionary

ee.Dictionary.toArray

Returns numeric values of a dictionary as an array. If no keys are specified, all values are returned in the natural ordering of the dictionary's keys. The default 'axis' is 0.

UsageReturns
Dictionary.toArray(keys, axis)Array
ArgumentTypeDetails
this: dictionaryDictionary

keysList, default: null

axisInteger, default: 0

ee.Dictionary.toImage

Creates an image of constants from values in a dictionary. The bands of the image are ordered and named according to the names argument. If no names are specified, the bands are sorted alpha-numerically.

UsageReturns
Dictionary.toImage(names)Image
ArgumentTypeDetails
this: dictionaryDictionary

The dictionary to convert.

namesList, default: null

The order of the output bands.

ee.Dictionary.values

Returns the values of a dictionary as a list. If no keys are specified, all values are returned in the natural ordering of the dictionary's keys.

UsageReturns
Dictionary.values(keys)List
ArgumentTypeDetails
this: dictionaryDictionary

keysList, default: null

ee.ErrorMargin

Returns an ErrorMargin of the given type with the given value.

UsageReturns
ee.ErrorMargin(value, unit)ErrorMargin
ArgumentTypeDetails
valueFloat, default: null

The maximum error value allowed by the margin. Ignored if the unit is 'infinite'.

unitString, default: "meters"

The unit of this margin: 'meters', 'projected' or 'infinite'.

ee.Feature

Features can be constructed from one of the following arguments plus an optional dictionary of properties:

  - An ee.Geometry.

  - A GeoJSON Geometry.

  - A GeoJSON Feature.

  - A computed object: reinterpreted as a geometry if properties are specified, and as a feature if they aren't.

UsageReturns
ee.Feature(geometry, properties)Feature
ArgumentTypeDetails
geometryComputedObject|Feature|Geometry|Object

A geometry or feature.

propertiesObject, optional

A dictionary of metadata properties. If the first parameter is a Feature (instead of a geometry), this is unused.

ee.Feature.area

Returns the area of the feature's default geometry. Area of points and line strings is 0, and the area of multi geometries is the sum of the areas of their componenets (intersecting areas are counted multiple times).

UsageReturns
Feature.area(maxError, proj)Float
ArgumentTypeDetails
this: featureElement

The feature from which the geometry is taken.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

ee.Feature.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
Feature.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Feature.bounds

Returns a feature containing the bounding box of the geometry of a given feature.

UsageReturns
Feature.bounds(maxError, proj)Feature
ArgumentTypeDetails
this: featureElement

The feature the bound of which is being calculated.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Feature.buffer

Returns the input buffered by a given distance. If the distance is positive, the geometry is expanded, and if the distance is negative, the geometry is contracted.

UsageReturns
Feature.buffer(distance, maxError, proj)Feature
ArgumentTypeDetails
this: featureElement

The feature the geometry of which is being buffered.

distanceFloat

The distance of the buffering, which may be negative. If no projection is specified, the unit is meters. Otherwise the unit is in the coordinate system of the projection.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when approximating the buffering circle and performing any necessary reprojection. If unspecified, defaults to 1% of the distance.

projProjection, default: null

If specified, the buffering will be performed in this projection and the distance will be interpreted as units of the coordinate system of this projection. Otherwise the distance is interpereted as meters and the buffering is performed in a spherical coordinate system.

ee.Feature.centroid

Returns a feature containing the point at the center of the highest-dimension components of the geometry of a feature. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.

UsageReturns
Feature.centroid(maxError, proj)Feature
ArgumentTypeDetails
this: featureElement

Calculates the centroid of this feature's default geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Feature.containedIn

Returns true iff the geometry of one feature is contained in the geometry of another.

UsageReturns
Feature.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftElement

The feature containing the geometry used as the left operand of the operation.

rightElement

The feature containing the geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Feature.contains

Returns true iff the geometry of one feature contains the geometry of another.

UsageReturns
Feature.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftElement

The feature containing the geometry used as the left operand of the operation.

rightElement

The feature containing the geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Feature.convexHull

Returns the feature, with the geometry replaced by the convex hull of the original geometry. The convex hull of a single point is the point itself, the convex hull of collinear points is a line, and the convex hull of everything else is a polygon. Note that a degenerate polygon with all vertices on the same line will result in a line segment.

UsageReturns
Feature.convexHull(maxError, proj)Feature
ArgumentTypeDetails
this: featureElement

The feature containing the geometry whole hull is being calculated.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Feature.copyProperties

Copies metadata properties from one element to another.

UsageReturns
Feature.copyProperties(source, properties, exclude)Element
ArgumentTypeDetails
this: destinationElement, default: null

The object whose properties to override.

sourceElement, default: null

The object from which to copy the properties.

propertiesList, default: null

The properties to copy. If omitted, all ordinary (i.e. non-system) properties are copied.

excludeList, default: null

The list of properties to exclude when copying all properties. Must not be specified if properties is.

ee.Feature.cutLines

Converts LineStrings into a MultiLineString by cutting it in two at each distance along the length of the LineString.

UsageReturns
Feature.cutLines(distances, maxError, proj)Feature
ArgumentTypeDetails
this: featureElement

Cuts the lines of this feature's default geometry.

distancesList

Distances along each LineString to cut the line into separate pieces, measured in units of the given proj, or meters if proj is unspecified.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

Projection of the result and distance measurements, or WGS84 if unspecified.

ee.Feature.difference

Returns a feature with the properties of the 'left' feature, and the geometry that results from subtracting the 'right' geometry from the 'left' geometry.

UsageReturns
Feature.difference(right, maxError, proj)Feature
ArgumentTypeDetails
this: leftElement

The feature containing the geometry used as the left operand of the operation. The properties of the result will be copied from this object.

rightElement

The feature containing the geometry used as the right operand of the operation. The properties of this object are ignored.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Feature.disjoint

Returns true iff the feature geometries are disjoint.

UsageReturns
Feature.disjoint(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftElement

The feature containing the geometry used as the left operand of the operation.

rightElement

The feature containing the geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Feature.dissolve

Returns a feature containing the union the geometry of a feature. This leaves single geometries untouched, and unions multi geometries.

UsageReturns
Feature.dissolve(maxError, proj)Element
ArgumentTypeDetails
this: featureElement

The feature the geometry of which is being unioned.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the union will be performed in this projection. Otherwise it will be performed in a spherical coordinate system.

ee.Feature.distance

Returns the minimum distance between the geometries of two features.

UsageReturns
Feature.distance(right, maxError, proj)Float
ArgumentTypeDetails
this: leftElement

The feature containing the geometry used as the left operand of the operation.

rightElement

The feature containing the geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Feature.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
Feature.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Feature.get

Extract a property from a feature.

UsageReturns
Feature.get(property)
ArgumentTypeDetails
this: objectElement

The feature to extract the property from.

propertyString

The property to extract.

ee.Feature.getInfo

An imperative function that returns information about this feature via an AJAX call.

Returns a description of the feature.

UsageReturns
Feature.getInfo(callback)GeoJSONFeature
ArgumentTypeDetails
this: featureFeature

The Feature instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously. If supplied, will be called with the first parameter if successful and the second if unsuccessful.

ee.Feature.getMap

An imperative function that returns a map ID and token, suitable for generating a Map overlay.

Returns an object containing a mapid string, an access token plus a Collection.draw image wrapping a FeatureCollection containing this feature. Or undefined if a callback is provided.

UsageReturns
Feature.getMap(visParams, callback)MapId|Object
ArgumentTypeDetails
this: featureFeature

The Feature instance.

visParamsObject, optional

The visualization parameters. Currently only one parameter, 'color', containing an RGB color string is user. If vis_params is null, black ("000000") is used.

callbackFunction, optional

An async callback.

ee.Feature.id

Returns the ID of a given element within a collection. Objects outside collections are not guaranteed to have IDs.

UsageReturns
Feature.id()String
ArgumentTypeDetails
this: elementElement

The element from which the ID is taken.

ee.Feature.intersection

Returns a feature containing the intersection of the geometries of two features, with the properties of the left feature.

UsageReturns
Feature.intersection(right, maxError, proj)Feature
ArgumentTypeDetails
this: leftElement

The feature containing the geometry used as the left operand of the operation. The properties of the result will be copied from this object.

rightElement

The feature containing the geometry used as the right operand of the operation. The properties of this object are ignored.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Feature.intersects

Returns true iff the feature geometries intersect.

UsageReturns
Feature.intersects(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftElement

The feature containing the geometry used as the left operand of the operation.

rightElement

The feature containing the geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Feature.length

Returns the length of the linear parts of the geometry of a given feature. Polygonal parts are ignored. The length of multi geometries is the sum of the lengths of their components.

UsageReturns
Feature.length(maxError, proj)Float
ArgumentTypeDetails
this: featureElement

The feature from which the geometry is taken.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Feature.perimeter

Returns the length of the perimeter of the polygonal parts of the geometry of a given feature. The perimeter of multi geometries is the sum of the perimeters of their components.

UsageReturns
Feature.perimeter(maxError, proj)Float
ArgumentTypeDetails
this: featureElement

The feature from which the geometry is taken.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Feature.propertyNames

Returns the names of properties on this element.

UsageReturns
Feature.propertyNames()List
ArgumentTypeDetails
this: elementElement

ee.Feature.select

Selects properties from a feature by name or RE2-compatible regex and optionally renames them.

UsageReturns
Feature.select(propertySelectors, newProperties, retainGeometry)Element
ArgumentTypeDetails
this: inputElement

The feature to select properties from.

propertySelectorsList

A list of names or regexes specifying the properties to select.

newPropertiesList, default: null

Optional new names for the output properties. Must match the number of properties selected.

retainGeometryBoolean, default: true

When false, the result will have a NULL geometry.

ee.Feature.serialize

Returns the serialized representation of this object.

UsageReturns
Feature.serialize()String
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

ee.Feature.set

Overrides one or more metadata properties of an Element.

Returns the element with the specified properties overridden.

UsageReturns
Feature.set(var_args)Element
ArgumentTypeDetails
this: elementElement

The Element instance.

var_argsVarArgs

Either a dictionary of properties, or a vararg sequence of properties, e.g. key1, value1, key2, value2, ...

ee.Feature.setGeometry

Returns the feature, with the geometry replaced by the specified geometry.

UsageReturns
Feature.setGeometry(geometry)Element
ArgumentTypeDetails
this: featureElement

The feature on which to set the geometry.

geometryGeometry, default: null

The geometry to set.

ee.Feature.setMulti

Overrides one or more metadata properties of an object.

UsageReturns
Feature.setMulti(properties)Element
ArgumentTypeDetails
this: objectElement

The object whose properties to override.

propertiesDictionary

The property values to override.

ee.Feature.simplify

Simplifies the geometry of a feature to within a given error margin. Note that this does not respect the error margin requested by the consumer of this algorithm, unless maxError is explicitly specified to be null.

This overrides the default Earth Engine policy for propagating error margins, so regardless of the geometry accuracy requested from the output, the inputs will be requested with the error margin specified in the arguments to this algorithm. This results in consistent rendering at all zoom levels of a rendered vector map, but at lower zoom levels (i.e. zoomed out), the geometry won't be simplified, which may harm performance.

UsageReturns
Feature.simplify(maxError, proj)Feature
ArgumentTypeDetails
this: featureElement

The feature whose geometry is being simplified.

maxErrorErrorMargin

The maximum amount of error by which the result may differ from the input.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in the same projection as the input. If the error margin is in projected units, the margin will be interpreted as units of this projection

ee.Feature.symmetricDifference

Returns a feature containing the symmetric difference between geometries of two features.

UsageReturns
Feature.symmetricDifference(right, maxError, proj)Feature
ArgumentTypeDetails
this: leftElement

The feature containing the geometry used as the left operand of the operation. The properties of the result will be copied from this object.

rightElement

The feature containing the geometry used as the right operand of the operation. The properties of this object are ignored.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Feature.toArray

Creates an array from the given properties of an object, which must all be numbers.

UsageReturns
Feature.toArray(properties)Array
ArgumentTypeDetails
this: featureFeature

The object from which to select array properties.

propertiesList

The property selectors for each array element.

ee.Feature.toDictionary

Extract properties from a feature as a dictionary.

UsageReturns
Feature.toDictionary(properties)Dictionary
ArgumentTypeDetails
this: elementElement

The feature to extract the property from.

propertiesList, default: null

The list of properties to extract. Defaults to all non-system properties.

ee.Feature.transform

Transforms the geometry of a feature to a specific projection.

UsageReturns
Feature.transform(proj, maxError)Feature
ArgumentTypeDetails
this: featureElement

The feature the geometry of which is being converted.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Feature.union

Returns a feature containing the union of the geometries of two features.

UsageReturns
Feature.union(right, maxError, proj)Feature
ArgumentTypeDetails
this: leftElement

The feature containing the geometry used as the left operand of the operation. The properties of the result will be copied from this object.

rightElement

The feature containing the geometry used as the right operand of the operation. The properties of this object are ignored.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Feature.withinDistance

Returns true iff the geometries of two features are within a specified distance.

UsageReturns
Feature.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftElement

The feature containing the geometry used as the left operand of the operation.

rightElement

The feature containing the geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.FeatureCollection

FeatureCollections can be constructed from the following arguments:

  - A string: assumed to be the name of a collection.

  - A number: assumed to be the ID of a Fusion Table.

  - A single geometry.

  - A single feature.

  - A list of features.

  - A computed object: reinterpreted as a collection.

UsageReturns
ee.FeatureCollection(args, column)FeatureCollection
ArgumentTypeDetails
argsComputedObject|Feature|FeatureCollection|Geometry|List

The constructor arguments.

columnString, optional

The name of the geometry column to use. Only useful with constructor types 1 and 2.

ee.FeatureCollection.aggregate_array

Aggregates over a given property of the objects in a collection, calculating a list of all the values of the selected property.

UsageReturns
FeatureCollection.aggregate_array(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_count

Aggregates over a given property of the objects in a collection, calculating the number of non-null values of the property.

UsageReturns
FeatureCollection.aggregate_count(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_count_distinct

Aggregates over a given property of the objects in a collection, calculating the number of distinct values for the selected property.

UsageReturns
FeatureCollection.aggregate_count_distinct(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_first

Aggregates over a given property of the objects in a collection, calculating the property value of the first object in the collection.

UsageReturns
FeatureCollection.aggregate_first(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_histogram

Aggregates over a given property of the objects in a collection, calculating a histogram of the selected property.

UsageReturns
FeatureCollection.aggregate_histogram(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_max

Aggregates over a given property of the objects in a collection, calculating the maximum of the values of the selected property.

UsageReturns
FeatureCollection.aggregate_max(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_mean

Aggregates over a given property of the objects in a collection, calculating the mean of the selected property.

UsageReturns
FeatureCollection.aggregate_mean(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_min

Aggregates over a given property of the objects in a collection, calculating the minimum of the values of the selected property.

UsageReturns
FeatureCollection.aggregate_min(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_product

Aggregates over a given property of the objects in a collection, calculating the product of the values of the selected property.

UsageReturns
FeatureCollection.aggregate_product(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_sample_sd

Aggregates over a given property of the objects in a collection, calculating the sample std. deviation of the values of the selected property.

UsageReturns
FeatureCollection.aggregate_sample_sd(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_sample_var

Aggregates over a given property of the objects in a collection, calculating the sample variance of the values of the selected property.

UsageReturns
FeatureCollection.aggregate_sample_var(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_stats

Aggregates over a given property of the objects in a collection, calculating the sum, min, max, mean, sample standard deviation, sample variance, total standard deviation and total variance of the selected property.

UsageReturns
FeatureCollection.aggregate_stats(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_sum

Aggregates over a given property of the objects in a collection, calculating the sum of the values of the selected property.

UsageReturns
FeatureCollection.aggregate_sum(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_total_sd

Aggregates over a given property of the objects in a collection, calculating the total std. deviation of the values of the selected property.

UsageReturns
FeatureCollection.aggregate_total_sd(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aggregate_total_var

Aggregates over a given property of the objects in a collection, calculating the total variance of the values of the selected property.

UsageReturns
FeatureCollection.aggregate_total_var(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.FeatureCollection.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
FeatureCollection.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.FeatureCollection.classify

Classifies each feature in a collection.

UsageReturns
FeatureCollection.classify(classifier, outputName)FeatureCollection
ArgumentTypeDetails
this: featuresFeatureCollection

The collection of features to classify. Each feature must contain all the properties in the classifier's schema.

classifierObject

The classifier to use.

outputNameString, default: "classification"

The name of the output property to be added.

ee.FeatureCollection.cluster

Clusters each feature in a collection, adding a new column to each feature containing the cluster number to which it has been assigned.

UsageReturns
FeatureCollection.cluster(clusterer, outputName)FeatureCollection
ArgumentTypeDetails
this: featuresFeatureCollection

The collection of features to cluster. Each feature must contain all the properties in the clusterer's schema.

clustererClusterer

The clusterer to use.

outputNameString, default: "cluster"

The name of the output property to be added.

ee.FeatureCollection.copyProperties

Copies metadata properties from one element to another.

UsageReturns
FeatureCollection.copyProperties(source, properties, exclude)Element
ArgumentTypeDetails
this: destinationElement, default: null

The object whose properties to override.

sourceElement, default: null

The object from which to copy the properties.

propertiesList, default: null

The properties to copy. If omitted, all ordinary (i.e. non-system) properties are copied.

excludeList, default: null

The list of properties to exclude when copying all properties. Must not be specified if properties is.

ee.FeatureCollection.distance

Produces a DOUBLE image where each pixel is the distance in meters from the pixel center to the nearest part of any Point or LineString features in the collection. Pixels that are not within 'searchRadius' meters of a geometry will be masked out.

Distances are computed on a sphere, so there is a small error proportional to the latitude difference between each pixel and the nearest geometry.

UsageReturns
FeatureCollection.distance(searchRadius, maxError)Image
ArgumentTypeDetails
this: featuresFeatureCollection

Feature collection from which to get features used to compute pixel distances.

searchRadiusFloat, default: 100000

Maximum distance in meters from each pixel to look for edges. Pixels will be masked unless there are edges within this distance.

maxErrorFloat, default: 100

Maximum reprojection error in meters, only used if the input polylines require reprojection. If '0' is provided, then this operation will fail if projection is required.

ee.FeatureCollection.distinct

Removes duplicates from a collection. Note that duplicates are determined using a strong hash over the serialized form of the selected properties.

UsageReturns
FeatureCollection.distinct(selectors)FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection from which objects will be selected.

selectorsSelectorSet

Which parts of the object to use for comparisons.

ee.FeatureCollection.draw

Paints a vector collection for visualization. Not intended for use as input to other algorithms.

UsageReturns
FeatureCollection.draw(color, pointRadius, strokeWidth)Image
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to draw.

colorString

A hex string in the format RRGGBB specifying the color to use for drawing the features.

pointRadiusInteger, default: 3

The radius in pixels of the point markers.

strokeWidthInteger, default: 2

The width in pixels of lines and polygon borders.

ee.FeatureCollection.errorMatrix

Computes a 2D error matrix for a collection by comparing two columns of a collection: one containing the actual values, and one containing predicted values.The values are expected to be small contiguous integers, starting from 0. Axis 1 (the rows) of the matrix correspond to the actual values, and Axis 0 (the columns) to the predicted values.

UsageReturns
FeatureCollection.errorMatrix(actual, predicted, order)ConfusionMatrix
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection.

actualString

The name of the property containing the actual value.

predictedString

The name of the property containing the predicted value.

orderList, default: null

A list of the expected values. If this argument is not specified, the values are assumed to be contiguous and span the range 0 to maxValue. If specified, only values matching this list are used, and the matrix will have dimensions and order matching the this list.

ee.FeatureCollection.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
FeatureCollection.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.FeatureCollection.filter

Apply a filter to this collection.

Collection filtering is done by wrapping a collection in a filter algorithm. As additional filters are applied to a collection, we try to avoid adding more wrappers and instead search for a wrapper we can add to, however if the collection doesn't have a filter, this will wrap it in one.

Returns the filtered collection.

UsageReturns
FeatureCollection.filter(newFilter)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

newFilterFilter

A filter to add to this collection.

ee.FeatureCollection.filterBounds

Shortcut to filter a collection by geometry. Items in the collection with a footprint that fails to intersect the bounds will be excluded when the collection is evaluated.

This is equivalent to this.filter(ee.Filter.bounds(...)).

Returns the filtered collection.

UsageReturns
FeatureCollection.filterBounds(geometry)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

geometryFeature|Geometry

The geometry to filter to.

ee.FeatureCollection.filterDate

Shortcut to filter a collection by a date range. Items in the collection with a time_start property that doesn't fall between the start and end dates will be excluded.

This is equivalent to this.filter(ee.Filter.date(...)).

Returns the filtered collection.

UsageReturns
FeatureCollection.filterDate(start, end)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

startDate|Number|String

The start date as a Date object, a string representation of a date, or milliseconds since epoch.

endDate|Number|String, optional

The end date as a Date object, a string representation of a date, or milliseconds since epoch.

ee.FeatureCollection.filterMetadata

Shortcuts to filter a collection by metadata. This is equivalent to this.filter(ee.Filter.metadata(...)).

Returns the filtered collection.

UsageReturns
FeatureCollection.filterMetadata(name, operator, value)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

nameString

The name of a property to filter.

operatorString

The name of a comparison operator. Possible values are: "equals", "less_than", "greater_than",

"not_equals", "not_less_than", "not_greater_than", "starts_with",

"ends_with", "not_starts_with", "not_ends_with", "contains",

"not_contains".

valueObject

  - The value to compare against.

ee.FeatureCollection.first

Returns the first entry from a given collection.

UsageReturns
FeatureCollection.first()Element
ArgumentTypeDetails
this: collectionFeatureCollection

The collection from which to select the first entry.

ee.FeatureCollection.flatten

Flattens collections of collections.

UsageReturns
FeatureCollection.flatten()FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection of collections.

ee.FeatureCollection.geometry

Extracts and merges the geometries of a collection. Requires that all the geometries in the collection share the projection and edge interpretation.

UsageReturns
FeatureCollection.geometry(maxError)Geometry
ArgumentTypeDetails
this: collectionFeatureCollection

The collection whose geometries will be extracted.

maxErrorErrorMargin, optional

An error margin to use when merging geometries.

ee.FeatureCollection.get

Extract a property from a feature.

UsageReturns
FeatureCollection.get(property)
ArgumentTypeDetails
this: objectElement

The feature to extract the property from.

propertyString

The property to extract.

ee.FeatureCollection.getDownloadURL

Get a download URL.

Returns a download URL or undefined if a callback was specified.

UsageReturns
FeatureCollection.getDownloadURL(format, selectors, filename, callback)Object|String
ArgumentTypeDetails
this: featurecollectionFeatureCollection

The FeatureCollection instance.

formatString, optional

The format of download, one of:

"csv", "json", "kml", "kmz".

selectorsList, optional

Selectors that should be used to determine which attributes will be downloaded.

filenameString, optional

Name of the file to be downloaded.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.FeatureCollection.getInfo

An imperative function that returns all the known information about this collection via an AJAX call.

Returns a collection description whose fields include:

  - features: a list containing metadata about the features in the collection.

  - properties: an optional dictionary containing the collection's metadata properties.

UsageReturns
FeatureCollection.getInfo(callback)FeatureCollectionDescription
ArgumentTypeDetails
this: featurecollectionFeatureCollection

The FeatureCollection instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously. If supplied, will be called with the first parameter if successful and the second if unsuccessful.

ee.FeatureCollection.getMap

An imperative function that returns a map id and token, suitable for generating a Map overlay.

Returns an object containing a mapid string, an acess token, plus a Collection.draw image wrapping this collection. Or undefined if a callback was specified.

UsageReturns
FeatureCollection.getMap(visParams, callback)MapId|Object
ArgumentTypeDetails
this: featurecollectionFeatureCollection

The FeatureCollection instance.

visParamsObject, optional

The visualization parameters. Currently only one parameter, 'color', containing an RGB color string is allowed. If vis_params isn't specified, then the color #000000 is used.

callbackFunction, optional

An async callback. If not supplied, the call is made synchronously.

ee.FeatureCollection.inverseDistance

Returns an inverse-distance weighted estimate of the value at each pixel.

UsageReturns
FeatureCollection.inverseDistance(range, propertyName, mean, stdDev, gamma, reducer)Image
ArgumentTypeDetails
this: collectionFeatureCollection

Feature collection to use as source data for the estimation.

rangeFloat

Size of the interpolation window (in meters).

propertyNameString

Name of the numeric property to be estimated.

meanFloat

Global expected mean.

stdDevFloat

Global standard deviation.

gammaFloat, default: 1

Determines how quickly the estimates tend towards the global mean.

reducerReducer, default: null

Reducer used to collapse the 'propertyName' value of overlapping points into a single value.

ee.FeatureCollection.iterate

Applies a user-supplied function to each element of a collection. The user-supplied function is given two arguments: the current element, and the value returned by the previous call to iterate() or the first argument, for the first iteration. The result is the value returned by the final call to the user-supplied function.

Returns the result of the Collection.iterate() call.

UsageReturns
FeatureCollection.iterate(algorithm, first)ComputedObject
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

algorithmFunction

The function to apply to each element. Must take two arguments: an element of the collection and the value from the previous iteration.

firstObject, optional

The initial state.

ee.FeatureCollection.kriging

Returns the results of sampling a Kriging estimator at each pixel.

UsageReturns
FeatureCollection.kriging(propertyName, shape, range, sill, nugget, maxDistance, reducer)Image
ArgumentTypeDetails
this: collectionFeatureCollection

Feature collection to use as source data for the estimation.

propertyNameString

Property to be estimated (must be numeric).

shapeString

Semivariogram shape (one of {exponential, gaussian, spherical}).

rangeFloat

Semivariogram range.

sillFloat

Semivariogram sill.

nuggetFloat

Semivariogram nugget.

maxDistanceFloat, default: null

Raidus which determines which fetaures are included in each pixel's computation. Defaults to the semivariogram's range.

reducerReducer, default: null

Reducer used to collapse the 'propertyName' value of overlapping points into a single value.

ee.FeatureCollection.limit

Limit a collection to the specified number of elements, optionally sorting them by a specified property first.

Returns the limited collection.

UsageReturns
FeatureCollection.limit(max, property, ascending)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

maxNumber

The number to limit the collection to.

propertyString, optional

The property to sort by, if sorting.

ascendingBoolean, optional

Whether to sort in ascending or descending order. The default is true (ascending).

ee.FeatureCollection.makeArray

Add a 1-D Array to each feature in a collection by combining a list of properties for each feature into a 1-D Array. All of the properties must be numeric values. If a feature doesn't contain all of the named properties, or any of them aren't numeric, the feature will be dropped from the resulting collection.

UsageReturns
FeatureCollection.makeArray(properties, name)FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection from which properties will be selected.

propertiesList

The properties to select.

nameString, default: "array"

The name of the new array property.

ee.FeatureCollection.map

Maps an algorithm over a collection.

Returns the mapped collection.

UsageReturns
FeatureCollection.map(algorithm, dropNulls)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

algorithmFunction

The operation to map over the images or features of the collection. A JavaScript function that receives an image or features and returns one. The function is called only once and the result is captured as a description, so it cannot perform imperative operations or rely on external state.

dropNullsBoolean, optional

If true, the mapped algorithm is allowed to return nulls, and the elements for which it returns nulls will be dropped.

ee.FeatureCollection.merge

Merges two collections into one. The result has all the elements that were in either collection.

UsageReturns
FeatureCollection.merge(collection2)FeatureCollection
ArgumentTypeDetails
this: collection1FeatureCollection

The first collection to merge.

collection2FeatureCollection

The second collection to merge.

ee.FeatureCollection.propertyNames

Returns the names of properties on this element.

UsageReturns
FeatureCollection.propertyNames()List
ArgumentTypeDetails
this: elementElement

ee.FeatureCollection.randomColumn

Adds a column of deterministic pseudorandom numbers to a collection. The numbers are double-precision floating point numbers in the range 0.0 (inclusive) to 1.0 (exclusive).

UsageReturns
FeatureCollection.randomColumn(columnName, seed)FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection to which to add a random column.

columnNameString, default: "random"

The name of the column to add.

seedLong, default: 0

A seed used when generating the random numbers.

ee.FeatureCollection.randomPoints

Generates points that are uniformly random on the sphere, and within the given region.

UsageReturns
ee.FeatureCollection.randomPoints(region, points, seed, maxError)FeatureCollection
ArgumentTypeDetails
regionGeometry

The region to generate points for.

pointsInteger, default: 1000

The number of points to generate.

seedLong, default: 0

A seed for the random number generator.

maxErrorErrorMargin, optional

The maximum amount of error tolerated when performing any necessary reprojection.

ee.FeatureCollection.reduceColumns

Apply a reducer to each element of a collection, using the given selectors to determine the inputs.

Returns a dictionary of results, keyed with the output names.

UsageReturns
FeatureCollection.reduceColumns(reducer, selectors, weightSelectors)Dictionary
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

reducerReducer

The reducer to apply.

selectorsList

A selector for each input of the reducer.

weightSelectorsList, default: null

A selector for each weighted input of the reducer.

ee.FeatureCollection.reduceToImage

Creates an image from a feature collection by applying a reducer over the selected properties of all the features that intersect each pixel.

UsageReturns
FeatureCollection.reduceToImage(properties, reducer)Image
ArgumentTypeDetails
this: collectionFeatureCollection

Feature collection to intersect with each output pixel.

propertiesList

Properties to select from each feature and pass into the reducer.

reducerReducer

A Reducer to combine the properties of each intersecting feature into a final result to store in the pixel.

ee.FeatureCollection.remap

Remaps the value of a specific property in a collection. Takes two parallel lists and maps values found in one to values in the other. Any element with a value that is not specified in the first list is dropped from the output collection.

UsageReturns
FeatureCollection.remap(lookupIn, lookupOut, columnName)FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to be modified.

lookupInList

The input mapping values. Restricted to strings and integers.

lookupOutList

The output mapping values. Must be the same size as lookupIn.

columnNameString

The name of the property to remap.

ee.FeatureCollection.select

Select properties from each Feature in a collection. It is also possible to call this function with only string arguments; they will be all be interpreted as propertySelectors (varargs).

Returns the feature collection with selected properties.

UsageReturns
FeatureCollection.select(propertySelectors, newProperties, retainGeometry)FeatureCollection
ArgumentTypeDetails
this: featurecollectionFeatureCollection

The FeatureCollection instance.

propertySelectorsList

A list of names or regexes specifying the attributes to select.

newPropertiesList, optional

A list of new names for the output properties. Must match the number of properties selected.

retainGeometryBoolean, optional

When false, the result will have a NULL geometry. Defaults to true.

ee.FeatureCollection.serialize

Returns the serialized representation of this object.

UsageReturns
FeatureCollection.serialize()String
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

ee.FeatureCollection.set

Overrides one or more metadata properties of an Element.

Returns the element with the specified properties overridden.

UsageReturns
FeatureCollection.set(var_args)Element
ArgumentTypeDetails
this: elementElement

The Element instance.

var_argsVarArgs

Either a dictionary of properties, or a vararg sequence of properties, e.g. key1, value1, key2, value2, ...

ee.FeatureCollection.setMulti

Overrides one or more metadata properties of an object.

UsageReturns
FeatureCollection.setMulti(properties)Element
ArgumentTypeDetails
this: objectElement

The object whose properties to override.

propertiesDictionary

The property values to override.

ee.FeatureCollection.size

Returns the number of elements in the collection.

UsageReturns
FeatureCollection.size()Integer
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to count.

ee.FeatureCollection.sort

Sort a collection by the specified property.

Returns the sorted collection.

UsageReturns
FeatureCollection.sort(property, ascending)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

propertyString

The property to sort by.

ascendingBoolean, optional

Whether to sort in ascending or descending order. The default is true (ascending).

ee.FeatureCollection.style

Draw a vector collection for visualization using a simple style language.

UsageReturns
FeatureCollection.style(color, pointSize, pointShape, width, fillColor, styleProperty, neighborhood)Image
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to draw.

colorString, default: "black"

A default color (CSS 3.0 color value e.g. 'FF0000' or 'red') to use for drawing the features. Supports opacity (e.g.: 'FF000088' for 50% transparent red).

pointSizeInteger, default: 3

The default size in pixels of the point markers.

pointShapeString, default: "circle"

The default shape of the marker to draw at each point location. One of: circle, square, diamond, cross, plus, pentagram, hexagram, triangle, triangle_up triangle_down, triangle_left, triangle_right, pentagon, hexagon, star5, star6. This argument also supports the following Matlab marker abbreviations: o, s, d, x, +, p, h, ^, v, <, >.

widthFloat, default: 2

The default line width for lines and outlines for polygons and point shapes.

fillColorString, default: null

The color for filling polygons and point shapes. Defaults to 'color' at 0.66 opacity.

stylePropertyString, default: null

A per-feature property expected to contain a dictionary. Values in the dictionary override any default values for that feature.

neighborhoodInteger, default: 5

If styleProperty is used and any feature has a pointSize or width larger than the defaults, tiling artifacts can occur. Specifies the maximum neighborhood (pointSize + width) needed for any feature.

ee.FeatureCollection.toDictionary

Extract properties from a feature as a dictionary.

UsageReturns
FeatureCollection.toDictionary(properties)Dictionary
ArgumentTypeDetails
this: elementElement

The feature to extract the property from.

propertiesList, default: null

The list of properties to extract. Defaults to all non-system properties.

ee.FeatureCollection.toList

Returns the elements of a collection as a list.

UsageReturns
FeatureCollection.toList(count, offset)List
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection to fetch.

countInteger

The maximum number of elements to fetch.

offsetInteger, default: 0

The number of elements to discard from the start. If set, (offset + count) elements will be fetched and the first offset elements will be discarded.

ee.FeatureCollection.union

Merges all geometries in a given collection into one and returns a collection containing a single feature with only an ID of 'union_result' and a geometry.

UsageReturns
FeatureCollection.union(maxError)FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The collection being merged.

maxErrorErrorMargin, default: null

The maximum error allowed when performing any necessary reprojections. If not specified, defaults to the error margin requested from the output.

ee.Filter

Constructs a new filter. This constructor accepts the following args:

  - Another filter.

  - A list of filters (which are implicitly ANDed together).

  - A ComputedObject returning a filter. Users shouldn't be making these; they're produced by the generator functions below.

UsageReturns
ee.Filter(filter)Filter
ArgumentTypeDetails
filterFilter|List, optional

Optional filter to add.

ee.Filter.and

Combine two or more filters using boolean AND.

Returns the constructed filter.

UsageReturns
ee.Filter.and(var_args)Filter
ArgumentTypeDetails
var_argsVarArgs

The filters to combine.

ee.Filter.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
Filter.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Filter.bounds

Filter on bounds.

Returns the modified filter.

UsageReturns
ee.Filter.bounds(geometry, errorMargin)Filter
ArgumentTypeDetails
geometryComputedObject|FeatureCollection|Geometry

The geometry, feature or collection to filter to.

errorMarginComputedObject|Number, optional

An optional error margin. If a number, interpreted as sphere surface meters.

ee.Filter.calendarRange

Returns a filter that passes if the object's timestamp falls within the given range of a calendar field. The month, day_of_year, day_of_month, and day_of_week are 1-based. Times are assumed to be in UTC. Weeks are assumed to begin on Monday as day 1. If end < start then this tests for value >= start OR value <= end, to allow for wrapping.

UsageReturns
ee.Filter.calendarRange(start, end, field)Filter
ArgumentTypeDetails
startInteger

The start of the desired calendar field, inclusive.

endInteger, default: null

The end of the desired calendar field, inclusive. Defaults to the same value as start.

fieldString, default: "day_of_year"

The calendar field to filter over. Options are: 'year', 'month', 'hour', 'minute', 'day_of_year', 'day_of_month', and 'day_of_week'.

ee.Filter.contains

Creates a unary or binary filter that passes if the left geometry contains the right geometry (empty geometries are not contained in anything).

UsageReturns
ee.Filter.contains(leftField, rightValue, rightField, leftValue, maxError)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

maxErrorErrorMargin, optional

The maximum reprojection error allowed during filter application.

ee.Filter.date

Filter images by date. The start and end may be a Date, numbers

(interpreted as milliseconds since 1970-01-01T00:00:00Z), or strings (such as '1996-01-01T08:00').

Returns the constructed filter.

UsageReturns
ee.Filter.date(start, end)Filter
ArgumentTypeDetails
startDate|Number|String

The inclusive start date.

endDate|Number|String, optional

The optional exclusive end date. If not specified, a 1-millisecond range starting at 'start' is created.

ee.Filter.dateRangeContains

Creates a unary or binary filter that passes if the left operand, a date range, contains the right operand, a date.

UsageReturns
ee.Filter.dateRangeContains(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.dayOfYear

Returns a filter that passes if the object's timestamp falls within the given day-of-year range.

UsageReturns
ee.Filter.dayOfYear(start, end)Filter
ArgumentTypeDetails
startInteger

The start of the desired day range, inclusive.

endInteger

The end of the desired day range, exclusive.

ee.Filter.disjoint

Creates a unary or binary filter that passes unless the left geometry intersects the right geometry.

UsageReturns
ee.Filter.disjoint(leftField, rightValue, rightField, leftValue, maxError)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

maxErrorErrorMargin, optional

The maximum reprojection error allowed during filter application.

ee.Filter.eq

Filter to metadata equal to the given value.

Returns the constructed filter.

UsageReturns
ee.Filter.eq(name, value)Filter
ArgumentTypeDetails
nameString

The property name to filter on.

valueObject

The value to compare against.

ee.Filter.equals

Creates a unary or binary filter that passes if the two operands are equals.

UsageReturns
ee.Filter.equals(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
Filter.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Filter.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
Filter.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Filter.greaterThan

Creates a unary or binary filter that passes if the left operand is greater than the right operand.

UsageReturns
ee.Filter.greaterThan(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.greaterThanOrEquals

Creates a unary or binary filter that passes unless the left operand is less than the right operand.

UsageReturns
ee.Filter.greaterThanOrEquals(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.gt

Filter on metadata greater than the given value.

Returns the constructed filter.

UsageReturns
ee.Filter.gt(name, value)Filter
ArgumentTypeDetails
nameString

The property name to filter on.

valueObject

The value to compare against.

ee.Filter.gte

Filter on metadata greater than or equal to the given value.

Returns the constructed filter.

UsageReturns
ee.Filter.gte(name, value)Filter
ArgumentTypeDetails
nameString

The property name to filter on.

valueObject

The value to compare against.

ee.Filter.inList

Filter on metadata contained in a list.

Returns the constructed filter.

UsageReturns
ee.Filter.inList(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, optional

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueList, optional

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, optional

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueList, optional

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.intersects

Creates a unary or binary filter that passes if the left geometry intersects the right geometry.

UsageReturns
ee.Filter.intersects(leftField, rightValue, rightField, leftValue, maxError)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

maxErrorErrorMargin, optional

The maximum reprojection error allowed during filter application.

ee.Filter.lessThan

Creates a unary or binary filter that passes if the left operand is less than the right operand.

UsageReturns
ee.Filter.lessThan(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.lessThanOrEquals

Creates a unary or binary filter that passes unless the left operand is greater than the right operand.

UsageReturns
ee.Filter.lessThanOrEquals(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.listContains

Creates a unary or binary filter that passes if the left operand, a list, contains the right operand.

UsageReturns
ee.Filter.listContains(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.lt

Filter to metadata less than the given value.

Returns the constructed filter.

UsageReturns
ee.Filter.lt(name, value)Filter
ArgumentTypeDetails
nameString

The property name to filter on.

valueObject

The value to compare against.

ee.Filter.lte

Filter on metadata less than or equal to the given value.

Returns the constructed filter.

UsageReturns
ee.Filter.lte(name, value)Filter
ArgumentTypeDetails
nameString

The property name to filter on.

valueObject

The value to compare against.

ee.Filter.maxDifference

Creates a unary or binary filter that passes if the left and right operands, both numbers, are within a given maximum difference. If used as a join condition, this numeric difference is used as a join measure.

UsageReturns
ee.Filter.maxDifference(difference, leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
differenceFloat

The maximum difference for which the filter will return true.

leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.neq

Filter to metadata not equal to the given value.

Returns the constructed filter.

UsageReturns
ee.Filter.neq(name, value)Filter
ArgumentTypeDetails
nameString

The property name to filter on.

valueObject

The value to compare against.

ee.Filter.not

Returns the opposite of this filter, i.e. a filter that will match iff this filter doesn't.

UsageReturns
Filter.not()Filter
ArgumentTypeDetails
this: filterFilter

The Filter instance.

ee.Filter.notEquals

Creates a unary or binary filter that passes unless the two operands are equals.

UsageReturns
ee.Filter.notEquals(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.or

Combine two or more filters using boolean OR.

Returns the constructed filter.

UsageReturns
ee.Filter.or(var_args)Filter
ArgumentTypeDetails
var_argsVarArgs

The filters to combine.

ee.Filter.rangeContains

Returns a filter that passes if the value of the selected field is in the specified range (inclusive).

UsageReturns
ee.Filter.rangeContains(field, minValue, maxValue)Filter
ArgumentTypeDetails
fieldString

A selector for the property being tested.

minValueObject

The lower bound of the range.

maxValueObject

The upper bound of the range.

ee.Filter.serialize

Returns the serialized representation of this object.

UsageReturns
Filter.serialize()String
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

ee.Filter.stringContains

Creates a unary or binary filter that passes if the left operand, a string, contains the right operand, also a string.

UsageReturns
ee.Filter.stringContains(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.stringEndsWith

Creates a unary or binary filter that passes if the left operand, a string, ends with the right operand, also a string.

UsageReturns
ee.Filter.stringEndsWith(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.stringStartsWith

Creates a unary or binary filter that passes if the left operand, a string, starts with the right operand, also a string.

UsageReturns
ee.Filter.stringStartsWith(leftField, rightValue, rightField, leftValue)Filter
ArgumentTypeDetails
leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

ee.Filter.withinDistance

Creates a unary or binary filter that passes if the left geometry is within a specified distance of the right geometry. If used as a join condition, this distance is used as a join measure.

UsageReturns
ee.Filter.withinDistance(distance, leftField, rightValue, rightField, leftValue, maxError)Filter
ArgumentTypeDetails
distanceFloat

The maximum distance for which the filter will return true.

leftFieldString, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValueObject, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightFieldString, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValueObject, default: null

The value of the left operand. Should not be specified if leftField is specified.

maxErrorErrorMargin, optional

The maximum reprojection error allowed during filter application.

ee.Geometry

Creates a geometry.

UsageReturns
ee.Geometry(geoJson, proj, geodesic, evenOdd)Geometry
ArgumentTypeDetails
geoJsonObject

The GeoJSON object describing the geometry or a ComputedObject to be reinterpreted as a Geometry. Supports CRS specifications as per the GeoJSON spec, but only allows named

(rather than "linked" CRSs). If this includes a 'geodesic' field, and opt_geodesic is not specified, it will be used as opt_geodesic.

projProjection, optional

An optional projection specification, either as a CRS ID code or as a WKT string. If specified, overrides any CRS found in the geoJson parameter. If unspecified and the geoJson does not declare a CRS, defaults to "EPSG:4326" (x=longitude, y=latitude).

geodesicBoolean, optional

Whether line segments should be interpreted as spherical geodesics. If false, indicates that line segments should be interpreted as planar lines in the specified CRS. If absent, defaults to true if the CRS is geographic (including the default EPSG:4326), or to false if the CRS is projected.

evenOddBoolean, optional

If true, polygon interiors will be determined by the even/odd rule, where a point is inside if it crosses an odd number of edges to reach a point at infinity. Otherwise polygons use the left- inside rule, where interiors are on the left side of the shell's edges when walking the vertices in the given order. If unspecified, defaults to true.

ee.Geometry.LineString

Constructs an ee.Geometry describing a LineString.

For convenience, varargs may be used when all arguments are numbers. This allows creating geodesic EPSG:4326 LineStrings given an even number of arguments, e.g. ee.Geometry.LineString(aLng, aLat, bLng, bLat, ...).

UsageReturns
ee.Geometry.LineString(coords, proj, geodesic, maxError)Geometry.LineString
ArgumentTypeDetails
coordsList

A list of at least two points. May be a list of coordinates in the GeoJSON 'LineString' format, a list of at least two ee.Geometry describing a point, or a list of at least four numbers defining the [x,y] coordinates of at least two points.

projProjection, optional

The projection of this geometry. If unspecified, the default is the projection of the input ee.Geometry, or EPSG:4326 if there are no ee.Geometry inputs.

geodesicBoolean, optional

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

maxErrorErrorMargin, optional

Max error when input geometry must be reprojected to an explicitly requested result projection or geodesic state.

ee.Geometry.LineString.area

Returns the area of the geometry. Area of points and line strings is 0, and the area of multi geometries is the sum of the areas of their componenets (intersecting areas are counted multiple times).

UsageReturns
LineString.area(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The geometry input.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

ee.Geometry.LineString.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
LineString.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Geometry.LineString.bounds

Returns the bounding rectangle of the geometry.

UsageReturns
LineString.bounds(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Return the bounding box of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.LineString.buffer

Returns the input buffered by a given distance. If the distance is positive, the geometry is expanded, and if the distance is negative, the geometry is contracted.

UsageReturns
LineString.buffer(distance, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry being buffered.

distanceFloat

The distance of the buffering, which may be negative. If no projection is specified, the unit is meters. Otherwise the unit is in the coordinate system of the projection.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when approximating the buffering circle and performing any necessary reprojection. If unspecified, defaults to 1% of the distance.

projProjection, default: null

If specified, the buffering will be performed in this projection and the distance will be interpreted as units of the coordinate system of this projection. Otherwise the distance is interpereted as meters and the buffering is performed in a spherical coordinate system.

ee.Geometry.LineString.centroid

Returns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.

UsageReturns
LineString.centroid(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the centroid of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.LineString.containedIn

Returns true iff one geometry is contained in the other.

UsageReturns
LineString.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LineString.contains

Returns true iff one geometry contains the other.

UsageReturns
LineString.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LineString.convexHull

Returns the convex hull of the given geometry. The convex hull of a single point is the point itself, the convex hull of collinear points is a line, and the convex hull of everything else is a polygon. Note that a degenerate polygon with all vertices on the same line will result in a line segment.

UsageReturns
LineString.convexHull(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the convex hull of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LineString.coordinates

Returns a GeoJSON-style list of the geometry's coordinates.

UsageReturns
LineString.coordinates()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LineString.cutLines

Converts LineStrings into a MultiLineString by cutting it in two at each distance along the length of the LineString.

UsageReturns
LineString.cutLines(distances, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Cuts the lines of this geometry.

distancesList

Distances along each LineString to cut the line into separate pieces, measured in units of the given proj, or meters if proj is unspecified.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

Projection of the result and distance measurements, or WGS84 if unspecified.

ee.Geometry.LineString.difference

Returns the result of subtracting the 'right' geometry from the 'left' geometry.

UsageReturns
LineString.difference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LineString.disjoint

Returns true iff the geometries are disjoint.

UsageReturns
LineString.disjoint(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LineString.dissolve

Returns the union of the geometry. This leaves single geometries untouched, and unions multi geometries.

UsageReturns
LineString.dissolve(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to union.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the union will be performed in this projection. Otherwise it will be performed in a spherical coordinate system.

ee.Geometry.LineString.distance

Returns the minimum distance between two geometries.

UsageReturns
LineString.distance(right, maxError, proj)Float
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LineString.edgesAreGeodesics

Returns true if the geometry edges, if any, are geodesics along a spherical model of the earth; if false, any edges are straight lines in the projection.

UsageReturns
LineString.edgesAreGeodesics()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LineString.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
LineString.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Geometry.LineString.geodesic

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth.

UsageReturns
LineString.geodesic()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LineString.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

UsageReturns
LineString.geometries()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LineString.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
LineString.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Geometry.LineString.intersection

Returns the intersection of the two geometries.

UsageReturns
LineString.intersection(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LineString.intersects

Returns true iff the geometries intersect.

UsageReturns
LineString.intersects(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LineString.isUnbounded

Returns whether the geometry is unbounded.

UsageReturns
LineString.isUnbounded()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LineString.length

Returns the length of the linear parts of the geometry. Polygonal parts are ignored. The length of multi geometries is the sum of the lengths of their components.

UsageReturns
LineString.length(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.LineString.perimeter

Returns the length of the perimeter of the polygonal parts of the geometry. The perimeter of multi geometries is the sum of the perimeters of their components.

UsageReturns
LineString.perimeter(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.LineString.projection

Returns the projection of the geometry.

UsageReturns
LineString.projection()Projection
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LineString.serialize

Returns the serialized representation of this object.

UsageReturns
LineString.serialize()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.LineString.simplify

Simplifies the geometry to within a given error margin. Note that this does not respect the error margin requested by the consumer of this algorithm, unless maxError is explicitly specified to be null.

This overrides the default Earth Engine policy for propagating error margins, so regardless of the geometry accuracy requested from the output, the inputs will be requested with the error margin specified in the arguments to this algorithm. This results in consistent rendering at all zoom levels of a rendered vector map, but at lower zoom levels (i.e. zoomed out), the geometry won't be simplified, which may harm performance.

UsageReturns
LineString.simplify(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to simplify.

maxErrorErrorMargin

The maximum amount of error by which the result may differ from the input.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in the same projection as the input. If the error margin is in projected units, the margin will be interpreted as units of this projection

ee.Geometry.LineString.symmetricDifference

Returns the symmetric difference between two geometries.

UsageReturns
LineString.symmetricDifference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LineString.toGeoJSON

Returns a GeoJSON representation of the geometry.

UsageReturns
LineString.toGeoJSON()GeoJSONGeometry
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.LineString.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

UsageReturns
LineString.toGeoJSONString()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.LineString.transform

Transforms the geometry to a specific projection.

UsageReturns
LineString.transform(proj, maxError)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to reproject.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Geometry.LineString.type

Returns the GeoJSON type of the geometry.

UsageReturns
LineString.type()String
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LineString.union

Returns the union of the two geometries.

UsageReturns
LineString.union(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LineString.withinDistance

Returns true iff the geometries are within a specified distance.

UsageReturns
LineString.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing

Constructs an ee.Geometry describing a LinearRing. If the last point is not equal to the first, a duplicate of the first point will be added at the end.

For convenience, varargs may be used when all arguments are numbers. This allows creating geodesic EPSG:4326 LinearRings given an even number of arguments, e.g. ee.Geometry.LinearRing(aLng, aLat, bLng, bLat, ..., aLng, aLat).

UsageReturns
ee.Geometry.LinearRing(coords, proj, geodesic, maxError)Geometry.LinearRing
ArgumentTypeDetails
coordsList

A list of points in the ring. May be a list of coordinates in the GeoJSON

'LinearRing' format, a list of at least three ee.Geometry describing a point, or a list of at least six numbers defining the [x,y] coordinates of at least three points.

projProjection, optional

The projection of this geometry. If unspecified, the default is the projection of the input ee.Geometry, or EPSG:4326 if there are no ee.Geometry inputs.

geodesicBoolean, optional

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

maxErrorErrorMargin, optional

Max error when input geometry must be reprojected to an explicitly requested result projection or geodesic state.

ee.Geometry.LinearRing.area

Returns the area of the geometry. Area of points and line strings is 0, and the area of multi geometries is the sum of the areas of their componenets (intersecting areas are counted multiple times).

UsageReturns
LinearRing.area(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The geometry input.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

ee.Geometry.LinearRing.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
LinearRing.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Geometry.LinearRing.bounds

Returns the bounding rectangle of the geometry.

UsageReturns
LinearRing.bounds(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Return the bounding box of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.LinearRing.buffer

Returns the input buffered by a given distance. If the distance is positive, the geometry is expanded, and if the distance is negative, the geometry is contracted.

UsageReturns
LinearRing.buffer(distance, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry being buffered.

distanceFloat

The distance of the buffering, which may be negative. If no projection is specified, the unit is meters. Otherwise the unit is in the coordinate system of the projection.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when approximating the buffering circle and performing any necessary reprojection. If unspecified, defaults to 1% of the distance.

projProjection, default: null

If specified, the buffering will be performed in this projection and the distance will be interpreted as units of the coordinate system of this projection. Otherwise the distance is interpereted as meters and the buffering is performed in a spherical coordinate system.

ee.Geometry.LinearRing.centroid

Returns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.

UsageReturns
LinearRing.centroid(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the centroid of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.LinearRing.containedIn

Returns true iff one geometry is contained in the other.

UsageReturns
LinearRing.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing.contains

Returns true iff one geometry contains the other.

UsageReturns
LinearRing.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing.convexHull

Returns the convex hull of the given geometry. The convex hull of a single point is the point itself, the convex hull of collinear points is a line, and the convex hull of everything else is a polygon. Note that a degenerate polygon with all vertices on the same line will result in a line segment.

UsageReturns
LinearRing.convexHull(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the convex hull of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing.coordinates

Returns a GeoJSON-style list of the geometry's coordinates.

UsageReturns
LinearRing.coordinates()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LinearRing.cutLines

Converts LineStrings into a MultiLineString by cutting it in two at each distance along the length of the LineString.

UsageReturns
LinearRing.cutLines(distances, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Cuts the lines of this geometry.

distancesList

Distances along each LineString to cut the line into separate pieces, measured in units of the given proj, or meters if proj is unspecified.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

Projection of the result and distance measurements, or WGS84 if unspecified.

ee.Geometry.LinearRing.difference

Returns the result of subtracting the 'right' geometry from the 'left' geometry.

UsageReturns
LinearRing.difference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing.disjoint

Returns true iff the geometries are disjoint.

UsageReturns
LinearRing.disjoint(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing.dissolve

Returns the union of the geometry. This leaves single geometries untouched, and unions multi geometries.

UsageReturns
LinearRing.dissolve(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to union.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the union will be performed in this projection. Otherwise it will be performed in a spherical coordinate system.

ee.Geometry.LinearRing.distance

Returns the minimum distance between two geometries.

UsageReturns
LinearRing.distance(right, maxError, proj)Float
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing.edgesAreGeodesics

Returns true if the geometry edges, if any, are geodesics along a spherical model of the earth; if false, any edges are straight lines in the projection.

UsageReturns
LinearRing.edgesAreGeodesics()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LinearRing.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
LinearRing.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Geometry.LinearRing.geodesic

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth.

UsageReturns
LinearRing.geodesic()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LinearRing.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

UsageReturns
LinearRing.geometries()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LinearRing.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
LinearRing.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Geometry.LinearRing.intersection

Returns the intersection of the two geometries.

UsageReturns
LinearRing.intersection(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing.intersects

Returns true iff the geometries intersect.

UsageReturns
LinearRing.intersects(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing.isUnbounded

Returns whether the geometry is unbounded.

UsageReturns
LinearRing.isUnbounded()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LinearRing.length

Returns the length of the linear parts of the geometry. Polygonal parts are ignored. The length of multi geometries is the sum of the lengths of their components.

UsageReturns
LinearRing.length(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.LinearRing.perimeter

Returns the length of the perimeter of the polygonal parts of the geometry. The perimeter of multi geometries is the sum of the perimeters of their components.

UsageReturns
LinearRing.perimeter(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.LinearRing.projection

Returns the projection of the geometry.

UsageReturns
LinearRing.projection()Projection
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LinearRing.serialize

Returns the serialized representation of this object.

UsageReturns
LinearRing.serialize()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.LinearRing.simplify

Simplifies the geometry to within a given error margin. Note that this does not respect the error margin requested by the consumer of this algorithm, unless maxError is explicitly specified to be null.

This overrides the default Earth Engine policy for propagating error margins, so regardless of the geometry accuracy requested from the output, the inputs will be requested with the error margin specified in the arguments to this algorithm. This results in consistent rendering at all zoom levels of a rendered vector map, but at lower zoom levels (i.e. zoomed out), the geometry won't be simplified, which may harm performance.

UsageReturns
LinearRing.simplify(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to simplify.

maxErrorErrorMargin

The maximum amount of error by which the result may differ from the input.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in the same projection as the input. If the error margin is in projected units, the margin will be interpreted as units of this projection

ee.Geometry.LinearRing.symmetricDifference

Returns the symmetric difference between two geometries.

UsageReturns
LinearRing.symmetricDifference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing.toGeoJSON

Returns a GeoJSON representation of the geometry.

UsageReturns
LinearRing.toGeoJSON()GeoJSONGeometry
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.LinearRing.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

UsageReturns
LinearRing.toGeoJSONString()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.LinearRing.transform

Transforms the geometry to a specific projection.

UsageReturns
LinearRing.transform(proj, maxError)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to reproject.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Geometry.LinearRing.type

Returns the GeoJSON type of the geometry.

UsageReturns
LinearRing.type()String
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.LinearRing.union

Returns the union of the two geometries.

UsageReturns
LinearRing.union(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.LinearRing.withinDistance

Returns true iff the geometries are within a specified distance.

UsageReturns
LinearRing.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString

Constructs an ee.Geometry describing a MultiLineString.

For convenience, varargs may be used when all arguments are numbers. This allows creating geodesic EPSG:4326 MultiLineStrings with a single LineString, given an even number of arguments, e.g. ee.Geometry.MultiLineString(aLng, aLat, bLng, bLat, ...).

UsageReturns
ee.Geometry.MultiLineString(coords, proj, geodesic, maxError)Geometry.MultiLineString
ArgumentTypeDetails
coordsList

A list of linestrings. May be a list of coordinates in the GeoJSON

'MultiLineString' format, a list of at least two ee.Geometry describing a LineString, or a list of number defining a single linestring.

projProjection, optional

The projection of this geometry. If unspecified, the default is the projection of the input ee.Geometry, or EPSG:4326 if there are no ee.Geometry inputs.

geodesicBoolean, optional

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

maxErrorErrorMargin, optional

Max error when input geometry must be reprojected to an explicitly requested result projection or geodesic state.

ee.Geometry.MultiLineString.area

Returns the area of the geometry. Area of points and line strings is 0, and the area of multi geometries is the sum of the areas of their componenets (intersecting areas are counted multiple times).

UsageReturns
MultiLineString.area(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The geometry input.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

ee.Geometry.MultiLineString.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
MultiLineString.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Geometry.MultiLineString.bounds

Returns the bounding rectangle of the geometry.

UsageReturns
MultiLineString.bounds(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Return the bounding box of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.MultiLineString.buffer

Returns the input buffered by a given distance. If the distance is positive, the geometry is expanded, and if the distance is negative, the geometry is contracted.

UsageReturns
MultiLineString.buffer(distance, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry being buffered.

distanceFloat

The distance of the buffering, which may be negative. If no projection is specified, the unit is meters. Otherwise the unit is in the coordinate system of the projection.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when approximating the buffering circle and performing any necessary reprojection. If unspecified, defaults to 1% of the distance.

projProjection, default: null

If specified, the buffering will be performed in this projection and the distance will be interpreted as units of the coordinate system of this projection. Otherwise the distance is interpereted as meters and the buffering is performed in a spherical coordinate system.

ee.Geometry.MultiLineString.centroid

Returns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.

UsageReturns
MultiLineString.centroid(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the centroid of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.MultiLineString.containedIn

Returns true iff one geometry is contained in the other.

UsageReturns
MultiLineString.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString.contains

Returns true iff one geometry contains the other.

UsageReturns
MultiLineString.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString.convexHull

Returns the convex hull of the given geometry. The convex hull of a single point is the point itself, the convex hull of collinear points is a line, and the convex hull of everything else is a polygon. Note that a degenerate polygon with all vertices on the same line will result in a line segment.

UsageReturns
MultiLineString.convexHull(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the convex hull of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString.coordinates

Returns a GeoJSON-style list of the geometry's coordinates.

UsageReturns
MultiLineString.coordinates()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiLineString.cutLines

Converts LineStrings into a MultiLineString by cutting it in two at each distance along the length of the LineString.

UsageReturns
MultiLineString.cutLines(distances, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Cuts the lines of this geometry.

distancesList

Distances along each LineString to cut the line into separate pieces, measured in units of the given proj, or meters if proj is unspecified.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

Projection of the result and distance measurements, or WGS84 if unspecified.

ee.Geometry.MultiLineString.difference

Returns the result of subtracting the 'right' geometry from the 'left' geometry.

UsageReturns
MultiLineString.difference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString.disjoint

Returns true iff the geometries are disjoint.

UsageReturns
MultiLineString.disjoint(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString.dissolve

Returns the union of the geometry. This leaves single geometries untouched, and unions multi geometries.

UsageReturns
MultiLineString.dissolve(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to union.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the union will be performed in this projection. Otherwise it will be performed in a spherical coordinate system.

ee.Geometry.MultiLineString.distance

Returns the minimum distance between two geometries.

UsageReturns
MultiLineString.distance(right, maxError, proj)Float
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString.edgesAreGeodesics

Returns true if the geometry edges, if any, are geodesics along a spherical model of the earth; if false, any edges are straight lines in the projection.

UsageReturns
MultiLineString.edgesAreGeodesics()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiLineString.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
MultiLineString.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Geometry.MultiLineString.geodesic

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth.

UsageReturns
MultiLineString.geodesic()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiLineString.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

UsageReturns
MultiLineString.geometries()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiLineString.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
MultiLineString.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Geometry.MultiLineString.intersection

Returns the intersection of the two geometries.

UsageReturns
MultiLineString.intersection(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString.intersects

Returns true iff the geometries intersect.

UsageReturns
MultiLineString.intersects(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString.isUnbounded

Returns whether the geometry is unbounded.

UsageReturns
MultiLineString.isUnbounded()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiLineString.length

Returns the length of the linear parts of the geometry. Polygonal parts are ignored. The length of multi geometries is the sum of the lengths of their components.

UsageReturns
MultiLineString.length(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.MultiLineString.perimeter

Returns the length of the perimeter of the polygonal parts of the geometry. The perimeter of multi geometries is the sum of the perimeters of their components.

UsageReturns
MultiLineString.perimeter(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.MultiLineString.projection

Returns the projection of the geometry.

UsageReturns
MultiLineString.projection()Projection
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiLineString.serialize

Returns the serialized representation of this object.

UsageReturns
MultiLineString.serialize()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.MultiLineString.simplify

Simplifies the geometry to within a given error margin. Note that this does not respect the error margin requested by the consumer of this algorithm, unless maxError is explicitly specified to be null.

This overrides the default Earth Engine policy for propagating error margins, so regardless of the geometry accuracy requested from the output, the inputs will be requested with the error margin specified in the arguments to this algorithm. This results in consistent rendering at all zoom levels of a rendered vector map, but at lower zoom levels (i.e. zoomed out), the geometry won't be simplified, which may harm performance.

UsageReturns
MultiLineString.simplify(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to simplify.

maxErrorErrorMargin

The maximum amount of error by which the result may differ from the input.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in the same projection as the input. If the error margin is in projected units, the margin will be interpreted as units of this projection

ee.Geometry.MultiLineString.symmetricDifference

Returns the symmetric difference between two geometries.

UsageReturns
MultiLineString.symmetricDifference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString.toGeoJSON

Returns a GeoJSON representation of the geometry.

UsageReturns
MultiLineString.toGeoJSON()GeoJSONGeometry
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.MultiLineString.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

UsageReturns
MultiLineString.toGeoJSONString()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.MultiLineString.transform

Transforms the geometry to a specific projection.

UsageReturns
MultiLineString.transform(proj, maxError)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to reproject.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Geometry.MultiLineString.type

Returns the GeoJSON type of the geometry.

UsageReturns
MultiLineString.type()String
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiLineString.union

Returns the union of the two geometries.

UsageReturns
MultiLineString.union(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiLineString.withinDistance

Returns true iff the geometries are within a specified distance.

UsageReturns
MultiLineString.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint

Constructs an ee.Geometry describing a MultiPoint.

For convenience, varargs may be used when all arguments are numbers. This allows creating EPSG:4326 MultiPoints given an even number of arguments, e.g. ee.Geometry.MultiPoint(aLng, aLat, bLng, bLat, ...).

UsageReturns
ee.Geometry.MultiPoint(coords, proj)Geometry.MultiPoint
ArgumentTypeDetails
coordsList

A list of points, each in the GeoJSON 'coordinates' format of a Point, or a list of the x,y coordinates in the given projection, or an ee.Geometry describing a point.

projProjection, optional

The projection of this geometry. If unspecified, the default is the projection of the input ee.Geometry, or EPSG:4326 if there are no ee.Geometry inputs.

ee.Geometry.MultiPoint.area

Returns the area of the geometry. Area of points and line strings is 0, and the area of multi geometries is the sum of the areas of their componenets (intersecting areas are counted multiple times).

UsageReturns
MultiPoint.area(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The geometry input.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

ee.Geometry.MultiPoint.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
MultiPoint.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Geometry.MultiPoint.bounds

Returns the bounding rectangle of the geometry.

UsageReturns
MultiPoint.bounds(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Return the bounding box of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.MultiPoint.buffer

Returns the input buffered by a given distance. If the distance is positive, the geometry is expanded, and if the distance is negative, the geometry is contracted.

UsageReturns
MultiPoint.buffer(distance, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry being buffered.

distanceFloat

The distance of the buffering, which may be negative. If no projection is specified, the unit is meters. Otherwise the unit is in the coordinate system of the projection.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when approximating the buffering circle and performing any necessary reprojection. If unspecified, defaults to 1% of the distance.

projProjection, default: null

If specified, the buffering will be performed in this projection and the distance will be interpreted as units of the coordinate system of this projection. Otherwise the distance is interpereted as meters and the buffering is performed in a spherical coordinate system.

ee.Geometry.MultiPoint.centroid

Returns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.

UsageReturns
MultiPoint.centroid(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the centroid of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.MultiPoint.containedIn

Returns true iff one geometry is contained in the other.

UsageReturns
MultiPoint.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint.contains

Returns true iff one geometry contains the other.

UsageReturns
MultiPoint.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint.convexHull

Returns the convex hull of the given geometry. The convex hull of a single point is the point itself, the convex hull of collinear points is a line, and the convex hull of everything else is a polygon. Note that a degenerate polygon with all vertices on the same line will result in a line segment.

UsageReturns
MultiPoint.convexHull(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the convex hull of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint.coordinates

Returns a GeoJSON-style list of the geometry's coordinates.

UsageReturns
MultiPoint.coordinates()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPoint.cutLines

Converts LineStrings into a MultiLineString by cutting it in two at each distance along the length of the LineString.

UsageReturns
MultiPoint.cutLines(distances, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Cuts the lines of this geometry.

distancesList

Distances along each LineString to cut the line into separate pieces, measured in units of the given proj, or meters if proj is unspecified.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

Projection of the result and distance measurements, or WGS84 if unspecified.

ee.Geometry.MultiPoint.difference

Returns the result of subtracting the 'right' geometry from the 'left' geometry.

UsageReturns
MultiPoint.difference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint.disjoint

Returns true iff the geometries are disjoint.

UsageReturns
MultiPoint.disjoint(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint.dissolve

Returns the union of the geometry. This leaves single geometries untouched, and unions multi geometries.

UsageReturns
MultiPoint.dissolve(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to union.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the union will be performed in this projection. Otherwise it will be performed in a spherical coordinate system.

ee.Geometry.MultiPoint.distance

Returns the minimum distance between two geometries.

UsageReturns
MultiPoint.distance(right, maxError, proj)Float
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint.edgesAreGeodesics

Returns true if the geometry edges, if any, are geodesics along a spherical model of the earth; if false, any edges are straight lines in the projection.

UsageReturns
MultiPoint.edgesAreGeodesics()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPoint.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
MultiPoint.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Geometry.MultiPoint.geodesic

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth.

UsageReturns
MultiPoint.geodesic()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPoint.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

UsageReturns
MultiPoint.geometries()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPoint.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
MultiPoint.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Geometry.MultiPoint.intersection

Returns the intersection of the two geometries.

UsageReturns
MultiPoint.intersection(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint.intersects

Returns true iff the geometries intersect.

UsageReturns
MultiPoint.intersects(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint.isUnbounded

Returns whether the geometry is unbounded.

UsageReturns
MultiPoint.isUnbounded()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPoint.length

Returns the length of the linear parts of the geometry. Polygonal parts are ignored. The length of multi geometries is the sum of the lengths of their components.

UsageReturns
MultiPoint.length(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.MultiPoint.perimeter

Returns the length of the perimeter of the polygonal parts of the geometry. The perimeter of multi geometries is the sum of the perimeters of their components.

UsageReturns
MultiPoint.perimeter(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.MultiPoint.projection

Returns the projection of the geometry.

UsageReturns
MultiPoint.projection()Projection
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPoint.serialize

Returns the serialized representation of this object.

UsageReturns
MultiPoint.serialize()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.MultiPoint.simplify

Simplifies the geometry to within a given error margin. Note that this does not respect the error margin requested by the consumer of this algorithm, unless maxError is explicitly specified to be null.

This overrides the default Earth Engine policy for propagating error margins, so regardless of the geometry accuracy requested from the output, the inputs will be requested with the error margin specified in the arguments to this algorithm. This results in consistent rendering at all zoom levels of a rendered vector map, but at lower zoom levels (i.e. zoomed out), the geometry won't be simplified, which may harm performance.

UsageReturns
MultiPoint.simplify(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to simplify.

maxErrorErrorMargin

The maximum amount of error by which the result may differ from the input.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in the same projection as the input. If the error margin is in projected units, the margin will be interpreted as units of this projection

ee.Geometry.MultiPoint.symmetricDifference

Returns the symmetric difference between two geometries.

UsageReturns
MultiPoint.symmetricDifference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint.toGeoJSON

Returns a GeoJSON representation of the geometry.

UsageReturns
MultiPoint.toGeoJSON()GeoJSONGeometry
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.MultiPoint.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

UsageReturns
MultiPoint.toGeoJSONString()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.MultiPoint.transform

Transforms the geometry to a specific projection.

UsageReturns
MultiPoint.transform(proj, maxError)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to reproject.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Geometry.MultiPoint.type

Returns the GeoJSON type of the geometry.

UsageReturns
MultiPoint.type()String
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPoint.union

Returns the union of the two geometries.

UsageReturns
MultiPoint.union(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPoint.withinDistance

Returns true iff the geometries are within a specified distance.

UsageReturns
MultiPoint.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon

Constructs an ee.Geometry describing a MultiPolygon.

For convenience, varargs may be used when all arguments are numbers. This allows creating geodesic EPSG:4326 MultiPolygons with a single Polygon with a single LinearRing given an even number of arguments, e.g. ee.Geometry.MultiPolygon(aLng, aLat, bLng, bLat, ..., aLng, aLat).

UsageReturns
ee.Geometry.MultiPolygon(coords, proj, geodesic, maxError, evenOdd)Geometry.MultiPolygon
ArgumentTypeDetails
coordsList

A list of polygons. May be a list of coordinates in the GeoJSON

'MultiPolygon' format, a list of ee.Geometry describing a Polygon, or a list of number defining a single polygon boundary.

projProjection, optional

The projection of this geometry. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesicBoolean, optional

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

maxErrorErrorMargin, optional

Max error when input geometry must be reprojected to an explicitly requested result projection or geodesic state.

evenOddBoolean, optional

If true, polygon interiors will be determined by the even/odd rule, where a point is inside if it crosses an odd number of edges to reach a point at infinity. Otherwise polygons use the left- inside rule, where interiors are on the left side of the shell's edges when walking the vertices in the given order. If unspecified, defaults to true.

ee.Geometry.MultiPolygon.area

Returns the area of the geometry. Area of points and line strings is 0, and the area of multi geometries is the sum of the areas of their componenets (intersecting areas are counted multiple times).

UsageReturns
MultiPolygon.area(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The geometry input.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

ee.Geometry.MultiPolygon.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
MultiPolygon.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Geometry.MultiPolygon.bounds

Returns the bounding rectangle of the geometry.

UsageReturns
MultiPolygon.bounds(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Return the bounding box of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.MultiPolygon.buffer

Returns the input buffered by a given distance. If the distance is positive, the geometry is expanded, and if the distance is negative, the geometry is contracted.

UsageReturns
MultiPolygon.buffer(distance, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry being buffered.

distanceFloat

The distance of the buffering, which may be negative. If no projection is specified, the unit is meters. Otherwise the unit is in the coordinate system of the projection.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when approximating the buffering circle and performing any necessary reprojection. If unspecified, defaults to 1% of the distance.

projProjection, default: null

If specified, the buffering will be performed in this projection and the distance will be interpreted as units of the coordinate system of this projection. Otherwise the distance is interpereted as meters and the buffering is performed in a spherical coordinate system.

ee.Geometry.MultiPolygon.centroid

Returns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.

UsageReturns
MultiPolygon.centroid(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the centroid of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.MultiPolygon.containedIn

Returns true iff one geometry is contained in the other.

UsageReturns
MultiPolygon.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon.contains

Returns true iff one geometry contains the other.

UsageReturns
MultiPolygon.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon.convexHull

Returns the convex hull of the given geometry. The convex hull of a single point is the point itself, the convex hull of collinear points is a line, and the convex hull of everything else is a polygon. Note that a degenerate polygon with all vertices on the same line will result in a line segment.

UsageReturns
MultiPolygon.convexHull(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the convex hull of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon.coordinates

Returns a GeoJSON-style list of the geometry's coordinates.

UsageReturns
MultiPolygon.coordinates()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPolygon.cutLines

Converts LineStrings into a MultiLineString by cutting it in two at each distance along the length of the LineString.

UsageReturns
MultiPolygon.cutLines(distances, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Cuts the lines of this geometry.

distancesList

Distances along each LineString to cut the line into separate pieces, measured in units of the given proj, or meters if proj is unspecified.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

Projection of the result and distance measurements, or WGS84 if unspecified.

ee.Geometry.MultiPolygon.difference

Returns the result of subtracting the 'right' geometry from the 'left' geometry.

UsageReturns
MultiPolygon.difference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon.disjoint

Returns true iff the geometries are disjoint.

UsageReturns
MultiPolygon.disjoint(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon.dissolve

Returns the union of the geometry. This leaves single geometries untouched, and unions multi geometries.

UsageReturns
MultiPolygon.dissolve(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to union.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the union will be performed in this projection. Otherwise it will be performed in a spherical coordinate system.

ee.Geometry.MultiPolygon.distance

Returns the minimum distance between two geometries.

UsageReturns
MultiPolygon.distance(right, maxError, proj)Float
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon.edgesAreGeodesics

Returns true if the geometry edges, if any, are geodesics along a spherical model of the earth; if false, any edges are straight lines in the projection.

UsageReturns
MultiPolygon.edgesAreGeodesics()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPolygon.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
MultiPolygon.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Geometry.MultiPolygon.geodesic

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth.

UsageReturns
MultiPolygon.geodesic()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPolygon.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

UsageReturns
MultiPolygon.geometries()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPolygon.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
MultiPolygon.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Geometry.MultiPolygon.intersection

Returns the intersection of the two geometries.

UsageReturns
MultiPolygon.intersection(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon.intersects

Returns true iff the geometries intersect.

UsageReturns
MultiPolygon.intersects(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon.isUnbounded

Returns whether the geometry is unbounded.

UsageReturns
MultiPolygon.isUnbounded()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPolygon.length

Returns the length of the linear parts of the geometry. Polygonal parts are ignored. The length of multi geometries is the sum of the lengths of their components.

UsageReturns
MultiPolygon.length(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.MultiPolygon.perimeter

Returns the length of the perimeter of the polygonal parts of the geometry. The perimeter of multi geometries is the sum of the perimeters of their components.

UsageReturns
MultiPolygon.perimeter(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.MultiPolygon.projection

Returns the projection of the geometry.

UsageReturns
MultiPolygon.projection()Projection
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPolygon.serialize

Returns the serialized representation of this object.

UsageReturns
MultiPolygon.serialize()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.MultiPolygon.simplify

Simplifies the geometry to within a given error margin. Note that this does not respect the error margin requested by the consumer of this algorithm, unless maxError is explicitly specified to be null.

This overrides the default Earth Engine policy for propagating error margins, so regardless of the geometry accuracy requested from the output, the inputs will be requested with the error margin specified in the arguments to this algorithm. This results in consistent rendering at all zoom levels of a rendered vector map, but at lower zoom levels (i.e. zoomed out), the geometry won't be simplified, which may harm performance.

UsageReturns
MultiPolygon.simplify(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to simplify.

maxErrorErrorMargin

The maximum amount of error by which the result may differ from the input.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in the same projection as the input. If the error margin is in projected units, the margin will be interpreted as units of this projection

ee.Geometry.MultiPolygon.symmetricDifference

Returns the symmetric difference between two geometries.

UsageReturns
MultiPolygon.symmetricDifference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon.toGeoJSON

Returns a GeoJSON representation of the geometry.

UsageReturns
MultiPolygon.toGeoJSON()GeoJSONGeometry
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.MultiPolygon.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

UsageReturns
MultiPolygon.toGeoJSONString()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.MultiPolygon.transform

Transforms the geometry to a specific projection.

UsageReturns
MultiPolygon.transform(proj, maxError)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to reproject.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Geometry.MultiPolygon.type

Returns the GeoJSON type of the geometry.

UsageReturns
MultiPolygon.type()String
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.MultiPolygon.union

Returns the union of the two geometries.

UsageReturns
MultiPolygon.union(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.MultiPolygon.withinDistance

Returns true iff the geometries are within a specified distance.

UsageReturns
MultiPolygon.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point

Constructs an ee.Geometry describing a point.

For convenience, varargs may be used when all arguments are numbers. This allows creating EPSG:4326 points, e.g. ee.Geometry.Point(lng, lat).

UsageReturns
ee.Geometry.Point(coords, proj)Geometry.Point
ArgumentTypeDetails
coordsList

A list of two [x,y] coordinates in the given projection.

projProjection, optional

The projection of this geometry, or EPSG:4326 if unspecified.

ee.Geometry.Point.area

Returns the area of the geometry. Area of points and line strings is 0, and the area of multi geometries is the sum of the areas of their componenets (intersecting areas are counted multiple times).

UsageReturns
Point.area(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The geometry input.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

ee.Geometry.Point.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
Point.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Geometry.Point.bounds

Returns the bounding rectangle of the geometry.

UsageReturns
Point.bounds(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Return the bounding box of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.Point.buffer

Returns the input buffered by a given distance. If the distance is positive, the geometry is expanded, and if the distance is negative, the geometry is contracted.

UsageReturns
Point.buffer(distance, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry being buffered.

distanceFloat

The distance of the buffering, which may be negative. If no projection is specified, the unit is meters. Otherwise the unit is in the coordinate system of the projection.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when approximating the buffering circle and performing any necessary reprojection. If unspecified, defaults to 1% of the distance.

projProjection, default: null

If specified, the buffering will be performed in this projection and the distance will be interpreted as units of the coordinate system of this projection. Otherwise the distance is interpereted as meters and the buffering is performed in a spherical coordinate system.

ee.Geometry.Point.centroid

Returns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.

UsageReturns
Point.centroid(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the centroid of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.Point.containedIn

Returns true iff one geometry is contained in the other.

UsageReturns
Point.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point.contains

Returns true iff one geometry contains the other.

UsageReturns
Point.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point.convexHull

Returns the convex hull of the given geometry. The convex hull of a single point is the point itself, the convex hull of collinear points is a line, and the convex hull of everything else is a polygon. Note that a degenerate polygon with all vertices on the same line will result in a line segment.

UsageReturns
Point.convexHull(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the convex hull of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point.coordinates

Returns a GeoJSON-style list of the geometry's coordinates.

UsageReturns
Point.coordinates()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Point.cutLines

Converts LineStrings into a MultiLineString by cutting it in two at each distance along the length of the LineString.

UsageReturns
Point.cutLines(distances, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Cuts the lines of this geometry.

distancesList

Distances along each LineString to cut the line into separate pieces, measured in units of the given proj, or meters if proj is unspecified.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

Projection of the result and distance measurements, or WGS84 if unspecified.

ee.Geometry.Point.difference

Returns the result of subtracting the 'right' geometry from the 'left' geometry.

UsageReturns
Point.difference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point.disjoint

Returns true iff the geometries are disjoint.

UsageReturns
Point.disjoint(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point.dissolve

Returns the union of the geometry. This leaves single geometries untouched, and unions multi geometries.

UsageReturns
Point.dissolve(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to union.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the union will be performed in this projection. Otherwise it will be performed in a spherical coordinate system.

ee.Geometry.Point.distance

Returns the minimum distance between two geometries.

UsageReturns
Point.distance(right, maxError, proj)Float
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point.edgesAreGeodesics

Returns true if the geometry edges, if any, are geodesics along a spherical model of the earth; if false, any edges are straight lines in the projection.

UsageReturns
Point.edgesAreGeodesics()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Point.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
Point.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Geometry.Point.geodesic

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth.

UsageReturns
Point.geodesic()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Point.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

UsageReturns
Point.geometries()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Point.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
Point.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Geometry.Point.intersection

Returns the intersection of the two geometries.

UsageReturns
Point.intersection(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point.intersects

Returns true iff the geometries intersect.

UsageReturns
Point.intersects(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point.isUnbounded

Returns whether the geometry is unbounded.

UsageReturns
Point.isUnbounded()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Point.length

Returns the length of the linear parts of the geometry. Polygonal parts are ignored. The length of multi geometries is the sum of the lengths of their components.

UsageReturns
Point.length(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.Point.perimeter

Returns the length of the perimeter of the polygonal parts of the geometry. The perimeter of multi geometries is the sum of the perimeters of their components.

UsageReturns
Point.perimeter(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.Point.projection

Returns the projection of the geometry.

UsageReturns
Point.projection()Projection
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Point.serialize

Returns the serialized representation of this object.

UsageReturns
Point.serialize()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.Point.simplify

Simplifies the geometry to within a given error margin. Note that this does not respect the error margin requested by the consumer of this algorithm, unless maxError is explicitly specified to be null.

This overrides the default Earth Engine policy for propagating error margins, so regardless of the geometry accuracy requested from the output, the inputs will be requested with the error margin specified in the arguments to this algorithm. This results in consistent rendering at all zoom levels of a rendered vector map, but at lower zoom levels (i.e. zoomed out), the geometry won't be simplified, which may harm performance.

UsageReturns
Point.simplify(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to simplify.

maxErrorErrorMargin

The maximum amount of error by which the result may differ from the input.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in the same projection as the input. If the error margin is in projected units, the margin will be interpreted as units of this projection

ee.Geometry.Point.symmetricDifference

Returns the symmetric difference between two geometries.

UsageReturns
Point.symmetricDifference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point.toGeoJSON

Returns a GeoJSON representation of the geometry.

UsageReturns
Point.toGeoJSON()GeoJSONGeometry
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.Point.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

UsageReturns
Point.toGeoJSONString()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.Point.transform

Transforms the geometry to a specific projection.

UsageReturns
Point.transform(proj, maxError)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to reproject.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Geometry.Point.type

Returns the GeoJSON type of the geometry.

UsageReturns
Point.type()String
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Point.union

Returns the union of the two geometries.

UsageReturns
Point.union(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Point.withinDistance

Returns true iff the geometries are within a specified distance.

UsageReturns
Point.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon

Constructs an ee.Geometry describing a polygon.

For convenience, varargs may be used when all arguments are numbers. This allows creating geodesic EPSG:4326 Polygons with a single LinearRing given an even number of arguments, e.g. ee.Geometry.Polygon(aLng, aLat, bLng, bLat, ..., aLng, aLat).

UsageReturns
ee.Geometry.Polygon(coords, proj, geodesic, maxError, evenOdd)Geometry.Polygon
ArgumentTypeDetails
coordsList

A list of rings defining the boundaries of the polygon. May be a list of coordinates in the GeoJSON 'Polygon' format, a list of ee.Geometry describing a LinearRing, or a list of number defining a single polygon boundary.

projProjection, optional

The projection of this geometry. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesicBoolean, optional

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

maxErrorErrorMargin, optional

Max error when input geometry must be reprojected to an explicitly requested result projection or geodesic state.

evenOddBoolean, optional

If true, polygon interiors will be determined by the even/odd rule, where a point is inside if it crosses an odd number of edges to reach a point at infinity. Otherwise polygons use the left- inside rule, where interiors are on the left side of the shell's edges when walking the vertices in the given order. If unspecified, defaults to true.

ee.Geometry.Polygon.area

Returns the area of the geometry. Area of points and line strings is 0, and the area of multi geometries is the sum of the areas of their componenets (intersecting areas are counted multiple times).

UsageReturns
Polygon.area(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The geometry input.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

ee.Geometry.Polygon.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
Polygon.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Geometry.Polygon.bounds

Returns the bounding rectangle of the geometry.

UsageReturns
Polygon.bounds(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Return the bounding box of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.Polygon.buffer

Returns the input buffered by a given distance. If the distance is positive, the geometry is expanded, and if the distance is negative, the geometry is contracted.

UsageReturns
Polygon.buffer(distance, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry being buffered.

distanceFloat

The distance of the buffering, which may be negative. If no projection is specified, the unit is meters. Otherwise the unit is in the coordinate system of the projection.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when approximating the buffering circle and performing any necessary reprojection. If unspecified, defaults to 1% of the distance.

projProjection, default: null

If specified, the buffering will be performed in this projection and the distance will be interpreted as units of the coordinate system of this projection. Otherwise the distance is interpereted as meters and the buffering is performed in a spherical coordinate system.

ee.Geometry.Polygon.centroid

Returns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.

UsageReturns
Polygon.centroid(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the centroid of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.Polygon.containedIn

Returns true iff one geometry is contained in the other.

UsageReturns
Polygon.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon.contains

Returns true iff one geometry contains the other.

UsageReturns
Polygon.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon.convexHull

Returns the convex hull of the given geometry. The convex hull of a single point is the point itself, the convex hull of collinear points is a line, and the convex hull of everything else is a polygon. Note that a degenerate polygon with all vertices on the same line will result in a line segment.

UsageReturns
Polygon.convexHull(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the convex hull of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon.coordinates

Returns a GeoJSON-style list of the geometry's coordinates.

UsageReturns
Polygon.coordinates()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Polygon.cutLines

Converts LineStrings into a MultiLineString by cutting it in two at each distance along the length of the LineString.

UsageReturns
Polygon.cutLines(distances, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Cuts the lines of this geometry.

distancesList

Distances along each LineString to cut the line into separate pieces, measured in units of the given proj, or meters if proj is unspecified.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

Projection of the result and distance measurements, or WGS84 if unspecified.

ee.Geometry.Polygon.difference

Returns the result of subtracting the 'right' geometry from the 'left' geometry.

UsageReturns
Polygon.difference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon.disjoint

Returns true iff the geometries are disjoint.

UsageReturns
Polygon.disjoint(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon.dissolve

Returns the union of the geometry. This leaves single geometries untouched, and unions multi geometries.

UsageReturns
Polygon.dissolve(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to union.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the union will be performed in this projection. Otherwise it will be performed in a spherical coordinate system.

ee.Geometry.Polygon.distance

Returns the minimum distance between two geometries.

UsageReturns
Polygon.distance(right, maxError, proj)Float
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon.edgesAreGeodesics

Returns true if the geometry edges, if any, are geodesics along a spherical model of the earth; if false, any edges are straight lines in the projection.

UsageReturns
Polygon.edgesAreGeodesics()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Polygon.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
Polygon.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Geometry.Polygon.geodesic

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth.

UsageReturns
Polygon.geodesic()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Polygon.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

UsageReturns
Polygon.geometries()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Polygon.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
Polygon.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Geometry.Polygon.intersection

Returns the intersection of the two geometries.

UsageReturns
Polygon.intersection(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon.intersects

Returns true iff the geometries intersect.

UsageReturns
Polygon.intersects(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon.isUnbounded

Returns whether the geometry is unbounded.

UsageReturns
Polygon.isUnbounded()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Polygon.length

Returns the length of the linear parts of the geometry. Polygonal parts are ignored. The length of multi geometries is the sum of the lengths of their components.

UsageReturns
Polygon.length(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.Polygon.perimeter

Returns the length of the perimeter of the polygonal parts of the geometry. The perimeter of multi geometries is the sum of the perimeters of their components.

UsageReturns
Polygon.perimeter(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.Polygon.projection

Returns the projection of the geometry.

UsageReturns
Polygon.projection()Projection
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Polygon.serialize

Returns the serialized representation of this object.

UsageReturns
Polygon.serialize()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.Polygon.simplify

Simplifies the geometry to within a given error margin. Note that this does not respect the error margin requested by the consumer of this algorithm, unless maxError is explicitly specified to be null.

This overrides the default Earth Engine policy for propagating error margins, so regardless of the geometry accuracy requested from the output, the inputs will be requested with the error margin specified in the arguments to this algorithm. This results in consistent rendering at all zoom levels of a rendered vector map, but at lower zoom levels (i.e. zoomed out), the geometry won't be simplified, which may harm performance.

UsageReturns
Polygon.simplify(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to simplify.

maxErrorErrorMargin

The maximum amount of error by which the result may differ from the input.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in the same projection as the input. If the error margin is in projected units, the margin will be interpreted as units of this projection

ee.Geometry.Polygon.symmetricDifference

Returns the symmetric difference between two geometries.

UsageReturns
Polygon.symmetricDifference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon.toGeoJSON

Returns a GeoJSON representation of the geometry.

UsageReturns
Polygon.toGeoJSON()GeoJSONGeometry
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.Polygon.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

UsageReturns
Polygon.toGeoJSONString()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.Polygon.transform

Transforms the geometry to a specific projection.

UsageReturns
Polygon.transform(proj, maxError)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to reproject.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Geometry.Polygon.type

Returns the GeoJSON type of the geometry.

UsageReturns
Polygon.type()String
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Polygon.union

Returns the union of the two geometries.

UsageReturns
Polygon.union(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Polygon.withinDistance

Returns true iff the geometries are within a specified distance.

UsageReturns
Polygon.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle

Constructs an ee.Geometry describing a rectangular polygon.

For convenience, varargs may be used when all arguments are numbers. This allows creating EPSG:4326 Polygons given exactly four coordinates, e.g. ee.Geometry.Rectangle(minLng, minLat, maxLng, maxLat).

UsageReturns
ee.Geometry.Rectangle(coords, proj, geodesic, evenOdd)Geometry.Rectangle
ArgumentTypeDetails
coordsList

The minimum and maximum corners of the rectangle, as a list of two points each in the format of GeoJSON 'Point' coordinates, or a list of two ee.Geometry describing a point, or a list of four numbers in the order xMin, yMin, xMax, yMax.

projProjection, optional

The projection of this geometry. If unspecified, the default is the projection of the input ee.Geometry, or EPSG:4326 if there are no ee.Geometry inputs.

geodesicBoolean, optional

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth. The default is the geodesic state of the inputs, or true if the inputs are numbers.

evenOddBoolean, optional

If true, polygon interiors will be determined by the even/odd rule, where a point is inside if it crosses an odd number of edges to reach a point at infinity. Otherwise polygons use the left- inside rule, where interiors are on the left side of the shell's edges when walking the vertices in the given order. If unspecified, defaults to true.

ee.Geometry.Rectangle.area

Returns the area of the geometry. Area of points and line strings is 0, and the area of multi geometries is the sum of the areas of their componenets (intersecting areas are counted multiple times).

UsageReturns
Rectangle.area(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The geometry input.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

ee.Geometry.Rectangle.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
Rectangle.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Geometry.Rectangle.bounds

Returns the bounding rectangle of the geometry.

UsageReturns
Rectangle.bounds(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Return the bounding box of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.Rectangle.buffer

Returns the input buffered by a given distance. If the distance is positive, the geometry is expanded, and if the distance is negative, the geometry is contracted.

UsageReturns
Rectangle.buffer(distance, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry being buffered.

distanceFloat

The distance of the buffering, which may be negative. If no projection is specified, the unit is meters. Otherwise the unit is in the coordinate system of the projection.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when approximating the buffering circle and performing any necessary reprojection. If unspecified, defaults to 1% of the distance.

projProjection, default: null

If specified, the buffering will be performed in this projection and the distance will be interpreted as units of the coordinate system of this projection. Otherwise the distance is interpereted as meters and the buffering is performed in a spherical coordinate system.

ee.Geometry.Rectangle.centroid

Returns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.

UsageReturns
Rectangle.centroid(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the centroid of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.Rectangle.containedIn

Returns true iff one geometry is contained in the other.

UsageReturns
Rectangle.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle.contains

Returns true iff one geometry contains the other.

UsageReturns
Rectangle.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle.convexHull

Returns the convex hull of the given geometry. The convex hull of a single point is the point itself, the convex hull of collinear points is a line, and the convex hull of everything else is a polygon. Note that a degenerate polygon with all vertices on the same line will result in a line segment.

UsageReturns
Rectangle.convexHull(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the convex hull of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle.coordinates

Returns a GeoJSON-style list of the geometry's coordinates.

UsageReturns
Rectangle.coordinates()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Rectangle.cutLines

Converts LineStrings into a MultiLineString by cutting it in two at each distance along the length of the LineString.

UsageReturns
Rectangle.cutLines(distances, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Cuts the lines of this geometry.

distancesList

Distances along each LineString to cut the line into separate pieces, measured in units of the given proj, or meters if proj is unspecified.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

Projection of the result and distance measurements, or WGS84 if unspecified.

ee.Geometry.Rectangle.difference

Returns the result of subtracting the 'right' geometry from the 'left' geometry.

UsageReturns
Rectangle.difference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle.disjoint

Returns true iff the geometries are disjoint.

UsageReturns
Rectangle.disjoint(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle.dissolve

Returns the union of the geometry. This leaves single geometries untouched, and unions multi geometries.

UsageReturns
Rectangle.dissolve(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to union.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the union will be performed in this projection. Otherwise it will be performed in a spherical coordinate system.

ee.Geometry.Rectangle.distance

Returns the minimum distance between two geometries.

UsageReturns
Rectangle.distance(right, maxError, proj)Float
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle.edgesAreGeodesics

Returns true if the geometry edges, if any, are geodesics along a spherical model of the earth; if false, any edges are straight lines in the projection.

UsageReturns
Rectangle.edgesAreGeodesics()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Rectangle.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
Rectangle.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Geometry.Rectangle.geodesic

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth.

UsageReturns
Rectangle.geodesic()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Rectangle.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

UsageReturns
Rectangle.geometries()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Rectangle.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
Rectangle.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Geometry.Rectangle.intersection

Returns the intersection of the two geometries.

UsageReturns
Rectangle.intersection(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle.intersects

Returns true iff the geometries intersect.

UsageReturns
Rectangle.intersects(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle.isUnbounded

Returns whether the geometry is unbounded.

UsageReturns
Rectangle.isUnbounded()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Rectangle.length

Returns the length of the linear parts of the geometry. Polygonal parts are ignored. The length of multi geometries is the sum of the lengths of their components.

UsageReturns
Rectangle.length(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.Rectangle.perimeter

Returns the length of the perimeter of the polygonal parts of the geometry. The perimeter of multi geometries is the sum of the perimeters of their components.

UsageReturns
Rectangle.perimeter(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.Rectangle.projection

Returns the projection of the geometry.

UsageReturns
Rectangle.projection()Projection
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Rectangle.serialize

Returns the serialized representation of this object.

UsageReturns
Rectangle.serialize()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.Rectangle.simplify

Simplifies the geometry to within a given error margin. Note that this does not respect the error margin requested by the consumer of this algorithm, unless maxError is explicitly specified to be null.

This overrides the default Earth Engine policy for propagating error margins, so regardless of the geometry accuracy requested from the output, the inputs will be requested with the error margin specified in the arguments to this algorithm. This results in consistent rendering at all zoom levels of a rendered vector map, but at lower zoom levels (i.e. zoomed out), the geometry won't be simplified, which may harm performance.

UsageReturns
Rectangle.simplify(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to simplify.

maxErrorErrorMargin

The maximum amount of error by which the result may differ from the input.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in the same projection as the input. If the error margin is in projected units, the margin will be interpreted as units of this projection

ee.Geometry.Rectangle.symmetricDifference

Returns the symmetric difference between two geometries.

UsageReturns
Rectangle.symmetricDifference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle.toGeoJSON

Returns a GeoJSON representation of the geometry.

UsageReturns
Rectangle.toGeoJSON()GeoJSONGeometry
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.Rectangle.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

UsageReturns
Rectangle.toGeoJSONString()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.Rectangle.transform

Transforms the geometry to a specific projection.

UsageReturns
Rectangle.transform(proj, maxError)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to reproject.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Geometry.Rectangle.type

Returns the GeoJSON type of the geometry.

UsageReturns
Rectangle.type()String
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.Rectangle.union

Returns the union of the two geometries.

UsageReturns
Rectangle.union(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.Rectangle.withinDistance

Returns true iff the geometries are within a specified distance.

UsageReturns
Rectangle.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.area

Returns the area of the geometry. Area of points and line strings is 0, and the area of multi geometries is the sum of the areas of their componenets (intersecting areas are counted multiple times).

UsageReturns
Geometry.area(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The geometry input.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in square meters.

ee.Geometry.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
Geometry.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Geometry.bounds

Returns the bounding rectangle of the geometry.

UsageReturns
Geometry.bounds(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Return the bounding box of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.buffer

Returns the input buffered by a given distance. If the distance is positive, the geometry is expanded, and if the distance is negative, the geometry is contracted.

UsageReturns
Geometry.buffer(distance, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry being buffered.

distanceFloat

The distance of the buffering, which may be negative. If no projection is specified, the unit is meters. Otherwise the unit is in the coordinate system of the projection.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when approximating the buffering circle and performing any necessary reprojection. If unspecified, defaults to 1% of the distance.

projProjection, default: null

If specified, the buffering will be performed in this projection and the distance will be interpreted as units of the coordinate system of this projection. Otherwise the distance is interpereted as meters and the buffering is performed in a spherical coordinate system.

ee.Geometry.centroid

Returns a point at the center of the highest-dimension components of the geometry. Lower-dimensional components are ignored, so the centroid of a geometry containing two polygons, three lines and a point is equivalent to the centroid of a geometry containing just the two polygons.

UsageReturns
Geometry.centroid(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the centroid of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in WGS84.

ee.Geometry.containedIn

Returns true iff one geometry is contained in the other.

UsageReturns
Geometry.containedIn(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.contains

Returns true iff one geometry contains the other.

UsageReturns
Geometry.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.convexHull

Returns the convex hull of the given geometry. The convex hull of a single point is the point itself, the convex hull of collinear points is a line, and the convex hull of everything else is a polygon. Note that a degenerate polygon with all vertices on the same line will result in a line segment.

UsageReturns
Geometry.convexHull(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Calculates the convex hull of this geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.coordinates

Returns a GeoJSON-style list of the geometry's coordinates.

UsageReturns
Geometry.coordinates()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.cutLines

Converts LineStrings into a MultiLineString by cutting it in two at each distance along the length of the LineString.

UsageReturns
Geometry.cutLines(distances, maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

Cuts the lines of this geometry.

distancesList

Distances along each LineString to cut the line into separate pieces, measured in units of the given proj, or meters if proj is unspecified.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

Projection of the result and distance measurements, or WGS84 if unspecified.

ee.Geometry.difference

Returns the result of subtracting the 'right' geometry from the 'left' geometry.

UsageReturns
Geometry.difference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.disjoint

Returns true iff the geometries are disjoint.

UsageReturns
Geometry.disjoint(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.dissolve

Returns the union of the geometry. This leaves single geometries untouched, and unions multi geometries.

UsageReturns
Geometry.dissolve(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to union.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the union will be performed in this projection. Otherwise it will be performed in a spherical coordinate system.

ee.Geometry.distance

Returns the minimum distance between two geometries.

UsageReturns
Geometry.distance(right, maxError, proj)Float
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.edgesAreGeodesics

Returns true if the geometry edges, if any, are geodesics along a spherical model of the earth; if false, any edges are straight lines in the projection.

UsageReturns
Geometry.edgesAreGeodesics()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
Geometry.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Geometry.geodesic

If false, edges are straight in the projection. If true, edges are curved to follow the shortest path on the surface of the Earth.

UsageReturns
Geometry.geodesic()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

UsageReturns
Geometry.geometries()List
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
Geometry.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Geometry.intersection

Returns the intersection of the two geometries.

UsageReturns
Geometry.intersection(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.intersects

Returns true iff the geometries intersect.

UsageReturns
Geometry.intersects(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.isUnbounded

Returns whether the geometry is unbounded.

UsageReturns
Geometry.isUnbounded()Boolean
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.length

Returns the length of the linear parts of the geometry. Polygonal parts are ignored. The length of multi geometries is the sum of the lengths of their components.

UsageReturns
Geometry.length(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.perimeter

Returns the length of the perimeter of the polygonal parts of the geometry. The perimeter of multi geometries is the sum of the perimeters of their components.

UsageReturns
Geometry.perimeter(maxError, proj)Float
ArgumentTypeDetails
this: geometryGeometry

The input geometry.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

If specified, the result will be in the units of the coordinate system of this projection. Otherwise it will be in meters.

ee.Geometry.projection

Returns the projection of the geometry.

UsageReturns
Geometry.projection()Projection
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.serialize

Returns the serialized representation of this object.

UsageReturns
Geometry.serialize()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.simplify

Simplifies the geometry to within a given error margin. Note that this does not respect the error margin requested by the consumer of this algorithm, unless maxError is explicitly specified to be null.

This overrides the default Earth Engine policy for propagating error margins, so regardless of the geometry accuracy requested from the output, the inputs will be requested with the error margin specified in the arguments to this algorithm. This results in consistent rendering at all zoom levels of a rendered vector map, but at lower zoom levels (i.e. zoomed out), the geometry won't be simplified, which may harm performance.

UsageReturns
Geometry.simplify(maxError, proj)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to simplify.

maxErrorErrorMargin

The maximum amount of error by which the result may differ from the input.

projProjection, default: null

If specified, the result will be in this projection. Otherwise it will be in the same projection as the input. If the error margin is in projected units, the margin will be interpreted as units of this projection

ee.Geometry.symmetricDifference

Returns the symmetric difference between two geometries.

UsageReturns
Geometry.symmetricDifference(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.toGeoJSON

Returns a GeoJSON representation of the geometry.

UsageReturns
Geometry.toGeoJSON()GeoJSONGeometry
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

UsageReturns
Geometry.toGeoJSONString()String
ArgumentTypeDetails
this: geometryGeometry

The Geometry instance.

ee.Geometry.transform

Transforms the geometry to a specific projection.

UsageReturns
Geometry.transform(proj, maxError)Geometry
ArgumentTypeDetails
this: geometryGeometry

The geometry to reproject.

projProjection, optional

The target projection. Defaults to WGS84. If this has a geographic CRS, the edges of the geometry will be interpreted as geodesics. Otherwise they will be interpreted as straight lines in the projection.

maxErrorErrorMargin, default: null

The maximum projection error.

ee.Geometry.type

Returns the GeoJSON type of the geometry.

UsageReturns
Geometry.type()String
ArgumentTypeDetails
this: geometryGeometry

ee.Geometry.union

Returns the union of the two geometries.

UsageReturns
Geometry.union(right, maxError, proj)Geometry
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Geometry.withinDistance

Returns true iff the geometries are within a specified distance.

UsageReturns
Geometry.withinDistance(right, distance, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometry

The geometry used as the left operand of the operation.

rightGeometry

The geometry used as the right operand of the operation.

distanceFloat

The distance threshold. If a projection is specified, the distance is in units of that projected coordinate system, otherwise it is in meters.

maxErrorErrorMargin, default: null

The maximum amount of error tolerated when performing any necessary reprojection.

projProjection, default: null

The projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

ee.Image

An object to represent an Earth Engine image. This constructor accepts a variety of arguments:

  - A string: an EarthEngine asset id,

  - A string and a number - an EarthEngine asset id and version,

  - A number or EEArray: creates a constant image,

  - A list: creates an image out of each list element and combines them into a single image,

  - An ee.Image: returns the argument,

  - Nothing: results in an empty transparent image.

UsageReturns
ee.Image(args)Image
ArgumentTypeDetails
argsImage|List, optional

Constructor argument.

ee.Image.abs

Computes the absolute value of the input.

UsageReturns
Image.abs()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.acos

Computes the arc cosine in radians of the input.

UsageReturns
Image.acos()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.add

Adds the first value to the second for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.add(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.addBands

Returns an image containing all bands copied from the first input and selected bands from the second input, optionally overwriting bands in the first image with the same name. The new image has the metadata and footprint from the first input image.

UsageReturns
Image.addBands(srcImg, names, overwrite)Image
ArgumentTypeDetails
this: dstImgImage

An image into which to copy bands.

srcImgImage

An image containing bands to copy.

namesList, default: null

Optional list of band names to copy. If names is omitted, all bands from srcImg will be copied over.

overwriteBoolean, default: false

If true, bands from srcImg will override bands with the same names in dstImg. Otherwise the new band will be renamed with a numerical suffix ('foo' to 'foo_1' unless 'foo_1' exists, then 'foo_2' unless it exists, etc).

ee.Image.and

Returns 1 iff both values are non-zero for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is boolean.

UsageReturns
Image.and(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.arrayAccum

Accumulates elements of each array pixel along the given axis, by setting each element of the result array pixel to the reduction of elements in that pixel along the given axis, up to and including the current position on the axis. May be used to make a cumulative sum, a monotonically increasing sequence, etc.

UsageReturns
Image.arrayAccum(axis, reducer)Image
ArgumentTypeDetails
this: inputImage

Input image.

axisInteger

Axis along which to perform the cumulative sum.

reducerReducer, default: null

Reducer to accumulate values. Default is SUM, to produce the cumulative sum of each vector along the given axis.

ee.Image.arrayCat

Creates an array image by concatenating each array pixel along the given axis in each band.

UsageReturns
Image.arrayCat(image2, axis)Image
ArgumentTypeDetails
this: image1Image

First array image to concatenate.

image2Image

Second array image to concatenate.

axisInteger

Axis to concatenate along.

ee.Image.arrayDimensions

Returns the number of dimensions in each array band, and 0 for scalar image bands.

UsageReturns
Image.arrayDimensions()Image
ArgumentTypeDetails
this: inputImage

Input image.

ee.Image.arrayDotProduct

Computes the dot product of each pair of 1-D arrays in the bands of the input images.

UsageReturns
Image.arrayDotProduct(image2)Image
ArgumentTypeDetails
this: image1Image

First array image of 1-D vectors.

image2Image

Second array image of 1-D vectors.

ee.Image.arrayFlatten

Converts a single band image of equal-shape multidimensional pixels to an image of scalar pixels, with one band for each element of the array.

UsageReturns
Image.arrayFlatten(coordinateLabels, separator)Image
ArgumentTypeDetails
this: imageImage

Image of multidimensional pixels to flatten.

coordinateLabelsList

Name of each position along each axis. For example, 2x2 arrays with axes meaning 'day' and 'color' could have labels like [['monday', 'tuesday'], ['red', 'green']], resulting in band names'monday_red', 'monday_green', 'tuesday_red', and 'tuesday_green'.

separatorString, default: "_"

Separator between array labels in each band name.

ee.Image.arrayGet

For each band, an output band of the same name is created with the value at the given position extracted from the input multidimensional pixel in that band.

UsageReturns
Image.arrayGet(position)Image
ArgumentTypeDetails
this: imageImage

Array to get an element from.

positionImage

The coordinates of the element to get. There must be as many scalar bands as there are dimensions in the input image.

ee.Image.arrayLength

Returns the length of each pixel's array along the given axis.

UsageReturns
Image.arrayLength(axis)Image
ArgumentTypeDetails
this: inputImage

Input image.

axisInteger

The axis along which to take the length.

ee.Image.arrayLengths

Returns a 1D array image with the length of each array axis.

UsageReturns
Image.arrayLengths()Image
ArgumentTypeDetails
this: inputImage

Input image.

ee.Image.arrayMask

Creates an array image where each array element is masked to those where the corresonding mask position is non-zero. If the mask image has one band it will be applied to all the bands of 'input', otherwise they must have the same number of bands.

UsageReturns
Image.arrayMask(mask)Image
ArgumentTypeDetails
this: inputImage

Array image to mask.

maskImage

Array image to mask with.

ee.Image.arrayProject

Projects the array in each pixel to a lower dimensional space by specifying the axes to retain. Dropped axes must be at most length 1.

UsageReturns
Image.arrayProject(axes)Image
ArgumentTypeDetails
this: inputImage

Input image.

axesList

The axes to retain. Other axes will be discarded and must be at most length 1.

ee.Image.arrayReduce

Reduces elements of each array pixel.

UsageReturns
Image.arrayReduce(reducer, axes, fieldAxis)Image
ArgumentTypeDetails
this: inputImage

Input image.

reducerReducer

The reducer to apply

axesList

The list of array axes to reduce in each pixel. The output will have a length of 1 in all these axes.

fieldAxisInteger, default: null

The axis for the reducer's input and output fields. Only required if the reducer has multiple inputs or outputs.

ee.Image.arrayRepeat

Repeats each array pixel along the given axis. Each output pixel will have the shape of the input pixel, except length along the repeated axis, which will be multiplied by the number of copies.

UsageReturns
Image.arrayRepeat(axis, copies)Image
ArgumentTypeDetails
this: inputImage

Image of array pixels to be repeated.

axisInteger

Axis along which to repeat each pixel's array.

copiesImage

Number of copies of each pixel.

ee.Image.arraySlice

Creates a subarray by slicing out each position along the given axis from the 'start' (inclusive) to 'end' (exclusive) by increments of 'step'. The result will have as many dimensions as the input, and the same length in all directions except the slicing axis, where the length will be the number of positions from 'start' to 'end' by 'step' that are in range of the input array's length along 'axis'. This means the result can be length 0 along the given axis if start=end, or if the start or end values are entirely out of range.

UsageReturns
Image.arraySlice(axis, start, end, step)Image
ArgumentTypeDetails
this: inputImage

Input array image.

axisInteger, default: 0

Axis to subset.

startImage, default: null

The coordinate of the first slice (inclusive) along 'axis'. Negative numbers are used to position the start of slicing relative to the end of the array, where -1 starts at the last position on the axis, -2 starts at the next to last position, etc. There must one band for start indices, or one band per 'input' band. If this argument is not set or masked at some pixel, then the slice at that pixel will start at index 0.

endImage, default: null

The coordinate (exclusive) at which to stop taking slices. By default this will be the length of the given axis. Negative numbers are used to position the end of slicing relative to the end of the array, where -1 will exclude the last position, -2 will exclude the last two positions, etc. There must be one band for end indices, or one band per 'input' band. If this argument is not set or masked at some pixel, then the slice at that pixel will end just after the last index.

stepInteger, default: 1

The separation between slices along 'axis'; a slice will be taken at each whole multiple of 'step' from 'start' (inclusive) to 'end' (exclusive). Must be positive.

ee.Image.arraySort

Sorts elements of each array pixel along one axis.

UsageReturns
Image.arraySort(keys)Image
ArgumentTypeDetails
this: imageImage

Array image to sort.

keysImage, default: null

Optional keys to sort by. If not provided, the values are used as the keys. The keys can only have multiple elements along one axis, which determines the direction to sort in.

ee.Image.arrayTranspose

Transposes two dimensions of each array pixel.

UsageReturns
Image.arrayTranspose(axis1, axis2)Image
ArgumentTypeDetails
this: inputImage

Input image.

axis1Integer, default: 0

First axis to swap.

axis2Integer, default: 1

Second axis to swap.

ee.Image.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
Image.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Image.asin

Computes the arc sine in radians of the input.

UsageReturns
Image.asin()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.atan

Computes the arc tangent in radians of the input.

UsageReturns
Image.atan()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.atan2

Calculates the angle formed by the 2D vector [x, y] for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is float.

UsageReturns
Image.atan2(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.bandNames

Returns a list containing the names of the bands of an image.

UsageReturns
Image.bandNames()List
ArgumentTypeDetails
this: imageImage

The image from which to get band names.

ee.Image.bandTypes

Returns a dictionary of the image's band types.

UsageReturns
Image.bandTypes()Dictionary
ArgumentTypeDetails
this: imageImage

The image from which to get band types.

ee.Image.bitCount

Calculates the number of one-bits in the 64-bit two's complement binary representation of the input.

UsageReturns
Image.bitCount()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.bitsToArrayImage

Turns the bits of an integer into a 1-D array. The array has a lengthup to the highest 'on' bit in the input.

UsageReturns
Image.bitsToArrayImage()Image
ArgumentTypeDetails
this: inputImage

Input image.

ee.Image.bitwiseAnd

Calculates the bitwise AND of the input values for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.bitwiseAnd(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.bitwiseNot

Calculates the bitwise NOT of the input, in the smallest signed integer type that can hold the input.

UsageReturns
Image.bitwiseNot()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.bitwiseOr

Calculates the bitwise OR of the input values for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.bitwiseOr(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.bitwiseXor

Calculates the bitwise XOR of the input values for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.bitwiseXor(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.bitwise_and

Calculates the bitwise AND of the input values for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.bitwise_and(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.bitwise_not

Calculates the bitwise NOT of the input, in the smallest signed integer type that can hold the input.

UsageReturns
Image.bitwise_not()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.bitwise_or

Calculates the bitwise OR of the input values for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.bitwise_or(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.bitwise_xor

Calculates the bitwise XOR of the input values for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.bitwise_xor(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.blend

Overlays one image on top of another. The images are blended together using the masks as opacity. If either of images has only 1 band, it is replicated to match the number of bands in the other image.

UsageReturns
Image.blend(top)Image
ArgumentTypeDetails
this: bottomImage

The bottom image.

topImage

The top image.

ee.Image.byte

Casts the input value to an unsigned 8-bit integer.

UsageReturns
Image.byte()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.cast

Casts some or all bands of an image to the specified types.

UsageReturns
Image.cast(bandTypes, bandOrder)Image
ArgumentTypeDetails
this: imageImage

The image to cast.

bandTypesDictionary

A dictionary from band name to band types. Types can be PixelTypes or strings. The valid strings are: 'int8', 'int16', 'int32', 'int64', 'uint8', 'uint16', 'uint32', 'byte', 'short', 'int', 'long', 'float' and 'double'. If bandTypes includes bands that are not already in the input image, they will be added to the image as transparent bands. If bandOrder isn't also specified, new bands will be appended in alphabetical order.

bandOrderList, default: null

A list specifying the order of the bands in the result. If specified, must match the full list of bands in the result.

ee.Image.cat

Concatenate the given images together into a single image.

Returns the combined image.

UsageReturns
ee.Image.cat(var_args)Image
ArgumentTypeDetails
var_argsVarArgs

The images to be combined.

ee.Image.cbrt

Computes the cubic root of the input.

UsageReturns
Image.cbrt()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.ceil

Computes the smallest integer greater than or equal to the input.

UsageReturns
Image.ceil()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.changeProj

Tweaks the projection of the input image, moving each pixel from its location in srcProj to the same coordinates in dstProj.

UsageReturns
Image.changeProj(srcProj, dstProj)Image
ArgumentTypeDetails
this: inputImage

srcProjProjection

The original projection.

dstProjProjection

The new projection.

ee.Image.clamp

Clamps the values in all bands of an image to all lie within the specified range.

UsageReturns
Image.clamp(low, high)Image
ArgumentTypeDetails
this: inputImage

The image to clamp.

lowFloat

The minimum allowed value in the range.

highFloat

The maximum allowed value in the range.

ee.Image.classify

Classifies an image.

UsageReturns
Image.classify(classifier, outputName)Image
ArgumentTypeDetails
this: imageImage

The image to classify. Bands are extracted from this image by name, and it must contain all the bands named in the classifier's schema.

classifierObject

The classifier to use.

outputNameString, default: "classification"

The name of the band to be added.

ee.Image.clip

Clips an image to a Geometry or Feature.

The output bands correspond exactly the input bands, except data not covered by the geometry is masked. The output image retains the metadata of the input image.

Use clipToCollection to clip an image to a FeatureCollection.

Returns the clipped image.

UsageReturns
Image.clip(geometry)Image
ArgumentTypeDetails
this: imageImage

The Image instance.

geometryFeature|Geometry|Object

The Geometry or Feature to clip to.

ee.Image.clipToCollection

Clips an image to a FeatureCollection. The output bands correspond exactly the input bands, except data not covered by the geometry of at least one feature from the collection is masked. The output image retains the metadata of the input image.

UsageReturns
Image.clipToCollection(collection)Image
ArgumentTypeDetails
this: inputImage

The image to clip.

collectionObject

The FeatureCollection to clip to.

ee.Image.cluster

Applies a clusterer to an image. Returns a new image with a single band containing values from 0 to N, indicating the cluster each pixel is assigned to.

UsageReturns
Image.cluster(clusterer, outputName)Image
ArgumentTypeDetails
this: imageImage

The image to cluster. Must contain all the bands in the clusterer's schema.

clustererClusterer

The clusterer to use.

outputNameString, default: "cluster"

The name of the output band.

ee.Image.connectedComponents

Finds connected components with the same value of the first band of the input and labels them with a globally unique value. Connectedness is specified by the given kernel. Objects larger than maxSize are considered background, and are masked.

UsageReturns
Image.connectedComponents(connectedness, maxSize)Image
ArgumentTypeDetails
this: imageImage

The image to label.

connectednessKernel

Connectedness kernel.

maxSizeInteger

Maximum size of objects to be labeled.

ee.Image.connectedPixelCount

Generate an image where each pixel contains the number of 4- or 8-connected neighbors (including itself).

UsageReturns
Image.connectedPixelCount(maxSize, eightConnected)Image
ArgumentTypeDetails
this: inputImage

The input image.

maxSizeInteger, default: 100

The maximum size of the neighborhood in pixels.

eightConnectedBoolean, default: true

Whether to use 8-connected rather 4-connected rules.

ee.Image.constant

Generates an image containing a constant value everywhere.

UsageReturns
ee.Image.constant(value)Image
ArgumentTypeDetails
valueObject

The value of the pixels in the constant image. Must be a number or an Array or a list of numbers or Arrays.

ee.Image.convolve

Convolves each band of an image with the given kernel.

UsageReturns
Image.convolve(kernel)Image
ArgumentTypeDetails
this: imageImage

The image to convolve.

kernelKernel

The kernel to convolve with.

ee.Image.cos

Computes the cosine of the input in radians.

UsageReturns
Image.cos()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.cosh

Computes the hyperbolic cosine of the input.

UsageReturns
Image.cosh()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.cumulativeCost

Computes a cumulative cost map based on an image containing costs to traverse each pixel and an image containing source locations.

UsageReturns
Image.cumulativeCost(source, maxDistance, geodeticDistance)Image
ArgumentTypeDetails
this: costImage

A single-band image representing the cost to traverse each pixel. Masked pixels can't be traversed.

sourceImage

A single-band image representing the sources. A pixel value different from 0 defines a source pixel.

maxDistanceFloat

Maximum distance for computation, in meters.

geodeticDistanceBoolean, default: true

If true, geodetic distance along the curved surface is used, assuming a spherical Earth of radius 6378137.0. If false, euclidean distance in the 2D plane of the map projection is used (faster, but less accurate).

ee.Image.date

Returns the acquisition time of an image as a Date object. This helper function is equivalent to ee.Date(image.get('system:time_start')).

UsageReturns
Image.date()Date
ArgumentTypeDetails
this: imageImage

The image whose acquisition time to return.

ee.Image.derivative

Computes the X and Y discrete derivatives for each band in the input image, in pixel coordinates.

UsageReturns
Image.derivative()Image
ArgumentTypeDetails
this: imageImage

The input image.

ee.Image.digamma

Computes the digamma function of the input.

UsageReturns
Image.digamma()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.displace

Warps an image using an image of displacements.

UsageReturns
Image.displace(displacement, mode)Image
ArgumentTypeDetails
this: imageImage

The image to warp.

displacementImage

An image containing displacement values. The first band is interpreted as the 'X' displacement and the second as the 'Y' displacement. Each displacement pixel is a [dx,dy] vector added to the pixel location to determine the corresponding pixel location in 'image'. Displacements are interpreted as meters in the default projection of the displacement image.

modeString, default: "bicubic"

The interpolation mode to use. One of 'nearest_neighbor', 'bilinear' or 'bicubic'.)

ee.Image.displacement

Determines displacements required to register an image to a reference image while allowing local, rubber sheet deformations. Displacements are computed in the CRS of the reference image, at a scale dictated by the lowest resolution of the following three projections: input image projection, reference image projection, and requested projection. The displacements are then transformed into the user-specified projection for output.

UsageReturns
Image.displacement(referenceImage, maxOffset, projection, patchWidth, stiffness)Image
ArgumentTypeDetails
this: imageImage

The image to register.

referenceImageImage

The image to register to.

maxOffsetFloat

The maximum offset allowed when attempting to align the input images, in meters. Using a smaller value can reduce computation time significantly, but it must still be large enough to cover the greatest displacement within the entire image region.

projectionProjection, default: null

The projection in which to output displacement values. The default is the projection of the first band of the reference image.

patchWidthFloat, default: null

Patch size for detecting image offsets, in meters. This should be set large enough to capture texture, as well as large enough that ignorable objects are small within the patch. Default is null. Patch size will be determined automatically if not provided.

stiffnessFloat, default: 5

Enforces a stiffness constraint on the solution. Valid values are in the range [0,10]. The stiffness is used for outlier rejection when determining displacements at adjacent grid points. Higher values move the solution towards a rigid transformation. Lower values allow more distortion or warping of the image during registration.

ee.Image.distance

Computes the distance to the nearest non-zero pixel in each band, using the specified distance kernel.

UsageReturns
Image.distance(kernel, skipMasked)Image
ArgumentTypeDetails
this: imageImage

The input image.

kernelKernel, default: null

The distance kernel.

skipMaskedBoolean, default: true

Mask output pixels if the corresponding input pixel is masked.

ee.Image.divide

Divides the first value by the second, returning 0 for division by 0 for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.divide(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.double

Casts the input value to a 64-bit float.

UsageReturns
Image.double()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.entropy

Computes the windowed entropy for each band using the specified kernel centered on each input pixel.

UsageReturns
Image.entropy(kernel)Image
ArgumentTypeDetails
this: imageImage

The image for which to compute the entropy.

kernelKernel

A kernel specifying the window in which to compute.

ee.Image.eq

Returns 1 iff the first value is equal to the second for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is boolean.

UsageReturns
Image.eq(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.erf

Computes the error function of the input.

UsageReturns
Image.erf()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.erfInv

Computes the inverse error function of the input.

UsageReturns
Image.erfInv()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.erfc

Computes the complementary error function of the input.

UsageReturns
Image.erfc()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.erfcInv

Computes the inverse complementary error function of the input.

UsageReturns
Image.erfcInv()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
Image.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Image.exp

Computes the Euler's number e raised to the power of the input.

UsageReturns
Image.exp()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.expression

Evaluates an arithmetic expression on an image, possibly involving additional images.

The bands of the primary input image are available using the built-in function b(), as b(0) or b('band_name').

Variables in the expression are interpreted as additional image parameters which must be supplied in opt_map. The bands of each such image can be accessed like image.band_name or image[0].

Both b() and image[] allow multiple arguments, to specify multiple bands, such as b(1, 'name', 3). Calling b() with no arguments, or using a variable by itself, returns all bands of the image.

Returns the image computed by the provided expression.

UsageReturns
Image.expression(expression, map)Image
ArgumentTypeDetails
this: imageImage

The Image instance.

expressionString

The expression to evaluate.

mapDictionary, optional

A map of input images available by name.

ee.Image.fastDistanceTransform

Returns the distance, as determined by the specified distance metric, to the nearest non-zero valued pixel in the input. The output contains values for all pixels within the given neighborhood size, regardless of the input's mask. Note: the default distance metric returns squared distance.

UsageReturns
Image.fastDistanceTransform(neighborhood, units, metric)Image
ArgumentTypeDetails
this: imageImage

The input image.

neighborhoodInteger, default: 256

Neighborhood size in pixels.

unitsString, default: "pixels"

The units of the neighborhood, currently only 'pixels' are supported.

metricString, default: "squared_euclidean"

Distance metric to use: options are 'squared_euclidean', 'manhattan' or 'chebyshev'.

ee.Image.first

Selects the value of the first value for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.first(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.firstNonZero

Selects the first value if it is non-zero, and the second value otherwise for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.firstNonZero(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.first_nonzero

Selects the first value if it is non-zero, and the second value otherwise for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.first_nonzero(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.float

Casts the input value to a 32-bit float.

UsageReturns
Image.float()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.floor

Computes the largest integer less than or equal to the input.

UsageReturns
Image.floor()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.focal_max

Applies a morphological reducer() filter to each band of an image using a named or custom kernel.

UsageReturns
Image.focal_max(radius, kernelType, units, iterations, kernel)Image
ArgumentTypeDetails
this: imageImage

The image to which to apply the operations.

radiusFloat, default: 1.5

The radius of the kernel to use.

kernelTypeString, default: "circle"

The type of kernel to use. Options include: 'circle', 'square', 'cross', 'plus', octagon' and 'diamond'.

unitsString, default: "pixels"

If a kernel is not specified, this determines whether the kernel is in meters or pixels.

iterationsInteger, default: 1

The number of times to apply the given kernel.

kernelKernel, default: null

A custom kernel. If used, kernelType and radius are ignored.

ee.Image.focal_mean

Applies a morphological mean filter to each band of an image using a named or custom kernel.

UsageReturns
Image.focal_mean(radius, kernelType, units, iterations, kernel)Image
ArgumentTypeDetails
this: imageImage

The image to which to apply the operations.

radiusFloat, default: 1.5

The radius of the kernel to use.

kernelTypeString, default: "circle"

The type of kernel to use. Options include: 'circle', 'square', 'cross', 'plus', octagon' and 'diamond'.

unitsString, default: "pixels"

If a kernel is not specified, this determines whether the kernel is in meters or pixels.

iterationsInteger, default: 1

The number of times to apply the given kernel.

kernelKernel, default: null

A custom kernel. If used, kernelType and radius are ignored.

ee.Image.focal_median

Applies a morphological reducer() filter to each band of an image using a named or custom kernel.

UsageReturns
Image.focal_median(radius, kernelType, units, iterations, kernel)Image
ArgumentTypeDetails
this: imageImage

The image to which to apply the operations.

radiusFloat, default: 1.5

The radius of the kernel to use.

kernelTypeString, default: "circle"

The type of kernel to use. Options include: 'circle', 'square', 'cross', 'plus', octagon' and 'diamond'.

unitsString, default: "pixels"

If a kernel is not specified, this determines whether the kernel is in meters or pixels.

iterationsInteger, default: 1

The number of times to apply the given kernel.

kernelKernel, default: null

A custom kernel. If used, kernelType and radius are ignored.

ee.Image.focal_min

Applies a morphological reducer() filter to each band of an image using a named or custom kernel.

UsageReturns
Image.focal_min(radius, kernelType, units, iterations, kernel)Image
ArgumentTypeDetails
this: imageImage

The image to which to apply the operations.

radiusFloat, default: 1.5

The radius of the kernel to use.

kernelTypeString, default: "circle"

The type of kernel to use. Options include: 'circle', 'square', 'cross', 'plus', octagon' and 'diamond'.

unitsString, default: "pixels"

If a kernel is not specified, this determines whether the kernel is in meters or pixels.

iterationsInteger, default: 1

The number of times to apply the given kernel.

kernelKernel, default: null

A custom kernel. If used, kernelType and radius are ignored.

ee.Image.focal_mode

Applies a morphological reducer() filter to each band of an image using a named or custom kernel.

UsageReturns
Image.focal_mode(radius, kernelType, units, iterations, kernel)Image
ArgumentTypeDetails
this: imageImage

The image to which to apply the operations.

radiusFloat, default: 1.5

The radius of the kernel to use.

kernelTypeString, default: "circle"

The type of kernel to use. Options include: 'circle', 'square', 'cross', 'plus', octagon' and 'diamond'.

unitsString, default: "pixels"

If a kernel is not specified, this determines whether the kernel is in meters or pixels.

iterationsInteger, default: 1

The number of times to apply the given kernel.

kernelKernel, default: null

A custom kernel. If used, kernelType and radius are ignored.

ee.Image.gamma

Computes the gamma function of the input.

UsageReturns
Image.gamma()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.gammainc

Calculates the regularized lower incomplete Gamma function (γ(x,a) for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is float.

UsageReturns
Image.gammainc(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.get

Extract a property from a feature.

UsageReturns
Image.get(property)
ArgumentTypeDetails
this: objectElement

The feature to extract the property from.

propertyString

The property to extract.

ee.Image.getDownloadURL

Get a Download URL

Returns returns a download URL, or undefined if a callback was specified.

UsageReturns
Image.getDownloadURL(params, callback)Object|String
ArgumentTypeDetails
this: imageImage

The Image instance.

paramsObject

An object containing download options with the following possible values:

  - name: a base name to use when constructing filenames.

  - bands: a description of the bands to download. Must be a list of dictionaries, each with the following keys:

    + id: the name of the band, a string, required.

    + crs: an optional CRS string defining the band projection.

    + crs_transform: an optional list of 6 numbers specifying an affine transform from the specified CRS, in row-major order:

[xScale, xShearing, xTranslation, yShearing, yScale, yTranslation]

    + dimensions: an optional list of two integers defining the width and height to which the band is cropped.

    + scale: an optional number, specifying the scale in meters of the band; ignored if crs and crs_transform is specified.

  - crs: a default CRS string to use for any bands that do not explicitly specify one.

  - crs_transform: a default affine transform to use for any bands that do not specify one, of the same format as the crs_transform of bands.

  - dimensions: default image cropping dimensions to use for any bands that do not specify them.

  - scale: a default scale to use for any bands that do not specify one; ignored if crs and crs_transform is specified.

  - region: a polygon specifying a region to download; ignored if crs and crs_transform is specified.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Image.getInfo

An imperative function that returns information about this image via an AJAX call.

Returns a description of the image. Includes:

  - bands - a list containing metadata about the bands in the collection.

  - properties - a dictionary containing the image's metadata properties.

UsageReturns
Image.getInfo(callback)ImageDescription
ArgumentTypeDetails
this: imageImage

The Image instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously. If supplied, will be called with the first parameter if successful and the second if unsuccessful.

ee.Image.getMap

An imperative function that returns a map id and token, suitable for generating a Map overlay.

Returns an object containing a mapid string, an access token plus this object, or an error message. Or undefined if a callback was specified.

UsageReturns
Image.getMap(visParams, callback)MapId|Object
ArgumentTypeDetails
this: imageImage

The Image instance.

visParamsImageVisualizationParameters, optional

The visualization parameters.

callbackFunction, optional

An async callback. If not supplied, the call is made synchronously.

ee.Image.getThumbURL

Get a thumbnail URL for this image.

Returns a thumbnail URL, or undefined if a callback was specified.

UsageReturns
Image.getThumbURL(params, callback)Object|String
ArgumentTypeDetails
this: imageImage

The Image instance.

paramsObject

Parameters identical to getMapId, plus, optionally:

  - dimensions (a number or pair of numbers in format WIDTHxHEIGHT) Maximum dimensions of the thumbnail to render, in pixels. If only one number is passed, it is used as the maximum, and the other dimension is computed by proportional scaling.

  - region (E,S,W,N or GeoJSON) Geospatial region of the image to render. By default, the whole image.

  - format (string) Either 'png' or 'jpg'.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Image.glcmTexture

Computes texture metrics from the Gray Level Co-occurrence Matrix around each pixel of every band.

UsageReturns
Image.glcmTexture(size, kernel, average)Image
ArgumentTypeDetails
this: imageImage

The image for which to compute texture metrics.

sizeInteger, default: 1

The size of the neighborhood to include in each GLCM.

kernelKernel, default: null

A kernel specifying the x and y offsets over which to compute the GLCMs. A GLCM is computed for each pixel in the kernel that is non-zero, except the center pixel and as long as a GLCM hasn't already been computed for the same direction and distance. For example, if either or both of the east and west pixels are set, only 1 (horizontal) GLCM is computed. Kernels are scanned from left to right and top to bottom. The default is a 3x3 square, resulting in 4 GLCMs with the offsets (-1, -1), (0, -1), (1, -1) and (-1, 0).

averageBoolean, default: true

If true, the directional bands for each metric are averaged.

ee.Image.gradient

Calculates the x and y gradient.

UsageReturns
Image.gradient()Image
ArgumentTypeDetails
this: inputImage

The input image.

ee.Image.gt

Returns 1 iff the first value is greater than the second for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is boolean.

UsageReturns
Image.gt(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.gte

Returns 1 iff the first value is greater than or equal to the second for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is boolean.

UsageReturns
Image.gte(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.hsvToRgb

Transforms the image from the HSV color space to the RGB color space. Produces three bands: red, green and blue, all floating point values in the range [0, 1].

UsageReturns
Image.hsvToRgb()Image
ArgumentTypeDetails
this: imageImage

The image to transform.

ee.Image.hypot

Calculates the magnitude of the 2D vector [x, y] for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is float.

UsageReturns
Image.hypot(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.id

Returns the ID of a given element within a collection. Objects outside collections are not guaranteed to have IDs.

UsageReturns
Image.id()String
ArgumentTypeDetails
this: elementElement

The element from which the ID is taken.

ee.Image.int

Casts the input value to a signed 32-bit integer.

UsageReturns
Image.int()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.int16

Casts the input value to a signed 16-bit integer.

UsageReturns
Image.int16()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.int32

Casts the input value to a signed 32-bit integer.

UsageReturns
Image.int32()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.int64

Casts the input value to a signed 64-bit integer.

UsageReturns
Image.int64()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.int8

Casts the input value to a signed 8-bit integer.

UsageReturns
Image.int8()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.interpolate

Interpolates each point in the first band of the input image into the piecewise-linear function specified by the x and y arrays. The x values must be strictly increasing. If an input point is less than the first or greater than the last x value, then the output is specified by the "behavior" argument: "extrapolate" specifies the output value is extrapolated from the two nearest points, "clamp" specifies the output value is taken from the nearest point, "input" specifies the output value is copied from the input and "mask" specifies the output value is masked.

UsageReturns
Image.interpolate(x, y, behavior)Image
ArgumentTypeDetails
this: imageImage

The image to which the interpolation is applied.

xList

The x axis (input) values in the piecewise function.

yList

The y axis (output) values in the piecewise function.

behaviorString, default: "extrapolate"

The behavior for points that are outside of the range of the supplied function. Options are: 'extrapolate', 'clamp', 'mask' or 'input'.

ee.Image.lanczos

Computes the Lanczos approximation of the input.

UsageReturns
Image.lanczos()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.leftShift

Calculates the left shift of v1 by v2 bits for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.leftShift(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.left_shift

Calculates the left shift of v1 by v2 bits for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.left_shift(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.load

Returns the image given its ID.

UsageReturns
ee.Image.load(id, version)Image
ArgumentTypeDetails
idString

The asset ID of the image.

versionLong, default: -1

The version of the asset. -1 signifies the latest version.

ee.Image.log

Computes the natural logarithm of the input.

UsageReturns
Image.log()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.log10

Computes the base-10 logarithm of the input.

UsageReturns
Image.log10()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.long

Casts the input value to a signed 64-bit integer.

UsageReturns
Image.long()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.lt

Returns 1 iff the first value is less than the second for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is boolean.

UsageReturns
Image.lt(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.lte

Returns 1 iff the first value is less than or equal to the second for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is boolean.

UsageReturns
Image.lte(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.mask

Gets or sets an image's mask. The output image retains the metadata and footprint of the input image. Pixels where the mask changes from zero to another value will be filled with zeros, or the values closest to zero within the range of the pixel type.

Note: the version that sets a mask will be deprecated. To set a mask from an image on previously unmasked pixels, use Image.updateMask. To unmask previously masked pixels, use Image.unmask.

UsageReturns
Image.mask(mask)Image
ArgumentTypeDetails
this: imageImage

The input image.

maskImage, default: null

The mask image. If specified, the input image is copied to the output but given the mask by the values of this image. If this is a single band, it is used for all bands in the input image. If not specified, returns an image created from the mask of the input image, scaled to the range [0:1] (invalid = 0, valid = 1.0).

ee.Image.matrixCholeskyDecomposition

Calculates the Cholesky decomposition of a matrix. The Cholesky decomposition is a decomposition into the form L*L' where L is a lower triangular matrix. The input must be a symmetric positive-definite matrix. Returns an image with 1 band named 'L'.

UsageReturns
Image.matrixCholeskyDecomposition()Image
ArgumentTypeDetails
this: imageImage

Image of 2-D matrices to be decomposed.

ee.Image.matrixDeterminant

Computes the determinant of the matrix.

UsageReturns
Image.matrixDeterminant()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.matrixDiagonal

Computes the diagonal of the matrix in a single column.

UsageReturns
Image.matrixDiagonal()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.matrixFnorm

Computes the Frobenius norm of the matrix.

UsageReturns
Image.matrixFnorm()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.matrixIdentity

Creates an image where each pixel is a 2D identity matrix of the given size.

UsageReturns
ee.Image.matrixIdentity(size)Image
ArgumentTypeDetails
sizeInteger

The length of each axis.

ee.Image.matrixInverse

Computes the inverse of the matrix.

UsageReturns
Image.matrixInverse()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.matrixLUDecomposition

Calculates the LU matrix decomposition such that P×input=L×U, where L is lower triangular (with unit diagonal terms), U is upper triangular and P is a partial pivot permutation matrix. The input matrix must be square. Returns an image with bands named 'L', 'U' and 'P'.

UsageReturns
Image.matrixLUDecomposition()Image
ArgumentTypeDetails
this: imageImage

Image of 2-D matrices to be decomposed.

ee.Image.matrixMultiply

Returns the matrix multiplication A*B for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.matrixMultiply(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.matrixPseudoInverse

Computes the Moore-Penrose pseudoinverse of the matrix.

UsageReturns
Image.matrixPseudoInverse()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.matrixQRDecomposition

Calculates the QR-decomposition of a matrix into two matrices Q and R such that input = QR, where Q is orthogonal, and R is upper triangular. Returns an image with bands named 'Q' and 'R'.

UsageReturns
Image.matrixQRDecomposition()Image
ArgumentTypeDetails
this: imageImage

Image of 2-D matrices to be decomposed.

ee.Image.matrixSingularValueDecomposition

Calculates the Singular Value Decomposition of the input matrix into U×S×V', such that U and V are orthogonal and S is diagonal. Returns an image with bands named 'U', 'S' and 'V'.

UsageReturns
Image.matrixSingularValueDecomposition()Image
ArgumentTypeDetails
this: imageImage

Image of 2-D matrices to be decomposed.

ee.Image.matrixSolve

Solves for x in the matrix equation A*x=B, finding a least-squares solution if A is overdetermined for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.matrixSolve(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.matrixToDiag

Computes a square diagonal matrix from a single column matrix.

UsageReturns
Image.matrixToDiag()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.matrixTrace

Computes the trace of the matrix.

UsageReturns
Image.matrixTrace()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.matrixTranspose

Transposes two dimensions of each array pixel.

UsageReturns
Image.matrixTranspose(axis1, axis2)Image
ArgumentTypeDetails
this: inputImage

Input image.

axis1Integer, default: 0

First axis to swap.

axis2Integer, default: 1

Second axis to swap.

ee.Image.max

Selects the maximum of the first and second values for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.max(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.medialAxis

Computes the discrete medial axis of the zero valued pixels of the first band of the input. Outputs 4 bands:

 medial - the medial axis points, scaled by the distance.

 coverage - the number of points supporting each medial axis point.

 xlabel - the horizontal distance to the power point for each pixel.

 ylabel - the vertical distance to the power point for each pixel.

UsageReturns
Image.medialAxis(neighborhood, units)Image
ArgumentTypeDetails
this: imageImage

The input image.

neighborhoodInteger, default: 256

Neighborhood size in pixels.

unitsString, default: "pixels"

The units of the neighborhood, currently only 'pixels' are supported.

ee.Image.metadata

Generates a constant image of type double from a metadata property.

UsageReturns
Image.metadata(property, name)Image
ArgumentTypeDetails
this: imageImage

The image from which to get the metadata

propertyString

The property from which to take the value.

nameString, default: null

The name for the output band. If unspecified, it will be the same as the property name.

ee.Image.min

Selects the minimum of the first and second values for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.min(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.mod

Calculates the remainder of the first value divided by the second for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.mod(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.multiply

Multiplies the first value by the second for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.multiply(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.neighborhoodToBands

Turn the neighborhood of a pixel into a set of bands. The neighborhood is specified using a Kernel, and only non-zero-weight kernel values are used. The weights of the kernel is otherwise ignored.

Each input band produces x * y output bands. Each output band is named 'input_x_y' where x and y indicate the pixel's location in the kernel. For example, a 3x3 kernel operating on a 2-band image produces 18 output bands.

UsageReturns
Image.neighborhoodToBands(kernel)Image
ArgumentTypeDetails
this: imageImage

The image to get pixels from.

kernelKernel

The kernel specifying the neighborhood. Zero-weight values are ignored.

ee.Image.neq

Returns 1 iff the first value is not equal to the second for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is boolean.

UsageReturns
Image.neq(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.normalizedDifference

Computes the normalized difference between two bands. If the bands to use are not specified, uses the first two bands. The normalized difference is computed as (first − second) / (first + second).

UsageReturns
Image.normalizedDifference(bandNames)Image
ArgumentTypeDetails
this: inputImage

The input image.

bandNamesList, default: null

A list of names specifying the bands to use. If not specified, the first and second bands are used.

ee.Image.not

Returns 0 if the input is non-zero, and 1 otherwise.

UsageReturns
Image.not()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.or

Returns 1 iff either input value is non-zero for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is boolean.

UsageReturns
Image.or(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.paint

Paints the geometries of a collection onto an image.

UsageReturns
Image.paint(featureCollection, color, width)Image
ArgumentTypeDetails
this: imageImage

The image on which the collection is painted.

featureCollectionFeatureCollection

The collection painted onto the image.

colorObject, default: 0

Either the name of a color property or a number.

widthObject, default: null

Either the name of a line-width property or a number.

ee.Image.pixelArea

Generate an image in which the value of each pixel is the area of that pixel in square meters.

UsageReturns
ee.Image.pixelArea()Image

No arguments.

ee.Image.pixelCoordinates

Creates a two band image containing the x and y coordinates of each pixel in the given projection.

UsageReturns
ee.Image.pixelCoordinates(projection)Image
ArgumentTypeDetails
projectionProjection

The projection in which to provide pixel.

ee.Image.pixelLonLat

Creates a two band image containing the longitude and latitude at each pixel, in degrees.

UsageReturns
ee.Image.pixelLonLat()Image

No arguments.

ee.Image.polynomial

Compute a polynomial at each pixel using the given coefficients.

UsageReturns
Image.polynomial(coefficients)Image
ArgumentTypeDetails
this: imageImage

The input image.

coefficientsList

The polynomial coefficients in increasing order of degree starting with the constant term.

ee.Image.pow

Raises the first value to the power of the second for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is float.

UsageReturns
Image.pow(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.projection

Returns the default projection of an Image. Throws an error if the bands of the image don't all have the same projection.

UsageReturns
Image.projection()Projection
ArgumentTypeDetails
this: imageImage

The image from which to get the projection.

ee.Image.propertyNames

Returns the names of properties on this element.

UsageReturns
Image.propertyNames()List
ArgumentTypeDetails
this: elementElement

ee.Image.random

Generates a uniform random number at each pixel location, in the range of 0 to 1.

UsageReturns
ee.Image.random(seed)Image
ArgumentTypeDetails
seedLong, default: 0

Seed for the random number generator.

ee.Image.randomVisualizer

Creates a vizualization image by assigning a random color to each unique value of the pixels of the first band. The first three bands of the output image will contan 8-bit R, G and B values, followed by all bands of the input image.

UsageReturns
Image.randomVisualizer()Image
ArgumentTypeDetails
this: imageImage

Image with at least one band.

ee.Image.reduce

Applies a reducer to all of the bands of an image.

The reducer must have a single input and will be called at each pixel to reduce the stack of band values.

The output image will have one band for each reducer output.

UsageReturns
Image.reduce(reducer)Image
ArgumentTypeDetails
this: imageImage

The image to reduce.

reducerReducer

The reducer to apply to the given image.

ee.Image.reduceNeighborhood

Applies the given reducer to the neighborhood around each pixel, as determined by the given kernel. If the reducer has a single input, it will be applied separately to each band of the collection; otherwise it must have the same number of inputs as the input image has bands.

The reducer output names determine the names of the output bands: reducers with multiple inputs will use the output names directly, while reducers with a single input will prefix the output name with the input band name (e.g. '10_mean', '20_mean', etc.).

Reducers with weighted inputs can have the input weight based on the input mask, the kernel value, or the smaller of those two.

UsageReturns
Image.reduceNeighborhood(reducer, kernel, inputWeight, skipMasked, optimization)Image
ArgumentTypeDetails
this: imageImage

The input image.

reducerReducer

The reducer to apply to pixels within the neighborhood.

kernelKernel

The kernel defining the neighborhood.

inputWeightString, default: "kernel"

One of 'mask', 'kernel', or 'min'.

skipMaskedBoolean, default: true

Mask output pixels if the corresponding input pixel is masked.

optimizationString, default: null

Optimization strategy. Options are 'boxcar' and 'window'. The 'boxcar' method is a fast method for computing count, sum or mean. It requires a homogenous kernel, a single-input reducer and either MASK, KERNEL or no weighting. The 'window' method uses a running window, and has the same requirements as 'boxcar', but can use any single input reducer. Both methods require considerable additional memory.

ee.Image.reduceRegion

Apply a reducer to all the pixels in a specific region.

Either the reducer must have the same number of inputs as the input image has bands, or it must have a single input and will be repeated for each band.

Returns a dictionary of the reducer's outputs.

UsageReturns
Image.reduceRegion(reducer, geometry, scale, crs, crsTransform, bestEffort, maxPixels, tileScale)Dictionary
ArgumentTypeDetails
this: imageImage

The image to reduce.

reducerReducer

The reducer to apply.

geometryGeometry, default: null

The region over which to reduce data. Defaults to the footprint of the image's first band.

scaleFloat, default: null

A nominal scale in meters of the projection to work in.

crsProjection, default: null

The projection to work in. If unspecified, the projection of the image's first band is used. If specified in addition to scale, rescaled to the specified scale.

crsTransformList, default: null

The list of CRS transform values. This is a row-major ordering of the 3x2 transform matrix. This option is mutually exclusive with 'scale', and replaces any transform already set on the projection.

bestEffortBoolean, default: false

If the polygon would contain too many pixels at the given scale, compute and use a larger scale which would allow the operation to succeed.

maxPixelsLong, default: 10000000

The maximum number of pixels to reduce.

tileScaleFloat, default: 1

A scaling factor used to reduce aggregation tile size; using a larger tileScale (e.g. 2 or 4) may enable computations that run out of memory with the default.

ee.Image.reduceRegions

Apply a reducer over the area of each feature in the given collection.

The reducer must have the same number of inputs as the input image has bands.

Returns the input features, each augmented with the corresponding reducer outputs.

UsageReturns
Image.reduceRegions(collection, reducer, scale, crs, crsTransform, tileScale)FeatureCollection
ArgumentTypeDetails
this: imageImage

The image to reduce.

collectionFeatureCollection

The features to reduce over.

reducerReducer

The reducer to apply.

scaleFloat, default: null

A nominal scale in meters of the projection to work in.

crsProjection, default: null

The projection to work in. If unspecified, the projection of the image's first band is used. If specified in addition to scale, rescaled to the specified scale.

crsTransformList, default: null

The list of CRS transform values. This is a row-major ordering of the 3x2 transform matrix. This option is mutually exclusive with 'scale', and will replace any transform already set on the projection.

tileScaleFloat, default: 1

A scaling factor used to reduce aggregation tile size; using a larger tileScale (e.g. 2 or 4) may enable computations that run out of memory with the default.

ee.Image.reduceResolution

Enables reprojection using the given reducer to combine all input pixels corresponding to each output pixel. If the reducer has a single input, it will be applied separately to each band of the collection; otherwise it must have the same number of inputs as the input image has bands.

The reducer output names determine the names of the output bands: reducers with multiple inputs will use the output names directly, reducers with a single input and single output will preserve the input band names, and reducers with a single input and multiple outputs will prefix the output name with the input band name (e.g. '10_mean', '10_stdDev', '20_mean', '20_stdDev', etc.).

Reducer input weights will be the product of the input mask and the fraction of the output pixel covered by the input pixel.

UsageReturns
Image.reduceResolution(reducer, bestEffort, maxPixels)Image
ArgumentTypeDetails
this: imageImage

The input image.

reducerReducer

The reducer to apply to be used for combining pixels.

bestEffortBoolean, default: false

If using the input at its default resolution would require too many pixels, start with already-reduced input pixels from a pyramid level that allows the operation to succeed.

maxPixelsInteger, default: 64

The maximum number of input pixels to combine for each output pixel. Setting this too large will cause out-of-memory problems.

ee.Image.reduceToVectors

Convert an image to a feature collection by reducing homogenous regions. Given an image containing a band of labeled segments and zero or more additional bands, runs a reducer over the pixels in each segment producing a feature per segment.

Either the reducer must have one fewer inputs than the image has bands, or it must have a single input and will be repeated for each band.

UsageReturns
Image.reduceToVectors(reducer, geometry, scale, geometryType, eightConnected, labelProperty, crs, crsTransform, bestEffort, maxPixels, tileScale, geometryInNativeProjection)FeatureCollection
ArgumentTypeDetails
this: imageImage

The input image. The first band is expected to be an integer type; adjacent pixels will be in the same segment if they have the same value in this band.

reducerReducer, default: null

The reducer to apply. Its inputs will be taken from the image's bands after dropping the first band. Defaults to Reducer.countEvery()

geometryGeometry, default: null

The region over which to reduce data. Defaults to the footprint of the image's first band.

scaleFloat, default: null

A nominal scale in meters of the projection to work in.

geometryTypeString, default: "polygon"

How to choose the geometry of each generated feature; one of 'polygon' (a polygon enclosing the pixels in the segment), 'bb' (a rectangle bounding the pixels), or 'centroid' (the centroid of the pixels).

eightConnectedBoolean, default: true

If true, diagonally-connected pixels are considered adjacent; otherwise only pixels that share an edge are.

labelPropertyString, default: "label"

If non-null, the value of the first band will be saved as the specified property of each feature.

crsProjection, default: null

The projection to work in. If unspecified, the projection of the image's first band is used. If specified in addition to scale, rescaled to the specified scale.

crsTransformList, default: null

The list of CRS transform values. This is a row-major ordering of the 3x2 transform matrix. This option is mutually exclusive with 'scale', and replaces any transform already set on the projection.

bestEffortBoolean, default: false

If the polygon would contain too many pixels at the given scale, compute and use a larger scale which would allow the operation to succeed.

maxPixelsLong, default: 10000000

The maximum number of pixels to reduce.

tileScaleFloat, default: 1

A scaling factor used to reduce aggregation tile size; using a larger tileScale (e.g. 2 or 4) may enable computations that run out of memory with the default.

geometryInNativeProjectionBoolean, default: false

Create geometries in the pixel projection, rather than WGS84.

ee.Image.register

Registers an image to a reference image while allowing local, rubber sheet deformations. Displacements are computed in the CRS of the reference image, at a scale dictated by the lowest resolution of the following three projections: input image projection, reference image projection, and requested projection. The displacements then applied to the input image to register it with the reference.

UsageReturns
Image.register(referenceImage, maxOffset, patchWidth, stiffness)Image
ArgumentTypeDetails
this: imageImage

The image to register.

referenceImageImage

The image to register to.

maxOffsetFloat

The maximum offset allowed when attempting to align the input images, in meters. Using a smaller value can reduce computation time significantly, but it must still be large enough to cover the greatest displacement within the entire image region.

patchWidthFloat, default: null

Patch size for detecting image offsets, in meters. This should be set large enough to capture texture, as well as large enough that ignorable objects are small within the patch. Default is null. Patch size will be determined automatically if notprovided.

stiffnessFloat, default: 5

Enforces a stiffness constraint on the solution. Valid values are in the range [0,10]. The stiffness is used for outlier rejection when determining displacements at adjacent grid points. Higher values move the solution towards a rigid transformation. Lower values allow more distortion or warping of the image during registration.

ee.Image.remap

Maps from input values to output values, represented by two parallel lists. Any input values not included in the input list are either set to defaultValue if it is given, or masked if it isn't. Note that inputs containing floating point values might sometimes fail to match due to floating point precision errors.

UsageReturns
Image.remap(from, to, defaultValue, bandName)Image
ArgumentTypeDetails
this: imageImage

The image to which the remapping is applied.

fromList

The source values (numbers or EEArrays). All values in this list will be mapped to the corresponding value in 'to'.

toList

The destination values (numbers or EEArrays). These are used to replace the corresponding values in 'from'. Must have the same number of values as 'from'.

defaultValueObject, default: null

The default value to replace values that weren't matched by a value in 'from'. If not specified, unmatched values are masked out.

bandNameString, default: null

The name of the band to remap. If not specified, the first band in the image is used.

ee.Image.rename

Rename the bands of an image.

Returns the renamed image.

UsageReturns
Image.rename(var_args)Image
ArgumentTypeDetails
this: imageImage

The Image instance.

var_argsList

The new names for the bands. Must match the number of bands in the Image.

ee.Image.reproject

Force an image to be computed in a given projection and resolution.

UsageReturns
Image.reproject(crs, crsTransform, scale)Image
ArgumentTypeDetails
this: imageImage

The Image to reproject.

crsProjection

The CRS to project the image to.

crsTransformList, default: null

The list of CRS transform values. This is a row-major ordering of the 3x2 transform matrix. This option is mutually exclusive with the scale option, and replaces any transform already on the projection.

scaleFloat, default: null

If scale is specified, then the projection is scaled by dividing the specified scale value by the nominal size of a meter in the specified projection. If scale is not specified, then the scale of the given projection will be used.

ee.Image.resample

An algorithm that returns an image identical to its argument, but which uses bilinear or bicubic interpolation (rather than the default nearest-neighbor) to compute pixels in projections other than its native projection or other levels of the same image pyramid.

This relies on the input image's default projection being meaningful, and so cannot be used on composites, for example. (Instead, you should resample the images that are used to create the composite.)

UsageReturns
Image.resample(mode)Image
ArgumentTypeDetails
this: imageImage

The Image to resample.

modeString, default: "bilinear"

The interpolation mode to use. One of 'bilinear' or 'bicubic'.)

ee.Image.rgb

Create a 3-band image specifically for visualization. This uses the first band in each image.

Returns the combined image.

UsageReturns
ee.Image.rgb(r, g, b)Image
ArgumentTypeDetails
rImage

The red image.

gImage

The green image.

bImage

The blue image.

ee.Image.rgbToHsv

Transforms the image from the RGB color space to the HSV color space. Produces three bands: hue, saturation and value, all floating point values in the range [0, 1].

UsageReturns
Image.rgbToHsv()Image
ArgumentTypeDetails
this: imageImage

The image to transform.

ee.Image.rightShift

Calculates the signed right shift of v1 by v2 bits for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.rightShift(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.right_shift

Calculates the signed right shift of v1 by v2 bits for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.right_shift(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.round

Computes the integer nearest to the input.

UsageReturns
Image.round()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.rsedTransform

Computes the 2D maximal height surface created by placing an inverted parabola over each non-zero pixel of the input image, where the pixel's value is the height of the parabola. Viewed as a binary image (zero/not-zero) this is equivalent to buffering each non-zero input pixel by the square root of its value, in pixels.

UsageReturns
Image.rsedTransform(neighborhood, units)Image
ArgumentTypeDetails
this: imageImage

The input image.

neighborhoodInteger, default: 256

Neighborhood size in pixels.

unitsString, default: "pixels"

The units of the neighborhood, currently only 'pixels' are supported.

ee.Image.sample

Samples the pixels of an image, returning them as a FeatureCollection. Each feature will have 1 property per band in the input image.

UsageReturns
Image.sample(region, scale, projection, factor, numPixels, seed, dropNulls, tileScale)FeatureCollection
ArgumentTypeDetails
this: imageImage

The image to sample.

regionGeometry, default: null

The region to sample from. If unspecified, uses the image's whole footprint.

scaleFloat, default: null

A nominal scale in meters of the projection to sample in.

projectionProjection, default: null

The projection in which to sample. If unspecified, the projection of the image's first band is used. If specified in addition to scale, rescaled to the specified scale.

factorFloat, default: null

A subsampling factor, within (0, 1]. If specified, 'numPixels' must not be specified. Defaults to no subsampling.

numPixelsLong, default: null

The approximate number of pixels to sample. If specified, 'factor' must not be specified.

seedInteger, default: 0

A randomization seed to use for subsampling.

dropNullsBoolean, default: true

Post filter the result to drop features that have null-valued properties.

tileScaleFloat, default: 1

A scaling factor used to reduce aggregation tile size; using a larger tileScale (e.g. 2 or 4) may enable computations that run out of memory with the default.

ee.Image.sampleRegions

Samples the pixels of an image in one or more regions, returning them as a FeatureCollection. Each output feature will have 1 property per band in the input image, as well as any specified properties copied from the input feature.

UsageReturns
Image.sampleRegions(collection, properties, scale, projection, tileScale)FeatureCollection
ArgumentTypeDetails
this: imageImage

The image to sample.

collectionFeatureCollection

The regions to sample over.

propertiesList, default: null

The list of properties to copy from each input feature. Defaults to all non-system properties.

scaleFloat, default: null

A nominal scale in meters of the projection to sample in. If unspecified,the scale of the image's first band is used.

projectionProjection, default: null

The projection in which to sample. If unspecified, the projection of the image's first band is used. If specified in addition to scale, rescaled to the specified scale.

tileScaleFloat, default: 1

A scaling factor used to reduce aggregation tile size; using a larger tileScale (e.g. 2 or 4) may enable computations that run out of memory with the default.

ee.Image.select

Selects bands from an image.

Returns an image with the selected bands.

UsageReturns
Image.select(var_args)Image
ArgumentTypeDetails
this: imageImage

The Image instance.

var_argsVarArgs

One of two possibilities:

  - Any number of non-list arguments. All of these will be interpreted as band selectors. These can be band names, regexes, or numeric indices. E.g. selected = image.select('a', 'b', 3, 'd');

  - Two lists. The first will be used as band selectors and the second as new names for the selected bands. The number of new names must match the number of selected bands. E.g. selected = image.select(['a', 4], ['newA', 'newB']);

ee.Image.serialize

Returns the serialized representation of this object.

UsageReturns
Image.serialize()String
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

ee.Image.set

Overrides one or more metadata properties of an Element.

Returns the element with the specified properties overridden.

UsageReturns
Image.set(var_args)Element
ArgumentTypeDetails
this: elementElement

The Element instance.

var_argsVarArgs

Either a dictionary of properties, or a vararg sequence of properties, e.g. key1, value1, key2, value2, ...

ee.Image.setMulti

Overrides one or more metadata properties of an object.

UsageReturns
Image.setMulti(properties)Element
ArgumentTypeDetails
this: objectElement

The object whose properties to override.

propertiesDictionary

The property values to override.

ee.Image.short

Casts the input value to a signed 16-bit integer.

UsageReturns
Image.short()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.sin

Computes the sine of the input in radians.

UsageReturns
Image.sin()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.sinh

Computes the hyperbolic sine of the input.

UsageReturns
Image.sinh()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.sldStyle

Styles a raster input with the provided OGC SLD styling.

Points of note:

 * OGC SLD 1.0 and OGC SE 1.1 are supported.

 * The XML document passed in can be complete, or just the SldRasterSymbolizer element and down.

 * Exactly one SldRasterSymbolizer is required.

 * Bands may be selected by their proper EarthEngine names or using numeric identifiers ("1", "2", ...). Proper EarthEngine names are tried first.

 * The Histogram and Normalize contrast stretch mechanisms are supported.

 * The type="values", type="intervals" and type="ramp" attributes for ColorMap element in SLD 1.0 (GeoServer extensions) are

   supported.

 * Opacity is only taken into account when it is 0.0 (transparent). Non-zero opacity values are treated as completely opaque.

 * The OverlapBehavior definition is currently ignored.

 * The ShadedRelief mechanism is not currently supported.

 * The ImageOutline mechanism is not currently supported.

 * The Geometry element is ignored.

The output image will have histogram_bandname metadata if histogram equalization or normalization is requested.

UsageReturns
Image.sldStyle(sldXml)Image
ArgumentTypeDetails
this: inputImage

The image to rendering using the SLD.

sldXmlString

The OGC SLD 1.0 or 1.1 document (or fragment).

ee.Image.slice

Selects a contiguous group of bands from an image by position.

UsageReturns
Image.slice(start, end)Image
ArgumentTypeDetails
this: imageImage

The image from which to select bands.

startInteger

Where to start the selection. Negative numbers select from the end, counting backwards.

endInteger, default: null

Where to end the selection. If omitted, selects all bands from the start position to the end.

ee.Image.sqrt

Computes the square root of the input.

UsageReturns
Image.sqrt()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.stratifiedSample

Extracts a stratified random sample of points from an image. Extracts the specified number of samples for each distinct value discovered within the 'classBand'. Returns a FeatureCollection of 1 Feature per extracted point, with each feature having 1 property per band in the input image. If there are less than the specified number of samples available for a given class value, then all of the points for that class will be included. Requires that the classBand contain integer values.

UsageReturns
Image.stratifiedSample(numPoints, classBand, region, scale, projection, seed, classValues, classPoints, dropNulls, tileScale)FeatureCollection
ArgumentTypeDetails
this: imageImage

The image to sample.

numPointsInteger

The default number of points to sample in each class. Can be overridden for specific classes using the 'classValues' and 'classPoints' properties.

classBandString, default: null

The name of the band containing the classes to use for stratification. If unspecified, the first band of the input image is used.

regionGeometry, default: null

The region to sample from. If unspecified, the input image's whole footprint is used.

scaleFloat, default: null

A nominal scale in meters of the projection to sample in. Defaults to the scale of the first band of the input image.

projectionProjection, default: null

The projection in which to sample. If unspecified, the projection of the input image's first band is used. If specified in addition to scale, rescaled to the specified scale.

seedInteger, default: 0

A randomization seed to use for subsampling.

classValuesList, default: null

A list of class values for which to override the numPixels parameter. Must be the same size as classPoints or null.

classPointsList, default: null

A list of the per-class maximum number of pixels to sample for each class in the classValues list. Must be the same size as classValues or null.

dropNullsBoolean, default: true

Skip pixels in which any band is masked.

tileScaleFloat, default: 1

A scaling factor used to reduce aggregation tile size; using a larger tileScale (e.g. 2 or 4) may enable computations that run out of memory with the default.

ee.Image.subtract

Subtracts the second value from the first for each matched pair of bands in image1 and image2. If either image1 or image2 has only 1 band, then it is used against all the bands in the other image. If the images have the same number of bands, but not the same names, they're used pairwise in the natural order. The output bands are named for the longer of the two inputs, or if they're equal in length, in image1's order. The type of the output pixels is the union of the input types.

UsageReturns
Image.subtract(image2)Image
ArgumentTypeDetails
this: image1Image

The image from which the left operand bands are taken.

image2Image

The image from which the right operand bands are taken.

ee.Image.tan

Computes the tangent of the input in radians.

UsageReturns
Image.tan()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.tanh

Computes the hyperbolic tangent of the input.

UsageReturns
Image.tanh()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toArray

Concatenates pixels from each band into a single array per pixel. The result will be masked if any input bands are masked.

UsageReturns
Image.toArray(axis)Image
ArgumentTypeDetails
this: imageImage

Image of bands to convert to an array per pixel. Bands must have scalar pixels, or array pixels with equal dimensionality.

axisInteger, default: 0

Axis to concatenate along; must be at least 0 and at most the dimension of the inputs. If the axis equals the dimension of the inputs, the result will have 1 more dimension than the inputs.

ee.Image.toByte

Casts the input value to an unsigned 8-bit integer.

UsageReturns
Image.toByte()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toDictionary

Extract properties from a feature as a dictionary.

UsageReturns
Image.toDictionary(properties)Dictionary
ArgumentTypeDetails
this: elementElement

The feature to extract the property from.

propertiesList, default: null

The list of properties to extract. Defaults to all non-system properties.

ee.Image.toDouble

Casts the input value to a 64-bit float.

UsageReturns
Image.toDouble()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toFloat

Casts the input value to a 32-bit float.

UsageReturns
Image.toFloat()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toInt

Casts the input value to a signed 32-bit integer.

UsageReturns
Image.toInt()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toInt16

Casts the input value to a signed 16-bit integer.

UsageReturns
Image.toInt16()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toInt32

Casts the input value to a signed 32-bit integer.

UsageReturns
Image.toInt32()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toInt64

Casts the input value to a signed 64-bit integer.

UsageReturns
Image.toInt64()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toInt8

Casts the input value to a signed 8-bit integer.

UsageReturns
Image.toInt8()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toLong

Casts the input value to a signed 64-bit integer.

UsageReturns
Image.toLong()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toShort

Casts the input value to a signed 16-bit integer.

UsageReturns
Image.toShort()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toUint16

Casts the input value to an unsigned 16-bit integer.

UsageReturns
Image.toUint16()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toUint32

Casts the input value to an unsigned 32-bit integer.

UsageReturns
Image.toUint32()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.toUint8

Casts the input value to an unsigned 8-bit integer.

UsageReturns
Image.toUint8()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.translate

Translate the input image.

UsageReturns
Image.translate(x, y, units, proj)Image
ArgumentTypeDetails
this: inputImage

xFloat

yFloat

unitsString, default: "meters"

The units for x and y; "meters" or "pixels".

projProjection, default: null

The projection in which to translate the image; defaults to the projection of the first band.

ee.Image.trigamma

Computes the trigamma function of the input.

UsageReturns
Image.trigamma()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.uint16

Casts the input value to an unsigned 16-bit integer.

UsageReturns
Image.uint16()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.uint32

Casts the input value to an unsigned 32-bit integer.

UsageReturns
Image.uint32()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.uint8

Casts the input value to an unsigned 8-bit integer.

UsageReturns
Image.uint8()Image
ArgumentTypeDetails
this: valueImage

The image to which the operation is applied.

ee.Image.unitScale

Scales the input so that the range of input values [low, high] becomes [0, 1]. Values outside the range are NOT clamped. This algorithm always produces floating point pixels.

UsageReturns
Image.unitScale(low, high)Image
ArgumentTypeDetails
this: inputImage

The image to scale.

lowFloat

The value mapped to 0.

highFloat

The value mapped to 1.

ee.Image.unmask

Replaces mask and value of the input image with the mask and value of another image at all positions where the input mask is zero. The output image retains the metadata of the input image. By default, the output image also retains the footprint of the input, but setting sameFootprint to false allows to extend the footprint.

UsageReturns
Image.unmask(value, sameFootprint)Image
ArgumentTypeDetails
this: inputImage

Input image.

valueImage, default: null

New value and mask for the masked pixels of the input image. If not specified, defaults to constant zero image which is valid everywhere.

sameFootprintBoolean, default: true

If true (or unspecified), the output retains the footprint of the input image. If false, the footprint of the output is the union of the input footprint with the footprint of the value image.

ee.Image.unmix

Unmix each pixel with the given endmembers, by computing the pseudo-inverse and multiplying it through each pixel. Returns an image of doubles with the same number of bands as endmembers.

UsageReturns
Image.unmix(endmembers, sumToOne, nonNegative)Image
ArgumentTypeDetails
this: imageImage

The input image.

endmembersList

The endmembers to unmix with.

sumToOneBoolean, default: false

Constrain the outputs to sum to one.

nonNegativeBoolean, default: false

Constrain the outputs to be non-negative.

ee.Image.updateMask

Updates an image's mask at all positions where the existing mask is not zero. The output image retains the metadata and footprint of the input image.

UsageReturns
Image.updateMask(mask)Image
ArgumentTypeDetails
this: imageImage

Input image.

maskImage

New mask for the image, as a floating-point value in the range [0, 1] (invalid = 0, valid = 1). If this image has a single band, it is used for all bands in the input image; otherwise, must have the same number of bands as the input image.

ee.Image.visualize

Produces an RGB or grayscale visualization of an image. Each of the gain, bias, min, max and gamma arguments can take either a single value, which will be applied to all bands, or a list of values the same length as bands.

UsageReturns
Image.visualize(bands, gain, bias, min, max, gamma, opacity, palette, forceRgbOutput)Image
ArgumentTypeDetails
this: imageImage

The image to visualize.

bandsObject, default: null

A list of the bands to visualize. If empty, the first 3 are used.

gainObject, default: null

The visualization gain(s) to use.

biasObject, default: null

The visualization bias(es) to use.

minObject, default: null

The value(s) to map to RGB8 value 0.

maxObject, default: null

The value(s) to map to RGB8 value 255.

gammaObject, default: null

The gamma correction factor(s) to use.

opacityNumber, default: null

The opacity scaling factor to use.

paletteObject, default: null

The color palette to use. List of CSS color identifiers or hexadecimal color strings (e.g. ['red', '00FF00', 'bluevlolet']).

forceRgbOutputBoolean, default: false

Whether to produce RGB output even for single-band inputs.

ee.Image.where

Performs conditional replacement of values.

For each pixel in each band of 'input', if the corresponding pixel in 'test' is nonzero, output the corresponding pixel in value, otherwise output the input pixel.

If at a given pixel, either test or value is masked, the input value is used. If the input is masked, nothing is done.

The output bands have the same names as the input bands. The output type of each band is the larger of the input and value types. The output image retains the metadata and footprint of the input image.

UsageReturns
Image.where(test, value)Image
ArgumentTypeDetails
this: inputImage

The input image.

testImage

The test image. The pixels of this image determines which of the input pixels is returned. If this is a single band, it is used for all bands in the input image. This may not be an array image.

valueImage

The output value to use where test is not zero. If this is a single band, it is used for all bands in the input image.

ee.Image.zeroCrossing

Finds zero-crossings on each band of an image.

UsageReturns
Image.zeroCrossing()Image
ArgumentTypeDetails
this: imageImage

The image from which to compute zero crossings.

ee.ImageCollection

ImageCollections can be constructed from the following arguments:

  - A string: assumed to be the name of a collection,

  - A list of images, or anything that can be used to construct an image.

  - A single image.

  - A computed object - reinterpreted as a collection.

UsageReturns
ee.ImageCollection(args)ImageCollection
ArgumentTypeDetails
argsComputedObject|Image|List

The constructor arguments.

ee.ImageCollection.aggregate_array

Aggregates over a given property of the objects in a collection, calculating a list of all the values of the selected property.

UsageReturns
ImageCollection.aggregate_array(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_count

Aggregates over a given property of the objects in a collection, calculating the number of non-null values of the property.

UsageReturns
ImageCollection.aggregate_count(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_count_distinct

Aggregates over a given property of the objects in a collection, calculating the number of distinct values for the selected property.

UsageReturns
ImageCollection.aggregate_count_distinct(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_first

Aggregates over a given property of the objects in a collection, calculating the property value of the first object in the collection.

UsageReturns
ImageCollection.aggregate_first(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_histogram

Aggregates over a given property of the objects in a collection, calculating a histogram of the selected property.

UsageReturns
ImageCollection.aggregate_histogram(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_max

Aggregates over a given property of the objects in a collection, calculating the maximum of the values of the selected property.

UsageReturns
ImageCollection.aggregate_max(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_mean

Aggregates over a given property of the objects in a collection, calculating the mean of the selected property.

UsageReturns
ImageCollection.aggregate_mean(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_min

Aggregates over a given property of the objects in a collection, calculating the minimum of the values of the selected property.

UsageReturns
ImageCollection.aggregate_min(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_product

Aggregates over a given property of the objects in a collection, calculating the product of the values of the selected property.

UsageReturns
ImageCollection.aggregate_product(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_sample_sd

Aggregates over a given property of the objects in a collection, calculating the sample std. deviation of the values of the selected property.

UsageReturns
ImageCollection.aggregate_sample_sd(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_sample_var

Aggregates over a given property of the objects in a collection, calculating the sample variance of the values of the selected property.

UsageReturns
ImageCollection.aggregate_sample_var(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_stats

Aggregates over a given property of the objects in a collection, calculating the sum, min, max, mean, sample standard deviation, sample variance, total standard deviation and total variance of the selected property.

UsageReturns
ImageCollection.aggregate_stats(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_sum

Aggregates over a given property of the objects in a collection, calculating the sum of the values of the selected property.

UsageReturns
ImageCollection.aggregate_sum(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_total_sd

Aggregates over a given property of the objects in a collection, calculating the total std. deviation of the values of the selected property.

UsageReturns
ImageCollection.aggregate_total_sd(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.aggregate_total_var

Aggregates over a given property of the objects in a collection, calculating the total variance of the values of the selected property.

UsageReturns
ImageCollection.aggregate_total_var(property)Object
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

propertyString

The property to use from each element of the collection.

ee.ImageCollection.and

Reduces an image collection by setting each pixel to 1 iff all the non-masked values at that pixel are non-zero across the stack of all matching bands. Bands are matched by name.

UsageReturns
ImageCollection.and()Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

ee.ImageCollection.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
ImageCollection.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.ImageCollection.cast

Casts some or all bands of each image in an ImageCollection to the specified types.

UsageReturns
ImageCollection.cast(bandTypes, bandOrder)ImageCollection
ArgumentTypeDetails
this: collectionImageCollection

The image collection to cast.

bandTypesDictionary

A dictionary from band name to band types. Types can be PixelTypes or strings. The valid strings are: 'int8', 'int16', 'int32', 'int64', 'uint8', 'uint16', 'uint32', 'byte', 'short', 'int', 'long', 'float' and 'double'. Must include all bands already in any image in the collection. If this includes bands that are not already in an input image, they will be added to the image as transparent bands.

bandOrderList

A list specifying the order of the bands in the result.Must match the keys of bandTypes.

ee.ImageCollection.combine

Makes a new collection that is a copy of the images in primary, adding all the bands from the image in secondary with a matching ID. If there's no matching image, the primary image is just copied. This is equivalent to a join on ID with merging of the bands of the result.

Note that this algorithm assumes that for a matching pair of inputs, both have the same footprint and metadata.

UsageReturns
ImageCollection.combine(secondary, overwrite)ImageCollection
ArgumentTypeDetails
this: primaryImageCollection

The primary collection to join.

secondaryImageCollection

The secondary collection to join.

overwriteBoolean, default: false

If true, bands with the same name will get overwritten. If false, bands with the same name will be renamed.

ee.ImageCollection.copyProperties

Copies metadata properties from one element to another.

UsageReturns
ImageCollection.copyProperties(source, properties, exclude)Element
ArgumentTypeDetails
this: destinationElement, default: null

The object whose properties to override.

sourceElement, default: null

The object from which to copy the properties.

propertiesList, default: null

The properties to copy. If omitted, all ordinary (i.e. non-system) properties are copied.

excludeList, default: null

The list of properties to exclude when copying all properties. Must not be specified if properties is.

ee.ImageCollection.count

Reduces an image collection by calculating the number of images with a valid mask at each pixel across the stack of all matching bands. Bands are matched by name.

UsageReturns
ImageCollection.count()Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

ee.ImageCollection.distance

Produces a DOUBLE image where each pixel is the distance in meters from the pixel center to the nearest part of any Point or LineString features in the collection. Pixels that are not within 'searchRadius' meters of a geometry will be masked out.

Distances are computed on a sphere, so there is a small error proportional to the latitude difference between each pixel and the nearest geometry.

UsageReturns
ImageCollection.distance(searchRadius, maxError)Image
ArgumentTypeDetails
this: featuresFeatureCollection

Feature collection from which to get features used to compute pixel distances.

searchRadiusFloat, default: 100000

Maximum distance in meters from each pixel to look for edges. Pixels will be masked unless there are edges within this distance.

maxErrorFloat, default: 100

Maximum reprojection error in meters, only used if the input polylines require reprojection. If '0' is provided, then this operation will fail if projection is required.

ee.ImageCollection.distinct

Removes duplicates from a collection. Note that duplicates are determined using a strong hash over the serialized form of the selected properties.

UsageReturns
ImageCollection.distinct(selectors)FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection from which objects will be selected.

selectorsSelectorSet

Which parts of the object to use for comparisons.

ee.ImageCollection.draw

Paints a vector collection for visualization. Not intended for use as input to other algorithms.

UsageReturns
ImageCollection.draw(color, pointRadius, strokeWidth)Image
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to draw.

colorString

A hex string in the format RRGGBB specifying the color to use for drawing the features.

pointRadiusInteger, default: 3

The radius in pixels of the point markers.

strokeWidthInteger, default: 2

The width in pixels of lines and polygon borders.

ee.ImageCollection.errorMatrix

Computes a 2D error matrix for a collection by comparing two columns of a collection: one containing the actual values, and one containing predicted values.The values are expected to be small contiguous integers, starting from 0. Axis 1 (the rows) of the matrix correspond to the actual values, and Axis 0 (the columns) to the predicted values.

UsageReturns
ImageCollection.errorMatrix(actual, predicted, order)ConfusionMatrix
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection.

actualString

The name of the property containing the actual value.

predictedString

The name of the property containing the predicted value.

orderList, default: null

A list of the expected values. If this argument is not specified, the values are assumed to be contiguous and span the range 0 to maxValue. If specified, only values matching this list are used, and the matrix will have dimensions and order matching the this list.

ee.ImageCollection.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
ImageCollection.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.ImageCollection.filter

Apply a filter to this collection.

Collection filtering is done by wrapping a collection in a filter algorithm. As additional filters are applied to a collection, we try to avoid adding more wrappers and instead search for a wrapper we can add to, however if the collection doesn't have a filter, this will wrap it in one.

Returns the filtered collection.

UsageReturns
ImageCollection.filter(newFilter)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

newFilterFilter

A filter to add to this collection.

ee.ImageCollection.filterBounds

Shortcut to filter a collection by geometry. Items in the collection with a footprint that fails to intersect the bounds will be excluded when the collection is evaluated.

This is equivalent to this.filter(ee.Filter.bounds(...)).

Returns the filtered collection.

UsageReturns
ImageCollection.filterBounds(geometry)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

geometryFeature|Geometry

The geometry to filter to.

ee.ImageCollection.filterDate

Shortcut to filter a collection by a date range. Items in the collection with a time_start property that doesn't fall between the start and end dates will be excluded.

This is equivalent to this.filter(ee.Filter.date(...)).

Returns the filtered collection.

UsageReturns
ImageCollection.filterDate(start, end)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

startDate|Number|String

The start date as a Date object, a string representation of a date, or milliseconds since epoch.

endDate|Number|String, optional

The end date as a Date object, a string representation of a date, or milliseconds since epoch.

ee.ImageCollection.filterMetadata

Shortcuts to filter a collection by metadata. This is equivalent to this.filter(ee.Filter.metadata(...)).

Returns the filtered collection.

UsageReturns
ImageCollection.filterMetadata(name, operator, value)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

nameString

The name of a property to filter.

operatorString

The name of a comparison operator. Possible values are: "equals", "less_than", "greater_than",

"not_equals", "not_less_than", "not_greater_than", "starts_with",

"ends_with", "not_starts_with", "not_ends_with", "contains",

"not_contains".

valueObject

  - The value to compare against.

ee.ImageCollection.first

Returns the first entry from a given collection.

UsageReturns
ImageCollection.first()Element
ArgumentTypeDetails
this: collectionFeatureCollection

The collection from which to select the first entry.

ee.ImageCollection.flatten

Flattens collections of collections.

UsageReturns
ImageCollection.flatten()FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection of collections.

ee.ImageCollection.formaTrend

Computes the long and short term trends of a time series or optionally, the trends of the ratio of the time series and a covariate. The long term trend is estimated from the linear term of a regression on the full time series. The short term trend is computed as the windowed minimum over the time series.

The time series and covariate series are expected to contain a single band each, and the time series is expected to be evenly spaced in time. The output is 4 float bands: the long and short term trends, the t-test of the long term trend against the time series, and the Bruce Hansen test of parameter stability.

UsageReturns
ImageCollection.formaTrend(covariates, windowSize)Image
ArgumentTypeDetails
this: timeSeriesImageCollection

Collection from which to extract trends.

covariatesImageCollection, default: null

Cofactors to use in the trend analysis.

windowSizeInteger, default: 6

Short term trend analysis window size, in images.

ee.ImageCollection.fromImages

Returns the image collection containing the given images.

UsageReturns
ee.ImageCollection.fromImages(images)ImageCollection
ArgumentTypeDetails
imagesList

The images to include in the collection.

ee.ImageCollection.geometry

Extracts and merges the geometries of a collection. Requires that all the geometries in the collection share the projection and edge interpretation.

UsageReturns
ImageCollection.geometry(maxError)Geometry
ArgumentTypeDetails
this: collectionFeatureCollection

The collection whose geometries will be extracted.

maxErrorErrorMargin, optional

An error margin to use when merging geometries.

ee.ImageCollection.get

Extract a property from a feature.

UsageReturns
ImageCollection.get(property)
ArgumentTypeDetails
this: objectElement

The feature to extract the property from.

propertyString

The property to extract.

ee.ImageCollection.getInfo

An imperative function that returns all the known information about this collection via an AJAX call.

Returns a collection description whose fields include:

  - features: a list containing metadata about the images in the collection.

  - bands: a dictionary describing the bands of the images in this collection.

  - properties: an optional dictionary containing the collection's metadata properties.

UsageReturns
ImageCollection.getInfo(callback)ImageCollectionDescription
ArgumentTypeDetails
this: imagecollectionImageCollection

The ImageCollection instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously. If supplied, will be called with the first parameter if successful and the second if unsuccessful.

ee.ImageCollection.getMap

An imperative function that returns a mapid via a synchronous AJAX call.

This mosaics the collection to a single image and return a mapid suitable for building a Google Maps overlay.

Returns returns a mapid and token, or undefined if a callback was specified.

UsageReturns
ImageCollection.getMap(visParams, callback)MapId|Object
ArgumentTypeDetails
this: imagecollectionImageCollection

The ImageCollection instance.

visParamsObject, optional

The visualization parameters.

callbackFunction, optional

An async callback. If not supplied, the call is made synchronously.

ee.ImageCollection.getRegion

Output an array of values for each [pixel, band, image] tuple in an ImageCollection. The output contains rows of id, lon, lat, time, and all bands for each image that intersects each pixel in the given region.

UsageReturns
ImageCollection.getRegion(geometry, scale, crs, crsTransform)List
ArgumentTypeDetails
this: collectionImageCollection

The image collection to extract data from.

geometryGeometry

The region over which to extract data.

scaleFloat, default: null

A nominal scale in meters of the projection to work in.

crsProjection, optional

The projection to work in. If unspecified, defaults to EPSG:4326. If specified in addition to scale, the projection is rescaled to the specified scale.

crsTransformList, default: null

The array of CRS transform values. This is a row-major ordering of a 3x2 affine transform. This option is mutually exclusive with the scale option, and will replace any transform already set on the given projection.

ee.ImageCollection.iterate

Applies a user-supplied function to each element of a collection. The user-supplied function is given two arguments: the current element, and the value returned by the previous call to iterate() or the first argument, for the first iteration. The result is the value returned by the final call to the user-supplied function.

Returns the result of the Collection.iterate() call.

UsageReturns
ImageCollection.iterate(algorithm, first)ComputedObject
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

algorithmFunction

The function to apply to each element. Must take two arguments: an element of the collection and the value from the previous iteration.

firstObject, optional

The initial state.

ee.ImageCollection.limit

Limit a collection to the specified number of elements, optionally sorting them by a specified property first.

Returns the limited collection.

UsageReturns
ImageCollection.limit(max, property, ascending)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

maxNumber

The number to limit the collection to.

propertyString, optional

The property to sort by, if sorting.

ascendingBoolean, optional

Whether to sort in ascending or descending order. The default is true (ascending).

ee.ImageCollection.load

Returns the image collection given its ID.

UsageReturns
ee.ImageCollection.load(id, version)ImageCollection
ArgumentTypeDetails
idString

The asset ID of the image collection.

versionLong, default: null

The version of the asset. -1 signifies the latest version.

ee.ImageCollection.map

Maps an algorithm over a collection.

Returns the mapped collection.

UsageReturns
ImageCollection.map(algorithm, dropNulls)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

algorithmFunction

The operation to map over the images or features of the collection. A JavaScript function that receives an image or features and returns one. The function is called only once and the result is captured as a description, so it cannot perform imperative operations or rely on external state.

dropNullsBoolean, optional

If true, the mapped algorithm is allowed to return nulls, and the elements for which it returns nulls will be dropped.

ee.ImageCollection.max

Reduces an image collection by calculating the maximum value of each pixel across the stack of all matching bands. Bands are matched by name.

UsageReturns
ImageCollection.max()Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

ee.ImageCollection.mean

Reduces an image collection by calculating the mean of all values at each pixel across the stack of all matching bands. Bands are matched by name.

UsageReturns
ImageCollection.mean()Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

ee.ImageCollection.median

Reduces an image collection by calculating the median of all values at each pixel across the stack of all matching bands. Bands are matched by name.

UsageReturns
ImageCollection.median()Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

ee.ImageCollection.merge

Merges two collections into one. The result has all the elements that were in either collection.

UsageReturns
ImageCollection.merge(collection2)FeatureCollection
ArgumentTypeDetails
this: collection1FeatureCollection

The first collection to merge.

collection2FeatureCollection

The second collection to merge.

ee.ImageCollection.min

Reduces an image collection by calculating the minimum value of each pixel across the stack of all matching bands. Bands are matched by name.

UsageReturns
ImageCollection.min()Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

ee.ImageCollection.mode

Reduces an image collection by calculating the most common value at each pixel across the stack of all matching bands. Bands are matched by name.

UsageReturns
ImageCollection.mode()Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

ee.ImageCollection.mosaic

Composites all the images in a collection, using the mask.

UsageReturns
ImageCollection.mosaic()Image
ArgumentTypeDetails
this: collectionImageCollection

The collection to mosaic.

ee.ImageCollection.or

Reduces an image collection by setting each pixel to 1 iff any of the non-masked values at that pixel are non-zero across the stack of all matching bands. Bands are matched by name.

UsageReturns
ImageCollection.or()Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

ee.ImageCollection.product

Reduces an image collection by calculating the product of all values at each pixel across the stack of all matching bands. Bands are matched by name.

UsageReturns
ImageCollection.product()Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

ee.ImageCollection.propertyNames

Returns the names of properties on this element.

UsageReturns
ImageCollection.propertyNames()List
ArgumentTypeDetails
this: elementElement

ee.ImageCollection.qualityMosaic

Composites all the images in a collection, using a quality band as a per-pixel ordering function.

UsageReturns
ImageCollection.qualityMosaic(qualityBand)Image
ArgumentTypeDetails
this: collectionImageCollection

The collection to mosaic.

qualityBandString

The name of the quality band in the collection.

ee.ImageCollection.randomColumn

Adds a column of deterministic pseudorandom numbers to a collection. The numbers are double-precision floating point numbers in the range 0.0 (inclusive) to 1.0 (exclusive).

UsageReturns
ImageCollection.randomColumn(columnName, seed)FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection to which to add a random column.

columnNameString, default: "random"

The name of the column to add.

seedLong, default: 0

A seed used when generating the random numbers.

ee.ImageCollection.reduce

Applies a reducer across all of the images in a collection.

If the reducer has a single input, it will be applied separately to each band of the collection; otherwise it must have the same number of inputs as the collection has bands.

The reducer output names determine the names of the output bands: reducers with multiple inputs will use the output names directly, while reducers with a single input will prefix the output name with the input band name (e.g. '10_mean', '20_mean', etc.).

UsageReturns
ImageCollection.reduce(reducer, parallelScale)Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

reducerReducer

The reducer to apply to the given collection.

parallelScaleFloat, default: 1

A scaling factor used to limit memory use; using a larger parallelScale (e.g. 2 or 4) may enable computations that run out of memory with the default.

ee.ImageCollection.reduceColumns

Apply a reducer to each element of a collection, using the given selectors to determine the inputs.

Returns a dictionary of results, keyed with the output names.

UsageReturns
ImageCollection.reduceColumns(reducer, selectors, weightSelectors)Dictionary
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to aggregate over.

reducerReducer

The reducer to apply.

selectorsList

A selector for each input of the reducer.

weightSelectorsList, default: null

A selector for each weighted input of the reducer.

ee.ImageCollection.reduceToImage

Creates an image from a feature collection by applying a reducer over the selected properties of all the features that intersect each pixel.

UsageReturns
ImageCollection.reduceToImage(properties, reducer)Image
ArgumentTypeDetails
this: collectionFeatureCollection

Feature collection to intersect with each output pixel.

propertiesList

Properties to select from each feature and pass into the reducer.

reducerReducer

A Reducer to combine the properties of each intersecting feature into a final result to store in the pixel.

ee.ImageCollection.remap

Remaps the value of a specific property in a collection. Takes two parallel lists and maps values found in one to values in the other. Any element with a value that is not specified in the first list is dropped from the output collection.

UsageReturns
ImageCollection.remap(lookupIn, lookupOut, columnName)FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to be modified.

lookupInList

The input mapping values. Restricted to strings and integers.

lookupOutList

The output mapping values. Must be the same size as lookupIn.

columnNameString

The name of the property to remap.

ee.ImageCollection.select

Select bands from each image in a collection.

Returns the image collection with selected bands.

UsageReturns
ImageCollection.select(selectors, names)ImageCollection
ArgumentTypeDetails
this: imagecollectionImageCollection

The ImageCollection instance.

selectorsList

A list of names, regexes or numeric indicies specifying the bands to select.

namesList, optional

A list of new names for the output bands. Must match the number of bands selected.

ee.ImageCollection.serialize

Returns the serialized representation of this object.

UsageReturns
ImageCollection.serialize()String
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

ee.ImageCollection.set

Overrides one or more metadata properties of an Element.

Returns the element with the specified properties overridden.

UsageReturns
ImageCollection.set(var_args)Element
ArgumentTypeDetails
this: elementElement

The Element instance.

var_argsVarArgs

Either a dictionary of properties, or a vararg sequence of properties, e.g. key1, value1, key2, value2, ...

ee.ImageCollection.setMulti

Overrides one or more metadata properties of an object.

UsageReturns
ImageCollection.setMulti(properties)Element
ArgumentTypeDetails
this: objectElement

The object whose properties to override.

propertiesDictionary

The property values to override.

ee.ImageCollection.size

Returns the number of elements in the collection.

UsageReturns
ImageCollection.size()Integer
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to count.

ee.ImageCollection.sort

Sort a collection by the specified property.

Returns the sorted collection.

UsageReturns
ImageCollection.sort(property, ascending)Collection
ArgumentTypeDetails
this: collectionCollection

The Collection instance.

propertyString

The property to sort by.

ascendingBoolean, optional

Whether to sort in ascending or descending order. The default is true (ascending).

ee.ImageCollection.style

Draw a vector collection for visualization using a simple style language.

UsageReturns
ImageCollection.style(color, pointSize, pointShape, width, fillColor, styleProperty, neighborhood)Image
ArgumentTypeDetails
this: collectionFeatureCollection

The collection to draw.

colorString, default: "black"

A default color (CSS 3.0 color value e.g. 'FF0000' or 'red') to use for drawing the features. Supports opacity (e.g.: 'FF000088' for 50% transparent red).

pointSizeInteger, default: 3

The default size in pixels of the point markers.

pointShapeString, default: "circle"

The default shape of the marker to draw at each point location. One of: circle, square, diamond, cross, plus, pentagram, hexagram, triangle, triangle_up triangle_down, triangle_left, triangle_right, pentagon, hexagon, star5, star6. This argument also supports the following Matlab marker abbreviations: o, s, d, x, +, p, h, ^, v, <, >.

widthFloat, default: 2

The default line width for lines and outlines for polygons and point shapes.

fillColorString, default: null

The color for filling polygons and point shapes. Defaults to 'color' at 0.66 opacity.

stylePropertyString, default: null

A per-feature property expected to contain a dictionary. Values in the dictionary override any default values for that feature.

neighborhoodInteger, default: 5

If styleProperty is used and any feature has a pointSize or width larger than the defaults, tiling artifacts can occur. Specifies the maximum neighborhood (pointSize + width) needed for any feature.

ee.ImageCollection.sum

Reduces an image collection by calculating the sum of all values at each pixel across the stack of all matching bands. Bands are matched by name.

UsageReturns
ImageCollection.sum()Image
ArgumentTypeDetails
this: collectionImageCollection

The image collection to reduce.

ee.ImageCollection.toArray

Converts an image collection into an image of 2D arrays. At each pixel, the images that have valid (unmasked) values in all bands are laid out along the first axis of the array in the order they appear in the image collection. The bands of each image are laid out along the second axis of the array, in the order the bands appear in that image. The array element type will be the union of the types of each band.

UsageReturns
ImageCollection.toArray()Image
ArgumentTypeDetails
this: collectionImageCollection

Image collection to convert to an array image. Bands must have scalar values, not array values.

ee.ImageCollection.toArrayPerBand

Concatenates multiple images into a single array image. The result will be masked if any input is masked.

UsageReturns
ImageCollection.toArrayPerBand(axis)Image
ArgumentTypeDetails
this: collectionImageCollection

Images to concatenate. A separate concatenation is done per band, so all the images must have the same dimensionality and shape per band, except length along the concatenation axis.

axisInteger, default: 0

Axis to concatenate along; must be at least 0 and at most the minimum dimension of any band in the collection.

ee.ImageCollection.toDictionary

Extract properties from a feature as a dictionary.

UsageReturns
ImageCollection.toDictionary(properties)Dictionary
ArgumentTypeDetails
this: elementElement

The feature to extract the property from.

propertiesList, default: null

The list of properties to extract. Defaults to all non-system properties.

ee.ImageCollection.toList

Returns the elements of a collection as a list.

UsageReturns
ImageCollection.toList(count, offset)List
ArgumentTypeDetails
this: collectionFeatureCollection

The input collection to fetch.

countInteger

The maximum number of elements to fetch.

offsetInteger, default: 0

The number of elements to discard from the start. If set, (offset + count) elements will be fetched and the first offset elements will be discarded.

ee.ImageCollection.union

Merges all geometries in a given collection into one and returns a collection containing a single feature with only an ID of 'union_result' and a geometry.

UsageReturns
ImageCollection.union(maxError)FeatureCollection
ArgumentTypeDetails
this: collectionFeatureCollection

The collection being merged.

maxErrorErrorMargin, default: null

The maximum error allowed when performing any necessary reprojections. If not specified, defaults to the error margin requested from the output.

ee.Join.apply

Joins two collections.

UsageReturns
Join.apply(primary, secondary, condition)FeatureCollection
ArgumentTypeDetails
this: joinJoin

The join to apply; determines how the the results are constructed.

primaryFeatureCollection

The primary collection.

secondaryFeatureCollection

The secondary collection.

conditionFilter

The join condition used to select the matches from the two collections.

ee.Join.inner

Returns a join that pairs elements from the primary collection with matching elements from the secondary collection. Each result has a 'primary' property that contains the element from the primary collection, and a 'secondary' property containing the matching element from the secondary collection. If measureKey is specified, the join measure is also attached to the object as a property.

UsageReturns
ee.Join.inner(primaryKey, secondaryKey, measureKey)Join
ArgumentTypeDetails
primaryKeyString, default: "primary"

The property name used to save the primary match.

secondaryKeyString, default: "secondary"

The property name used to save the secondary match.

measureKeyString, default: null

An optional property name used to save the measure of the join condition.

ee.Join.inverted

Returns a join that produces the elements of the primary collection that match no elements of the secondary collection. No properties are added to the results.

UsageReturns
ee.Join.inverted()Join

No arguments.

ee.Join.saveAll

Returns a join that pairs each element from the first collection with a group of matching elements from the second collection. The list of matches is added to each result as an additional property. If measureKey is specified, each match has the value of its join measure attached. Join measures are produced when withinDistance or maxDifference filters are used as the join condition.

UsageReturns
ee.Join.saveAll(matchesKey, ordering, ascending, measureKey)Join
ArgumentTypeDetails
matchesKeyString

The property name used to save the matches list.

orderingString, default: null

The property on which to sort the matches list.

ascendingBoolean, default: true

Whether the ordering is ascending.

measureKeyString, default: null

An optional property name used to save the measure of the join condition on each match.

ee.Join.saveBest

Returns a join that pairs each element from the first collection with a matching element from the second collection. The match with the best join measure is added to each result as an additional property. Join measures are produced when withinDistance or maxDifference filters are used as the join condition.

UsageReturns
ee.Join.saveBest(matchKey, measureKey)Join
ArgumentTypeDetails
matchKeyString

The key used to save the match.

measureKeyString

The key used to save the measure of the join condition on the match.

ee.Join.saveFirst

Returns a join that pairs each element from the first collection with a matching element from the second collection. The first match is added to the result as an additional property.

UsageReturns
ee.Join.saveFirst(matchKey, ordering, ascending, measureKey)Join
ArgumentTypeDetails
matchKeyString

The property name used to save the match.

orderingString, default: null

The property on which to sort the matches before selecting the first.

ascendingBoolean, default: true

Whether the ordering is ascending.

measureKeyString, default: null

An optional property name used to save the measure of the join condition on the match.

ee.Join.simple

Returns a join that produces the elements of the primary collection that match any element of the secondary collection. No properties are added to the results.

UsageReturns
ee.Join.simple()Join

No arguments.

ee.Kernel.add

Adds two kernels (pointwise), after aligning their centers.

UsageReturns
Kernel.add(kernel2, normalize)Kernel
ArgumentTypeDetails
this: kernel1Kernel

The first kernel.

kernel2Kernel

The second kernel.

normalizeBoolean, default: false

Normalize the kernel.

ee.Kernel.chebyshev

Generates a distance kernel based on Chebyshev distance (greatest distance along any dimension).

UsageReturns
ee.Kernel.chebyshev(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The radius of the kernel to generate.

unitsString, default: "pixels"

The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.Kernel.circle

Generates a circle-shaped boolean kernel.

UsageReturns
ee.Kernel.circle(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The radius of the kernel to generate.

unitsString, default: "pixels"

The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: true

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.Kernel.compass

Generates a 3x3 Prewitt's Compass edge-detection kernel.

UsageReturns
ee.Kernel.compass(magnitude, normalize)Kernel
ArgumentTypeDetails
magnitudeFloat, default: 1

Scale each value by this amount.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.cross

Generates a cross-shaped boolean kernel.

UsageReturns
ee.Kernel.cross(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The radius of the kernel to generate.

unitsString, default: "pixels"

The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: true

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.Kernel.diamond

Generates a diamond-shaped boolean kernel.

UsageReturns
ee.Kernel.diamond(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The radius of the kernel to generate.

unitsString, default: "pixels"

The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: true

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.Kernel.euclidean

Generates a distance kernel based on Euclidean (straight-line) distance.

UsageReturns
ee.Kernel.euclidean(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The radius of the kernel to generate.

unitsString, default: "pixels"

The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.Kernel.fixed

Creates a Kernel.

UsageReturns
ee.Kernel.fixed(width, height, weights, x, y, normalize)Kernel
ArgumentTypeDetails
widthInteger

The width of the kernel in pixels.

heightInteger

The height of the kernel in pixels.

weightsList

The pixel values of the kernel.

xInteger, default: -1

The location of the focus, as an offset from the left.

yInteger, default: -1

The location of the focus, as an offset from the top.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.gaussian

Generates a Gaussian kernel from a sampled continuous Gaussian.

UsageReturns
ee.Kernel.gaussian(radius, sigma, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The radius of the kernel to generate.

sigmaFloat, default: 1

Standard deviation of the Gaussian function (same units as radius).

unitsString, default: "pixels"

The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: true

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.Kernel.inverse

Returns a kernel which has each of its weights multiplicatively inverted. Weights with a value of zero are not inverted and remain zero.

UsageReturns
Kernel.inverse()Kernel
ArgumentTypeDetails
this: kernelKernel

The kernel to have its entries inverted.

ee.Kernel.kirsch

Generates a 3x3 Kirsch's Compass edge-detection kernel.

UsageReturns
ee.Kernel.kirsch(magnitude, normalize)Kernel
ArgumentTypeDetails
magnitudeFloat, default: 1

Scale each value by this amount.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.laplacian4

Generates a 3x3 Laplacian-4 edge-detection kernel.

UsageReturns
ee.Kernel.laplacian4(magnitude, normalize)Kernel
ArgumentTypeDetails
magnitudeFloat, default: 1

Scale each value by this amount.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.laplacian8

Generates a 3x3 Laplacian-8 edge-detection kernel.

UsageReturns
ee.Kernel.laplacian8(magnitude, normalize)Kernel
ArgumentTypeDetails
magnitudeFloat, default: 1

Scale each value by this amount.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.manhattan

Generates a distance kernel based on rectilinear (city-block) distance.

UsageReturns
ee.Kernel.manhattan(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The radius of the kernel to generate.

unitsString, default: "pixels"

The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.Kernel.octagon

Generates an octagon-shaped boolean kernel.

UsageReturns
ee.Kernel.octagon(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The radius of the kernel to generate.

unitsString, default: "pixels"

The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: true

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.Kernel.plus

Generates a plus-shaped boolean kernel.

UsageReturns
ee.Kernel.plus(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The radius of the kernel to generate.

unitsString, default: "pixels"

The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: true

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.Kernel.prewitt

Generates a 3x3 Prewitt edge-detection kernel.

UsageReturns
ee.Kernel.prewitt(magnitude, normalize)Kernel
ArgumentTypeDetails
magnitudeFloat, default: 1

Scale each value by this amount.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.rectangle

Generates a rectangular-shaped kernel.

UsageReturns
ee.Kernel.rectangle(xRadius, yRadius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
xRadiusFloat

The horizontal radius of the kernel to generate.

yRadiusFloat

The vertical radius of the kernel to generate.

unitsString, default: "pixels"

The system of measurement for the kernel ("pixels" or "meters"). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: true

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.Kernel.roberts

Generates a 2x2 Roberts edge-detection kernel.

UsageReturns
ee.Kernel.roberts(magnitude, normalize)Kernel
ArgumentTypeDetails
magnitudeFloat, default: 1

Scale each value by this amount.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.rotate

Creates a Kernel.

UsageReturns
Kernel.rotate(rotations)Kernel
ArgumentTypeDetails
this: kernelKernel

The kernel to be rotated.

rotationsInteger

Number of 90 deg. rotations to make (negative numbers rotate counterclockwise).

ee.Kernel.sobel

Generates a 3x3 Sobel edge-detection kernel.

UsageReturns
ee.Kernel.sobel(magnitude, normalize)Kernel
ArgumentTypeDetails
magnitudeFloat, default: 1

Scale each value by this amount.

normalizeBoolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.square

Generates a square-shaped boolean kernel.

UsageReturns
ee.Kernel.square(radius, units, normalize, magnitude)Kernel
ArgumentTypeDetails
radiusFloat

The radius of the kernel to generate.

unitsString, default: "pixels"

The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed.

normalizeBoolean, default: true

Normalize the kernel values to sum to 1.

magnitudeFloat, default: 1

Scale each value by this amount.

ee.List

Constructs a new list.

UsageReturns
ee.List(list)List
ArgumentTypeDetails
listList

A list or a computed object.

ee.List.add

Appends the element to the end of list.

UsageReturns
List.add(element)List
ArgumentTypeDetails
this: listList

elementObject

ee.List.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
List.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.List.cat

Concatenates the contents of other onto list.

UsageReturns
List.cat(other)List
ArgumentTypeDetails
this: listList

otherList

ee.List.contains

Returns true if list contains element.

UsageReturns
List.contains(element)Boolean
ArgumentTypeDetails
this: listList

elementObject

ee.List.containsAll

Returns true if list contains all of the elements of other, regardless of order.

UsageReturns
List.containsAll(other)Boolean
ArgumentTypeDetails
this: listList

otherList

ee.List.equals

Returns true if list contains the same elements as other, in the same order.

UsageReturns
List.equals(other)Boolean
ArgumentTypeDetails
this: listList

otherList

ee.List.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
List.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.List.flatten

Flattens any sublists into a single list.

UsageReturns
List.flatten()List
ArgumentTypeDetails
this: listList

ee.List.frequency

Returns the number of elements in list equal to element.

UsageReturns
List.frequency(element)Integer
ArgumentTypeDetails
this: listList

elementObject

ee.List.get

Returns the element at the specified position in list. A negative index counts backwards from the end of the list.

UsageReturns
List.get(index)Object
ArgumentTypeDetails
this: listList

indexInteger

ee.List.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
List.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.List.indexOf

Returns the position of the first occurrence of target in list, or -1 if list does not contain target.

UsageReturns
List.indexOf(element)Integer
ArgumentTypeDetails
this: listList

elementObject

ee.List.indexOfSublist

Returns the starting position of the first occurrence of target within list, or -1 if there is no such occurrence.

UsageReturns
List.indexOfSublist(target)Integer
ArgumentTypeDetails
this: listList

targetList

ee.List.insert

Inserts element at the specified position in list. A negative index counts backwards from the end of the list.

UsageReturns
List.insert(index, element)List
ArgumentTypeDetails
this: listList

indexInteger

elementObject

ee.List.iterate

Iterate an algorithm over a list. The algorithm is expected to take two objects, the current list item, and the result from the previous iteration or the value of first for the first iteration.

UsageReturns
List.iterate(function, first)Object
ArgumentTypeDetails
this: listList

functionAlgorithm

firstObject

ee.List.lastIndexOfSubList

Returns the starting position of the last occurrence of target within list, or -1 if there is no such occurrence.

UsageReturns
List.lastIndexOfSubList(target)Integer
ArgumentTypeDetails
this: listList

targetList

ee.List.length

Returns the number of elements in list.

UsageReturns
List.length()Integer
ArgumentTypeDetails
this: listList

ee.List.map

Map an algorithm over a list. The algorithm is expected to take an Object and return an Object.

UsageReturns
List.map(baseAlgorithm)List
ArgumentTypeDetails
this: listList

baseAlgorithmAlgorithm

ee.List.reduce

Apply a reducer to a list. If the reducer takes more than 1 input, then each element in the list is assumed to be a list of inputs. If the reducer returns a single output, it is returned directly, otherwise returns a dictionary containing the named reducer outputs.

UsageReturns
List.reduce(reducer)Object
ArgumentTypeDetails
this: listList

reducerReducer

ee.List.remove

Removes the first occurrence of the specified element from list, if it is present.

UsageReturns
List.remove(element)List
ArgumentTypeDetails
this: listList

elementObject

ee.List.removeAll

Removes from list all of the elements that are contained in other list.

UsageReturns
List.removeAll(other)List
ArgumentTypeDetails
this: listList

otherList

ee.List.repeat

Returns a new list containing value repeated count times.

UsageReturns
ee.List.repeat(value, count)List
ArgumentTypeDetails
valueObject

countInteger

ee.List.replace

Replaces the first occurrence of oldVal in list with newVal.

UsageReturns
List.replace(oldval, newval)List
ArgumentTypeDetails
this: listList

oldvalObject

newvalObject

ee.List.replaceAll

Replaces all occurrences of oldVal in list with newVal.

UsageReturns
List.replaceAll(oldval, newval)List
ArgumentTypeDetails
this: listList

oldvalObject

newvalObject

ee.List.reverse

Reverses the order of the elements in list.

UsageReturns
List.reverse()List
ArgumentTypeDetails
this: listList

ee.List.rotate

Rotates the elements of the list by the specified distance.

UsageReturns
List.rotate(distance)List
ArgumentTypeDetails
this: listList

distanceInteger

ee.List.sequence

Generate a sequence of numbers from start to end (inclusive) in increments of step, or in count equally-spaced increments. If end is not specified it is computed from start + step * count, so at least one of end or count must be specified.

UsageReturns
ee.List.sequence(start, end, step, count)List
ArgumentTypeDetails
startNumber

endNumber, default: null

stepNumber, default: 1

countInteger, default: null

ee.List.serialize

Returns the serialized representation of this object.

UsageReturns
List.serialize()String
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

ee.List.set

Replaces the value at the specified position in list with element. A negative index counts backwards from the end of the list.

UsageReturns
List.set(index, element)List
ArgumentTypeDetails
this: listList

indexInteger

elementObject

ee.List.size

Returns the number of elements in list.

UsageReturns
List.size()Integer
ArgumentTypeDetails
this: listList

ee.List.slice

Returns a portion of list between the start index, inclusive, and end index, exclusive. Negative values for start or end count backwards from the end of the list. Values greater than the size of the list are legal but are truncated to the size of list.

UsageReturns
List.slice(start, end)List
ArgumentTypeDetails
this: listList

startInteger

endInteger, default: null

ee.List.sort

Sorts the list into ascending order.

UsageReturns
List.sort()List
ArgumentTypeDetails
this: listList

ee.List.splice

Starting at the start index, removes count elements from list and insert the contents of other at that location. If start is negative, it counts backwards from the end of the list.

UsageReturns
List.splice(start, count, other)List
ArgumentTypeDetails
this: listList

startInteger

countInteger

otherList, default: null

ee.List.swap

Swaps the elements at the specified positions. A negative position counts backwards from the end of the list.

UsageReturns
List.swap(pos1, pos2)List
ArgumentTypeDetails
this: listList

pos1Integer

pos2Integer

ee.List.zip

Pairs the elements of two lists to create a list of two-element lists. When the input lists are of different sizes, the final list has the same size as the shortest one.

UsageReturns
List.zip(other)List
ArgumentTypeDetails
this: listList

otherList

ee.Number

Constructs a new Number.

UsageReturns
ee.Number(number)Number
ArgumentTypeDetails
numberNumber|Object

A number or a computed object.

ee.Number.abs

Computes the absolute value of the input.

UsageReturns
Number.abs()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.acos

Computes the arc cosine in radians of the input.

UsageReturns
Number.acos()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.add

Adds the first value to the second.

UsageReturns
Number.add(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.and

Returns 1 iff both values are non-zero.

UsageReturns
Number.and(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
Number.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.Number.asin

Computes the arc sine in radians of the input.

UsageReturns
Number.asin()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.atan

Computes the arc tangent in radians of the input.

UsageReturns
Number.atan()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.atan2

Calculates the angle formed by the 2D vector [x, y].

UsageReturns
Number.atan2(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.bitCount

Calculates the number of one-bits in the 64-bit two's complement binary representation of the input.

UsageReturns
Number.bitCount()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.bitwiseAnd

Calculates the bitwise AND of the input values.

UsageReturns
Number.bitwiseAnd(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.bitwiseNot

Calculates the bitwise NOT of the input, in the smallest signed integer type that can hold the input.

UsageReturns
Number.bitwiseNot()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.bitwiseOr

Calculates the bitwise OR of the input values.

UsageReturns
Number.bitwiseOr(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.bitwiseXor

Calculates the bitwise XOR of the input values.

UsageReturns
Number.bitwiseXor(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.bitwise_and

Calculates the bitwise AND of the input values.

UsageReturns
Number.bitwise_and(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.bitwise_not

Calculates the bitwise NOT of the input, in the smallest signed integer type that can hold the input.

UsageReturns
Number.bitwise_not()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.bitwise_or

Calculates the bitwise OR of the input values.

UsageReturns
Number.bitwise_or(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.bitwise_xor

Calculates the bitwise XOR of the input values.

UsageReturns
Number.bitwise_xor(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.byte

Casts the input value to an unsigned 8-bit integer.

UsageReturns
Number.byte()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.cbrt

Computes the cubic root of the input.

UsageReturns
Number.cbrt()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.ceil

Computes the smallest integer greater than or equal to the input.

UsageReturns
Number.ceil()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.cos

Computes the cosine of the input in radians.

UsageReturns
Number.cos()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.cosh

Computes the hyperbolic cosine of the input.

UsageReturns
Number.cosh()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.digamma

Computes the digamma function of the input.

UsageReturns
Number.digamma()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.divide

Divides the first value by the second, returning 0 for division by 0.

UsageReturns
Number.divide(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.double

Casts the input value to a 64-bit float.

UsageReturns
Number.double()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.eq

Returns 1 iff the first value is equal to the second.

UsageReturns
Number.eq(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.erf

Computes the error function of the input.

UsageReturns
Number.erf()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.erfInv

Computes the inverse error function of the input.

UsageReturns
Number.erfInv()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.erfc

Computes the complementary error function of the input.

UsageReturns
Number.erfc()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.erfcInv

Computes the inverse complementary error function of the input.

UsageReturns
Number.erfcInv()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.evaluate

Asynchronously retrieves the value of this object from the server and passes it to the provided callback function.

UsageReturns
Number.evaluate(callback)
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction

A function of the form function(success, failure), called when the server returns an answer. If the request succeeded, the success argument contains the evaluated result. If the request failed, the failure argument will contains an error message.

ee.Number.exp

Computes the Euler's number e raised to the power of the input.

UsageReturns
Number.exp()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.first

Selects the value of the first value.

UsageReturns
Number.first(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.firstNonZero

Selects the first value if it is non-zero, and the second value otherwise.

UsageReturns
Number.firstNonZero(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.first_nonzero

Selects the first value if it is non-zero, and the second value otherwise.

UsageReturns
Number.first_nonzero(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.float

Casts the input value to a 32-bit float.

UsageReturns
Number.float()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.floor

Computes the largest integer less than or equal to the input.

UsageReturns
Number.floor()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.format

Convert a number to a string using printf-style formatting.

UsageReturns
Number.format(pattern)String
ArgumentTypeDetails
this: numberNumber

The number to convert to a string.

patternString, default: "%s"

A printf-style format string. For example, '%.2f' produces numbers formatted like '3.14', and '%05d' produces numbers formatted like '00042'. The format string must satisfy the following criteria:

1. Zero or more prefix characters.

2. Exactly one '%'.

3. Zero or more modifier characters in the set [#-+ 0,(.\d].

4. Exactly one conversion character in the set [sdoxXeEfgGaA].

5. Zero or more suffix characters.

 

For more about format strings, see https://docs.oracle.com/javase/7/docs/api/java/util/Formatter.html

ee.Number.gamma

Computes the gamma function of the input.

UsageReturns
Number.gamma()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.gammainc

Calculates the regularized lower incomplete Gamma function (γ(x,a).

UsageReturns
Number.gammainc(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.getInfo

Retrieves the value of this object from the server.

If no callback function is provided, the request is made synchronously. If a callback is provided, the request is made asynchronously.

The asynchronous mode is preferred because the synchronous mode stops all other code (for example, the EE Code Editor UI) while waiting for the server. To make an asynchronous request, evaluate() is preferred over getInfo().

Returns the computed value of this object.

UsageReturns
Number.getInfo(callback)Object
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

callbackFunction, optional

An optional callback. If not supplied, the call is made synchronously.

ee.Number.gt

Returns 1 iff the first value is greater than the second.

UsageReturns
Number.gt(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.gte

Returns 1 iff the first value is greater than or equal to the second.

UsageReturns
Number.gte(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.hypot

Calculates the magnitude of the 2D vector [x, y].

UsageReturns
Number.hypot(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.int

Casts the input value to a signed 32-bit integer.

UsageReturns
Number.int()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.int16

Casts the input value to a signed 16-bit integer.

UsageReturns
Number.int16()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.int32

Casts the input value to a signed 32-bit integer.

UsageReturns
Number.int32()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.int64

Casts the input value to a signed 64-bit integer.

UsageReturns
Number.int64()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.int8

Casts the input value to a signed 8-bit integer.

UsageReturns
Number.int8()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.lanczos

Computes the Lanczos approximation of the input.

UsageReturns
Number.lanczos()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.leftShift

Calculates the left shift of v1 by v2 bits.

UsageReturns
Number.leftShift(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.left_shift

Calculates the left shift of v1 by v2 bits.

UsageReturns
Number.left_shift(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.log

Computes the natural logarithm of the input.

UsageReturns
Number.log()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.log10

Computes the base-10 logarithm of the input.

UsageReturns
Number.log10()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.long

Casts the input value to a signed 64-bit integer.

UsageReturns
Number.long()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.lt

Returns 1 iff the first value is less than the second.

UsageReturns
Number.lt(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.lte

Returns 1 iff the first value is less than or equal to the second.

UsageReturns
Number.lte(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.max

Selects the maximum of the first and second values.

UsageReturns
Number.max(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.min

Selects the minimum of the first and second values.

UsageReturns
Number.min(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.mod

Calculates the remainder of the first value divided by the second.

UsageReturns
Number.mod(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.multiply

Multiplies the first value by the second.

UsageReturns
Number.multiply(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.neq

Returns 1 iff the first value is not equal to the second.

UsageReturns
Number.neq(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.not

Returns 0 if the input is non-zero, and 1 otherwise.

UsageReturns
Number.not()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.or

Returns 1 iff either input value is non-zero.

UsageReturns
Number.or(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.parse

Convert a string to a number.

UsageReturns
ee.Number.parse(input, radix)Number
ArgumentTypeDetails
inputString

The string to convert to a number.

radixInteger, default: 10

An integer representing the base number system from which to convert. If input is not an integer, radix must equal 10 or not be specified.

ee.Number.pow

Raises the first value to the power of the second.

UsageReturns
Number.pow(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.rightShift

Calculates the signed right shift of v1 by v2 bits.

UsageReturns
Number.rightShift(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.right_shift

Calculates the signed right shift of v1 by v2 bits.

UsageReturns
Number.right_shift(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.round

Computes the integer nearest to the input.

UsageReturns
Number.round()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.serialize

Returns the serialized representation of this object.

UsageReturns
Number.serialize()String
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

ee.Number.short

Casts the input value to a signed 16-bit integer.

UsageReturns
Number.short()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.sin

Computes the sine of the input in radians.

UsageReturns
Number.sin()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.sinh

Computes the hyperbolic sine of the input.

UsageReturns
Number.sinh()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.sqrt

Computes the square root of the input.

UsageReturns
Number.sqrt()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.subtract

Subtracts the second value from the first.

UsageReturns
Number.subtract(right)Number
ArgumentTypeDetails
this: leftNumber

The left-hand value.

rightNumber

The right-hand value.

ee.Number.tan

Computes the tangent of the input in radians.

UsageReturns
Number.tan()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.tanh

Computes the hyperbolic tangent of the input.

UsageReturns
Number.tanh()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toByte

Casts the input value to an unsigned 8-bit integer.

UsageReturns
Number.toByte()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toDouble

Casts the input value to a 64-bit float.

UsageReturns
Number.toDouble()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toFloat

Casts the input value to a 32-bit float.

UsageReturns
Number.toFloat()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toInt

Casts the input value to a signed 32-bit integer.

UsageReturns
Number.toInt()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toInt16

Casts the input value to a signed 16-bit integer.

UsageReturns
Number.toInt16()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toInt32

Casts the input value to a signed 32-bit integer.

UsageReturns
Number.toInt32()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toInt64

Casts the input value to a signed 64-bit integer.

UsageReturns
Number.toInt64()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toInt8

Casts the input value to a signed 8-bit integer.

UsageReturns
Number.toInt8()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toLong

Casts the input value to a signed 64-bit integer.

UsageReturns
Number.toLong()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toShort

Casts the input value to a signed 16-bit integer.

UsageReturns
Number.toShort()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toUint16

Casts the input value to an unsigned 16-bit integer.

UsageReturns
Number.toUint16()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toUint32

Casts the input value to an unsigned 32-bit integer.

UsageReturns
Number.toUint32()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.toUint8

Casts the input value to an unsigned 8-bit integer.

UsageReturns
Number.toUint8()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.trigamma

Computes the trigamma function of the input.

UsageReturns
Number.trigamma()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.uint16

Casts the input value to an unsigned 16-bit integer.

UsageReturns
Number.uint16()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.uint32

Casts the input value to an unsigned 32-bit integer.

UsageReturns
Number.uint32()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.Number.uint8

Casts the input value to an unsigned 8-bit integer.

UsageReturns
Number.uint8()Number
ArgumentTypeDetails
this: inputNumber

The input value.

ee.PixelType

Returns a PixelType of the given precision with the given limits per element, and an optional dimensionality.

UsageReturns
ee.PixelType(precision, minValue, maxValue, dimensions)PixelType
ArgumentTypeDetails
precisionObject

The pixel precision, one of 'int', 'float', or 'double'.

minValueNumber, default: null

The minimum value of pixels of this type. If precision is 'float' or 'double', this can be null, signifying negative infinity.

maxValueNumber, default: null

The maximum value of pixels of this type. If precision is 'float' or 'double', this can be null, signifying positive infinity.

dimensionsInteger, default: 0

The number of dimensions in which pixels of this type can vary; 0 is a scalar, 1 is a vector, 2 is a matrix, etc.

ee.PixelType.double

Returns the 64-bit floating point pixel type.

UsageReturns
ee.PixelType.double()PixelType

No arguments.

ee.PixelType.float

Returns the 32-bit floating point pixel type.

UsageReturns
ee.PixelType.float()PixelType

No arguments.

ee.PixelType.int16

Returns the 16-bit signed integer pixel type.

UsageReturns
ee.PixelType.int16()PixelType

No arguments.

ee.PixelType.int32

Returns the 32-bit signed integer pixel type.

UsageReturns
ee.PixelType.int32()PixelType

No arguments.

ee.PixelType.int64

Returns the 64-bit signed integer pixel type.

UsageReturns
ee.PixelType.int64()PixelType

No arguments.

ee.PixelType.int8

Returns the 8-bit signed integer pixel type.

UsageReturns
ee.PixelType.int8()PixelType

No arguments.

ee.PixelType.uint16

Returns the 16-bit unsigned integer pixel type.

UsageReturns
ee.PixelType.uint16()PixelType

No arguments.

ee.PixelType.uint32

Returns the 32-bit unsigned integer pixel type.

UsageReturns
ee.PixelType.uint32()PixelType

No arguments.

ee.PixelType.uint8

Returns the 8-bit unsigned integer pixel type.

UsageReturns
ee.PixelType.uint8()PixelType

No arguments.

ee.Projection

Returns a Projection with the given base coordinate system and the given transform between projected coordinates and the base. If no transform is specified, the identity transform is assumed.

UsageReturns
ee.Projection(crs, transform, transformWkt)Projection
ArgumentTypeDetails
crsObject

The base coordinate reference system of this Projection, given as a well-known authority code (e.g. 'EPSG:4326') or a WKT string.

transformList, default: null

The transform between projected coordinates and the base coordinate system, specified as a 2x3 affine transform matrix in row-major order: [xScale, xShearing, xTranslation, yShearing, yScale, yTranslation]. May not specify both this and 'transformWkt'.

transformWktString, default: null

The transform between projected coordinates and the base coordinate system, specified as a WKT string. May not specify both this and 'transform'.

ee.Projection.atScale

Returns the projection scaled such that its units have the given scale in linear meters, as measured at the point of true scale.

UsageReturns
Projection.atScale(meters)Projection
ArgumentTypeDetails
this: projectionProjection

metersFloat

ee.Projection.crs

Returns the authority code (e.g. 'EPSG:4326') for the base coordinate system of this projection, or null if the base coordinate system is not found in any available database.

UsageReturns
Projection.crs()String
ArgumentTypeDetails
this: projectionProjection

ee.Projection.nominalScale

Returns the linear scale in meters of the units of this projection, as measured at the point of true scale.

UsageReturns
Projection.nominalScale()Float
ArgumentTypeDetails
this: projProjection

ee.Projection.scale

Returns the projection scaled by the given amount in each axis.

UsageReturns
Projection.scale(x, y)Projection
ArgumentTypeDetails
this: projectionProjection

xFloat

yFloat

ee.Projection.transform

Returns a WKT representation of the transform of this Projection. This is the transform that converts from projected coordinates to the base coordinate system.

UsageReturns
Projection.transform()String
ArgumentTypeDetails
this: projectionProjection

ee.Projection.translate

Returns the projection translated by the given amount in each axis.

UsageReturns
Projection.translate(x, y)Projection
ArgumentTypeDetails
this: projectionProjection

xFloat

yFloat

ee.Projection.wkt

Returns a WKT representation of the base coordinate system of this Projection.

UsageReturns
Projection.wkt()String
ArgumentTypeDetails
this: projectionProjection

ee.Reducer.allNonZero

Returns a Reducer that returns 1 if all of its inputs are non-zero, 0 otherwise.

UsageReturns
ee.Reducer.allNonZero()Reducer

No arguments.

ee.Reducer.anyNonZero

Returns a Reducer that returns 1 if any of its inputs are non-zero, 0 otherwise.

UsageReturns
ee.Reducer.anyNonZero()Reducer

No arguments.

ee.Reducer.autoHistogram

Create a reducer that will compute a histogram of the inputs. The output is a Nx2 array of the lower bucket bounds and the counts of each bucket, and is suitable for use per-pixel.

UsageReturns
ee.Reducer.autoHistogram(maxBuckets, minBucketWidth, maxRaw)Reducer
ArgumentTypeDetails
maxBucketsInteger, default: null

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidthFloat, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRawInteger, default: null

The number of values to accumulate before building the initial histogram.

ee.Reducer.bitwiseAnd

Returns a Reducer that computes the bitwise-and summation of its inputs.

UsageReturns
ee.Reducer.bitwiseAnd()Reducer

No arguments.

ee.Reducer.bitwiseOr

Returns a Reducer that computes the bitwise-or summation of its inputs.

UsageReturns
ee.Reducer.bitwiseOr()Reducer

No arguments.

ee.Reducer.centeredCovariance

Creates a reducer that reduces some number of 1-D arrays of the same length N to a covariance matrix of shape NxN. WARNING: this reducer requires that the data has been mean centered.

UsageReturns
ee.Reducer.centeredCovariance()Reducer

No arguments.

ee.Reducer.combine

Creates a Reducer that runs two reducers in parallel. The combined reducer's outputs will be those of reducer1 followed by those of reducer2, where the output names of reducer2 are prefixed with the given string.

If sharedInputs is true, the reducers must have the same number of inputs, and the combined reducer's will match them; if it is false, the inputs of the combined reducer will be those of reducer1 followed by those of reducer2.

UsageReturns
Reducer.combine(reducer2, outputPrefix, sharedInputs)Reducer
ArgumentTypeDetails
this: reducer1Reducer

reducer2Reducer

outputPrefixString, default: ""

Prefix for reducer2's output names.

sharedInputsBoolean, default: false

ee.Reducer.count

Returns a Reducer that computes the number of non-null inputs.

UsageReturns
ee.Reducer.count()Reducer

No arguments.

ee.Reducer.countDistinct

Returns a Reducer that computes the number of distinct inputs.

UsageReturns
ee.Reducer.countDistinct()Reducer

No arguments.

ee.Reducer.countEvery

Returns a Reducer that computes the number of inputs.

UsageReturns
ee.Reducer.countEvery()Reducer

No arguments.

ee.Reducer.covariance

Creates a reducer that reduces some number of 1-D arrays of the same length N to a covariance matrix of shape NxN. This reducer uses the one-pass covariance formula from Sandia National Laboratories Technical Report SAND2008-6212, which can lose accuracy if the values span a large range.

UsageReturns
ee.Reducer.covariance()Reducer

No arguments.

ee.Reducer.first

Returns a Reducer that returns the first of its inputs.

UsageReturns
ee.Reducer.first()Reducer

No arguments.

ee.Reducer.firstNonNull

Returns a Reducer that returns the first of its non-null inputs.

UsageReturns
ee.Reducer.firstNonNull()Reducer

No arguments.

ee.Reducer.fixedHistogram

Creates a reducer that will compute a histogram of the inputs using a fixed number of fixed width bins. Values outside of the [min, max) range are ignored. The output is a Nx2 array of bucket lower edges and counts and is suitable for use per-pixel.

UsageReturns
ee.Reducer.fixedHistogram(min, max, steps)Reducer
ArgumentTypeDetails
minFloat

The lower (inclusive) bound of the first bucket.

maxFloat

The upper (exclusive) bound of the last bucket.

stepsInteger

The number of buckets to use.

ee.Reducer.forEach

Creates a Reducer by combining a copy of the given reducer for each output name in the given list. If the reducer has a single output, the output names are used as-is; otherwise they are prefixed to the original output names.

UsageReturns
Reducer.forEach(outputNames)Reducer
ArgumentTypeDetails
this: reducerReducer

outputNamesList

ee.Reducer.forEachBand

Creates a Reducer by combining a copy of the given reducer for each band in the given image, using the band names as output names.

UsageReturns
Reducer.forEachBand(image)Reducer
ArgumentTypeDetails
this: reducerReducer

imageImage

ee.Reducer.forEachElement

Separately reduces each position in array inputs of equal shape, producing an array output of the same shape.

For example, with the 'sum' reducer applied to 5 arrays with shape 2x2, the output will be a 2x2 array, where each position is the sum of the 5 values at that position.

UsageReturns
Reducer.forEachElement()Reducer
ArgumentTypeDetails
this: reducerReducer

The reducer to apply to each array element.

ee.Reducer.frequencyHistogram

Returns a Reducer that returns a (weighted) frequency table of its inputs.

UsageReturns
ee.Reducer.frequencyHistogram()Reducer

No arguments.

ee.Reducer.getOutputs

Returns a list of the output names of the given reducer.

UsageReturns
Reducer.getOutputs()List
ArgumentTypeDetails
this: reducerReducer

ee.Reducer.group

Groups reducer records by the value of a given input, and reduces each group with the given reducer.

UsageReturns
Reducer.group(groupField, groupName)Reducer
ArgumentTypeDetails
this: reducerReducer

The reducer to apply to each group, without the group field.

groupFieldInteger, default: 0

The field that contains record groups.

groupNameString, default: "group"

The dictionary key that contains the group. Defaults to 'group'.

ee.Reducer.histogram

Create a reducer that will compute a histogram of the inputs.

UsageReturns
ee.Reducer.histogram(maxBuckets, minBucketWidth, maxRaw)Reducer
ArgumentTypeDetails
maxBucketsInteger, default: null

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidthFloat, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRawInteger, default: null

The number of values to accumulate before building the initial histogram.

ee.Reducer.intervalMean

Creates a Reducer to compute the mean of all inputs in the specified percentile range. For small numbers of inputs (up to maxRaw) the mean will be computed directly; for larger numbers of inputs the mean will be derived from a histogram.

UsageReturns
ee.Reducer.intervalMean(minPercentile, maxPercentile, maxBuckets, minBucketWidth, maxRaw)Reducer
ArgumentTypeDetails
minPercentileFloat

The lower bound of the percentile range.

maxPercentileFloat

The upper bound of the percentile range.

maxBucketsInteger, default: null

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidthFloat, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRawInteger, default: null

The number of values to accumulate before building the initial histogram.

ee.Reducer.kendallsCorrelation

Creates a reducer that computes the Kendall's Tau-b rank correlation and p-value on a two-sided test of H0: x and y are independent. A positive tau value indicates an increasing trend; negative value indicates a decreasing trend. Currently the p-value test is disabled and only returns null.

UsageReturns
ee.Reducer.kendallsCorrelation(numInputs)Reducer
ArgumentTypeDetails
numInputsInteger, default: 1

The number of inputs to expect (1 or 2). If 1 is specified, automatically generates sequence numbers for the x value (meaning there can be no ties).

ee.Reducer.last

Returns a Reducer that returns the last of its inputs.

UsageReturns
ee.Reducer.last()Reducer

No arguments.

ee.Reducer.lastNonNull

Returns a Reducer that returns the last of its non-null inputs.

UsageReturns
ee.Reducer.lastNonNull()Reducer

No arguments.

ee.Reducer.linearFit

Returns a Reducer that computes the slope and offset for a (weighted) linear regression of 2 inputs.

UsageReturns
ee.Reducer.linearFit()Reducer

No arguments.

ee.Reducer.linearRegression

Creates a reducer that computes a linear least squares regression with numX independent variables and numY dependent variables.

Each input tuple will have values for the independent variables followed by the dependent variables.

The first output is a coefficients array with dimensions (numX, numY); each column contains the coefficients for the corresponding dependent variable. The second output is a vector of the root mean square of the residuals of each dependent variable. Both outputs are null if the system is underdetermined, e.g. the number of inputs is less than or equal to numX.

UsageReturns
ee.Reducer.linearRegression(numX, numY)Reducer
ArgumentTypeDetails
numXInteger

The number of input dimensions.

numYInteger, default: 1

The number of output dimensions.

ee.Reducer.max

Creates a reducer that outputs the maximum value of its (first) input. If numInputs is greater than one, also outputs the corresponding values of the additional inputs.

UsageReturns
ee.Reducer.max(numInputs)Reducer
ArgumentTypeDetails
numInputsInteger, default: 1

The number of inputs.

ee.Reducer.mean

Returns a Reducer that computes the (weighted) arithmetic mean of its inputs.

UsageReturns
ee.Reducer.mean()Reducer

No arguments.

ee.Reducer.median

Create a reducer that will compute the median of the inputs. For small numbers of inputs (up to maxRaw) the median will be computed directly; for larger numbers of inputs the median will be derived from a histogram.

UsageReturns
ee.Reducer.median(maxBuckets, minBucketWidth, maxRaw)Reducer
ArgumentTypeDetails
maxBucketsInteger, default: null

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidthFloat, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRawInteger, default: null

The number of values to accumulate before building the initial histogram.

ee.Reducer.min

Creates a reducer that outputs the minimum value of its (first) input. If numInputs is greater than one, also outputs the corresponding values of the additional inputs.

UsageReturns
ee.Reducer.min(numInputs)Reducer
ArgumentTypeDetails
numInputsInteger, default: 1

The number of inputs.

ee.Reducer.minMax

Returns a Reducer that computes the minimum and maximum of its inputs.

UsageReturns
ee.Reducer.minMax()Reducer

No arguments.

ee.Reducer.mode

Create a reducer that will compute the mode of the inputs. For small numbers of inputs (up to maxRaw) the mode will be computed directly; for larger numbers of inputs the mode will be derived from a histogram.

UsageReturns
ee.Reducer.mode(maxBuckets, minBucketWidth, maxRaw)Reducer
ArgumentTypeDetails
maxBucketsInteger, default: null

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidthFloat, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRawInteger, default: null

The number of values to accumulate before building the initial histogram.

ee.Reducer.pearsonsCorrelation

Creates a two-input reducer that computes Pearson's product-moment correlation coefficient and the 2-sided p-value test for correlation = 0.

UsageReturns
ee.Reducer.pearsonsCorrelation()Reducer

No arguments.

ee.Reducer.percentile

Create a reducer that will compute the specified percentiles, e.g. given [0, 50, 100] will produce outputs named 'p0', 'p50', and 'p100' with the min, median, and max respectively. For small numbers of inputs (up to maxRaw) the percentiles will be computed directly; for larger numbers of inputs the percentiles will be derived from a histogram.

UsageReturns
ee.Reducer.percentile(percentiles, outputNames, maxBuckets, minBucketWidth, maxRaw)Reducer
ArgumentTypeDetails
percentilesList

A list of numbers between 0 and 100.

outputNamesList, default: null

A list of names for the outputs, or null to get default names.

maxBucketsInteger, default: null

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidthFloat, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRawInteger, default: null

The number of values to accumulate before building the initial histogram.

ee.Reducer.product

Returns a Reducer that computes the product of its inputs.

UsageReturns
ee.Reducer.product()Reducer

No arguments.

ee.Reducer.repeat

Creates a Reducer by combining the specified number of copies of the given reducer. Output names are the same as the given reducer, but each is a list of the corresponding output from each of the reducers.

UsageReturns
Reducer.repeat(count)Reducer
ArgumentTypeDetails
this: reducerReducer

countInteger

ee.Reducer.robustLinearRegression

Creates a reducer that computes a robust least squares regression with numX independent variables and numY dependent variables, using iteratively reweighted least squares with the Talwar cost function. A point is considered an outlier if the RMS of residuals is greater than beta.

Each input tuple will have values for the independent variables followed by the dependent variables.

The first output is a coefficients array with dimensions (numX, numY); each column contains the coefficients for the corresponding dependent variable. The second is a vector of the root mean square of the residuals of each dependent variable. Both outputs are null if the system is underdetermined, e.g. the number of inputs is less than numX.

UsageReturns
ee.Reducer.robustLinearRegression(numX, numY, beta)Reducer
ArgumentTypeDetails
numXInteger

The number of input dimensions.

numYInteger, default: 1

The number of output dimensions.

betaFloat, default: null

Residual error outlier margin. If null, a default value will be computed.

ee.Reducer.sampleStdDev

Returns a Reducer that computes the sample standard deviation of its inputs.

UsageReturns
ee.Reducer.sampleStdDev()Reducer

No arguments.

ee.Reducer.sampleVariance

Returns a Reducer that computes the sample variance of its inputs.

UsageReturns
ee.Reducer.sampleVariance()Reducer

No arguments.

ee.Reducer.sensSlope

Creates a two-input reducer that computes the Sen's slope estimator. It returns two double values; the estimated slope and the offset.

UsageReturns
ee.Reducer.sensSlope()Reducer

No arguments.

ee.Reducer.setOutputs

Returns a Reducer with the same inputs as the given Reducer, but with outputs renamed and/or removed.

UsageReturns
Reducer.setOutputs(outputs)Reducer
ArgumentTypeDetails
this: reducerReducer

outputsList

The new output names; any output whose name is null or empty will be dropped.

ee.Reducer.spearmansCorrelation

Creates a two-input reducer that computes the Spearman's rank-moment correlation and its p-value on a two-sided test of H0: x and y are independent. Currently, the p-value test is disabled and returns null.

UsageReturns
ee.Reducer.spearmansCorrelation()Reducer

No arguments.

ee.Reducer.splitWeights

Returns a Reducer with the same outputs as the given Reducer, but with each weighted input replaced by two unweighted inputs.

UsageReturns
Reducer.splitWeights()Reducer
ArgumentTypeDetails
this: reducerReducer

ee.Reducer.stdDev

Returns a Reducer that computes the standard deviation of its inputs.

UsageReturns
ee.Reducer.stdDev()Reducer

No arguments.

ee.Reducer.sum

Returns a Reducer that computes the (weighted) sum of its inputs.

UsageReturns
ee.Reducer.sum()Reducer

No arguments.

ee.Reducer.toCollection

Returns a reducer that collects its inputs into a FeatureCollection.

UsageReturns
ee.Reducer.toCollection(propertyNames, numOptional)Reducer
ArgumentTypeDetails
propertyNamesList

The property names that will be defined on each output feature; determines the number of reducer inputs.

numOptionalInteger, default: 0

The last numOptional inputs will be considered optional; the other inputs must be non-null or the input tuple will be dropped.

ee.Reducer.toList

Creates a reducer that collects its inputs into a list, optionally grouped into tuples.

UsageReturns
ee.Reducer.toList(tupleSize, numOptional)Reducer
ArgumentTypeDetails
tupleSizeInteger, default: null

The size of each output tuple, or null for no grouping. Also determines the number of inputs (null tupleSize has 1 input).

numOptionalInteger, default: 0

The last numOptional inputs will be considered optional; the other inputs must be non-null or the input tuple will be dropped.

ee.Reducer.unweighted

Returns a Reducer with the same inputs and outputs as the given Reducer, but with no weighted inputs.

UsageReturns
Reducer.unweighted()Reducer
ArgumentTypeDetails
this: reducerReducer

ee.Reducer.variance

Returns a Reducer that computes the variance of its inputs.

UsageReturns
ee.Reducer.variance()Reducer

No arguments.

ee.SelectorSet

Returns a SelectorSet for a list of selector paths.

UsageReturns
ee.SelectorSet(paths)SelectorSet
ArgumentTypeDetails
pathsObject

ee.String

Constructs a new String.

UsageReturns
ee.String(string)String
ArgumentTypeDetails
stringObject|String

A string or a computed object.

ee.String.aside

Calls a function passing this object as the first argument, and returning itself. Convenient e.g. when debugging:

var c = ee.ImageCollection('foo').aside(print)

.filterDate('2001-01-01', '2002-01-01').aside(print, 'In 2001')

.filterBounds(geom).aside(print, 'In region')

.aside(Map.addLayer, {min: 0, max: 142}, 'Filtered')

.select('a', 'b');

Returns the same object, for chaining.

UsageReturns
String.aside(func, var_args)ComputedObject
ArgumentTypeDetails
this: computedobjectComputedObject

The ComputedObject instance.

funcFunction

The function to call.

var_argsVarArgs

Any extra arguments to pass to the function.

ee.String.cat

Concatenates two strings.

UsageReturns
String.cat(string2)String
ArgumentTypeDetails
this: string1String

The first string.

string2String

The second string.