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.

Usage

Returns

ee.Algorithms.CannyEdgeDetector(image, threshold, sigma)

Image

Argument

Type

Details

image

Image

The image on which to apply edge detection.

threshold

Float

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

ee.Algorithms.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].

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.

Usage

Returns

ee.Algorithms.Date(value, timeZone)

Date

Argument

Type

Details

value

Object

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'.

timeZone

String, 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.

Usage

Returns

ee.Algorithms.Describe(input)

Object

Argument

Type

Details

input

Object

The object to describe.

ee.Algorithms.Dictionary

Constructs a dictionary.

Usage

Returns

ee.Algorithms.Dictionary(input)

Dictionary

Argument

Type

Details

input

Object, 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.

Usage

Returns

ee.Algorithms.FMask.fillMinima(image, borderValue, neighborhood)

Image

Argument

Type

Details

image

Image

The image to fill.

borderValue

Long, default: null

The border value.

neighborhood

Integer, 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.

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

geodesic

Boolean, 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.

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

geodesic

Boolean, 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.

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

geodesic

Boolean, 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.

maxError

ErrorMargin, default: null

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

ee.Algorithms.GeometryConstructors.MultiLineString

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

crs

Projection, 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.

geodesic

Boolean, 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.

maxError

ErrorMargin, 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.

Usage

Returns

ee.Algorithms.GeometryConstructors.MultiPoint(coordinates, crs)

Geometry

Argument

Type

Details

coordinates

List

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

crs

Projection, 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.

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

crs

Projection, 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.

geodesic

Boolean, 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.

maxError

ErrorMargin, default: null

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

evenOdd

Boolean, 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.

Usage

Returns

ee.Algorithms.GeometryConstructors.Point(coordinates, crs)

Geometry

Argument

Type

Details

coordinates

List

The coordinates of this Point in x,y order.

crs

Projection, 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

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.

crs

Projection, 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.

geodesic

Boolean, 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.

maxError

ErrorMargin, default: null

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

evenOdd

Boolean, 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

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

crs

Projection, 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.

geodesic

Boolean, 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.

evenOdd

Boolean, 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.

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

azimuth

Float

Azimuth in degrees.

zenith

Float

Zenith in degrees.

neighborhoodSize

Integer, default: 0

Neighborhood size.

hysteresis

Boolean, 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.

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

lineThreshold

Float, default: 72

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

smooth

Boolean, 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.

Usage

Returns

ee.Algorithms.If(condition, trueCase, falseCase)

Object

Argument

Type

Details

condition

Object, 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.

trueCase

Object, default: null

The result to return if the condition is true.

falseCase

Object, default: null

The result to return if the condition is false.

ee.Algorithms.IsEqual

Returns whether two objects are equal.

Usage

Returns

ee.Algorithms.IsEqual(left, right)

Boolean

Argument

Type

Details

left

Object, default: null

right

Object, 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:

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.

Usage

Returns

ee.Algorithms.Landsat.calibratedRadiance(image)

Image

Argument

Type

Details

image

Image

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.

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.

Usage

Returns

ee.Algorithms.Landsat.simpleCloudScore(image)

Image

Argument

Type

Details

image

Image

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.

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

asFloat

Boolean, 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.

Usage

Returns

ee.Algorithms.ProjectionTransform(feature, proj, maxError)

Feature

Argument

Type

Details

feature

Element

The feature the geometry of which is being converted.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Algorithms.String

Converts the input to a string.

Usage

Returns

ee.Algorithms.String(input)

String

Argument

Type

Details

input

Object

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.

Usage

Returns

ee.Algorithms.Terrain(input)

Image

Argument

Type

Details

input

Image

An elevation image, in meters.

ee.Array

Returns an array with the given coordinates.

Usage

Returns

ee.Array(values, pixelType)

Array

Argument

Type

Details

values

Object

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.

pixelType

PixelType, 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.

Usage

Returns

Array.abs()

Array

Argument

Type

Details

this: input

Array

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.

Usage

Returns

Array.accum(axis, reducer)

Array

Argument

Type

Details

this: array

Array

Array to accumulate.

axis

Integer

Axis along which to perform the accumulation.

reducer

Reducer, 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.

Usage

Returns

Array.acos()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.add

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

Usage

Returns

Array.add(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.and

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

Usage

Returns

Array.and(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.asin

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

Usage

Returns

Array.asin()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.atan

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

Usage

Returns

Array.atan()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.atan2

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

Usage

Returns

Array.atan2(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

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.

Usage

Returns

Array.bitCount()

Array

Argument

Type

Details

this: input

Array

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.

Usage

Returns

ee.Array.bitsToArray(input)

Array

Argument

Type

Details

input

Number

ee.Array.bitwiseAnd

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

Usage

Returns

Array.bitwiseAnd(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

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.

Usage

Returns

Array.bitwiseNot()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.bitwiseOr

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

Usage

Returns

Array.bitwiseOr(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.bitwiseXor

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

Usage

Returns

Array.bitwiseXor(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.bitwise_and

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

Usage

Returns

Array.bitwise_and(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

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.

Usage

Returns

Array.bitwise_not()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.bitwise_or

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

Usage

Returns

Array.bitwise_or(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.bitwise_xor

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

Usage

Returns

Array.bitwise_xor(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.byte

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

Usage

Returns

Array.byte()

Array

Argument

Type

Details

this: input

Array

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.

Usage

Returns

ee.Array.cat(arrays, axis)

Array

Argument

Type

Details

arrays

List

Arrays to concatenate.

axis

Integer, default: 0

Axis to concatenate along.

ee.Array.cbrt

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

Usage

Returns

Array.cbrt()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.ceil

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

Usage

Returns

Array.ceil()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.cos

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

Usage

Returns

Array.cos()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.cosh

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

Usage

Returns

Array.cosh()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.cut

Cut an array along one or more axes.

Usage

Returns

Array.cut(position)

Array

Argument

Type

Details

this: array

Array

The array to cut.

position

List

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.

Usage

Returns

Array.digamma()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.divide

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

Usage

Returns

Array.divide(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.dotProduct

Compute the dot product between two 1-D arrays.

Usage

Returns

Array.dotProduct(array2)

Number

Argument

Type

Details

this: array1

Array

The first 1-D array.

array2

Array

The second 1-D array.

ee.Array.double

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

Usage

Returns

Array.double()

Array

Argument

Type

Details

this: input

Array

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.

Usage

Returns

Array.eigen()

Array

Argument

Type

Details

this: input

Array

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.

Usage

Returns

Array.eq(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.erf

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

Usage

Returns

Array.erf()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.erfInv

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

Usage

Returns

Array.erfInv()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.erfc

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

Usage

Returns

Array.erfc()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.erfcInv

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

Usage

Returns

Array.erfcInv()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.exp

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

Usage

Returns

Array.exp()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.first

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

Usage

Returns

Array.first(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

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.

Usage

Returns

Array.firstNonZero(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

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.

Usage

Returns

Array.first_nonzero(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.float

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

Usage

Returns

Array.float()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.floor

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

ee.Array.gt

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

Usage

Returns

Array.gt(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

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.

Usage

Returns

Array.gte(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.hypot

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

Usage

Returns

Array.hypot(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.identity

Creates a 2D identity matrix of the given size.

Usage

Returns

ee.Array.identity(size)

Array

Argument

Type

Details

size

Integer

The length of each axis.

ee.Array.int

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

Usage

Returns

Array.int()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.int16

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

Usage

Returns

Array.int16()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.int32

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

Usage

Returns

Array.int32()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.int64

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

Usage

Returns

Array.int64()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.int8

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

Usage

Returns

Array.int8()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.lanczos

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

Usage

Returns

Array.lanczos()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.leftShift

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

Usage

Returns

Array.leftShift(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.left_shift

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

Usage

Returns

Array.left_shift(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.length

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

Usage

Returns

Array.length()

Array

Argument

Type

Details

this: array

Array

The array from which to extract the axis lengths.

ee.Array.log

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

Usage

Returns

Array.log()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.log10

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

Usage

Returns

Array.log10()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.long

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

Usage

Returns

Array.long()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.lt

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

Usage

Returns

Array.lt(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

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.

Usage

Returns

Array.lte(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

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.

Usage

Returns

Array.mask(mask)

Array

Argument

Type

Details

this: input

Array

Array to mask.

mask

Array

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'.

Usage

Returns

Array.matrixCholeskyDecomposition()

Dictionary

Argument

Type

Details

this: array

Array

The array to decompose.

ee.Array.matrixDeterminant

Computes the determinant of the matrix.

Usage

Returns

Array.matrixDeterminant()

Number

Argument

Type

Details

this: input

Array

The array to compute on.

ee.Array.matrixDiagonal

Computes the diagonal of the matrix in a single column.

Usage

Returns

Array.matrixDiagonal()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.matrixFnorm

Computes the Frobenius norm of the matrix.

Usage

Returns

Array.matrixFnorm()

Number

Argument

Type

Details

this: input

Array

The array to compute on.

ee.Array.matrixInverse

Computes the inverse of the matrix.

Usage

Returns

Array.matrixInverse()

Array

Argument

Type

Details

this: input

Array

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'.

Usage

Returns

Array.matrixLUDecomposition()

Dictionary

Argument

Type

Details

this: array

Array

The array to decompose.

ee.Array.matrixMultiply

Returns the matrix multiplication A*B.

Usage

Returns

Array.matrixMultiply(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.matrixPseudoInverse

Computes the Moore-Penrose pseudoinverse of the matrix.

Usage

Returns

Array.matrixPseudoInverse()

Array

Argument

Type

Details

this: input

Array

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'.

Usage

Returns

Array.matrixQRDecomposition()

Dictionary

Argument

Type

Details

this: array

Array

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'.

Usage

Returns

Array.matrixSingularValueDecomposition()

Dictionary

Argument

Type

Details

this: array

Array

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.

Usage

Returns

Array.matrixSolve(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.matrixToDiag

Computes a square diagonal matrix from a single column matrix.

Usage

Returns

Array.matrixToDiag()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.matrixTrace

Computes the trace of the matrix.

Usage

Returns

Array.matrixTrace()

Number

Argument

Type

Details

this: input

Array

The array to compute on.

ee.Array.matrixTranspose

Transposes two dimensions of an array.

Usage

Returns

Array.matrixTranspose(axis1, axis2)

Array

Argument

Type

Details

this: array

Array

Array to transpose.

axis1

Integer, default: 0

First axis to swap.

axis2

Integer, default: 1

Second axis to swap.

ee.Array.max

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

Usage

Returns

Array.max(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.min

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

Usage

Returns

Array.min(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.mod

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

Usage

Returns

Array.mod(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.multiply

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

Usage

Returns

Array.multiply(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.neq

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

Usage

Returns

Array.neq(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.not

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

Usage

Returns

Array.not()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.or

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

Usage

Returns

Array.or(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.pow

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

Usage

Returns

Array.pow(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

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.

Usage

Returns

Array.project(axes)

Array

Argument

Type

Details

this: array

Array

Array to project.

axes

List

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.

Usage

Returns

Array.reduce(reducer, axes, fieldAxis)

Array

Argument

Type

Details

this: array

Array

The array.

reducer

Reducer

The reducer to apply

axes

List

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

fieldAxis

Integer, 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.

Usage

Returns

Array.repeat(axis, copies)

Array

Argument

Type

Details

this: array

Array

Array to repeat.

axis

Integer, default: 0

The axis along which to repeat the array.

copies

Integer, 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.

Usage

Returns

Array.rightShift(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.right_shift

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

Usage

Returns

Array.right_shift(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.round

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

Usage

Returns

Array.round()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.short

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

Usage

Returns

Array.short()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.sin

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

Usage

Returns

Array.sin()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.sinh

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

Usage

Returns

Array.sinh()

Array

Argument

Type

Details

this: input

Array

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.

Usage

Returns

Array.slice(axis, start, end, step)

Array

Argument

Type

Details

this: array

Array

Array to slice.

axis

Integer, default: 0

The axis to slice on.

start

Integer, 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.

end

Integer, 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.

step

Integer, 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.

Usage

Returns

Array.sort(keys)

Array

Argument

Type

Details

this: array

Array

Array image to sort.

keys

Array, 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.

Usage

Returns

Array.sqrt()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.subtract

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

Usage

Returns

Array.subtract(right)

Array

Argument

Type

Details

this: left

Array

The left-hand value.

right

Array

The right-hand value.

ee.Array.tan

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

Usage

Returns

Array.tan()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.tanh

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

Usage

Returns

Array.tanh()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toByte

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

Usage

Returns

Array.toByte()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toDouble

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

Usage

Returns

Array.toDouble()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toFloat

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

Usage

Returns

Array.toFloat()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toInt

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

Usage

Returns

Array.toInt()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toInt16

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

Usage

Returns

Array.toInt16()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toInt32

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

Usage

Returns

Array.toInt32()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toInt64

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

Usage

Returns

Array.toInt64()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toInt8

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

Usage

Returns

Array.toInt8()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toList

Turns an Array into a list of lists of numbers.

Usage

Returns

Array.toList()

List

Argument

Type

Details

this: array

Array

Array to convert.

ee.Array.toLong

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

Usage

Returns

Array.toLong()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toShort

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

Usage

Returns

Array.toShort()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toUint16

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

Usage

Returns

Array.toUint16()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toUint32

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

Usage

Returns

Array.toUint32()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.toUint8

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

Usage

Returns

Array.toUint8()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.transpose

Transposes two dimensions of an array.

Usage

Returns

Array.transpose(axis1, axis2)

Array

Argument

Type

Details

this: array

Array

Array to transpose.

axis1

Integer, default: 0

First axis to swap.

axis2

Integer, default: 1

Second axis to swap.

ee.Array.trigamma

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

Usage

Returns

Array.trigamma()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.uint16

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

Usage

Returns

Array.uint16()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.uint32

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

Usage

Returns

Array.uint32()

Array

Argument

Type

Details

this: input

Array

The input array.

ee.Array.uint8

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

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

minSplitPoplulation

Integer, default: 1

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

minSplitCost

Float, default: 1e-10

Do not split if training set cost less than this.

prune

Boolean, default: false

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

pruneErrorTolerance

Float, default: 0.5

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

quantizationResolution

Integer, default: 100

The quantization resolution for numerical features.

quantizationMargin

Float, default: 0.1

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

randomSeed

Integer, 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.

Usage

Returns

Classifier.confusionMatrix()

ConfusionMatrix

Argument

Type

Details

this: classifier

Classifier

The classifier to use.

ee.Classifier.continuousNaiveBayes

Creates an empty Continuous Naive Bayes classifier.

Usage

Returns

ee.Classifier.continuousNaiveBayes(lambda)

Classifier

Argument

Type

Details

lambda

Float, 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.

Usage

Returns

ee.Classifier.decisionTree(treeString)

Classifier

Argument

Type

Details

treeString

String

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.

Usage

Returns

Classifier.explain()

Dictionary

Argument

Type

Details

this: classifier

Classifier

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.

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

minLeafPopulation

Integer, default: 1

The minimum size of a terminal node.

bagFraction

Float, default: 0.5

The fraction of input to bag per tree.

outOfBagMode

Boolean, default: false

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

seed

Integer, 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.

Usage

Returns

Classifier.schema()

List

Argument

Type

Details

this: classifier

Classifier

ee.Classifier.setOutputMode

Sets the output mode.

Usage

Returns

Classifier.setOutputMode(mode)

Classifier

Argument

Type

Details

this: classifier

Classifier

An input classifier.

mode

String

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.

Usage

Returns

ee.Classifier.spectralRegion(coordinates, schema)

Classifier

Argument

Type

Details

coordinates

List

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.

schema

List, 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'].

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

inputProperties

List, 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).

subsampling

Float, default: 1

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

subsamplingSeed

Integer, 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.

Usage

Returns

ee.Classifier.winnow(epochs, learningRate, biasLearningRate, margin)

Classifier

Argument

Type

Details

epochs

Integer, default: 5

The number of training epochs.

learningRate

Float, default: 0.1

The learning rate.

biasLearningRate

Float, default: 0.1

The learning rate for updating bias weights.

margin

Float, 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.

Usage

Returns

Clusterer.schema()

List

Argument

Type

Details

this: clusterer

Clusterer

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.

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).

subsampling

Float, default: 1

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

subsamplingSeed

Integer, 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:

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:

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.

periodicPruning

Integer, default: 10000

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

minDensity

Integer, default: 2

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

t1

Float, default: -1.5

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

t2

Float, default: -1

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

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.

Usage

Returns

ee.ConfusionMatrix(array, order)

ConfusionMatrix

Argument

Type

Details

array

Object

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

order

List, 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.

Usage

Returns

ConfusionMatrix.accuracy()

Float

Argument

Type

Details

this: confusionMatrix

ConfusionMatrix

ee.ConfusionMatrix.array

Returns a confusion matrix as an Array.

Usage

Returns

ConfusionMatrix.array()

Array

Argument

Type

Details

this: confusionMatrix

ConfusionMatrix

ee.ConfusionMatrix.consumersAccuracy

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

Usage

Returns

ConfusionMatrix.consumersAccuracy()

Array

Argument

Type

Details

this: confusionMatrix

ConfusionMatrix

ee.ConfusionMatrix.kappa

Computes the Kappa statistic for the confusion matrix.

Usage

Returns

ConfusionMatrix.kappa()

Float

Argument

Type

Details

this: confusionMatrix

ConfusionMatrix

ee.ConfusionMatrix.order

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

Usage

Returns

ConfusionMatrix.order()

List

Argument

Type

Details

this: confusionMatrix

ConfusionMatrix

ee.ConfusionMatrix.producersAccuracy

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

Usage

Returns

ConfusionMatrix.producersAccuracy()

Array

Argument

Type

Details

this: confusionMatrix

ConfusionMatrix

ee.Date

Constructs a new Date object.

Usage

Returns

ee.Date(date, tz)

Date

Argument

Type

Details

date

ComputedObject|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.

tz

String, 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.

Usage

Returns

Date.advance(delta, unit, timeZone)

Date

Argument

Type

Details

this: date

Date

delta

Float

unit

String

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

timeZone

String, 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.

Usage

Returns

Date.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

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.

Usage

Returns

Date.difference(start, unit)

Float

Argument

Type

Details

this: date

Date

start

Date

unit

String

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.

Usage

Returns

Date.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

Date.format(format, timeZone)

String

Argument

Type

Details

this: date

Date

format

String, 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.

ee.Date.getFraction

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

Usage

Returns

Date.getFraction(unit, timeZone)

Float

Argument

Type

Details

this: date

Date

unit

String

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

timeZone

String, 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.

Usage

Returns

Date.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, 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').

Usage

Returns

Date.getRange(unit, timeZone)

DateRange

Argument

Type

Details

this: date

Date

unit

String

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

timeZone

String, 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.

Usage

Returns

Date.getRelative(unit, inUnit, timeZone)

Long

Argument

Type

Details

this: date

Date

unit

String

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

inUnit

String

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

timeZone

String, 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.

Usage

Returns

Date.millis()

Long

Argument

Type

Details

this: date

Date

ee.Date.parse

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

Usage

Returns

ee.Date.parse(format, date, timeZone)

Date

Argument

Type

Details

format

String

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

date

String

A string matching the given pattern.

timeZone

String, default: null

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

ee.Date.serialize

Returns the serialized representation of this object.

Usage

Returns

Date.serialize()

String

Argument

Type

Details

this: computedobject

ComputedObject

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'.

Usage

Returns

ee.Date.unitRatio(numerator, denominator)

Float

Argument

Type

Details

numerator

String

denominator

String

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.

Usage

Returns

Date.update(year, month, day, hour, minute, second, timeZone)

Date

Argument

Type

Details

this: date

Date

year

Integer, default: null

month

Integer, default: null

day

Integer, default: null

hour

Integer, default: null

minute

Integer, default: null

second

Integer, default: null

timeZone

String, 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.

Usage

Returns

ee.DateRange(start, end, timeZone)

DateRange

Argument

Type

Details

start

Object

end

Object, default: null

timeZone

String, 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.

Usage

Returns

DateRange.contains(other)

Boolean

Argument

Type

Details

this: dateRange

DateRange

other

Object

ee.DateRange.end

Returns the (exclusive) end of this DateRange.

Usage

Returns

DateRange.end()

Date

Argument

Type

Details

this: dateRange

DateRange

ee.DateRange.intersection

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

Usage

Returns

DateRange.intersection(other)

DateRange

Argument

Type

Details

this: dateRange

DateRange

other

DateRange

ee.DateRange.intersects

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

Usage

Returns

DateRange.intersects(other)

Boolean

Argument

Type

Details

this: dateRange

DateRange

other

DateRange

ee.DateRange.isEmpty

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

Usage

Returns

DateRange.isEmpty()

Boolean

Argument

Type

Details

this: dateRange

DateRange

ee.DateRange.isUnbounded

Returns true if this DateRange contains all dates.

Usage

Returns

DateRange.isUnbounded()

Boolean

Argument

Type

Details

this: dateRange

DateRange

ee.DateRange.start

Returns the (inclusive) start of this DateRange.

Usage

Returns

DateRange.start()

Date

Argument

Type

Details

this: dateRange

DateRange

ee.DateRange.unbounded

Returns a DateRange that includes all possible dates.

Usage

Returns

ee.DateRange.unbounded()

DateRange

No arguments.

ee.DateRange.union

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

Usage

Returns

DateRange.union(other)

DateRange

Argument

Type

Details

this: dateRange

DateRange

other

DateRange

ee.Dictionary

Constructs a new Dictionary.

Usage

Returns

ee.Dictionary(dict)

Dictionary

Argument

Type

Details

dict

ComputedObject|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.

Usage

Returns

Dictionary.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

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.

Usage

Returns

Dictionary.combine(second, overwrite)

Dictionary

Argument

Type

Details

this: first

Dictionary

second

Dictionary

overwrite

Boolean, default: true

ee.Dictionary.contains

Returns true if the dictionary contains the given key.

Usage

Returns

Dictionary.contains(key)

Boolean

Argument

Type

Details

this: dictionary

Dictionary

key

String, default: null

ee.Dictionary.evaluate

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

Usage

Returns

Dictionary.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

ee.Dictionary.fromLists(keys, values)

Dictionary

Argument

Type

Details

keys

List

values

List

ee.Dictionary.get

Extracts a named value from a dictionary.

Usage

Returns

Dictionary.get(key)

Object

Argument

Type

Details

this: dictionary

Dictionary

key

String

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.

Usage

Returns

Dictionary.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, 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.

Usage

Returns

Dictionary.keys()

List

Argument

Type

Details

this: dictionary

Dictionary

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.

Usage

Returns

Dictionary.map(baseAlgorithm)

Dictionary

Argument

Type

Details

this: dictionary

Dictionary

baseAlgorithm

Algorithm

ee.Dictionary.remove

Returns a dictionary with the specified keys removed.

Usage

Returns

Dictionary.remove(selectors, ignoreMissing)

Dictionary

Argument

Type

Details

this: dictionary

Dictionary

selectors

List

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

ignoreMissing

Boolean, default: false

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

ee.Dictionary.rename

Rename elements in a dictionary.

Usage

Returns

Dictionary.rename(from, to, overwrite)

Dictionary

Argument

Type

Details

this: dictionary

Dictionary

from

List

A list of keys to be renamed.

to

List

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

overwrite

Boolean, default: false

Allow overwriting existing properties with the same name.

ee.Dictionary.select

Returns a dictionary with only the specified keys.

Usage

Returns

Dictionary.select(selectors, ignoreMissing)

Dictionary

Argument

Type

Details

this: dictionary

Dictionary

selectors

List

A list of keys or regular expressions to select.

ignoreMissing

Boolean, default: false

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

ee.Dictionary.serialize

Returns the serialized representation of this object.

Usage

Returns

Dictionary.serialize()

String

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

ee.Dictionary.set

Set a value in a dictionary.

Usage

Returns

Dictionary.set(key, value)

Object

Argument

Type

Details

this: dictionary

Dictionary

key

String

value

Object

ee.Dictionary.size

Returns the number of entries in a dictionary.

Usage

Returns

Dictionary.size()

Integer

Argument

Type

Details

this: dictionary

Dictionary

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.

Usage

Returns

Dictionary.toArray(keys, axis)

Array

Argument

Type

Details

this: dictionary

Dictionary

keys

List, default: null

axis

Integer, 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.

Usage

Returns

Dictionary.toImage(names)

Image

Argument

Type

Details

this: dictionary

Dictionary

The dictionary to convert.

names

List, 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.

Usage

Returns

Dictionary.values(keys)

List

Argument

Type

Details

this: dictionary

Dictionary

keys

List, default: null

ee.ErrorMargin

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

Usage

Returns

ee.ErrorMargin(value, unit)

ErrorMargin

Argument

Type

Details

value

Float, default: null

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

unit

String, 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.

Usage

Returns

ee.Feature(geometry, properties)

Feature

Argument

Type

Details

geometry

ComputedObject|Feature|Geometry|Object

A geometry or feature.

properties

Object, 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).

Usage

Returns

Feature.area(maxError, proj)

Float

Argument

Type

Details

this: feature

Element

The feature from which the geometry is taken.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

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.

Usage

Returns

Feature.bounds(maxError, proj)

Feature

Argument

Type

Details

this: feature

Element

The feature the bound of which is being calculated.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.buffer(distance, maxError, proj)

Feature

Argument

Type

Details

this: feature

Element

The feature the geometry of which is being buffered.

distance

Float

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.

maxError

ErrorMargin, 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.

proj

Projection, 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.

Usage

Returns

Feature.centroid(maxError, proj)

Feature

Argument

Type

Details

this: feature

Element

Calculates the centroid of this feature's default geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.containedIn(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Element

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

right

Element

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.contains(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Element

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

right

Element

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.convexHull(maxError, proj)

Feature

Argument

Type

Details

this: feature

Element

The feature containing the geometry whole hull is being calculated.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.copyProperties(source, properties, exclude)

Element

Argument

Type

Details

this: destination

Element, default: null

The object whose properties to override.

source

Element, default: null

The object from which to copy the properties.

properties

List, default: null

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

exclude

List, 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.

Usage

Returns

Feature.cutLines(distances, maxError, proj)

Feature

Argument

Type

Details

this: feature

Element

Cuts the lines of this feature's default geometry.

distances

List

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.difference(right, maxError, proj)

Feature

Argument

Type

Details

this: left

Element

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

right

Element

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.disjoint(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Element

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

right

Element

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.dissolve(maxError, proj)

Element

Argument

Type

Details

this: feature

Element

The feature the geometry of which is being unioned.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.distance(right, maxError, proj)

Float

Argument

Type

Details

this: left

Element

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

right

Element

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

Feature.get(property)

Argument

Type

Details

this: object

Element

The feature to extract the property from.

property

String

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.

Usage

Returns

Feature.getInfo(callback)

GeoJSONFeature

Argument

Type

Details

this: feature

Feature

The Feature instance.

callback

Function, 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.

Usage

Returns

Feature.getMap(visParams, callback)

MapId|Object

Argument

Type

Details

this: feature

Feature

The Feature instance.

visParams

Object, 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.

callback

Function, 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.

Usage

Returns

Feature.id()

String

Argument

Type

Details

this: element

Element

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.

Usage

Returns

Feature.intersection(right, maxError, proj)

Feature

Argument

Type

Details

this: left

Element

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

right

Element

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.intersects(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Element

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

right

Element

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.length(maxError, proj)

Float

Argument

Type

Details

this: feature

Element

The feature from which the geometry is taken.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.perimeter(maxError, proj)

Float

Argument

Type

Details

this: feature

Element

The feature from which the geometry is taken.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.propertyNames()

List

Argument

Type

Details

this: element

Element

ee.Feature.select

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

Usage

Returns

Feature.select(propertySelectors, newProperties, retainGeometry)

Element

Argument

Type

Details

this: input

Element

The feature to select properties from.

propertySelectors

List

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

newProperties

List, default: null

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

retainGeometry

Boolean, default: true

When false, the result will have a NULL geometry.

ee.Feature.serialize

Returns the serialized representation of this object.

Usage

Returns

Feature.serialize()

String

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

ee.Feature.set

Overrides one or more metadata properties of an Element.

Returns the element with the specified properties overridden.

Usage

Returns

Feature.set(var_args)

Element

Argument

Type

Details

this: element

Element

The Element instance.

var_args

VarArgs

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.

Usage

Returns

Feature.setGeometry(geometry)

Element

Argument

Type

Details

this: feature

Element

The feature on which to set the geometry.

geometry

Geometry, default: null

The geometry to set.

ee.Feature.setMulti

Overrides one or more metadata properties of an object.

Usage

Returns

Feature.setMulti(properties)

Element

Argument

Type

Details

this: object

Element

The object whose properties to override.

properties

Dictionary

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.

Usage

Returns

Feature.simplify(maxError, proj)

Feature

Argument

Type

Details

this: feature

Element

The feature whose geometry is being simplified.

maxError

ErrorMargin

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

proj

Projection, 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.

Usage

Returns

Feature.symmetricDifference(right, maxError, proj)

Feature

Argument

Type

Details

this: left

Element

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

right

Element

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.toArray(properties)

Array

Argument

Type

Details

this: feature

Feature

The object from which to select array properties.

properties

List

The property selectors for each array element.

ee.Feature.toDictionary

Extract properties from a feature as a dictionary.

Usage

Returns

Feature.toDictionary(properties)

Dictionary

Argument

Type

Details

this: element

Element

The feature to extract the property from.

properties

List, 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.

Usage

Returns

Feature.transform(proj, maxError)

Feature

Argument

Type

Details

this: feature

Element

The feature the geometry of which is being converted.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Feature.union

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

Usage

Returns

Feature.union(right, maxError, proj)

Feature

Argument

Type

Details

this: left

Element

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

right

Element

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Feature.withinDistance(right, distance, maxError, proj)

Boolean

Argument

Type

Details

this: left

Element

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

right

Element

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

distance

Float

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

ee.FeatureCollection(args, column)

FeatureCollection

Argument

Type

Details

args

ComputedObject|Feature|FeatureCollection|Geometry|List

The constructor arguments.

column

String, 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.

Usage

Returns

FeatureCollection.aggregate_array(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_count(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_count_distinct(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_first(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_histogram(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_max(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_mean(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_min(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_product(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_sample_sd(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_sample_var(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_stats(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_sum(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_total_sd(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aggregate_total_var(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

FeatureCollection.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.FeatureCollection.classify

Classifies each feature in a collection.

Usage

Returns

FeatureCollection.classify(classifier, outputName)

FeatureCollection

Argument

Type

Details

this: features

FeatureCollection

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

classifier

Object

The classifier to use.

outputName

String, 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.

Usage

Returns

FeatureCollection.cluster(clusterer, outputName)

FeatureCollection

Argument

Type

Details

this: features

FeatureCollection

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

clusterer

Clusterer

The clusterer to use.

outputName

String, default: "cluster"

The name of the output property to be added.

ee.FeatureCollection.copyProperties

Copies metadata properties from one element to another.

Usage

Returns

FeatureCollection.copyProperties(source, properties, exclude)

Element

Argument

Type

Details

this: destination

Element, default: null

The object whose properties to override.

source

Element, default: null

The object from which to copy the properties.

properties

List, default: null

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

exclude

List, 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.

Usage

Returns

FeatureCollection.distance(searchRadius, maxError)

Image

Argument

Type

Details

this: features

FeatureCollection

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

searchRadius

Float, default: 100000

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

maxError

Float, 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.

Usage

Returns

FeatureCollection.distinct(selectors)

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

The input collection from which objects will be selected.

selectors

SelectorSet

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.

Usage

Returns

FeatureCollection.draw(color, pointRadius, strokeWidth)

Image

Argument

Type

Details

this: collection

FeatureCollection

The collection to draw.

color

String

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

pointRadius

Integer, default: 3

The radius in pixels of the point markers.

strokeWidth

Integer, 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.

Usage

Returns

FeatureCollection.errorMatrix(actual, predicted, order)

ConfusionMatrix

Argument

Type

Details

this: collection

FeatureCollection

The input collection.

actual

String

The name of the property containing the actual value.

predicted

String

The name of the property containing the predicted value.

order

List, 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.

Usage

Returns

FeatureCollection.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

FeatureCollection.filter(newFilter)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

newFilter

Filter

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.

Usage

Returns

FeatureCollection.filterBounds(geometry)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

geometry

Feature|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.

Usage

Returns

FeatureCollection.filterDate(start, end)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

start

Date|Number|String

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

end

Date|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.

Usage

Returns

FeatureCollection.filterMetadata(name, operator, value)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

name

String

The name of a property to filter.

operator

String

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".

value

Object

- The value to compare against.

ee.FeatureCollection.first

Returns the first entry from a given collection.

Usage

Returns

FeatureCollection.first()

Element

Argument

Type

Details

this: collection

FeatureCollection

The collection from which to select the first entry.

ee.FeatureCollection.flatten

Flattens collections of collections.

Usage

Returns

FeatureCollection.flatten()

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

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.

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.

Usage

Returns

FeatureCollection.iterate(algorithm, first)

ComputedObject

Argument

Type

Details

this: collection

Collection

The Collection instance.

algorithm

Function

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

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

reducer

Reducer, 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.

Usage

Returns

FeatureCollection.limit(max, property, ascending)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

max

Number

The number to limit the collection to.

property

String, optional

The property to sort by, if sorting.

ascending

Boolean, 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.

Usage

Returns

FeatureCollection.makeArray(properties, name)

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

The input collection from which properties will be selected.

properties

List

The properties to select.

name

String, default: "array"

The name of the new array property.

ee.FeatureCollection.map

Maps an algorithm over a collection.

Returns the mapped collection.

Usage

Returns

FeatureCollection.map(algorithm, dropNulls)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

algorithm

Function

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.

dropNulls

Boolean, 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.

Usage

Returns

FeatureCollection.merge(collection2)

FeatureCollection

Argument

Type

Details

this: collection1

FeatureCollection

The first collection to merge.

collection2

FeatureCollection

The second collection to merge.

ee.FeatureCollection.propertyNames

Returns the names of properties on this element.

Usage

Returns

FeatureCollection.propertyNames()

List

Argument

Type

Details

this: element

Element

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).

Usage

Returns

FeatureCollection.randomColumn(columnName, seed)

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

The input collection to which to add a random column.

columnName

String, default: "random"

The name of the column to add.

seed

Long, 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.

Usage

Returns

ee.FeatureCollection.randomPoints(region, points, seed, maxError)

FeatureCollection

Argument

Type

Details

region

Geometry

The region to generate points for.

points

Integer, default: 1000

The number of points to generate.

seed

Long, default: 0

A seed for the random number generator.

maxError

ErrorMargin, 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.

Usage

Returns

FeatureCollection.reduceColumns(reducer, selectors, weightSelectors)

Dictionary

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

reducer

Reducer

The reducer to apply.

selectors

List

A selector for each input of the reducer.

weightSelectors

List, 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.

Usage

Returns

FeatureCollection.reduceToImage(properties, reducer)

Image

Argument

Type

Details

this: collection

FeatureCollection

Feature collection to intersect with each output pixel.

properties

List

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

reducer

Reducer

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.

Usage

Returns

FeatureCollection.remap(lookupIn, lookupOut, columnName)

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

The collection to be modified.

lookupIn

List

The input mapping values. Restricted to strings and integers.

lookupOut

List

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

columnName

String

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).

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

fillColor

String, default: null

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

styleProperty

String, default: null

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

neighborhood

Integer, 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.

Usage

Returns

FeatureCollection.toDictionary(properties)

Dictionary

Argument

Type

Details

this: element

Element

The feature to extract the property from.

properties

List, 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.

Usage

Returns

FeatureCollection.toList(count, offset)

List

Argument

Type

Details

this: collection

FeatureCollection

The input collection to fetch.

count

Integer

The maximum number of elements to fetch.

offset

Integer, 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.

Usage

Returns

FeatureCollection.union(maxError)

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

The collection being merged.

maxError

ErrorMargin, 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.

Usage

Returns

ee.Filter(filter)

Filter

Argument

Type

Details

filter

Filter|List, optional

Optional filter to add.

ee.Filter.and

Combine two or more filters using boolean AND.

Returns the constructed filter.

Usage

Returns

ee.Filter.and(var_args)

Filter

Argument

Type

Details

var_args

VarArgs

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.

Usage

Returns

Filter.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Filter.bounds

Filter on bounds.

Returns the modified filter.

Usage

Returns

ee.Filter.bounds(geometry, errorMargin)

Filter

Argument

Type

Details

geometry

ComputedObject|FeatureCollection|Geometry

The geometry, feature or collection to filter to.

errorMargin

ComputedObject|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.

Usage

Returns

ee.Filter.calendarRange(start, end, field)

Filter

Argument

Type

Details

start

Integer

The start of the desired calendar field, inclusive.

end

Integer, default: null

The end of the desired calendar field, inclusive. Defaults to the same value as start.

A selector for the left operand. Should not be specified if leftValue is specified.

rightValue

Object, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightField

String, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValue

Object, default: null

The value of the left operand. Should not be specified if leftField is specified.

maxError

ErrorMargin, optional

The maximum reprojection error allowed during filter application.

ee.Filter.eq

Filter to metadata equal to the given value.

Returns the constructed filter.

Usage

Returns

ee.Filter.eq(name, value)

Filter

Argument

Type

Details

name

String

The property name to filter on.

value

Object

The value to compare against.

ee.Filter.equals

Creates a unary or binary filter that passes if the two operands are equals.

Usage

Returns

ee.Filter.equals(leftField, rightValue, rightField, leftValue)

Filter

Argument

Type

Details

leftField

String, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValue

Object, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightField

String, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValue

Object, 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.

Usage

Returns

Filter.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

Filter.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, 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.

Usage

Returns

ee.Filter.greaterThan(leftField, rightValue, rightField, leftValue)

Filter

Argument

Type

Details

leftField

String, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValue

Object, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightField

String, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValue

Object, 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.

A selector for the left operand. Should not be specified if leftValue is specified.

rightValue

Object, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightField

String, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValue

Object, 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.

Usage

Returns

ee.Filter.listContains(leftField, rightValue, rightField, leftValue)

Filter

Argument

Type

Details

leftField

String, default: null

A selector for the left operand. Should not be specified if leftValue is specified.

rightValue

Object, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightField

String, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValue

Object, 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.

Usage

Returns

ee.Filter.lt(name, value)

Filter

Argument

Type

Details

name

String

The property name to filter on.

value

Object

The value to compare against.

ee.Filter.lte

Filter on metadata less than or equal to the given value.

Returns the constructed filter.

Usage

Returns

ee.Filter.lte(name, value)

Filter

Argument

Type

Details

name

String

The property name to filter on.

value

Object

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.

A selector for the left operand. Should not be specified if leftValue is specified.

rightValue

Object, default: null

The value of the right operand. Should not be specified if rightField is specified.

rightField

String, default: null

A selector for the right operand. Should not be specified if rightValue is specified.

leftValue

Object, default: null

The value of the left operand. Should not be specified if leftField is specified.

maxError

ErrorMargin, optional

The maximum reprojection error allowed during filter application.

ee.Geometry

Creates a geometry.

Usage

Returns

ee.Geometry(geoJson, proj, geodesic, evenOdd)

Geometry

Argument

Type

Details

geoJson

Object

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.

proj

Projection, 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).

geodesic

Boolean, 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.

evenOdd

Boolean, 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, ...).

Usage

Returns

ee.Geometry.LineString(coords, proj, geodesic, maxError)

Geometry.LineString

Argument

Type

Details

coords

List

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.

proj

Projection, 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.

geodesic

Boolean, 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.

maxError

ErrorMargin, 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).

Usage

Returns

LineString.area(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The geometry input.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Geometry.LineString.bounds

Returns the bounding rectangle of the geometry.

Usage

Returns

LineString.bounds(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Return the bounding box of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.buffer(distance, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry being buffered.

distance

Float

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.

maxError

ErrorMargin, 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.

proj

Projection, 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.

Usage

Returns

LineString.centroid(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the centroid of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.containedIn(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.contains(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.convexHull(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the convex hull of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.coordinates()

List

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.LineString.cutLines

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

Usage

Returns

LineString.cutLines(distances, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Cuts the lines of this geometry.

distances

List

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.difference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.disjoint(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.dissolve(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to union.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.distance(right, maxError, proj)

Float

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.edgesAreGeodesics()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.LineString.evaluate

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

Usage

Returns

LineString.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

LineString.geodesic()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.LineString.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

Usage

Returns

LineString.geometries()

List

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

LineString.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, optional

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

ee.Geometry.LineString.intersection

Returns the intersection of the two geometries.

Usage

Returns

LineString.intersection(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.intersects(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.isUnbounded()

Boolean

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

LineString.length(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.perimeter(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.projection()

Projection

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.LineString.serialize

Returns the serialized representation of this object.

Usage

Returns

LineString.serialize()

String

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

LineString.simplify(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to simplify.

maxError

ErrorMargin

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

proj

Projection, 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.

Usage

Returns

LineString.symmetricDifference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.toGeoJSON()

GeoJSONGeometry

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.LineString.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

Usage

Returns

LineString.toGeoJSONString()

String

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.LineString.transform

Transforms the geometry to a specific projection.

Usage

Returns

LineString.transform(proj, maxError)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to reproject.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Geometry.LineString.type

Returns the GeoJSON type of the geometry.

Usage

Returns

LineString.type()

String

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.LineString.union

Returns the union of the two geometries.

Usage

Returns

LineString.union(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LineString.withinDistance(right, distance, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

distance

Float

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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).

Usage

Returns

ee.Geometry.LinearRing(coords, proj, geodesic, maxError)

Geometry.LinearRing

Argument

Type

Details

coords

List

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.

proj

Projection, 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.

geodesic

Boolean, 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.

maxError

ErrorMargin, 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).

Usage

Returns

LinearRing.area(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The geometry input.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Geometry.LinearRing.bounds

Returns the bounding rectangle of the geometry.

Usage

Returns

LinearRing.bounds(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Return the bounding box of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.buffer(distance, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry being buffered.

distance

Float

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.

maxError

ErrorMargin, 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.

proj

Projection, 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.

Usage

Returns

LinearRing.centroid(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the centroid of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.containedIn(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.contains(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.convexHull(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the convex hull of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.coordinates()

List

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.LinearRing.cutLines

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

Usage

Returns

LinearRing.cutLines(distances, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Cuts the lines of this geometry.

distances

List

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.difference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.disjoint(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.dissolve(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to union.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.distance(right, maxError, proj)

Float

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.edgesAreGeodesics()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.LinearRing.evaluate

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

Usage

Returns

LinearRing.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

LinearRing.geodesic()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.LinearRing.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

Usage

Returns

LinearRing.geometries()

List

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

LinearRing.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, optional

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

ee.Geometry.LinearRing.intersection

Returns the intersection of the two geometries.

Usage

Returns

LinearRing.intersection(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.intersects(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.isUnbounded()

Boolean

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

LinearRing.length(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.perimeter(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.projection()

Projection

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.LinearRing.serialize

Returns the serialized representation of this object.

Usage

Returns

LinearRing.serialize()

String

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

LinearRing.simplify(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to simplify.

maxError

ErrorMargin

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

proj

Projection, 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.

Usage

Returns

LinearRing.symmetricDifference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.toGeoJSON()

GeoJSONGeometry

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.LinearRing.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

Usage

Returns

LinearRing.toGeoJSONString()

String

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.LinearRing.transform

Transforms the geometry to a specific projection.

Usage

Returns

LinearRing.transform(proj, maxError)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to reproject.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Geometry.LinearRing.type

Returns the GeoJSON type of the geometry.

Usage

Returns

LinearRing.type()

String

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.LinearRing.union

Returns the union of the two geometries.

Usage

Returns

LinearRing.union(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

LinearRing.withinDistance(right, distance, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

distance

Float

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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, ...).

Usage

Returns

ee.Geometry.MultiLineString(coords, proj, geodesic, maxError)

Geometry.MultiLineString

Argument

Type

Details

coords

List

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.

proj

Projection, 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.

geodesic

Boolean, 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.

maxError

ErrorMargin, 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).

Usage

Returns

MultiLineString.area(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The geometry input.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Geometry.MultiLineString.bounds

Returns the bounding rectangle of the geometry.

Usage

Returns

MultiLineString.bounds(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Return the bounding box of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.buffer(distance, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry being buffered.

distance

Float

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.

maxError

ErrorMargin, 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.

proj

Projection, 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.

Usage

Returns

MultiLineString.centroid(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the centroid of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.containedIn(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.contains(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.convexHull(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the convex hull of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.coordinates()

List

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiLineString.cutLines

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

Usage

Returns

MultiLineString.cutLines(distances, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Cuts the lines of this geometry.

distances

List

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.difference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.disjoint(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.dissolve(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to union.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.distance(right, maxError, proj)

Float

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.edgesAreGeodesics()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiLineString.evaluate

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

Usage

Returns

MultiLineString.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

MultiLineString.geodesic()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiLineString.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

Usage

Returns

MultiLineString.geometries()

List

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

MultiLineString.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, optional

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

ee.Geometry.MultiLineString.intersection

Returns the intersection of the two geometries.

Usage

Returns

MultiLineString.intersection(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.intersects(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.isUnbounded()

Boolean

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

MultiLineString.length(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.perimeter(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.projection()

Projection

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiLineString.serialize

Returns the serialized representation of this object.

Usage

Returns

MultiLineString.serialize()

String

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

MultiLineString.simplify(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to simplify.

maxError

ErrorMargin

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

proj

Projection, 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.

Usage

Returns

MultiLineString.symmetricDifference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.toGeoJSON()

GeoJSONGeometry

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.MultiLineString.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

Usage

Returns

MultiLineString.toGeoJSONString()

String

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.MultiLineString.transform

Transforms the geometry to a specific projection.

Usage

Returns

MultiLineString.transform(proj, maxError)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to reproject.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Geometry.MultiLineString.type

Returns the GeoJSON type of the geometry.

Usage

Returns

MultiLineString.type()

String

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiLineString.union

Returns the union of the two geometries.

Usage

Returns

MultiLineString.union(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiLineString.withinDistance(right, distance, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

distance

Float

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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, ...).

Usage

Returns

ee.Geometry.MultiPoint(coords, proj)

Geometry.MultiPoint

Argument

Type

Details

coords

List

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.

proj

Projection, 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).

Usage

Returns

MultiPoint.area(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The geometry input.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Geometry.MultiPoint.bounds

Returns the bounding rectangle of the geometry.

Usage

Returns

MultiPoint.bounds(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Return the bounding box of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.buffer(distance, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry being buffered.

distance

Float

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.

maxError

ErrorMargin, 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.

proj

Projection, 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.

Usage

Returns

MultiPoint.centroid(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the centroid of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.containedIn(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.contains(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.convexHull(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the convex hull of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.coordinates()

List

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiPoint.cutLines

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

Usage

Returns

MultiPoint.cutLines(distances, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Cuts the lines of this geometry.

distances

List

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.difference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.disjoint(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.dissolve(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to union.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.distance(right, maxError, proj)

Float

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.edgesAreGeodesics()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiPoint.evaluate

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

Usage

Returns

MultiPoint.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

MultiPoint.geodesic()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiPoint.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

Usage

Returns

MultiPoint.geometries()

List

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

MultiPoint.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, optional

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

ee.Geometry.MultiPoint.intersection

Returns the intersection of the two geometries.

Usage

Returns

MultiPoint.intersection(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.intersects(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.isUnbounded()

Boolean

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

MultiPoint.length(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.perimeter(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.projection()

Projection

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiPoint.serialize

Returns the serialized representation of this object.

Usage

Returns

MultiPoint.serialize()

String

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

MultiPoint.simplify(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to simplify.

maxError

ErrorMargin

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

proj

Projection, 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.

Usage

Returns

MultiPoint.symmetricDifference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.toGeoJSON()

GeoJSONGeometry

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.MultiPoint.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

Usage

Returns

MultiPoint.toGeoJSONString()

String

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.MultiPoint.transform

Transforms the geometry to a specific projection.

Usage

Returns

MultiPoint.transform(proj, maxError)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to reproject.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Geometry.MultiPoint.type

Returns the GeoJSON type of the geometry.

Usage

Returns

MultiPoint.type()

String

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiPoint.union

Returns the union of the two geometries.

Usage

Returns

MultiPoint.union(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPoint.withinDistance(right, distance, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

distance

Float

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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).

Usage

Returns

ee.Geometry.MultiPolygon(coords, proj, geodesic, maxError, evenOdd)

Geometry.MultiPolygon

Argument

Type

Details

coords

List

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.

proj

Projection, optional

The projection of this geometry. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesic

Boolean, 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.

maxError

ErrorMargin, optional

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

evenOdd

Boolean, 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).

Usage

Returns

MultiPolygon.area(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The geometry input.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Geometry.MultiPolygon.bounds

Returns the bounding rectangle of the geometry.

Usage

Returns

MultiPolygon.bounds(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Return the bounding box of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.buffer(distance, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry being buffered.

distance

Float

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.

maxError

ErrorMargin, 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.

proj

Projection, 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.

Usage

Returns

MultiPolygon.centroid(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the centroid of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.containedIn(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.contains(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.convexHull(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the convex hull of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.coordinates()

List

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiPolygon.cutLines

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

Usage

Returns

MultiPolygon.cutLines(distances, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Cuts the lines of this geometry.

distances

List

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.difference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.disjoint(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.dissolve(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to union.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.distance(right, maxError, proj)

Float

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.edgesAreGeodesics()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiPolygon.evaluate

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

Usage

Returns

MultiPolygon.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

MultiPolygon.geodesic()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiPolygon.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

Usage

Returns

MultiPolygon.geometries()

List

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

MultiPolygon.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, optional

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

ee.Geometry.MultiPolygon.intersection

Returns the intersection of the two geometries.

Usage

Returns

MultiPolygon.intersection(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.intersects(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.isUnbounded()

Boolean

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

MultiPolygon.length(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.perimeter(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.projection()

Projection

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiPolygon.serialize

Returns the serialized representation of this object.

Usage

Returns

MultiPolygon.serialize()

String

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

MultiPolygon.simplify(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to simplify.

maxError

ErrorMargin

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.symmetricDifference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.toGeoJSON()

GeoJSONGeometry

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.MultiPolygon.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

Usage

Returns

MultiPolygon.toGeoJSONString()

String

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.MultiPolygon.transform

Transforms the geometry to a specific projection.

Usage

Returns

MultiPolygon.transform(proj, maxError)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to reproject.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Geometry.MultiPolygon.type

Returns the GeoJSON type of the geometry.

Usage

Returns

MultiPolygon.type()

String

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.MultiPolygon.union

Returns the union of the two geometries.

Usage

Returns

MultiPolygon.union(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

MultiPolygon.withinDistance(right, distance, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

distance

Float

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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).

Usage

Returns

ee.Geometry.Point(coords, proj)

Geometry.Point

Argument

Type

Details

coords

List

A list of two [x,y] coordinates in the given projection.

proj

Projection, 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).

Usage

Returns

Point.area(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The geometry input.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Geometry.Point.bounds

Returns the bounding rectangle of the geometry.

Usage

Returns

Point.bounds(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Return the bounding box of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.buffer(distance, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry being buffered.

distance

Float

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.

maxError

ErrorMargin, 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.

proj

Projection, 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.

Usage

Returns

Point.centroid(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the centroid of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.containedIn(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.contains(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.convexHull(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the convex hull of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.coordinates()

List

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Point.cutLines

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

Usage

Returns

Point.cutLines(distances, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Cuts the lines of this geometry.

distances

List

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.difference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.disjoint(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.dissolve(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to union.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.distance(right, maxError, proj)

Float

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.edgesAreGeodesics()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Point.evaluate

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

Usage

Returns

Point.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

Point.geodesic()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Point.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

Usage

Returns

Point.geometries()

List

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Point.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, optional

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

ee.Geometry.Point.intersection

Returns the intersection of the two geometries.

Usage

Returns

Point.intersection(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.intersects(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.isUnbounded()

Boolean

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Point.length(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.perimeter(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.projection()

Projection

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Point.serialize

Returns the serialized representation of this object.

Usage

Returns

Point.serialize()

String

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Point.simplify(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to simplify.

maxError

ErrorMargin

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

proj

Projection, 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.

Usage

Returns

Point.symmetricDifference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.toGeoJSON()

GeoJSONGeometry

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.Point.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

Usage

Returns

Point.toGeoJSONString()

String

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.Point.transform

Transforms the geometry to a specific projection.

Usage

Returns

Point.transform(proj, maxError)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to reproject.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Geometry.Point.type

Returns the GeoJSON type of the geometry.

Usage

Returns

Point.type()

String

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Point.union

Returns the union of the two geometries.

Usage

Returns

Point.union(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Point.withinDistance(right, distance, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

distance

Float

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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).

Usage

Returns

ee.Geometry.Polygon(coords, proj, geodesic, maxError, evenOdd)

Geometry.Polygon

Argument

Type

Details

coords

List

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.

proj

Projection, optional

The projection of this geometry. The default is the projection of the inputs, where Numbers are assumed to be EPSG:4326.

geodesic

Boolean, 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.

maxError

ErrorMargin, optional

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

evenOdd

Boolean, 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).

Usage

Returns

Polygon.area(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The geometry input.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Geometry.Polygon.bounds

Returns the bounding rectangle of the geometry.

Usage

Returns

Polygon.bounds(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Return the bounding box of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.buffer(distance, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry being buffered.

distance

Float

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.

maxError

ErrorMargin, 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.

proj

Projection, 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.

Usage

Returns

Polygon.centroid(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the centroid of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.containedIn(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.contains(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.convexHull(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the convex hull of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.coordinates()

List

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Polygon.cutLines

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

Usage

Returns

Polygon.cutLines(distances, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Cuts the lines of this geometry.

distances

List

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.difference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.disjoint(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.dissolve(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to union.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.distance(right, maxError, proj)

Float

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.edgesAreGeodesics()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Polygon.evaluate

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

Usage

Returns

Polygon.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

Polygon.geodesic()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Polygon.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

Usage

Returns

Polygon.geometries()

List

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Polygon.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, optional

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

ee.Geometry.Polygon.intersection

Returns the intersection of the two geometries.

Usage

Returns

Polygon.intersection(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.intersects(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.isUnbounded()

Boolean

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Polygon.length(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.perimeter(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.projection()

Projection

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Polygon.serialize

Returns the serialized representation of this object.

Usage

Returns

Polygon.serialize()

String

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Polygon.simplify(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to simplify.

maxError

ErrorMargin

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

proj

Projection, 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.

Usage

Returns

Polygon.symmetricDifference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.toGeoJSON()

GeoJSONGeometry

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.Polygon.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

Usage

Returns

Polygon.toGeoJSONString()

String

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.Polygon.transform

Transforms the geometry to a specific projection.

Usage

Returns

Polygon.transform(proj, maxError)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to reproject.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Geometry.Polygon.type

Returns the GeoJSON type of the geometry.

Usage

Returns

Polygon.type()

String

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Polygon.union

Returns the union of the two geometries.

Usage

Returns

Polygon.union(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Polygon.withinDistance(right, distance, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

distance

Float

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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).

Usage

Returns

ee.Geometry.Rectangle(coords, proj, geodesic, evenOdd)

Geometry.Rectangle

Argument

Type

Details

coords

List

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.

proj

Projection, 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.

geodesic

Boolean, 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.

evenOdd

Boolean, 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).

Usage

Returns

Rectangle.area(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The geometry input.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Geometry.Rectangle.bounds

Returns the bounding rectangle of the geometry.

Usage

Returns

Rectangle.bounds(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Return the bounding box of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.buffer(distance, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry being buffered.

distance

Float

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.

maxError

ErrorMargin, 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.

proj

Projection, 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.

Usage

Returns

Rectangle.centroid(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the centroid of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.containedIn(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.contains(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.convexHull(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the convex hull of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.coordinates()

List

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Rectangle.cutLines

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

Usage

Returns

Rectangle.cutLines(distances, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Cuts the lines of this geometry.

distances

List

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.difference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.disjoint(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.dissolve(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to union.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.distance(right, maxError, proj)

Float

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.edgesAreGeodesics()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Rectangle.evaluate

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

Usage

Returns

Rectangle.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

Rectangle.geodesic()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Rectangle.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

Usage

Returns

Rectangle.geometries()

List

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Rectangle.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, optional

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

ee.Geometry.Rectangle.intersection

Returns the intersection of the two geometries.

Usage

Returns

Rectangle.intersection(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.intersects(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.isUnbounded()

Boolean

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Rectangle.length(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.perimeter(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.projection()

Projection

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Rectangle.serialize

Returns the serialized representation of this object.

Usage

Returns

Rectangle.serialize()

String

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Rectangle.simplify(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to simplify.

maxError

ErrorMargin

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

proj

Projection, 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.

Usage

Returns

Rectangle.symmetricDifference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.toGeoJSON()

GeoJSONGeometry

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.Rectangle.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

Usage

Returns

Rectangle.toGeoJSONString()

String

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.Rectangle.transform

Transforms the geometry to a specific projection.

Usage

Returns

Rectangle.transform(proj, maxError)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to reproject.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Geometry.Rectangle.type

Returns the GeoJSON type of the geometry.

Usage

Returns

Rectangle.type()

String

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.Rectangle.union

Returns the union of the two geometries.

Usage

Returns

Rectangle.union(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Rectangle.withinDistance(right, distance, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

distance

Float

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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).

Usage

Returns

Geometry.area(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The geometry input.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Geometry.bounds

Returns the bounding rectangle of the geometry.

Usage

Returns

Geometry.bounds(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Return the bounding box of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.buffer(distance, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry being buffered.

distance

Float

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.

maxError

ErrorMargin, 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.

proj

Projection, 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.

Usage

Returns

Geometry.centroid(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the centroid of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.containedIn(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.contains(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.convexHull(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Calculates the convex hull of this geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.coordinates()

List

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.cutLines

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

Usage

Returns

Geometry.cutLines(distances, maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

Cuts the lines of this geometry.

distances

List

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.difference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.disjoint(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.dissolve(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to union.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.distance(right, maxError, proj)

Float

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.edgesAreGeodesics()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.evaluate

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

Usage

Returns

Geometry.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

Geometry.geodesic()

Boolean

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.geometries

Returns the list of geometries in a GeometryCollection, or a singleton list of the geometry for single geometries.

Usage

Returns

Geometry.geometries()

List

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Geometry.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, optional

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

ee.Geometry.intersection

Returns the intersection of the two geometries.

Usage

Returns

Geometry.intersection(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.intersects(right, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.isUnbounded()

Boolean

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Geometry.length(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.perimeter(maxError, proj)

Float

Argument

Type

Details

this: geometry

Geometry

The input geometry.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.projection()

Projection

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.serialize

Returns the serialized representation of this object.

Usage

Returns

Geometry.serialize()

String

Argument

Type

Details

this: geometry

Geometry

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.

Usage

Returns

Geometry.simplify(maxError, proj)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to simplify.

maxError

ErrorMargin

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

proj

Projection, 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.

Usage

Returns

Geometry.symmetricDifference(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.toGeoJSON()

GeoJSONGeometry

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

Usage

Returns

Geometry.toGeoJSONString()

String

Argument

Type

Details

this: geometry

Geometry

The Geometry instance.

ee.Geometry.transform

Transforms the geometry to a specific projection.

Usage

Returns

Geometry.transform(proj, maxError)

Geometry

Argument

Type

Details

this: geometry

Geometry

The geometry to reproject.

proj

Projection, 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.

maxError

ErrorMargin, default: null

The maximum projection error.

ee.Geometry.type

Returns the GeoJSON type of the geometry.

Usage

Returns

Geometry.type()

String

Argument

Type

Details

this: geometry

Geometry

ee.Geometry.union

Returns the union of the two geometries.

Usage

Returns

Geometry.union(right, maxError, proj)

Geometry

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

Geometry.withinDistance(right, distance, maxError, proj)

Boolean

Argument

Type

Details

this: left

Geometry

The geometry used as the left operand of the operation.

right

Geometry

The geometry used as the right operand of the operation.

distance

Float

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

maxError

ErrorMargin, default: null

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

proj

Projection, 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.

Usage

Returns

ee.Image(args)

Image

Argument

Type

Details

args

Image|List, optional

Constructor argument.

ee.Image.abs

Computes the absolute value of the input.

Usage

Returns

Image.abs()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.acos

Computes the arc cosine in radians of the input.

Usage

Returns

Image.acos()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.add(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.addBands(srcImg, names, overwrite)

Image

Argument

Type

Details

this: dstImg

Image

An image into which to copy bands.

srcImg

Image

An image containing bands to copy.

names

List, default: null

Optional list of band names to copy. If names is omitted, all bands from srcImg will be copied over.

overwrite

Boolean, 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.

Usage

Returns

Image.and(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.arrayAccum(axis, reducer)

Image

Argument

Type

Details

this: input

Image

Input image.

axis

Integer

Axis along which to perform the cumulative sum.

reducer

Reducer, 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.

Usage

Returns

Image.arrayCat(image2, axis)

Image

Argument

Type

Details

this: image1

Image

First array image to concatenate.

image2

Image

Second array image to concatenate.

axis

Integer

Axis to concatenate along.

ee.Image.arrayDimensions

Returns the number of dimensions in each array band, and 0 for scalar image bands.

Usage

Returns

Image.arrayDimensions()

Image

Argument

Type

Details

this: input

Image

Input image.

ee.Image.arrayDotProduct

Computes the dot product of each pair of 1-D arrays in the bands of the input images.

Usage

Returns

Image.arrayDotProduct(image2)

Image

Argument

Type

Details

this: image1

Image

First array image of 1-D vectors.

image2

Image

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.

Usage

Returns

Image.arrayFlatten(coordinateLabels, separator)

Image

Argument

Type

Details

this: image

Image

Image of multidimensional pixels to flatten.

coordinateLabels

List

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'.

separator

String, 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.

Usage

Returns

Image.arrayGet(position)

Image

Argument

Type

Details

this: image

Image

Array to get an element from.

position

Image

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.

Usage

Returns

Image.arrayLength(axis)

Image

Argument

Type

Details

this: input

Image

Input image.

axis

Integer

The axis along which to take the length.

ee.Image.arrayLengths

Returns a 1D array image with the length of each array axis.

Usage

Returns

Image.arrayLengths()

Image

Argument

Type

Details

this: input

Image

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.

Usage

Returns

Image.arrayMask(mask)

Image

Argument

Type

Details

this: input

Image

Array image to mask.

mask

Image

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.

Usage

Returns

Image.arrayProject(axes)

Image

Argument

Type

Details

this: input

Image

Input image.

axes

List

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.

Usage

Returns

Image.arrayReduce(reducer, axes, fieldAxis)

Image

Argument

Type

Details

this: input

Image

Input image.

reducer

Reducer

The reducer to apply

axes

List

The list of array axes to reduce in each pixel. The output will have a length of 1 in all these axes.

fieldAxis

Integer, 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.

Usage

Returns

Image.arrayRepeat(axis, copies)

Image

Argument

Type

Details

this: input

Image

Image of array pixels to be repeated.

axis

Integer

Axis along which to repeat each pixel's array.

copies

Image

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.

Usage

Returns

Image.arraySlice(axis, start, end, step)

Image

Argument

Type

Details

this: input

Image

Input array image.

axis

Integer, default: 0

Axis to subset.

start

Image, 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.

end

Image, 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.

step

Integer, 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.

Usage

Returns

Image.arraySort(keys)

Image

Argument

Type

Details

this: image

Image

Array image to sort.

keys

Image, 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.

Usage

Returns

Image.arrayTranspose(axis1, axis2)

Image

Argument

Type

Details

this: input

Image

Input image.

axis1

Integer, default: 0

First axis to swap.

axis2

Integer, 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.

Usage

Returns

Image.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Image.asin

Computes the arc sine in radians of the input.

Usage

Returns

Image.asin()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.atan

Computes the arc tangent in radians of the input.

Usage

Returns

Image.atan()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.atan2(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.bandNames()

List

Argument

Type

Details

this: image

Image

The image from which to get band names.

ee.Image.bandTypes

Returns a dictionary of the image's band types.

Usage

Returns

Image.bandTypes()

Dictionary

Argument

Type

Details

this: image

Image

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.

Usage

Returns

Image.bitCount()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.bitsToArrayImage()

Image

Argument

Type

Details

this: input

Image

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.

Usage

Returns

Image.bitwiseAnd(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.bitwiseNot()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.bitwiseOr(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.bitwiseXor(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.bitwise_and(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.bitwise_not()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.bitwise_or(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.bitwise_xor(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.blend(top)

Image

Argument

Type

Details

this: bottom

Image

The bottom image.

top

Image

The top image.

ee.Image.byte

Casts the input value to an unsigned 8-bit integer.

Usage

Returns

Image.byte()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.cast

Casts some or all bands of an image to the specified types.

Usage

Returns

Image.cast(bandTypes, bandOrder)

Image

Argument

Type

Details

this: image

Image

The image to cast.

bandTypes

Dictionary

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.

bandOrder

List, 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.

Usage

Returns

ee.Image.cat(var_args)

Image

Argument

Type

Details

var_args

VarArgs

The images to be combined.

ee.Image.cbrt

Computes the cubic root of the input.

Usage

Returns

Image.cbrt()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.ceil

Computes the smallest integer greater than or equal to the input.

Usage

Returns

Image.ceil()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.changeProj(srcProj, dstProj)

Image

Argument

Type

Details

this: input

Image

srcProj

Projection

The original projection.

dstProj

Projection

The new projection.

ee.Image.clamp

Clamps the values in all bands of an image to all lie within the specified range.

Usage

Returns

Image.clamp(low, high)

Image

Argument

Type

Details

this: input

Image

The image to clamp.

low

Float

The minimum allowed value in the range.

high

Float

The maximum allowed value in the range.

ee.Image.classify

Classifies an image.

Usage

Returns

Image.classify(classifier, outputName)

Image

Argument

Type

Details

this: image

Image

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.

classifier

Object

The classifier to use.

outputName

String, 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.

Usage

Returns

Image.clip(geometry)

Image

Argument

Type

Details

this: image

Image

The Image instance.

geometry

Feature|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.

Usage

Returns

Image.clipToCollection(collection)

Image

Argument

Type

Details

this: input

Image

The image to clip.

collection

Object

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.

Usage

Returns

Image.cluster(clusterer, outputName)

Image

Argument

Type

Details

this: image

Image

The image to cluster. Must contain all the bands in the clusterer's schema.

clusterer

Clusterer

The clusterer to use.

outputName

String, 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.

Usage

Returns

Image.connectedComponents(connectedness, maxSize)

Image

Argument

Type

Details

this: image

Image

The image to label.

connectedness

Kernel

Connectedness kernel.

maxSize

Integer

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).

Usage

Returns

Image.connectedPixelCount(maxSize, eightConnected)

Image

Argument

Type

Details

this: input

Image

The input image.

maxSize

Integer, default: 100

The maximum size of the neighborhood in pixels.

eightConnected

Boolean, default: true

Whether to use 8-connected rather 4-connected rules.

ee.Image.constant

Generates an image containing a constant value everywhere.

Usage

Returns

ee.Image.constant(value)

Image

Argument

Type

Details

value

Object

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.

Usage

Returns

Image.convolve(kernel)

Image

Argument

Type

Details

this: image

Image

The image to convolve.

kernel

Kernel

The kernel to convolve with.

ee.Image.cos

Computes the cosine of the input in radians.

Usage

Returns

Image.cos()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.cosh

Computes the hyperbolic cosine of the input.

Usage

Returns

Image.cosh()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.cumulativeCost(source, maxDistance, geodeticDistance)

Image

Argument

Type

Details

this: cost

Image

A single-band image representing the cost to traverse each pixel. Masked pixels can't be traversed.

source

Image

A single-band image representing the sources. A pixel value different from 0 defines a source pixel.

maxDistance

Float

Maximum distance for computation, in meters.

geodeticDistance

Boolean, 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')).

Usage

Returns

Image.date()

Date

Argument

Type

Details

this: image

Image

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.

Usage

Returns

Image.derivative()

Image

Argument

Type

Details

this: image

Image

The input image.

ee.Image.digamma

Computes the digamma function of the input.

Usage

Returns

Image.digamma()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.displace

Warps an image using an image of displacements.

Usage

Returns

Image.displace(displacement, mode)

Image

Argument

Type

Details

this: image

Image

The image to warp.

displacement

Image

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.

mode

String, 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.

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.

projection

Projection, default: null

The projection in which to output displacement values. The default is the projection of the first band of the reference image.

patchWidth

Float, 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.

stiffness

Float, 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.

Usage

Returns

Image.distance(kernel, skipMasked)

Image

Argument

Type

Details

this: image

Image

The input image.

kernel

Kernel, default: null

The distance kernel.

skipMasked

Boolean, 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.

Usage

Returns

Image.divide(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

The image from which the right operand bands are taken.

ee.Image.double

Casts the input value to a 64-bit float.

Usage

Returns

Image.double()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.entropy(kernel)

Image

Argument

Type

Details

this: image

Image

The image for which to compute the entropy.

kernel

Kernel

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.

Usage

Returns

Image.eq(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

The image from which the right operand bands are taken.

ee.Image.erf

Computes the error function of the input.

Usage

Returns

Image.erf()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.erfInv

Computes the inverse error function of the input.

Usage

Returns

Image.erfInv()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.erfc

Computes the complementary error function of the input.

Usage

Returns

Image.erfc()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.erfcInv

Computes the inverse complementary error function of the input.

Usage

Returns

Image.erfcInv()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.expression

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.

Usage

Returns

Image.expression(expression, map)

Image

Argument

Type

Details

this: image

Image

The Image instance.

expression

String

The expression to evaluate.

map

Dictionary, 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.

Usage

Returns

Image.fastDistanceTransform(neighborhood, units, metric)

Image

Argument

Type

Details

this: image

Image

The input image.

neighborhood

Integer, default: 256

Neighborhood size in pixels.

units

String, default: "pixels"

The units of the neighborhood, currently only 'pixels' are supported.

metric

String, 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.

Usage

Returns

Image.first(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.firstNonZero(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.first_nonzero(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

The image from which the right operand bands are taken.

ee.Image.float

Casts the input value to a 32-bit float.

Usage

Returns

Image.float()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.floor

Computes the largest integer less than or equal to the input.

Usage

Returns

Image.floor()

Image

Argument

Type

Details

this: value

Image

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.

If a kernel is not specified, this determines whether the kernel is in meters or pixels.

iterations

Integer, default: 1

The number of times to apply the given kernel.

kernel

Kernel, default: null

A custom kernel. If used, kernelType and radius are ignored.

ee.Image.gamma

Computes the gamma function of the input.

Usage

Returns

Image.gamma()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.gammainc(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

The image from which the right operand bands are taken.

ee.Image.get

Extract a property from a feature.

Usage

Returns

Image.get(property)

Argument

Type

Details

this: object

Element

The feature to extract the property from.

property

String

The property to extract.

ee.Image.getDownloadURL

Get a Download URL

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

Usage

Returns

Image.getDownloadURL(params, callback)

Object|String

Argument

Type

Details

this: image

Image

The Image instance.

params

Object

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.

callback

Function, 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.

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.

Usage

Returns

Image.getMap(visParams, callback)

MapId|Object

Argument

Type

Details

this: image

Image

The Image instance.

visParams

ImageVisualizationParameters, optional

The visualization parameters.

callback

Function, 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.

Usage

Returns

Image.getThumbURL(params, callback)

Object|String

Argument

Type

Details

this: image

Image

The Image instance.

params

Object

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'.

callback

Function, 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.

Usage

Returns

Image.glcmTexture(size, kernel, average)

Image

Argument

Type

Details

this: image

Image

The image for which to compute texture metrics.

size

Integer, default: 1

The size of the neighborhood to include in each GLCM.

kernel

Kernel, 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).

average

Boolean, default: true

If true, the directional bands for each metric are averaged.

ee.Image.gradient

Calculates the x and y gradient.

Usage

Returns

Image.gradient()

Image

Argument

Type

Details

this: input

Image

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.

Usage

Returns

Image.gt(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.gte(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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].

Usage

Returns

Image.hsvToRgb()

Image

Argument

Type

Details

this: image

Image

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.

Usage

Returns

Image.hypot(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.id()

String

Argument

Type

Details

this: element

Element

The element from which the ID is taken.

ee.Image.int

Casts the input value to a signed 32-bit integer.

Usage

Returns

Image.int()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.int16

Casts the input value to a signed 16-bit integer.

Usage

Returns

Image.int16()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.int32

Casts the input value to a signed 32-bit integer.

Usage

Returns

Image.int32()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.int64

Casts the input value to a signed 64-bit integer.

Usage

Returns

Image.int64()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.int8

Casts the input value to a signed 8-bit integer.

Usage

Returns

Image.int8()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.interpolate(x, y, behavior)

Image

Argument

Type

Details

this: image

Image

The image to which the interpolation is applied.

x

List

The x axis (input) values in the piecewise function.

y

List

The y axis (output) values in the piecewise function.

behavior

String, 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.

Usage

Returns

Image.lanczos()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.leftShift(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.left_shift(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

The image from which the right operand bands are taken.

ee.Image.load

Returns the image given its ID.

Usage

Returns

ee.Image.load(id, version)

Image

Argument

Type

Details

id

String

The asset ID of the image.

version

Long, default: -1

The version of the asset. -1 signifies the latest version.

ee.Image.log

Computes the natural logarithm of the input.

Usage

Returns

Image.log()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.log10

Computes the base-10 logarithm of the input.

Usage

Returns

Image.log10()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.long

Casts the input value to a signed 64-bit integer.

Usage

Returns

Image.long()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.lt(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.lte(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.mask(mask)

Image

Argument

Type

Details

this: image

Image

The input image.

mask

Image, 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'.

Usage

Returns

Image.matrixCholeskyDecomposition()

Image

Argument

Type

Details

this: image

Image

Image of 2-D matrices to be decomposed.

ee.Image.matrixDeterminant

Computes the determinant of the matrix.

Usage

Returns

Image.matrixDeterminant()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.matrixDiagonal

Computes the diagonal of the matrix in a single column.

Usage

Returns

Image.matrixDiagonal()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.matrixFnorm

Computes the Frobenius norm of the matrix.

Usage

Returns

Image.matrixFnorm()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

ee.Image.matrixIdentity(size)

Image

Argument

Type

Details

size

Integer

The length of each axis.

ee.Image.matrixInverse

Computes the inverse of the matrix.

Usage

Returns

Image.matrixInverse()

Image

Argument

Type

Details

this: value

Image

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'.

Usage

Returns

Image.matrixLUDecomposition()

Image

Argument

Type

Details

this: image

Image

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.

Usage

Returns

Image.matrixMultiply(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

The image from which the right operand bands are taken.

ee.Image.matrixPseudoInverse

Computes the Moore-Penrose pseudoinverse of the matrix.

Usage

Returns

Image.matrixPseudoInverse()

Image

Argument

Type

Details

this: value

Image

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'.

Usage

Returns

Image.matrixQRDecomposition()

Image

Argument

Type

Details

this: image

Image

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'.

Usage

Returns

Image.matrixSingularValueDecomposition()

Image

Argument

Type

Details

this: image

Image

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.

Usage

Returns

Image.matrixSolve(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

The image from which the right operand bands are taken.

ee.Image.matrixToDiag

Computes a square diagonal matrix from a single column matrix.

Usage

Returns

Image.matrixToDiag()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.matrixTrace

Computes the trace of the matrix.

Usage

Returns

Image.matrixTrace()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.matrixTranspose

Transposes two dimensions of each array pixel.

Usage

Returns

Image.matrixTranspose(axis1, axis2)

Image

Argument

Type

Details

this: input

Image

Input image.

axis1

Integer, default: 0

First axis to swap.

axis2

Integer, 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.

Usage

Returns

Image.max(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.medialAxis(neighborhood, units)

Image

Argument

Type

Details

this: image

Image

The input image.

neighborhood

Integer, default: 256

Neighborhood size in pixels.

units

String, 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.

Usage

Returns

Image.metadata(property, name)

Image

Argument

Type

Details

this: image

Image

The image from which to get the metadata

property

String

The property from which to take the value.

name

String, 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.

Usage

Returns

Image.min(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.mod(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.multiply(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.neighborhoodToBands(kernel)

Image

Argument

Type

Details

this: image

Image

The image to get pixels from.

kernel

Kernel

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.

Usage

Returns

Image.neq(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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).

Usage

Returns

Image.normalizedDifference(bandNames)

Image

Argument

Type

Details

this: input

Image

The input image.

bandNames

List, 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.

Usage

Returns

Image.not()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.or(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

The image from which the right operand bands are taken.

ee.Image.paint

Paints the geometries of a collection onto an image.

Usage

Returns

Image.paint(featureCollection, color, width)

Image

Argument

Type

Details

this: image

Image

The image on which the collection is painted.

featureCollection

FeatureCollection

The collection painted onto the image.

color

Object, default: 0

Either the name of a color property or a number.

width

Object, 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.

Usage

Returns

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.

Usage

Returns

ee.Image.pixelCoordinates(projection)

Image

Argument

Type

Details

projection

Projection

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.

Usage

Returns

ee.Image.pixelLonLat()

Image

No arguments.

ee.Image.polynomial

Compute a polynomial at each pixel using the given coefficients.

Usage

Returns

Image.polynomial(coefficients)

Image

Argument

Type

Details

this: image

Image

The input image.

coefficients

List

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.

Usage

Returns

Image.pow(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.projection()

Projection

Argument

Type

Details

this: image

Image

The image from which to get the projection.

ee.Image.propertyNames

Returns the names of properties on this element.

Usage

Returns

Image.propertyNames()

List

Argument

Type

Details

this: element

Element

ee.Image.random

Generates a uniform random number at each pixel location, in the range of 0 to 1.

Usage

Returns

ee.Image.random(seed)

Image

Argument

Type

Details

seed

Long, 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.

Usage

Returns

Image.randomVisualizer()

Image

Argument

Type

Details

this: image

Image

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.

Usage

Returns

Image.reduce(reducer)

Image

Argument

Type

Details

this: image

Image

The image to reduce.

reducer

Reducer

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.

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.

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.

crsTransform

List, 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.

tileScale

Float, 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.

Usage

Returns

Image.reduceResolution(reducer, bestEffort, maxPixels)

Image

Argument

Type

Details

this: image

Image

The input image.

reducer

Reducer

The reducer to apply to be used for combining pixels.

bestEffort

Boolean, 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.

maxPixels

Integer, 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.

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.

reducer

Reducer, 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()

geometry

Geometry, default: null

The region over which to reduce data. Defaults to the footprint of the image's first band.

scale

Float, default: null

A nominal scale in meters of the projection to work in.

geometryType

String, 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).

eightConnected

Boolean, default: true

If true, diagonally-connected pixels are considered adjacent; otherwise only pixels that share an edge are.

labelProperty

String, default: "label"

If non-null, the value of the first band will be saved as the specified property of each feature.

crs

Projection, 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.

crsTransform

List, 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.

bestEffort

Boolean, 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.

maxPixels

Long, default: 10000000

The maximum number of pixels to reduce.

tileScale

Float, 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.

geometryInNativeProjection

Boolean, 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.

Usage

Returns

Image.register(referenceImage, maxOffset, patchWidth, stiffness)

Image

Argument

Type

Details

this: image

Image

The image to register.

referenceImage

Image

The image to register to.

maxOffset

Float

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.

patchWidth

Float, 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.

stiffness

Float, 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.

Usage

Returns

Image.remap(from, to, defaultValue, bandName)

Image

Argument

Type

Details

this: image

Image

The image to which the remapping is applied.

from

List

The source values (numbers or EEArrays). All values in this list will be mapped to the corresponding value in 'to'.

to

List

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'.

defaultValue

Object, 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.

bandName

String, 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.

Usage

Returns

Image.rename(var_args)

Image

Argument

Type

Details

this: image

Image

The Image instance.

var_args

List

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.

Usage

Returns

Image.reproject(crs, crsTransform, scale)

Image

Argument

Type

Details

this: image

Image

The Image to reproject.

crs

Projection

The CRS to project the image to.

crsTransform

List, 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.

scale

Float, 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.)

Usage

Returns

Image.resample(mode)

Image

Argument

Type

Details

this: image

Image

The Image to resample.

mode

String, 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.

Usage

Returns

ee.Image.rgb(r, g, b)

Image

Argument

Type

Details

r

Image

The red image.

g

Image

The green image.

b

Image

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].

Usage

Returns

Image.rgbToHsv()

Image

Argument

Type

Details

this: image

Image

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.

Usage

Returns

Image.rightShift(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

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.

Usage

Returns

Image.right_shift(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

The image from which the right operand bands are taken.

ee.Image.round

Computes the integer nearest to the input.

Usage

Returns

Image.round()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.rsedTransform(neighborhood, units)

Image

Argument

Type

Details

this: image

Image

The input image.

neighborhood

Integer, default: 256

Neighborhood size in pixels.

units

String, 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.

The region to sample from. If unspecified, uses the image's whole footprint.

scale

Float, default: null

A nominal scale in meters of the projection to sample in.

projection

Projection, 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.

factor

Float, default: null

A subsampling factor, within (0, 1]. If specified, 'numPixels' must not be specified. Defaults to no subsampling.

numPixels

Long, default: null

The approximate number of pixels to sample. If specified, 'factor' must not be specified.

seed

Integer, default: 0

A randomization seed to use for subsampling.

dropNulls

Boolean, default: true

Post filter the result to drop features that have null-valued properties.

tileScale

Float, 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.

The list of properties to copy from each input feature. Defaults to all non-system properties.

scale

Float, 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.

projection

Projection, 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.

tileScale

Float, 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.

Usage

Returns

Image.select(var_args)

Image

Argument

Type

Details

this: image

Image

The Image instance.

var_args

VarArgs

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.

Usage

Returns

Image.serialize()

String

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

ee.Image.set

Overrides one or more metadata properties of an Element.

Returns the element with the specified properties overridden.

Usage

Returns

Image.set(var_args)

Element

Argument

Type

Details

this: element

Element

The Element instance.

var_args

VarArgs

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.

Usage

Returns

Image.setMulti(properties)

Element

Argument

Type

Details

this: object

Element

The object whose properties to override.

properties

Dictionary

The property values to override.

ee.Image.short

Casts the input value to a signed 16-bit integer.

Usage

Returns

Image.short()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.sin

Computes the sine of the input in radians.

Usage

Returns

Image.sin()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.sinh

Computes the hyperbolic sine of the input.

Usage

Returns

Image.sinh()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.sldStyle(sldXml)

Image

Argument

Type

Details

this: input

Image

The image to rendering using the SLD.

sldXml

String

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.

Usage

Returns

Image.slice(start, end)

Image

Argument

Type

Details

this: image

Image

The image from which to select bands.

start

Integer

Where to start the selection. Negative numbers select from the end, counting backwards.

end

Integer, 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.

Usage

Returns

Image.sqrt()

Image

Argument

Type

Details

this: value

Image

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.

The default number of points to sample in each class. Can be overridden for specific classes using the 'classValues' and 'classPoints' properties.

classBand

String, 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.

region

Geometry, default: null

The region to sample from. If unspecified, the input image's whole footprint is used.

scale

Float, 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.

projection

Projection, 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.

seed

Integer, default: 0

A randomization seed to use for subsampling.

classValues

List, default: null

A list of class values for which to override the numPixels parameter. Must be the same size as classPoints or null.

classPoints

List, 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.

dropNulls

Boolean, default: true

Skip pixels in which any band is masked.

tileScale

Float, 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.

Usage

Returns

Image.subtract(image2)

Image

Argument

Type

Details

this: image1

Image

The image from which the left operand bands are taken.

image2

Image

The image from which the right operand bands are taken.

ee.Image.tan

Computes the tangent of the input in radians.

Usage

Returns

Image.tan()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.tanh

Computes the hyperbolic tangent of the input.

Usage

Returns

Image.tanh()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.toArray(axis)

Image

Argument

Type

Details

this: image

Image

Image of bands to convert to an array per pixel. Bands must have scalar pixels, or array pixels with equal dimensionality.

axis

Integer, 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.

Usage

Returns

Image.toByte()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toDictionary

Extract properties from a feature as a dictionary.

Usage

Returns

Image.toDictionary(properties)

Dictionary

Argument

Type

Details

this: element

Element

The feature to extract the property from.

properties

List, 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.

Usage

Returns

Image.toDouble()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toFloat

Casts the input value to a 32-bit float.

Usage

Returns

Image.toFloat()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toInt

Casts the input value to a signed 32-bit integer.

Usage

Returns

Image.toInt()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toInt16

Casts the input value to a signed 16-bit integer.

Usage

Returns

Image.toInt16()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toInt32

Casts the input value to a signed 32-bit integer.

Usage

Returns

Image.toInt32()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toInt64

Casts the input value to a signed 64-bit integer.

Usage

Returns

Image.toInt64()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toInt8

Casts the input value to a signed 8-bit integer.

Usage

Returns

Image.toInt8()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toLong

Casts the input value to a signed 64-bit integer.

Usage

Returns

Image.toLong()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toShort

Casts the input value to a signed 16-bit integer.

Usage

Returns

Image.toShort()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toUint16

Casts the input value to an unsigned 16-bit integer.

Usage

Returns

Image.toUint16()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toUint32

Casts the input value to an unsigned 32-bit integer.

Usage

Returns

Image.toUint32()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.toUint8

Casts the input value to an unsigned 8-bit integer.

Usage

Returns

Image.toUint8()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.translate

Translate the input image.

Usage

Returns

Image.translate(x, y, units, proj)

Image

Argument

Type

Details

this: input

Image

x

Float

y

Float

units

String, default: "meters"

The units for x and y; "meters" or "pixels".

proj

Projection, 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.

Usage

Returns

Image.trigamma()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.uint16

Casts the input value to an unsigned 16-bit integer.

Usage

Returns

Image.uint16()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.uint32

Casts the input value to an unsigned 32-bit integer.

Usage

Returns

Image.uint32()

Image

Argument

Type

Details

this: value

Image

The image to which the operation is applied.

ee.Image.uint8

Casts the input value to an unsigned 8-bit integer.

Usage

Returns

Image.uint8()

Image

Argument

Type

Details

this: value

Image

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.

Usage

Returns

Image.unitScale(low, high)

Image

Argument

Type

Details

this: input

Image

The image to scale.

low

Float

The value mapped to 0.

high

Float

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.

Usage

Returns

Image.unmask(value, sameFootprint)

Image

Argument

Type

Details

this: input

Image

Input image.

value

Image, 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.

sameFootprint

Boolean, 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.

Usage

Returns

Image.unmix(endmembers, sumToOne, nonNegative)

Image

Argument

Type

Details

this: image

Image

The input image.

endmembers

List

The endmembers to unmix with.

sumToOne

Boolean, default: false

Constrain the outputs to sum to one.

nonNegative

Boolean, 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.

Usage

Returns

Image.updateMask(mask)

Image

Argument

Type

Details

this: image

Image

Input image.

mask

Image

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.

ee.Image.where

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.

Usage

Returns

Image.where(test, value)

Image

Argument

Type

Details

this: input

Image

The input image.

test

Image

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.

value

Image

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.

Usage

Returns

Image.zeroCrossing()

Image

Argument

Type

Details

this: image

Image

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.

Usage

Returns

ee.ImageCollection(args)

ImageCollection

Argument

Type

Details

args

ComputedObject|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.

Usage

Returns

ImageCollection.aggregate_array(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_count(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_count_distinct(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_first(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_histogram(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_max(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_mean(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_min(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_product(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_sample_sd(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_sample_var(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_stats(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_sum(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_total_sd(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.aggregate_total_var(property)

Object

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

property

String

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.

Usage

Returns

ImageCollection.and()

Image

Argument

Type

Details

this: collection

ImageCollection

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.

Usage

Returns

ImageCollection.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

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.

Usage

Returns

ImageCollection.cast(bandTypes, bandOrder)

ImageCollection

Argument

Type

Details

this: collection

ImageCollection

The image collection to cast.

bandTypes

Dictionary

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.

bandOrder

List

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.

Usage

Returns

ImageCollection.combine(secondary, overwrite)

ImageCollection

Argument

Type

Details

this: primary

ImageCollection

The primary collection to join.

secondary

ImageCollection

The secondary collection to join.

overwrite

Boolean, 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.

Usage

Returns

ImageCollection.copyProperties(source, properties, exclude)

Element

Argument

Type

Details

this: destination

Element, default: null

The object whose properties to override.

source

Element, default: null

The object from which to copy the properties.

properties

List, default: null

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

exclude

List, 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.

Usage

Returns

ImageCollection.count()

Image

Argument

Type

Details

this: collection

ImageCollection

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.

Usage

Returns

ImageCollection.distance(searchRadius, maxError)

Image

Argument

Type

Details

this: features

FeatureCollection

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

searchRadius

Float, default: 100000

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

maxError

Float, 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.

Usage

Returns

ImageCollection.distinct(selectors)

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

The input collection from which objects will be selected.

selectors

SelectorSet

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.

Usage

Returns

ImageCollection.draw(color, pointRadius, strokeWidth)

Image

Argument

Type

Details

this: collection

FeatureCollection

The collection to draw.

color

String

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

pointRadius

Integer, default: 3

The radius in pixels of the point markers.

strokeWidth

Integer, 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.

Usage

Returns

ImageCollection.errorMatrix(actual, predicted, order)

ConfusionMatrix

Argument

Type

Details

this: collection

FeatureCollection

The input collection.

actual

String

The name of the property containing the actual value.

predicted

String

The name of the property containing the predicted value.

order

List, 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.

Usage

Returns

ImageCollection.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

ImageCollection.filter(newFilter)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

newFilter

Filter

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.

Usage

Returns

ImageCollection.filterBounds(geometry)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

geometry

Feature|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.

Usage

Returns

ImageCollection.filterDate(start, end)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

start

Date|Number|String

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

end

Date|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.

Usage

Returns

ImageCollection.filterMetadata(name, operator, value)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

name

String

The name of a property to filter.

operator

String

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".

value

Object

- The value to compare against.

ee.ImageCollection.first

Returns the first entry from a given collection.

Usage

Returns

ImageCollection.first()

Element

Argument

Type

Details

this: collection

FeatureCollection

The collection from which to select the first entry.

ee.ImageCollection.flatten

Flattens collections of collections.

Usage

Returns

ImageCollection.flatten()

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

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.

Usage

Returns

ImageCollection.formaTrend(covariates, windowSize)

Image

Argument

Type

Details

this: timeSeries

ImageCollection

Collection from which to extract trends.

covariates

ImageCollection, default: null

Cofactors to use in the trend analysis.

windowSize

Integer, default: 6

Short term trend analysis window size, in images.

ee.ImageCollection.fromImages

Returns the image collection containing the given images.

Usage

Returns

ee.ImageCollection.fromImages(images)

ImageCollection

Argument

Type

Details

images

List

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.

Usage

Returns

ImageCollection.geometry(maxError)

Geometry

Argument

Type

Details

this: collection

FeatureCollection

The collection whose geometries will be extracted.

maxError

ErrorMargin, optional

An error margin to use when merging geometries.

ee.ImageCollection.get

Extract a property from a feature.

Usage

Returns

ImageCollection.get(property)

Argument

Type

Details

this: object

Element

The feature to extract the property from.

property

String

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.

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.

Usage

Returns

ImageCollection.getMap(visParams, callback)

MapId|Object

Argument

Type

Details

this: imagecollection

ImageCollection

The ImageCollection instance.

visParams

Object, optional

The visualization parameters.

callback

Function, 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.

Usage

Returns

ImageCollection.getRegion(geometry, scale, crs, crsTransform)

List

Argument

Type

Details

this: collection

ImageCollection

The image collection to extract data from.

geometry

Geometry

The region over which to extract data.

scale

Float, default: null

A nominal scale in meters of the projection to work in.

crs

Projection, 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.

crsTransform

List, 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.

Usage

Returns

ImageCollection.iterate(algorithm, first)

ComputedObject

Argument

Type

Details

this: collection

Collection

The Collection instance.

algorithm

Function

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

first

Object, 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.

Usage

Returns

ImageCollection.limit(max, property, ascending)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

max

Number

The number to limit the collection to.

property

String, optional

The property to sort by, if sorting.

ascending

Boolean, optional

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

ee.ImageCollection.load

Returns the image collection given its ID.

Usage

Returns

ee.ImageCollection.load(id, version)

ImageCollection

Argument

Type

Details

id

String

The asset ID of the image collection.

version

Long, 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.

Usage

Returns

ImageCollection.map(algorithm, dropNulls)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

algorithm

Function

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.

dropNulls

Boolean, 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.

Usage

Returns

ImageCollection.max()

Image

Argument

Type

Details

this: collection

ImageCollection

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.

Usage

Returns

ImageCollection.mean()

Image

Argument

Type

Details

this: collection

ImageCollection

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.

Usage

Returns

ImageCollection.median()

Image

Argument

Type

Details

this: collection

ImageCollection

The image collection to reduce.

ee.ImageCollection.merge

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

Usage

Returns

ImageCollection.merge(collection2)

FeatureCollection

Argument

Type

Details

this: collection1

FeatureCollection

The first collection to merge.

collection2

FeatureCollection

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.

Usage

Returns

ImageCollection.min()

Image

Argument

Type

Details

this: collection

ImageCollection

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.

Usage

Returns

ImageCollection.mode()

Image

Argument

Type

Details

this: collection

ImageCollection

The image collection to reduce.

ee.ImageCollection.mosaic

Composites all the images in a collection, using the mask.

Usage

Returns

ImageCollection.mosaic()

Image

Argument

Type

Details

this: collection

ImageCollection

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.

Usage

Returns

ImageCollection.or()

Image

Argument

Type

Details

this: collection

ImageCollection

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.

Usage

Returns

ImageCollection.product()

Image

Argument

Type

Details

this: collection

ImageCollection

The image collection to reduce.

ee.ImageCollection.propertyNames

Returns the names of properties on this element.

Usage

Returns

ImageCollection.propertyNames()

List

Argument

Type

Details

this: element

Element

ee.ImageCollection.qualityMosaic

Composites all the images in a collection, using a quality band as a per-pixel ordering function.

Usage

Returns

ImageCollection.qualityMosaic(qualityBand)

Image

Argument

Type

Details

this: collection

ImageCollection

The collection to mosaic.

qualityBand

String

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).

Usage

Returns

ImageCollection.randomColumn(columnName, seed)

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

The input collection to which to add a random column.

columnName

String, default: "random"

The name of the column to add.

seed

Long, 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.).

Usage

Returns

ImageCollection.reduce(reducer, parallelScale)

Image

Argument

Type

Details

this: collection

ImageCollection

The image collection to reduce.

reducer

Reducer

The reducer to apply to the given collection.

parallelScale

Float, 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.

Usage

Returns

ImageCollection.reduceColumns(reducer, selectors, weightSelectors)

Dictionary

Argument

Type

Details

this: collection

FeatureCollection

The collection to aggregate over.

reducer

Reducer

The reducer to apply.

selectors

List

A selector for each input of the reducer.

weightSelectors

List, 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.

Usage

Returns

ImageCollection.reduceToImage(properties, reducer)

Image

Argument

Type

Details

this: collection

FeatureCollection

Feature collection to intersect with each output pixel.

properties

List

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

reducer

Reducer

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.

Usage

Returns

ImageCollection.remap(lookupIn, lookupOut, columnName)

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

The collection to be modified.

lookupIn

List

The input mapping values. Restricted to strings and integers.

lookupOut

List

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

columnName

String

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.

Usage

Returns

ImageCollection.select(selectors, names)

ImageCollection

Argument

Type

Details

this: imagecollection

ImageCollection

The ImageCollection instance.

selectors

List

A list of names, regexes or numeric indicies specifying the bands to select.

names

List, 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.

Usage

Returns

ImageCollection.serialize()

String

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

ee.ImageCollection.set

Overrides one or more metadata properties of an Element.

Returns the element with the specified properties overridden.

Usage

Returns

ImageCollection.set(var_args)

Element

Argument

Type

Details

this: element

Element

The Element instance.

var_args

VarArgs

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.

Usage

Returns

ImageCollection.setMulti(properties)

Element

Argument

Type

Details

this: object

Element

The object whose properties to override.

properties

Dictionary

The property values to override.

ee.ImageCollection.size

Returns the number of elements in the collection.

Usage

Returns

ImageCollection.size()

Integer

Argument

Type

Details

this: collection

FeatureCollection

The collection to count.

ee.ImageCollection.sort

Sort a collection by the specified property.

Returns the sorted collection.

Usage

Returns

ImageCollection.sort(property, ascending)

Collection

Argument

Type

Details

this: collection

Collection

The Collection instance.

property

String

The property to sort by.

ascending

Boolean, 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.

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

fillColor

String, default: null

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

styleProperty

String, default: null

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

neighborhood

Integer, 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.

Usage

Returns

ImageCollection.sum()

Image

Argument

Type

Details

this: collection

ImageCollection

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.

Usage

Returns

ImageCollection.toArray()

Image

Argument

Type

Details

this: collection

ImageCollection

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.

Usage

Returns

ImageCollection.toArrayPerBand(axis)

Image

Argument

Type

Details

this: collection

ImageCollection

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.

axis

Integer, 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.

Usage

Returns

ImageCollection.toDictionary(properties)

Dictionary

Argument

Type

Details

this: element

Element

The feature to extract the property from.

properties

List, 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.

Usage

Returns

ImageCollection.toList(count, offset)

List

Argument

Type

Details

this: collection

FeatureCollection

The input collection to fetch.

count

Integer

The maximum number of elements to fetch.

offset

Integer, 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.

Usage

Returns

ImageCollection.union(maxError)

FeatureCollection

Argument

Type

Details

this: collection

FeatureCollection

The collection being merged.

maxError

ErrorMargin, 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.

Usage

Returns

Join.apply(primary, secondary, condition)

FeatureCollection

Argument

Type

Details

this: join

Join

The join to apply; determines how the the results are constructed.

primary

FeatureCollection

The primary collection.

secondary

FeatureCollection

The secondary collection.

condition

Filter

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.

Usage

Returns

ee.Join.inner(primaryKey, secondaryKey, measureKey)

Join

Argument

Type

Details

primaryKey

String, default: "primary"

The property name used to save the primary match.

secondaryKey

String, default: "secondary"

The property name used to save the secondary match.

measureKey

String, 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.

Usage

Returns

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.

Usage

Returns

ee.Join.saveAll(matchesKey, ordering, ascending, measureKey)

Join

Argument

Type

Details

matchesKey

String

The property name used to save the matches list.

ordering

String, default: null

The property on which to sort the matches list.

ascending

Boolean, default: true

Whether the ordering is ascending.

measureKey

String, 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.

Usage

Returns

ee.Join.saveBest(matchKey, measureKey)

Join

Argument

Type

Details

matchKey

String

The key used to save the match.

measureKey

String

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.

Usage

Returns

ee.Join.saveFirst(matchKey, ordering, ascending, measureKey)

Join

Argument

Type

Details

matchKey

String

The property name used to save the match.

ordering

String, default: null

The property on which to sort the matches before selecting the first.

ascending

Boolean, default: true

Whether the ordering is ascending.

measureKey

String, 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.

Usage

Returns

ee.Join.simple()

Join

No arguments.

ee.Kernel.add

Adds two kernels (pointwise), after aligning their centers.

Usage

Returns

Kernel.add(kernel2, normalize)

Kernel

Argument

Type

Details

this: kernel1

Kernel

The first kernel.

kernel2

Kernel

The second kernel.

normalize

Boolean, default: false

Normalize the kernel.

ee.Kernel.chebyshev

Generates a distance kernel based on Chebyshev distance (greatest distance along any dimension).

Usage

Returns

ee.Kernel.chebyshev(radius, units, normalize, magnitude)

Kernel

Argument

Type

Details

radius

Float

The radius of the kernel to generate.

units

String, 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.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

magnitude

Float, default: 1

Scale each value by this amount.

ee.Kernel.circle

Generates a circle-shaped boolean kernel.

Usage

Returns

ee.Kernel.circle(radius, units, normalize, magnitude)

Kernel

Argument

Type

Details

radius

Float

The radius of the kernel to generate.

units

String, 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.

normalize

Boolean, default: true

Normalize the kernel values to sum to 1.

magnitude

Float, default: 1

Scale each value by this amount.

ee.Kernel.compass

Generates a 3x3 Prewitt's Compass edge-detection kernel.

Usage

Returns

ee.Kernel.compass(magnitude, normalize)

Kernel

Argument

Type

Details

magnitude

Float, default: 1

Scale each value by this amount.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.cross

Generates a cross-shaped boolean kernel.

Usage

Returns

ee.Kernel.cross(radius, units, normalize, magnitude)

Kernel

Argument

Type

Details

radius

Float

The radius of the kernel to generate.

units

String, 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.

normalize

Boolean, default: true

Normalize the kernel values to sum to 1.

magnitude

Float, default: 1

Scale each value by this amount.

ee.Kernel.diamond

Generates a diamond-shaped boolean kernel.

Usage

Returns

ee.Kernel.diamond(radius, units, normalize, magnitude)

Kernel

Argument

Type

Details

radius

Float

The radius of the kernel to generate.

units

String, 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.

normalize

Boolean, default: true

Normalize the kernel values to sum to 1.

magnitude

Float, default: 1

Scale each value by this amount.

ee.Kernel.euclidean

Generates a distance kernel based on Euclidean (straight-line) distance.

Usage

Returns

ee.Kernel.euclidean(radius, units, normalize, magnitude)

Kernel

Argument

Type

Details

radius

Float

The radius of the kernel to generate.

units

String, 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.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

magnitude

Float, default: 1

Scale each value by this amount.

ee.Kernel.fixed

Creates a Kernel.

Usage

Returns

ee.Kernel.fixed(width, height, weights, x, y, normalize)

Kernel

Argument

Type

Details

width

Integer

The width of the kernel in pixels.

height

Integer

The height of the kernel in pixels.

weights

List

The pixel values of the kernel.

x

Integer, default: -1

The location of the focus, as an offset from the left.

y

Integer, default: -1

The location of the focus, as an offset from the top.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.gaussian

Generates a Gaussian kernel from a sampled continuous Gaussian.

Usage

Returns

ee.Kernel.gaussian(radius, sigma, units, normalize, magnitude)

Kernel

Argument

Type

Details

radius

Float

The radius of the kernel to generate.

sigma

Float, default: 1

Standard deviation of the Gaussian function (same units as radius).

units

String, 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.

normalize

Boolean, default: true

Normalize the kernel values to sum to 1.

magnitude

Float, 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.

Usage

Returns

Kernel.inverse()

Kernel

Argument

Type

Details

this: kernel

Kernel

The kernel to have its entries inverted.

ee.Kernel.kirsch

Generates a 3x3 Kirsch's Compass edge-detection kernel.

Usage

Returns

ee.Kernel.kirsch(magnitude, normalize)

Kernel

Argument

Type

Details

magnitude

Float, default: 1

Scale each value by this amount.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.laplacian4

Generates a 3x3 Laplacian-4 edge-detection kernel.

Usage

Returns

ee.Kernel.laplacian4(magnitude, normalize)

Kernel

Argument

Type

Details

magnitude

Float, default: 1

Scale each value by this amount.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.laplacian8

Generates a 3x3 Laplacian-8 edge-detection kernel.

Usage

Returns

ee.Kernel.laplacian8(magnitude, normalize)

Kernel

Argument

Type

Details

magnitude

Float, default: 1

Scale each value by this amount.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.manhattan

Generates a distance kernel based on rectilinear (city-block) distance.

Usage

Returns

ee.Kernel.manhattan(radius, units, normalize, magnitude)

Kernel

Argument

Type

Details

radius

Float

The radius of the kernel to generate.

units

String, 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.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

magnitude

Float, default: 1

Scale each value by this amount.

ee.Kernel.octagon

Generates an octagon-shaped boolean kernel.

Usage

Returns

ee.Kernel.octagon(radius, units, normalize, magnitude)

Kernel

Argument

Type

Details

radius

Float

The radius of the kernel to generate.

units

String, 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.

normalize

Boolean, default: true

Normalize the kernel values to sum to 1.

magnitude

Float, default: 1

Scale each value by this amount.

ee.Kernel.plus

Generates a plus-shaped boolean kernel.

Usage

Returns

ee.Kernel.plus(radius, units, normalize, magnitude)

Kernel

Argument

Type

Details

radius

Float

The radius of the kernel to generate.

units

String, 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.

normalize

Boolean, default: true

Normalize the kernel values to sum to 1.

magnitude

Float, default: 1

Scale each value by this amount.

ee.Kernel.prewitt

Generates a 3x3 Prewitt edge-detection kernel.

Usage

Returns

ee.Kernel.prewitt(magnitude, normalize)

Kernel

Argument

Type

Details

magnitude

Float, default: 1

Scale each value by this amount.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.rectangle

Generates a rectangular-shaped kernel.

Usage

Returns

ee.Kernel.rectangle(xRadius, yRadius, units, normalize, magnitude)

Kernel

Argument

Type

Details

xRadius

Float

The horizontal radius of the kernel to generate.

yRadius

Float

The vertical radius of the kernel to generate.

units

String, 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.

normalize

Boolean, default: true

Normalize the kernel values to sum to 1.

magnitude

Float, default: 1

Scale each value by this amount.

ee.Kernel.roberts

Generates a 2x2 Roberts edge-detection kernel.

Usage

Returns

ee.Kernel.roberts(magnitude, normalize)

Kernel

Argument

Type

Details

magnitude

Float, default: 1

Scale each value by this amount.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.rotate

Creates a Kernel.

Usage

Returns

Kernel.rotate(rotations)

Kernel

Argument

Type

Details

this: kernel

Kernel

The kernel to be rotated.

rotations

Integer

Number of 90 deg. rotations to make (negative numbers rotate counterclockwise).

ee.Kernel.sobel

Generates a 3x3 Sobel edge-detection kernel.

Usage

Returns

ee.Kernel.sobel(magnitude, normalize)

Kernel

Argument

Type

Details

magnitude

Float, default: 1

Scale each value by this amount.

normalize

Boolean, default: false

Normalize the kernel values to sum to 1.

ee.Kernel.square

Generates a square-shaped boolean kernel.

Usage

Returns

ee.Kernel.square(radius, units, normalize, magnitude)

Kernel

Argument

Type

Details

radius

Float

The radius of the kernel to generate.

units

String, 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.

normalize

Boolean, default: true

Normalize the kernel values to sum to 1.

magnitude

Float, default: 1

Scale each value by this amount.

ee.List

Constructs a new list.

Usage

Returns

ee.List(list)

List

Argument

Type

Details

list

List

A list or a computed object.

ee.List.add

Appends the element to the end of list.

Usage

Returns

List.add(element)

List

Argument

Type

Details

this: list

List

element

Object

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.

Usage

Returns

List.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.List.cat

Concatenates the contents of other onto list.

Usage

Returns

List.cat(other)

List

Argument

Type

Details

this: list

List

other

List

ee.List.contains

Returns true if list contains element.

Usage

Returns

List.contains(element)

Boolean

Argument

Type

Details

this: list

List

element

Object

ee.List.containsAll

Returns true if list contains all of the elements of other, regardless of order.

Usage

Returns

List.containsAll(other)

Boolean

Argument

Type

Details

this: list

List

other

List

ee.List.equals

Returns true if list contains the same elements as other, in the same order.

Usage

Returns

List.equals(other)

Boolean

Argument

Type

Details

this: list

List

other

List

ee.List.evaluate

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

Usage

Returns

List.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

List.flatten()

List

Argument

Type

Details

this: list

List

ee.List.frequency

Returns the number of elements in list equal to element.

Usage

Returns

List.frequency(element)

Integer

Argument

Type

Details

this: list

List

element

Object

ee.List.get

Returns the element at the specified position in list. A negative index counts backwards from the end of the list.

Usage

Returns

List.get(index)

Object

Argument

Type

Details

this: list

List

index

Integer

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.

Usage

Returns

List.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, 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.

Usage

Returns

List.indexOf(element)

Integer

Argument

Type

Details

this: list

List

element

Object

ee.List.indexOfSublist

Returns the starting position of the first occurrence of target within list, or -1 if there is no such occurrence.

Usage

Returns

List.indexOfSublist(target)

Integer

Argument

Type

Details

this: list

List

target

List

ee.List.insert

Inserts element at the specified position in list. A negative index counts backwards from the end of the list.

Usage

Returns

List.insert(index, element)

List

Argument

Type

Details

this: list

List

index

Integer

element

Object

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.

Usage

Returns

List.iterate(function, first)

Object

Argument

Type

Details

this: list

List

function

Algorithm

first

Object

ee.List.lastIndexOfSubList

Returns the starting position of the last occurrence of target within list, or -1 if there is no such occurrence.

Usage

Returns

List.lastIndexOfSubList(target)

Integer

Argument

Type

Details

this: list

List

target

List

ee.List.length

Returns the number of elements in list.

Usage

Returns

List.length()

Integer

Argument

Type

Details

this: list

List

ee.List.map

Map an algorithm over a list. The algorithm is expected to take an Object and return an Object.

Usage

Returns

List.map(baseAlgorithm)

List

Argument

Type

Details

this: list

List

baseAlgorithm

Algorithm

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.

Usage

Returns

List.reduce(reducer)

Object

Argument

Type

Details

this: list

List

reducer

Reducer

ee.List.remove

Removes the first occurrence of the specified element from list, if it is present.

Usage

Returns

List.remove(element)

List

Argument

Type

Details

this: list

List

element

Object

ee.List.removeAll

Removes from list all of the elements that are contained in other list.

Usage

Returns

List.removeAll(other)

List

Argument

Type

Details

this: list

List

other

List

ee.List.repeat

Returns a new list containing value repeated count times.

Usage

Returns

ee.List.repeat(value, count)

List

Argument

Type

Details

value

Object

count

Integer

ee.List.replace

Replaces the first occurrence of oldVal in list with newVal.

Usage

Returns

List.replace(oldval, newval)

List

Argument

Type

Details

this: list

List

oldval

Object

newval

Object

ee.List.replaceAll

Replaces all occurrences of oldVal in list with newVal.

Usage

Returns

List.replaceAll(oldval, newval)

List

Argument

Type

Details

this: list

List

oldval

Object

newval

Object

ee.List.reverse

Reverses the order of the elements in list.

Usage

Returns

List.reverse()

List

Argument

Type

Details

this: list

List

ee.List.rotate

Rotates the elements of the list by the specified distance.

Usage

Returns

List.rotate(distance)

List

Argument

Type

Details

this: list

List

distance

Integer

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.

Usage

Returns

ee.List.sequence(start, end, step, count)

List

Argument

Type

Details

start

Number

end

Number, default: null

step

Number, default: 1

count

Integer, default: null

ee.List.serialize

Returns the serialized representation of this object.

Usage

Returns

List.serialize()

String

Argument

Type

Details

this: computedobject

ComputedObject

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.

Usage

Returns

List.set(index, element)

List

Argument

Type

Details

this: list

List

index

Integer

element

Object

ee.List.size

Returns the number of elements in list.

Usage

Returns

List.size()

Integer

Argument

Type

Details

this: list

List

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.

Usage

Returns

List.slice(start, end)

List

Argument

Type

Details

this: list

List

start

Integer

end

Integer, default: null

ee.List.sort

Sorts the list into ascending order.

Usage

Returns

List.sort()

List

Argument

Type

Details

this: list

List

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.

Usage

Returns

List.splice(start, count, other)

List

Argument

Type

Details

this: list

List

start

Integer

count

Integer

other

List, default: null

ee.List.swap

Swaps the elements at the specified positions. A negative position counts backwards from the end of the list.

Usage

Returns

List.swap(pos1, pos2)

List

Argument

Type

Details

this: list

List

pos1

Integer

pos2

Integer

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.

Usage

Returns

List.zip(other)

List

Argument

Type

Details

this: list

List

other

List

ee.Number

Constructs a new Number.

Usage

Returns

ee.Number(number)

Number

Argument

Type

Details

number

Number|Object

A number or a computed object.

ee.Number.abs

Computes the absolute value of the input.

Usage

Returns

Number.abs()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.acos

Computes the arc cosine in radians of the input.

Usage

Returns

Number.acos()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.add

Adds the first value to the second.

Usage

Returns

Number.add(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.and

Returns 1 iff both values are non-zero.

Usage

Returns

Number.and(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

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.

Usage

Returns

Number.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.Number.asin

Computes the arc sine in radians of the input.

Usage

Returns

Number.asin()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.atan

Computes the arc tangent in radians of the input.

Usage

Returns

Number.atan()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.atan2

Calculates the angle formed by the 2D vector [x, y].

Usage

Returns

Number.atan2(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

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.

Usage

Returns

Number.bitCount()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.bitwiseAnd

Calculates the bitwise AND of the input values.

Usage

Returns

Number.bitwiseAnd(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

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.

Usage

Returns

Number.bitwiseNot()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.bitwiseOr

Calculates the bitwise OR of the input values.

Usage

Returns

Number.bitwiseOr(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.bitwiseXor

Calculates the bitwise XOR of the input values.

Usage

Returns

Number.bitwiseXor(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.bitwise_and

Calculates the bitwise AND of the input values.

Usage

Returns

Number.bitwise_and(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

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.

Usage

Returns

Number.bitwise_not()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.bitwise_or

Calculates the bitwise OR of the input values.

Usage

Returns

Number.bitwise_or(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.bitwise_xor

Calculates the bitwise XOR of the input values.

Usage

Returns

Number.bitwise_xor(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.byte

Casts the input value to an unsigned 8-bit integer.

Usage

Returns

Number.byte()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.cbrt

Computes the cubic root of the input.

Usage

Returns

Number.cbrt()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.ceil

Computes the smallest integer greater than or equal to the input.

Usage

Returns

Number.ceil()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.cos

Computes the cosine of the input in radians.

Usage

Returns

Number.cos()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.cosh

Computes the hyperbolic cosine of the input.

Usage

Returns

Number.cosh()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.digamma

Computes the digamma function of the input.

Usage

Returns

Number.digamma()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.divide

Divides the first value by the second, returning 0 for division by 0.

Usage

Returns

Number.divide(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.double

Casts the input value to a 64-bit float.

Usage

Returns

Number.double()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.eq

Returns 1 iff the first value is equal to the second.

Usage

Returns

Number.eq(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.erf

Computes the error function of the input.

Usage

Returns

Number.erf()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.erfInv

Computes the inverse error function of the input.

Usage

Returns

Number.erfInv()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.erfc

Computes the complementary error function of the input.

Usage

Returns

Number.erfc()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.erfcInv

Computes the inverse complementary error function of the input.

Usage

Returns

Number.erfcInv()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.evaluate

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

Usage

Returns

Number.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.

Usage

Returns

Number.exp()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.first

Selects the value of the first value.

Usage

Returns

Number.first(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.firstNonZero

Selects the first value if it is non-zero, and the second value otherwise.

Usage

Returns

Number.firstNonZero(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.first_nonzero

Selects the first value if it is non-zero, and the second value otherwise.

Usage

Returns

Number.first_nonzero(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.float

Casts the input value to a 32-bit float.

Usage

Returns

Number.float()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.floor

Computes the largest integer less than or equal to the input.

Usage

Returns

Number.floor()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.format

Convert a number to a string using printf-style formatting.

Usage

Returns

Number.format(pattern)

String

Argument

Type

Details

this: number

Number

The number to convert to a string.

pattern

String, 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.

Usage

Returns

Number.gamma()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.gammainc

Calculates the regularized lower incomplete Gamma function (γ(x,a).

Usage

Returns

Number.gammainc(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

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.

Usage

Returns

Number.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, 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.

Usage

Returns

Number.gt(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.gte

Returns 1 iff the first value is greater than or equal to the second.

Usage

Returns

Number.gte(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.hypot

Calculates the magnitude of the 2D vector [x, y].

Usage

Returns

Number.hypot(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.int

Casts the input value to a signed 32-bit integer.

Usage

Returns

Number.int()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.int16

Casts the input value to a signed 16-bit integer.

Usage

Returns

Number.int16()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.int32

Casts the input value to a signed 32-bit integer.

Usage

Returns

Number.int32()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.int64

Casts the input value to a signed 64-bit integer.

Usage

Returns

Number.int64()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.int8

Casts the input value to a signed 8-bit integer.

Usage

Returns

Number.int8()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.lanczos

Computes the Lanczos approximation of the input.

Usage

Returns

Number.lanczos()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.leftShift

Calculates the left shift of v1 by v2 bits.

Usage

Returns

Number.leftShift(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.left_shift

Calculates the left shift of v1 by v2 bits.

Usage

Returns

Number.left_shift(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.log

Computes the natural logarithm of the input.

Usage

Returns

Number.log()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.log10

Computes the base-10 logarithm of the input.

Usage

Returns

Number.log10()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.long

Casts the input value to a signed 64-bit integer.

Usage

Returns

Number.long()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.lt

Returns 1 iff the first value is less than the second.

Usage

Returns

Number.lt(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.lte

Returns 1 iff the first value is less than or equal to the second.

Usage

Returns

Number.lte(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.max

Selects the maximum of the first and second values.

Usage

Returns

Number.max(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.min

Selects the minimum of the first and second values.

Usage

Returns

Number.min(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.mod

Calculates the remainder of the first value divided by the second.

Usage

Returns

Number.mod(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.multiply

Multiplies the first value by the second.

Usage

Returns

Number.multiply(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.neq

Returns 1 iff the first value is not equal to the second.

Usage

Returns

Number.neq(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.not

Returns 0 if the input is non-zero, and 1 otherwise.

Usage

Returns

Number.not()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.or

Returns 1 iff either input value is non-zero.

Usage

Returns

Number.or(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.parse

Convert a string to a number.

Usage

Returns

ee.Number.parse(input, radix)

Number

Argument

Type

Details

input

String

The string to convert to a number.

radix

Integer, 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.

Usage

Returns

Number.pow(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.rightShift

Calculates the signed right shift of v1 by v2 bits.

Usage

Returns

Number.rightShift(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.right_shift

Calculates the signed right shift of v1 by v2 bits.

Usage

Returns

Number.right_shift(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.round

Computes the integer nearest to the input.

Usage

Returns

Number.round()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.serialize

Returns the serialized representation of this object.

Usage

Returns

Number.serialize()

String

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

ee.Number.short

Casts the input value to a signed 16-bit integer.

Usage

Returns

Number.short()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.sin

Computes the sine of the input in radians.

Usage

Returns

Number.sin()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.sinh

Computes the hyperbolic sine of the input.

Usage

Returns

Number.sinh()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.sqrt

Computes the square root of the input.

Usage

Returns

Number.sqrt()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.subtract

Subtracts the second value from the first.

Usage

Returns

Number.subtract(right)

Number

Argument

Type

Details

this: left

Number

The left-hand value.

right

Number

The right-hand value.

ee.Number.tan

Computes the tangent of the input in radians.

Usage

Returns

Number.tan()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.tanh

Computes the hyperbolic tangent of the input.

Usage

Returns

Number.tanh()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toByte

Casts the input value to an unsigned 8-bit integer.

Usage

Returns

Number.toByte()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toDouble

Casts the input value to a 64-bit float.

Usage

Returns

Number.toDouble()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toFloat

Casts the input value to a 32-bit float.

Usage

Returns

Number.toFloat()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toInt

Casts the input value to a signed 32-bit integer.

Usage

Returns

Number.toInt()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toInt16

Casts the input value to a signed 16-bit integer.

Usage

Returns

Number.toInt16()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toInt32

Casts the input value to a signed 32-bit integer.

Usage

Returns

Number.toInt32()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toInt64

Casts the input value to a signed 64-bit integer.

Usage

Returns

Number.toInt64()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toInt8

Casts the input value to a signed 8-bit integer.

Usage

Returns

Number.toInt8()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toLong

Casts the input value to a signed 64-bit integer.

Usage

Returns

Number.toLong()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toShort

Casts the input value to a signed 16-bit integer.

Usage

Returns

Number.toShort()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toUint16

Casts the input value to an unsigned 16-bit integer.

Usage

Returns

Number.toUint16()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toUint32

Casts the input value to an unsigned 32-bit integer.

Usage

Returns

Number.toUint32()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.toUint8

Casts the input value to an unsigned 8-bit integer.

Usage

Returns

Number.toUint8()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.trigamma

Computes the trigamma function of the input.

Usage

Returns

Number.trigamma()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.uint16

Casts the input value to an unsigned 16-bit integer.

Usage

Returns

Number.uint16()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.uint32

Casts the input value to an unsigned 32-bit integer.

Usage

Returns

Number.uint32()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.Number.uint8

Casts the input value to an unsigned 8-bit integer.

Usage

Returns

Number.uint8()

Number

Argument

Type

Details

this: input

Number

The input value.

ee.PixelType

Returns a PixelType of the given precision with the given limits per element, and an optional dimensionality.

Usage

Returns

ee.PixelType(precision, minValue, maxValue, dimensions)

PixelType

Argument

Type

Details

precision

Object

The pixel precision, one of 'int', 'float', or 'double'.

minValue

Number, default: null

The minimum value of pixels of this type. If precision is 'float' or 'double', this can be null, signifying negative infinity.

maxValue

Number, default: null

The maximum value of pixels of this type. If precision is 'float' or 'double', this can be null, signifying positive infinity.

dimensions

Integer, 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.

Usage

Returns

ee.PixelType.double()

PixelType

No arguments.

ee.PixelType.float

Returns the 32-bit floating point pixel type.

Usage

Returns

ee.PixelType.float()

PixelType

No arguments.

ee.PixelType.int16

Returns the 16-bit signed integer pixel type.

Usage

Returns

ee.PixelType.int16()

PixelType

No arguments.

ee.PixelType.int32

Returns the 32-bit signed integer pixel type.

Usage

Returns

ee.PixelType.int32()

PixelType

No arguments.

ee.PixelType.int64

Returns the 64-bit signed integer pixel type.

Usage

Returns

ee.PixelType.int64()

PixelType

No arguments.

ee.PixelType.int8

Returns the 8-bit signed integer pixel type.

Usage

Returns

ee.PixelType.int8()

PixelType

No arguments.

ee.PixelType.uint16

Returns the 16-bit unsigned integer pixel type.

Usage

Returns

ee.PixelType.uint16()

PixelType

No arguments.

ee.PixelType.uint32

Returns the 32-bit unsigned integer pixel type.

Usage

Returns

ee.PixelType.uint32()

PixelType

No arguments.

ee.PixelType.uint8

Returns the 8-bit unsigned integer pixel type.

Usage

Returns

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.

Usage

Returns

ee.Projection(crs, transform, transformWkt)

Projection

Argument

Type

Details

crs

Object

The base coordinate reference system of this Projection, given as a well-known authority code (e.g. 'EPSG:4326') or a WKT string.

transform

List, 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'.

transformWkt

String, 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.

Usage

Returns

Projection.atScale(meters)

Projection

Argument

Type

Details

this: projection

Projection

meters

Float

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.

Usage

Returns

Projection.crs()

String

Argument

Type

Details

this: projection

Projection

ee.Projection.nominalScale

Returns the linear scale in meters of the units of this projection, as measured at the point of true scale.

Usage

Returns

Projection.nominalScale()

Float

Argument

Type

Details

this: proj

Projection

ee.Projection.scale

Returns the projection scaled by the given amount in each axis.

Usage

Returns

Projection.scale(x, y)

Projection

Argument

Type

Details

this: projection

Projection

x

Float

y

Float

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.

Usage

Returns

Projection.transform()

String

Argument

Type

Details

this: projection

Projection

ee.Projection.translate

Returns the projection translated by the given amount in each axis.

Usage

Returns

Projection.translate(x, y)

Projection

Argument

Type

Details

this: projection

Projection

x

Float

y

Float

ee.Projection.wkt

Returns a WKT representation of the base coordinate system of this Projection.

Usage

Returns

Projection.wkt()

String

Argument

Type

Details

this: projection

Projection

ee.Reducer.allNonZero

Returns a Reducer that returns 1 if all of its inputs are non-zero, 0 otherwise.

Usage

Returns

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.

Usage

Returns

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.

Usage

Returns

ee.Reducer.autoHistogram(maxBuckets, minBucketWidth, maxRaw)

Reducer

Argument

Type

Details

maxBuckets

Integer, default: null

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidth

Float, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRaw

Integer, 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.

Usage

Returns

ee.Reducer.bitwiseAnd()

Reducer

No arguments.

ee.Reducer.bitwiseOr

Returns a Reducer that computes the bitwise-or summation of its inputs.

Usage

Returns

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.

Usage

Returns

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.

Usage

Returns

Reducer.combine(reducer2, outputPrefix, sharedInputs)

Reducer

Argument

Type

Details

this: reducer1

Reducer

reducer2

Reducer

outputPrefix

String, default: ""

Prefix for reducer2's output names.

sharedInputs

Boolean, default: false

ee.Reducer.count

Returns a Reducer that computes the number of non-null inputs.

Usage

Returns

ee.Reducer.count()

Reducer

No arguments.

ee.Reducer.countDistinct

Returns a Reducer that computes the number of distinct inputs.

Usage

Returns

ee.Reducer.countDistinct()

Reducer

No arguments.

ee.Reducer.countEvery

Returns a Reducer that computes the number of inputs.

Usage

Returns

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.

Usage

Returns

ee.Reducer.covariance()

Reducer

No arguments.

ee.Reducer.first

Returns a Reducer that returns the first of its inputs.

Usage

Returns

ee.Reducer.first()

Reducer

No arguments.

ee.Reducer.firstNonNull

Returns a Reducer that returns the first of its non-null inputs.

Usage

Returns

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.

Usage

Returns

ee.Reducer.fixedHistogram(min, max, steps)

Reducer

Argument

Type

Details

min

Float

The lower (inclusive) bound of the first bucket.

max

Float

The upper (exclusive) bound of the last bucket.

steps

Integer

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.

Usage

Returns

Reducer.forEach(outputNames)

Reducer

Argument

Type

Details

this: reducer

Reducer

outputNames

List

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.

Usage

Returns

Reducer.forEachBand(image)

Reducer

Argument

Type

Details

this: reducer

Reducer

image

Image

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.

Usage

Returns

Reducer.forEachElement()

Reducer

Argument

Type

Details

this: reducer

Reducer

The reducer to apply to each array element.

ee.Reducer.frequencyHistogram

Returns a Reducer that returns a (weighted) frequency table of its inputs.

Usage

Returns

ee.Reducer.frequencyHistogram()

Reducer

No arguments.

ee.Reducer.getOutputs

Returns a list of the output names of the given reducer.

Usage

Returns

Reducer.getOutputs()

List

Argument

Type

Details

this: reducer

Reducer

ee.Reducer.group

Groups reducer records by the value of a given input, and reduces each group with the given reducer.

Usage

Returns

Reducer.group(groupField, groupName)

Reducer

Argument

Type

Details

this: reducer

Reducer

The reducer to apply to each group, without the group field.

groupField

Integer, default: 0

The field that contains record groups.

groupName

String, 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.

Usage

Returns

ee.Reducer.histogram(maxBuckets, minBucketWidth, maxRaw)

Reducer

Argument

Type

Details

maxBuckets

Integer, default: null

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidth

Float, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRaw

Integer, 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.

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidth

Float, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRaw

Integer, 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.

Usage

Returns

ee.Reducer.kendallsCorrelation(numInputs)

Reducer

Argument

Type

Details

numInputs

Integer, 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.

Usage

Returns

ee.Reducer.last()

Reducer

No arguments.

ee.Reducer.lastNonNull

Returns a Reducer that returns the last of its non-null inputs.

Usage

Returns

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.

ee.Reducer.linearRegression

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.

Usage

Returns

ee.Reducer.linearRegression(numX, numY)

Reducer

Argument

Type

Details

numX

Integer

The number of input dimensions.

numY

Integer, 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.

Usage

Returns

ee.Reducer.max(numInputs)

Reducer

Argument

Type

Details

numInputs

Integer, default: 1

The number of inputs.

ee.Reducer.mean

Returns a Reducer that computes the (weighted) arithmetic mean of its inputs.

Usage

Returns

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.

Usage

Returns

ee.Reducer.median(maxBuckets, minBucketWidth, maxRaw)

Reducer

Argument

Type

Details

maxBuckets

Integer, default: null

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidth

Float, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRaw

Integer, 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.

Usage

Returns

ee.Reducer.min(numInputs)

Reducer

Argument

Type

Details

numInputs

Integer, default: 1

The number of inputs.

ee.Reducer.minMax

Returns a Reducer that computes the minimum and maximum of its inputs.

Usage

Returns

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.

Usage

Returns

ee.Reducer.mode(maxBuckets, minBucketWidth, maxRaw)

Reducer

Argument

Type

Details

maxBuckets

Integer, default: null

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidth

Float, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRaw

Integer, default: null

The number of values to accumulate before building the initial histogram.

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.

The maximum number of buckets to use when building a histogram; will be rounded up to a power of 2.

minBucketWidth

Float, default: null

The minimum histogram bucket width, or null to allow any power of 2.

maxRaw

Integer, 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.

Usage

Returns

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.

Usage

Returns

Reducer.repeat(count)

Reducer

Argument

Type

Details

this: reducer

Reducer

count

Integer

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.

Usage

Returns

ee.Reducer.robustLinearRegression(numX, numY, beta)

Reducer

Argument

Type

Details

numX

Integer

The number of input dimensions.

numY

Integer, default: 1

The number of output dimensions.

beta

Float, 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.

Usage

Returns

ee.Reducer.sampleStdDev()

Reducer

No arguments.

ee.Reducer.sampleVariance

Returns a Reducer that computes the sample variance of its inputs.

Usage

Returns

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.

Usage

Returns

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.

Usage

Returns

Reducer.setOutputs(outputs)

Reducer

Argument

Type

Details

this: reducer

Reducer

outputs

List

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.

Usage

Returns

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.

Usage

Returns

Reducer.splitWeights()

Reducer

Argument

Type

Details

this: reducer

Reducer

ee.Reducer.stdDev

Returns a Reducer that computes the standard deviation of its inputs.

Usage

Returns

ee.Reducer.stdDev()

Reducer

No arguments.

ee.Reducer.sum

Returns a Reducer that computes the (weighted) sum of its inputs.

Usage

Returns

ee.Reducer.sum()

Reducer

No arguments.

ee.Reducer.toCollection

Returns a reducer that collects its inputs into a FeatureCollection.

Usage

Returns

ee.Reducer.toCollection(propertyNames, numOptional)

Reducer

Argument

Type

Details

propertyNames

List

The property names that will be defined on each output feature; determines the number of reducer inputs.

numOptional

Integer, 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.

Usage

Returns

ee.Reducer.toList(tupleSize, numOptional)

Reducer

Argument

Type

Details

tupleSize

Integer, default: null

The size of each output tuple, or null for no grouping. Also determines the number of inputs (null tupleSize has 1 input).

numOptional

Integer, 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.

Usage

Returns

Reducer.unweighted()

Reducer

Argument

Type

Details

this: reducer

Reducer

ee.Reducer.variance

Returns a Reducer that computes the variance of its inputs.

Usage

Returns

ee.Reducer.variance()

Reducer

No arguments.

ee.SelectorSet

Returns a SelectorSet for a list of selector paths.

Usage

Returns

ee.SelectorSet(paths)

SelectorSet

Argument

Type

Details

paths

Object

ee.String

Constructs a new String.

Usage

Returns

ee.String(string)

String

Argument

Type

Details

string

Object|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.

Usage

Returns

String.aside(func, var_args)

ComputedObject

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

func

Function

The function to call.

var_args

VarArgs

Any extra arguments to pass to the function.

ee.String.cat

Concatenates two strings.

Usage

Returns

String.cat(string2)

String

Argument

Type

Details

this: string1

String

The first string.

string2

String

The second string.

ee.String.compareTo

Compares two strings lexicographically. Returns: the value 0 if the two strings are lexicographically equal; a value less than 0 if string1 is less than string2; and a value greater than 0 if string1 is lexicographically greater than string2.

Usage

Returns

String.compareTo(string2)

Integer

Argument

Type

Details

this: string1

String

The string to compare.

string2

String

The string to be compared.

ee.String.decodeJSON

Decodes a JSON string.

Usage

Returns

String.decodeJSON()

Object

Argument

Type

Details

this: string

String

The string to decode.

ee.String.evaluate

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

Usage

Returns

String.evaluate(callback)

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function

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.String.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.

Usage

Returns

String.getInfo(callback)

Object

Argument

Type

Details

this: computedobject

ComputedObject

The ComputedObject instance.

callback

Function, optional

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