## 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, ` | 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. |

`sigma` | Float, default: 1 | Sigma value for a gaussian filter applied before edge detection. 0 means apply no filtering. |

## ee.Algorithms.Collection

Returns a Collection containing the specified features.

Usage | Returns |
---|---|

`ee.Algorithms.Collection(features)` | FeatureCollection |

Argument | Type | Details |
---|---|---|

`features` | List | The features comprising the collection. |

## ee.Algorithms.CrossCorrelation

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

Usage | Returns |
---|---|

`ee.Algorithms.CrossCorrelation(imageA, imageB, maxGap, windowSize, ` | Image |

Argument | Type | Details |
---|---|---|

`imageA` | Image | First image, with N bands. |

`imageB` | Image | Second image, must have the same number of bands as imageA. |

`maxGap` | Integer | The greatest distance a pixel may shift in either X or Y. |

`windowSize` | Integer | Size of the window to be compared. |

`maxMaskedFrac` | Float, default: 0 | The maximum fraction of pixels within the correlation window that are allowed to be masked. This test is applied at each offset location within the search region. For each offset, the overlapping image patches are compared and a correlation score computed. A pixel within these overlapping patches is considered masked if either of the patches is masked there. If the test fails at any single location in the search region, the output 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, ` | 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(` | 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, ` | 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.

Usage | Returns |
---|---|

`ee.Algorithms.FMask.matchClouds(input, cloud, shadow, btemp, sceneLow, sceneHigh, ` | Image |

Argument | Type | Details |
---|---|---|

`input` | Image | The scene for which to compute cloud and shadow masks. |

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

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

`btemp` | Image | Brightness temperature image, in Celsius. |

`sceneLow` | Float | The 0.175 percentile brightness temperature of the scene. |

`sceneHigh` | Float | The 0.825 percentile brightness temperature of the scene. |

`neighborhood` | Integer, default: 50 | The neighborhood to pad around each tile. |

## ee.Algorithms.Feature

Returns a Feature composed of the given geometry and metadata.

Usage | Returns |
---|---|

`ee.Algorithms.Feature(` | Feature |

Argument | Type | Details |
---|---|---|

`geometry` | Geometry, default: null | The geometry of the feature. |

`metadata` | Dictionary, default: {} | The properties of the feature. |

`geometryKey` | String, default: null | Obsolete; has no effect. |

## ee.Algorithms.GeometryConstructors.BBox

Constructs a rectangle whose edges are lines of latitude and longitude.

The result is a planar WGS84 rectangle.

If (east - west) ≥ 360 then the longitude range will be normalized to -180 to +180; otherwise they will be treated as designating points on a circle (e.g. east may be numerically less than west).

Usage | Returns |
---|---|

`ee.Algorithms.GeometryConstructors.BBox(west, south, east, north)` | Geometry |

Argument | Type | Details |
---|---|---|

`west` | Float | The westernmost enclosed longitude. Will be adjusted to lie in the range -180 to 180. |

`south` | Float | The southernmost enclosed latitude. If less than -90 (south pole), will be treated as -90. |

`east` | Float | The easternmost enclosed longitude. |

`north` | Float | The northernmost enclosed longitude. If greater than +90 (north pole), will be treated as +90. |

## ee.Algorithms.GeometryConstructors.LineString

Constructs a LineString from the given coordinates.

Usage | Returns |
---|---|

`ee.Algorithms.GeometryConstructors.LineString(coordinates, ` | 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. |

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

Usage | Returns |
---|---|

`ee.Algorithms.GeometryConstructors.LinearRing(coordinates, ` | 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. |

`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.MultiGeometry

Constructs a MultiGeometry from the given list of geometry elements.

Usage | Returns |
---|---|

`ee.Algorithms.GeometryConstructors.MultiGeometry(geometries, ` | Geometry |

Argument | Type | Details |
---|---|---|

`geometries` | List | The list of geometries for the MultiGeometry. |

`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.MultiLineString

Constructs a MultiLineString from the given coordinates.

Usage | Returns |
---|---|

`ee.Algorithms.GeometryConstructors.MultiLineString(coordinates, ` | Geometry |

Argument | Type | Details |
---|---|---|

`coordinates` | List | 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 | |

`geodesic` | Boolean, default: null | |

`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, ` | Geometry |

Argument | Type | Details |
---|---|---|

`coordinates` | List | The list of Points or pairs of Numbers in x,y order. |

`crs` | Projection, default: null |

## ee.Algorithms.GeometryConstructors.MultiPolygon

Constructs a MultiPolygon from the given coordinates.

Usage | Returns |
---|---|

`ee.Algorithms.GeometryConstructors.MultiPolygon(coordinates, ` | Geometry |

Argument | Type | Details |
---|---|---|

`coordinates` | List | 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 | |

`geodesic` | Boolean, default: null | |

`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, ` | Geometry |

Argument | Type | Details |
---|---|---|

`coordinates` | List | The coordinates of this Point in x,y order. |

`crs` | Projection, default: null |

## ee.Algorithms.GeometryConstructors.Polygon

Constructs a Polygon from the given coordinates.

Usage | Returns |
---|---|

`ee.Algorithms.GeometryConstructors.Polygon(coordinates, ` | Geometry |

Argument | Type | Details |
---|---|---|

`coordinates` | List | 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 | |

`geodesic` | Boolean, default: null | |

`maxError` | ErrorMargin, default: null | |

`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

Constructs a rectangular polygon from the given corner points.

Usage | Returns |
---|---|

`ee.Algorithms.GeometryConstructors.Rectangle(coordinates, ` | Geometry |

Argument | Type | Details |
---|---|---|

`coordinates` | List | 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 | |

`geodesic` | Boolean, default: null | |

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

Usage | Returns |
---|---|

`ee.Algorithms.HillShadow(image, azimuth, zenith, ` | Image |

Argument | Type | Details |
---|---|---|

`image` | Image | 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.

Usage | Returns |
---|---|

`ee.Algorithms.HoughTransform(image, ` | Image |

Argument | Type | Details |
---|---|---|

`image` | Image | The image to which to apply the transform. |

`gridSize` | Integer, default: 256 | Grid size. |

`inputThreshold` | Float, default: 64 | 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(` | 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.Image.Segmentation.GMeans

Performs G-Means clustering on the input image. Iteratively applies k-means followed by a normality test to automatically determine the number of clusters to use. The output contains a 'clusters' band containing the integer ID of the cluster that each pixel belongs to. The algorithm can work either on a fixed grid of non-overlapping cells (gridSize, which can be smaller than a tile) or on tiles with overlap (neighborhoodSize). The default is to use tiles with no overlap. Clusters in one cell or tile are unrelated to clusters in another. Any cluster that spans a cell or tile boundary may receive two different labels in the two halves. Any input pixels with partial masks are fully masked in the output. This algorithm is only expected to perform well for images with a narrow dynamic range (i.e. bytes or shorts).

See: G. Hamerly and C. Elkan. 'Learning the k in k-means'. NIPS, 2003.

Usage | Returns |
---|---|

`ee.Algorithms.Image.Segmentation.GMeans(image, ` | Image |

Argument | Type | Details |
---|---|---|

`image` | Image | The input image for clustering. |

`numIterations` | Integer, default: 10 | Number of iterations. Default 10. |

`pValue` | Float, default: 50 | Significance level for normality test. |

`neighborhoodSize` | Integer, default: 0 | Neighborhood size. The amount to extend each tile (overlap) when computing the clusters. This option is mutually exclusive with gridSize. |

`gridSize` | Integer, default: null | Grid cell-size. If greater than 0, kMeans will be run independently on cells of this size. This has the effect of limiting the size of any cluster to be gridSize or smaller. This option is mutually exclusive with neighborhoodSize. |

`uniqueLabels` | Boolean, default: true | If true, clusters are assigned unique IDs. Otherwise, they repeat per tile or grid cell. |

## ee.Algorithms.Image.Segmentation.KMeans

Performs K-Means clustering on the input image. Outputs a 1-band image containing the ID of the cluster that each pixel belongs to. The algorithm can work either on a fixed grid of non-overlapping cells (gridSize, which can be smaller than a tile) or on tiles with overlap (neighborhoodSize). The default is to use tiles with no overlap. Clusters in one cell or tile are unrelated to clusters in another. Any cluster that spans a cell or tile boundary may receive two different labels in the two halves. Any input pixels with partial masks are fully masked in the output.

Usage | Returns |
---|---|

`ee.Algorithms.Image.Segmentation.KMeans(image, ` | Image |

Argument | Type | Details |
---|---|---|

`image` | Image | The input image for clustering. |

`numClusters` | Integer, default: 8 | Number of clusters. |

`numIterations` | Integer, default: 20 | Number of iterations. |

`neighborhoodSize` | Integer, default: 0 | Neighborhood size. The amount to extend each tile (overlap) when computing the clusters. This option is mutually exclusive with gridSize. |

`gridSize` | Integer, default: null | Grid cell-size. If greater than 0, kMeans will be run independently on cells of this size. This has the effect of limiting the size of any cluster to be gridSize or smaller. This option is mutually exclusive with neighborhoodSize. |

`forceConvergence` | Boolean, default: false | If true, an error is thrown if convergence is not achieved before numIterations. |

`uniqueLabels` | Boolean, default: true | If true, clusters are assigned unique IDs. Otherwise, they repeat per tile or grid cell. |

## ee.Algorithms.Image.Segmentation.SNIC

Superpixel clustering based on SNIC (Simple Non-Iterative Clustering). Outputs a band of cluster IDs and the per-cluster averages for each of the input bands. If the 'seeds' image isn't provided as input, the output will include a 'seeds' band containing the generated seed locations. See: Achanta, Radhakrishna and Susstrunk, Sabine, 'Superpixels and Polygons using Simple Non-Iterative Clustering', CVPR, 2017.

Usage | Returns |
---|---|

`ee.Algorithms.Image.Segmentation.SNIC(image, ` | Image |

Argument | Type | Details |
---|---|---|

`image` | Image | The input image for clustering. |

`size` | Integer, default: 5 | The superpixel seed location spacing, in pixels. If 'seeds' image is provided, no grid is produced. |

`compactness` | Float, default: 1 | Compactness factor. Larger values cause clusters to be more compact (square). Setting this to 0 disables spatial distance weighting. |

`connectivity` | Integer, default: 8 | Connectivity. Either 4 or 8. |

`neighborhoodSize` | Integer, default: null | Tile neighborhood size (to avoid tile boundary artifacts). Defaults to 2 * size. |

`seeds` | Image, default: null | If provided, any non-zero valued pixels are used as seed locations. Pixels that touch (as specified by 'connectivity') are considered to belong to the same cluster. |

## ee.Algorithms.Image.Segmentation.seedGrid

Selects seed pixels for clustering.

Usage | Returns |
---|---|

`ee.Algorithms.Image.Segmentation.seedGrid(` | Image |

Argument | Type | Details |
---|---|---|

`size` | Integer, default: 5 | The superpixel seed location spacing, in pixels. |

`gridType` | String, default: "square" | Type of grid. One of 'square' or 'hex'. |

## ee.Algorithms.IsEqual

Returns whether two objects are equal.

Usage | Returns |
---|---|

`ee.Algorithms.IsEqual(` | 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:

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

Usage | Returns |
---|---|

`ee.Algorithms.Landsat.TOA(input)` | Image |

Argument | Type | Details |
---|---|---|

`input` | Image | The Landsat image to process. |

## ee.Algorithms.Landsat.calibratedRadiance

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

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.

Usage | Returns |
---|---|

`ee.Algorithms.Landsat.pathRowLimit(collection, ` | ImageCollection |

Argument | Type | Details |
---|---|---|

`collection` | ImageCollection | The Landsat ImageCollection to limit. |

`maxScenesPerPathRow` | Integer, default: 25 | The max number of scenes to return per path/row. |

`maxScenesTotal` | Integer, default: 100 | The max number of scenes to return per request total. |

## ee.Algorithms.Landsat.simpleCloudScore

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

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.

Usage | Returns |
---|---|

`ee.Algorithms.Landsat.simpleComposite(collection, ` | Image |

Argument | Type | Details |
---|---|---|

`collection` | ImageCollection | The raw Landsat ImageCollection to composite. |

`percentile` | Integer, default: 50 | The percentile value to use when compositing each band. |

`cloudScoreRange` | Integer, default: 10 | The size of the range of cloud scores to accept per pixel. |

`maxDepth` | Integer, default: 40 | 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.ObjectType

Returns a string representing the type of the given object.

Usage | Returns |
---|---|

`ee.Algorithms.ObjectType(` | String |

Argument | Type | Details |
---|---|---|

`value` | Object, default: null | The object to get the type of. |

## ee.Algorithms.ProjectionTransform

Transforms the geometry of a feature to a specific projection.

Usage | Returns |
---|---|

`ee.Algorithms.ProjectionTransform(feature, ` | 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.Sentinel2.CDI

Computes the Cloud Displacement Index (CDI) from a Sentinel-2 Level 1C image. CDI is a measure of the optical separation in elevated objects due to sensor parallax. Returns a floating point band named "cdi".

See Frantz, D., Hass, E., Uhl, A., Stoffels, J., & Hill, J. (2018). Improvement of the Fmask algorithm for Sentinel-2 images: Separating clouds from bright surfaces based on parallax effects. Remote sensing of environment, 215, 471-481.

Usage | Returns |
---|---|

`ee.Algorithms.Sentinel2.CDI(source)` | Image |

Argument | Type | Details |
---|---|---|

`source` | Image | The source image. |

## 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.TemporalSegmentation.Ccdc

Implements the Continuous Change Detection and Classification temporal breakpoint algorithm. This algorithm finds temporal breakpoints in an image collection by iteratively fitting harmonic functions to the data. Fit coefficients are produced for all input bands, but the bands used for breakpoint detection can be specified with the 'breakpointBands' argument.

For more details, see Zhu, Z. and Woodcock, C.E., 2014. Continuous change detection and classification of land cover using all available Landsat data. Remote sensing of Environment, 144, pp.152-171.

Usage | Returns |
---|---|

`ee.Algorithms.TemporalSegmentation.Ccdc(collection, ` | Image |

Argument | Type | Details |
---|---|---|

`collection` | ImageCollection | Collection of images on which to run CCDC. |

`breakpointBands` | List, default: null | The name or index of the bands to use for change detection. If unspecified, all bands are used. |

`tmaskBands` | List, default: null | The name or index of the bands to use for iterative TMask cloud detection. These are typically the green band and the SWIR2 band. If unspecified, TMask is not used. If specified, 'tmaskBands' must be included in 'breakpointBands'. |

`minObservations` | Integer, default: 6 | The number of observations required to flag a change. |

`chiSquareProbability` | Float, default: 0.99 | The chi-square probability threshold for change detection in the range of [0, 1] |

`minNumOfYearsScaler` | Float, default: 1.33 | Factors of minimum number of years to apply new fitting. |

`dateFormat` | Integer, default: 0 | The time representation to use during fitting: 0 = jDays, 1 = fractional years, 2 = unix time in milliseconds. The start, end and break times for each temporal segment will be encoded this way. |

`lambda` | Float, default: 20 | Lambda for LASSO regression fitting. If set to 0, regular OLS is used instead of LASSO. |

`maxIterations` | Integer, default: 25000 | Maximum number of runs for LASSO regression convergence. If set to 0, regular OLS is used instead of LASSO. |

## ee.Algorithms.TemporalSegmentation.Ewmacd

Exponentially Weighted Moving Average Change Detection. This algorithm computes a harmonic model for the 'training' portion of the input data and subtracts that from the original results. The residuals are then subjected to Shewhart X-bar charts and an exponentially weighted moving average. Disturbed pixels are indicated when the charts signal a deviation from the given control limits.

The output is a 5 band image containing the bands:

ewma: a 1D array of the EWMA score for each input image. Negative values represent disturbance and positive values represent recovery.

harmonicCoefficients: A 1-D array of the computed harmonic coefficient pairs. The coefficients are ordered as [constant, sin0, cos0, sin1, cos1...]

rmse: the RMSE from the harmonic regression.

rSquared: r-squared value from the harmonic regression.

residuals: 1D array of residuals from the harmonic regression.

See: Brooks, E.B., Wynne, R.H., Thomas, V.A., Blinn, C.E. and Coulston, J.W., 2014. On-the-fly massively multitemporal change detection using statistical quality control charts and Landsat data. IEEE Transactions on Geoscience and Remote Sensing, 52(6), pp.3316-3332.

Usage | Returns |
---|---|

`ee.Algorithms.TemporalSegmentation.Ewmacd(timeSeries, vegetationThreshold, trainingStartYear, trainingEndYear, ` | Image |

Argument | Type | Details |
---|---|---|

`timeSeries` | ImageCollection | Collection from which to extract EWMA. This collection is expected to contain 1 image for each year and be sorted temporally. |

`vegetationThreshold` | Float | Threshold for vegetation. Values below this are considered non-vegetation. |

`trainingStartYear` | Integer | Start year of training period, inclusive. |

`trainingEndYear` | Integer | End year of training period, exclusive. |

`harmonicCount` | Integer, default: 2 | Number of harmonic function pairs (sine and cosine) used. |

`xBarLimit1` | Float, default: 1.5 | Threshold for initial training xBar limit. |

`xBarLimit2` | Integer, default: 20 | Threshold for running xBar limit. |

`lambda` | Float, default: 0.3 | The 'lambda' tuning parameter weighting new years vs the running average. |

`lambdasigs` | Float, default: 3 | EWMA control bounds, in units of standard deviations. |

`rounding` | Boolean, default: true | Should rounding be performed for EWMA |

`persistence` | Integer, default: 3 | Minimum number of observations needed to consider a change. |

## ee.Algorithms.TemporalSegmentation.LandTrendr

Landsat-based detection of Trends in Disturbance and Recovery: temporally segments a time-series of images by extracting the spectral trajectories of change over time. The first band of each image is used to find breakpoints, and those breakpoints are used to perform fitting on all subsequent bands. The breakpoints are returned as a 2-D matrix of 4 rows and as many columns as images. The first two rows are the original X and Y values. The third row contains the Y values fitted to the estimated segments, and the 4th row contains a 1 if the corresponding point was used as a segment vertex or 0 if not. Any additional fitted bands are appended as rows in the output. Breakpoint fitting assumes that increasing values represent disturbance and decreasing values represent recovery.

See: Kennedy, R.E., Yang, Z. and Cohen, W.B., 2010. Detecting trends in forest disturbance and recovery using yearly Landsat time series: 1. LandTrendr - Temporal segmentation algorithms. Remote Sensing of Environment, 114(12), pp.2897-2910.

Usage | Returns |
---|---|

`ee.Algorithms.TemporalSegmentation.LandTrendr(timeSeries, maxSegments, ` | Image |

Argument | Type | Details |
---|---|---|

`timeSeries` | ImageCollection | Yearly time-series from which to extract breakpoints. The first band is usedto find breakpoints, and all subsequent bands are fitted using those breakpoints. |

`maxSegments` | Integer | Maximum number of segments to be fitted on the time series. |

`spikeThreshold` | Float, default: 0.9 | Threshold for dampening the spikes (1.0 means no dampening). |

`vertexCountOvershoot` | Integer, default: 3 | The initial model can overshoot the maxSegments + 1 vertices by this amount. Later, it will be pruned down to maxSegments + 1. |

`preventOneYearRecovery` | Boolean, default: false | Prevent segments that represent one year recoveries. |

`recoveryThreshold` | Float, default: 0.25 | If a segment has a recovery rate faster than 1/recoveryThreshold (in years), then the segment is disallowed. |

`pvalThreshold` | Float, default: 0.1 | If the p-value of the fitted model exceeds this threshold, then the current model is discarded and another one is fitted using the Levenberg-Marquardt optimizer. |

`bestModelProportion` | Float, default: 1.25 | Takes the model with most vertices that has a p-value that is at most this proportion away from the model with lowest p-value. |

`minObservationsNeeded` | Integer, default: 6 | Min observations needed to perform output fitting. |

## ee.Algorithms.TemporalSegmentation.LandTrendrFit

Interpolates a time series using a set of LandTrendr breakpoint years. For each input band in the timeSeries, outputs a new 1D array-valued band containing the input values interpolated between the breakpoint times identified by the vertices image. See the LandTrendr Algorithm for more details.

Usage | Returns |
---|---|

`ee.Algorithms.TemporalSegmentation.LandTrendrFit(timeSeries, vertices, ` | Image |

Argument | Type | Details |
---|---|---|

`timeSeries` | ImageCollection | Time series to interpolate. |

`vertices` | Image | Vertices image. A 1D array of LandTrendr breakpoint years. |

`spikeThreshold` | Float, default: 0.9 | Threshold for dampening input spikes (1.0 means no dampening). |

`minObservationsNeeded` | Integer, default: 6 | Min observations needed. |

## ee.Algorithms.TemporalSegmentation.VCT

Vegetation Change Tracker, an automated approach for reconstructing recent forest disturbance history using dense Landsat time series stacks.

The output is a 2D array per pixel containing 6 rows x N years. The output rows contain: input years, VCT landcover mask, magnitude in term of the UD composite, magnitude of distubance in B4, magnitude of distubance in NDVI, magnitude of distubance in dNBR.

See: Huang, C., Goward, S.N., Masek, J.G., Thomas, N., Zhu, Z. and Vogelmann, J.E., 2010. An automated approach for reconstructing recent forest disturbance history using dense Landsat time series stacks. Remote Sensing of Environment, 114(1), pp.183-198.

Usage | Returns |
---|---|

`ee.Algorithms.TemporalSegmentation.VCT(timeSeries, landCover, ` | Image |

Argument | Type | Details |
---|---|---|

`timeSeries` | ImageCollection | Collection from which to extract VCT disturbances, containing the bands: B3, B4, B5, B7, thermal, NDVI, DNBR and COMP. This collection is expected to contain 1 image for each year, sorted by time. |

`landCover` | ImageCollection | Collection from which to extract VCT masks. This collection is expected to contain 1 image for each image in the timeSeries, sorted by time. |

`maxUd` | Float, default: 4 | Maximum Z-score composite value for detecting forest. |

`minNdvi` | Float, default: 0.45 | Minimum NDVI value for forest. |

`forThrMax` | Float, default: 3 | Maximum threshold for forest. |

`nYears` | Integer, default: 30 | Maximum number of years. |

## ee.Algorithms.TemporalSegmentation.Verdet

Vegetation Regeneration and Disturbance Estimates through Time, forest change detection algorithm. This algorithm generates a yearly clear-sky composite from satellite imagery, calculates a spectral vegetation index for each pixel in that composite, spatially segments the vegetation index image into patches, temporally divides the time series into differently sloped segments, and then labels those segments as disturbed, stable, or regenerating. Segmentation at both the spatial and temporal steps are performed using total variation regularization.

The output consists of a 1D array per pixel containing the slope of fitted trend lines. Negative values indicate disturbance and positive values regeneration.

See: Hughes, M.J., Kaylor, S.D. and Hayes, D.J., 2017. Patch-based forest change detection from Landsat time series. Forests, 8(5), p.166.

Usage | Returns |
---|---|

`ee.Algorithms.TemporalSegmentation.Verdet(timeSeries, ` | Image |

Argument | Type | Details |
---|---|---|

`timeSeries` | ImageCollection | Collection from which to extract VeRDET scores. This collection is expected to contain 1 image for each year, sorted temporally. |

`tolerance` | Float, default: 0.0001 | convergence tolerance |

`alpha` | Float, default: 0.03333333333333333 | Regularization parameter for segmentation. |

`nRuns` | Integer, default: 100 | Maximum number of runs for convergence. |

## 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, ` | 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, ` | 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.argmax

Returns the position, as a list of indices in each array axis, of the maximum value in an array, or null if the array is empty. If there are multiple occurrences of the maximum, returns the position of the first.

Usage | Returns |
---|---|

`Array.argmax()` | List |

Argument | Type | Details |
---|---|---|

this: `array` | Array |

## 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, ` | 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.

This implementation uses DecompositionFactory.eig() from https://ejml.org.

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.

Usage | Returns |
---|---|

`Array.floor()` | Array |

Argument | Type | Details |
---|---|---|

this: `input` | Array | The input array. |

## ee.Array.gamma

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

Usage | Returns |
---|---|

`Array.gamma()` | Array |

Argument | Type | Details |
---|---|---|

this: `input` | Array | The input array. |

## ee.Array.gammainc

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

Usage | Returns |
---|---|

`Array.gammainc(right)` | Array |

Argument | Type | Details |
---|---|---|

this: `left` | Array | The left-hand value. |

`right` | Array | The right-hand value. |

## ee.Array.get

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

Usage | Returns |
---|---|

`Array.get(position)` | Number |

Argument | Type | Details |
---|---|---|

this: `array` | Array | The array to extract from. |

`position` | List | The coordinates of the element to get. |

## ee.Array.gt

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

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(` | 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.pad

Pad an array to a given length. The pad value will be repeatedly appended to the array to extend it to given length along each axis. If the array is already as large or larger than a given length, it will remain unchanged along that axis.

Usage | Returns |
---|---|

`Array.pad(lengths, ` | Array |

Argument | Type | Details |
---|---|---|

this: `array` | Array | Array to pad. |

`lengths` | List | A list of new lengths for each axis. |

`pad` | Number, default: 0 | The value with which to pad the array. |

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

The output always has the same dimensionality as the input, and the individual axes are affected as follows:

- The axes specified in the 'axes' parameter have their length reduced to 1 (by applying the reducer).

- If the reducer has multiple inputs or multiple outputs, the axis specified in 'fieldAxis' will be used to provide the reducer's inputs and store the reducer's outputs.

- All other axes are unaffected (independent reductions are performed).

Usage | Returns |
---|---|

`Array.reduce(reducer, axes, ` | Array |

Argument | Type | Details |
---|---|---|

this: `array` | Array | The array. |

`reducer` | Reducer | The reducer to apply. Each of its outputs must be a number, not an array or other type. |

`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 to use as the reducer's input and output fields. Only required if the reducer has multiple inputs or multiple outputs, in which case the axis must have length equal to the number of reducer inputs, and in the result it will have length equal to the number of reducer 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(` | 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.reshape

Reshapes an array to a new list of dimension lengths.

Usage | Returns |
---|---|

`Array.reshape(shape)` | Array |

Argument | Type | Details |
---|---|---|

this: `array` | Array | Array to reshape. |

`shape` | Array | New shape to which arrays are converted. If one component of the shape is the special value -1, the size of that dimension is computed so that the total size remains constant. In particular, a shape of [-1] flattens into 1-D. At most one component of shape can be -1. |

## 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.signum

On an element-wise basis, computes the signum function (sign) of the input; zero if the input is zero, 1 if the input is greater than zero, -1 if the input is less than zero.

Usage | Returns |
---|---|

`Array.signum()` | 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(` | 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(` | 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(` | 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.

Usage | Returns |
---|---|

`Array.uint8()` | Array |

Argument | Type | Details |
---|---|---|

this: `input` | Array | The input array. |

## ee.Blob

Loads a Blob from a Google Cloud Storage URL.

Usage | Returns |
---|---|

`ee.Blob(url)` | Blob |

Argument | Type | Details |
---|---|---|

`url` | String | The Blob's Google Cloud Storage URL. |

## ee.Blob.string

Returns the contents of the blob as a String.

Usage | Returns |
---|---|

`Blob.string(` | String |

Argument | Type | Details |
---|---|---|

this: `blob` | Blob | |

`encoding` | String, default: null |

## ee.Blob.url

Returns the Blob's Google Cloud Storage URL.

Usage | Returns |
---|---|

`Blob.url()` | String |

Argument | Type | Details |
---|---|---|

this: `blob` | Blob |

## ee.Classifier.confusionMatrix

Computes a 2D confusion matrix for a classifier based on its training data (ie: resubstitution error). Axis 0 of the matrix correspond to the input classes, and axis 1 to the output classes. The rows and columns start at class 0 and increase sequentially up to the maximum class value, so some rows or columns might be empty if the input classes aren't 0-based or sequential.

Usage | Returns |
---|---|

`Classifier.confusionMatrix()` | ConfusionMatrix |

Argument | Type | Details |
---|---|---|

this: `classifier` | Classifier | The classifier to use. |

## 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.decisionTreeEnsemble

Creates a classifier that applies the given decision trees.

Usage | Returns |
---|---|

`ee.Classifier.decisionTreeEnsemble(treeStrings)` | Classifier |

Argument | Type | Details |
---|---|---|

`treeStrings` | List | The decision trees, specified in the text format generated by R and other similar tools. Each item in the list should contain one or more trees in text format. |

## 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.gmoMaxEnt

Creates an empty GMO Maximum Entropy classifier. See:

"Efﬁcient Large-Scale Distributed Training of Conditional Maximum Entropy Models,"

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

Usage | Returns |
---|---|

`ee.Classifier.gmoMaxEnt(` | Classifier |

Argument | Type | Details |
---|---|---|

`weight1` | Float, default: 0 | The weight for L1 regularization. |

`weight2` | Float, default: 0.000009999999747378752 | The weight for L2 regularization. |

`epsilon` | Float, default: 0.000009999999747378752 | The epsilon for stopping optimization. |

`minIterations` | Integer, default: 0 | The minimum number of iterations of optimizer. |

`maxIterations` | Integer, default: 100 | The maximum number of iterations of optimizer. |

## ee.Classifier.libsvm

Creates an empty Support Vector Machine classifier.

Usage | Returns |
---|---|

`ee.Classifier.libsvm(` | Classifier |

Argument | Type | Details |
---|---|---|

`decisionProcedure` | String, default: "Voting" | The decision procedure to use for classification. Either 'Voting' or 'Margin'. Not used for regression. |

`svmType` | String, default: "C_SVC" | The SVM type. One of C_SVC, NU_SVC, ONE_CLASS, EPSILON_SVR or NU_SVR. |

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

`shrinking` | Boolean, default: true | Whether to use shrinking heuristics. |

`degree` | Integer, default: null | The degree of polynomial. Valid for POLY kernels. |

`gamma` | Float, default: null | The gamma value in the kernel function. Defaults to the reciprocal of the number of features. Valid for POLY, RBF and SIGMOID kernels. |

`coef0` | Float, default: null | The coef₀ value in the kernel function. Defaults to 0. Valid for POLY and SIGMOID kernels. |

`cost` | Float, default: null | The cost (C) parameter. Defaults to 1. Only valid for C-SVC, epsilon-SVR, and nu-SVR. |

`nu` | Float, default: null | The nu parameter. Defaults to 0.5. Only valid for nu-SVC, one-class SVM, and nu-SVR. |

`terminationEpsilon` | Float, default: null | The termination criterion tolerance (e). Defaults to 0.001. Only valid for epsilon-SVR. |

`lossEpsilon` | Float, default: null | The epsilon in the loss function (p). Defaults to 0.1. Only valid for epsilon-SVR. |

`oneClass` | Integer, default: null | The class of the training data on which to train in a one-class SVM. Defaults to 0. Only valid for one-class SVM. Possible values are 0 and 1. The classifier output is binary (0/1) and will match this class value for the data determined to be in the class. |

## ee.Classifier.minimumDistance

Creates a minimum distance classifier for the given distance metric.

Usage | Returns |
---|---|

`ee.Classifier.minimumDistance(` | Classifier |

Argument | Type | Details |
---|---|---|

`metric` | String, default: "euclidean" | The distance metric to use. Options are: 'euclidean' - euclidean distance from the unnormalized class mean. 'cosine' - spectral angle from the unnormalized class mean. 'mahalanobis' - Mahalanobis distance from the class mean. |

## ee.Classifier.mode

Returns the classifier mode: CLASSIFICATION, REGRESSION, PROBABILITY, MULTIPROBABILITY, RAW or RAW_REGRESSION.

Usage | Returns |
---|---|

`Classifier.mode()` | String |

Argument | Type | Details |
---|---|---|

this: `classifier` | Classifier |

## 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. - MULTIPROBABILITY: The output is an array of probabilities that each class is correct ordered by classes seen. - RAW: The output is an array of the internal representation of the classification process. For example, the raw votes in multi-decision tree models. - RAW_REGRESSION: The output is an array of the internal representation of the regression process. For example, the raw predictions of multiple regression trees. Not all classifiers support modes other than CLASSIFICATION. |

## ee.Classifier.smileCart

Creates an empty CART classifier. See:

"Classification and Regression Trees,"

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

Chapman and Hall, 1984.

Usage | Returns |
---|---|

`ee.Classifier.smileCart(` | Classifier |

Argument | Type | Details |
---|---|---|

`maxNodes` | Integer, default: null | The maximum number of leaf nodes in each tree. If unspecified, defaults to no limit. |

`minLeafPopulation` | Integer, default: 1 | Only create nodes whose training set contains at least this many points. |

## ee.Classifier.smileGradientTreeBoost

Creates an empty Gradient Tree Boost classifier.

Usage | Returns |
---|---|

`ee.Classifier.smileGradientTreeBoost(numberOfTrees, ` | Classifier |

Argument | Type | Details |
---|---|---|

`numberOfTrees` | Integer | The number of decision trees to create. |

`shrinkage` | Float, default: 0.005 | The shrinkage parameter in (0, 1] controls the learning rate of procedure. |

`samplingRate` | Float, default: 0.7 | The sampling rate for stochastic tree boosting. |

`maxNodes` | Integer, default: null | The maximum number of leaf nodes in each tree. If unspecified, defaults to no limit. |

`loss` | String, default: "LeastAbsoluteDeviation" | Loss function for regression. One of: LeastSquares, LeastAbsoluteDeviation, Huber. |

`seed` | Integer, default: 0 | The randomization seed. |

## ee.Classifier.smileNaiveBayes

Creates an empty Naive Bayes classifier. This classifier assumes that the feature vector consists of positive integers, and negative inputs are discarded.

Usage | Returns |
---|---|

`ee.Classifier.smileNaiveBayes(` | Classifier |

Argument | Type | Details |
---|---|---|

`lambda` | Float, default: 0.000001 | A smoothing lambda. Used to avoid assigning zero probability to classes not seen during training, instead using lambda / (lambda * nFeatures). |

## ee.Classifier.smileRandomForest

Creates an empty Random Forest classifier.

Usage | Returns |
---|---|

`ee.Classifier.smileRandomForest(numberOfTrees, ` | Classifier |

Argument | Type | Details |
---|---|---|

`numberOfTrees` | Integer | The number of decision trees to create. |

`variablesPerSplit` | Integer, default: null | The number of variables per split. If unspecified, uses the square root of the number of variables. |

`minLeafPopulation` | Integer, default: 1 | Only create nodes whose training set contains at least this many points. |

`bagFraction` | Float, default: 0.5 | The fraction of input to bag per tree. |

`maxNodes` | Integer, default: null | The maximum number of leaf nodes in each tree. If unspecified, defaults to no limit. |

`seed` | Integer, default: 0 | The randomization seed. |

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

## ee.Classifier.train

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

Usage | Returns |
---|---|

`Classifier.train(features, classProperty, ` | Classifier |

Argument | Type | Details |
---|---|---|

this: `classifier` | Classifier | An input classifier. |

`features` | FeatureCollection | The collection to train on. |

`classProperty` | String | 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.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.

Usage | Returns |
---|---|

`Clusterer.train(features, ` | Clusterer |

Argument | Type | Details |
---|---|---|

this: `clusterer` | Clusterer | An input Clusterer. |

`features` | FeatureCollection | The collection to train on. |

`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.Clusterer.wekaCascadeKMeans

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

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

Usage | Returns |
---|---|

`ee.Clusterer.wekaCascadeKMeans(` | Clusterer |

Argument | Type | Details |
---|---|---|

`minClusters` | Integer, default: 2 | Min number of clusters. |

`maxClusters` | Integer, default: 10 | Max number of clusters. |

`restarts` | Integer, default: 10 | Number of restarts. |

`manual` | Boolean, default: false | Manually select the number of clusters. |

`init` | Boolean, default: false | Set whether to initialize using the probabilistic farthest first like method of the k-means++ algorithm (rather than the standard random selection of initial cluster centers). |

`distanceFunction` | String, default: "Euclidean" | Distance function to use. Options are: Euclidean & Manhattan |

`maxIterations` | Integer, default: null | Maximum number of iterations for k-means. |

## ee.Clusterer.wekaCobweb

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

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

Usage | Returns |
---|---|

`ee.Clusterer.wekaCobweb(` | Clusterer |

Argument | Type | Details |
---|---|---|

`acuity` | Float, default: 1 | Acuity (minimum standard deviation). |

`cutoff` | Float, default: 0.002 | Cutoff (minimum category utility). |

`seed` | Integer, default: 42 | Random number seed. |

## ee.Clusterer.wekaKMeans

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

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

Usage | Returns |
---|---|

`ee.Clusterer.wekaKMeans(nClusters, ` | Clusterer |

Argument | Type | Details |
---|---|---|

`nClusters` | Integer | Number of clusters. |

`init` | Integer, default: 0 | Initialization method to use.0 = random, 1 = k-means++, 2 = canopy, 3 = farthest first. |

`canopies` | Boolean, default: false | Use canopies to reduce the number of distance calculations. |

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

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

`distanceFunction` | String, default: "Euclidean" | Distance function to use. Options are: Euclidean & Manhattan |

`maxIterations` | Integer, default: null | Maximum number of iterations. |

`preserveOrder` | Boolean, default: false | Preserve order of instances. |

`fast` | Boolean, default: false | Enables faster distance calculations, using cut-off values. Disables the calculation/output of squared errors/distances |

`seed` | Integer, default: 10 | The randomization seed. |

## ee.Clusterer.wekaLVQ

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

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

Usage | Returns |
---|---|

`ee.Clusterer.wekaLVQ(` | Clusterer |

Argument | Type | Details |
---|---|---|

`numClusters` | Integer, default: 7 | The number of clusters. |

`learningRate` | Float, default: 1 | The learning rate for the training algorithm. (Value should be greaterthan 0 and less or equal to 1). |

`epochs` | Integer, default: 1000 | Number of training epochs. (Value should be greater than or equal to 1). |

`normalizeInput` | Boolean, default: false | Skip normalizing the attributes. |

## ee.Clusterer.wekaXMeans

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

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

Usage | Returns |
---|---|

`ee.Clusterer.wekaXMeans(` | Clusterer |

Argument | Type | Details |
---|---|---|

`minClusters` | Integer, default: 2 | Minimum number of clusters. |

`maxClusters` | Integer, default: 8 | Maximum number of clusters. |

`maxIterations` | Integer, default: 3 | Maximum number of overall iterations. |

`maxKMeans` | Integer, default: 1000 | The maximum number of iterations to perform in KMeans. |

`maxForChildren` | Integer, default: 1000 | The maximum number of iterations in KMeans that is performed on the child centers. |

`useKD` | Boolean, default: false | Use a KDTree. |

`cutoffFactor` | Float, default: 0 | Takes the given percentage of the split centroids if none of the children win. |

`distanceFunction` | String, default: "Euclidean" | Distance function to use. Options are: Chebyshev, Euclidean & Manhattan. |

`seed` | Integer, default: 10 | The randomization seed. |

## ee.ConfusionMatrix

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

Usage | Returns |
---|---|

`ee.ConfusionMatrix(array, ` | 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, ` | 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, ` | 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(` | 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. |

`timeZone` | String, default: null | The time zone (e.g. 'America/Los_Angeles'); defaults to UTC. |

## ee.Date.fromYMD

Returns a Date given year, month, day.

Usage | Returns |
---|---|

`ee.Date.fromYMD(year, month, day, ` | Date |

Argument | Type | Details |
---|---|---|

`year` | Integer | |

`month` | Integer | |

`day` | Integer | |

`timeZone` | String, default: null | The time zone (e.g. 'America/Los_Angeles'); defaults to UTC. |

## ee.Date.get

Returns the specified unit of this date.

Usage | Returns |
---|---|

`Date.get(unit, ` | Long |

Argument | Type | Details |
---|---|---|

this: `date` | Date | |

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

`timeZone` | String, default: null | The time zone (e.g. 'America/Los_Angeles'); defaults to UTC. |

## ee.Date.getFraction

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

Usage | Returns |
---|---|

`Date.getFraction(unit, ` | 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(` | 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, ` | 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, ` | 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, ` | 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. |

`legacy` | Boolean, optional | Enables legacy format. |

## 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(` | 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` | Number, 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, ` | 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(` | 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, ` | 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(` | 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. If the dictionary does not contain the given key, then defaultValue is returned, unless it is null.

Usage | Returns |
---|---|

`Dictionary.get(key, ` | Object |

Argument | Type | Details |
---|---|---|

this: `dictionary` | Dictionary | |

`key` | String | |

`defaultValue` | Object, default: null |

## ee.Dictionary.getArray

Extracts a named array value from a dictionary.

Usage | Returns |
---|---|

`Dictionary.getArray(key)` | Array |

Argument | Type | Details |
---|---|---|

this: `dictionary` | Dictionary | |

`key` | String |

## ee.Dictionary.getGeometry

Extracts a named geometry value from a dictionary.

Usage | Returns |
---|---|

`Dictionary.getGeometry(key)` | Geometry |

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(` | 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.getNumber

Extracts a named number value from a dictionary.

Usage | Returns |
---|---|

`Dictionary.getNumber(key)` | Number |

Argument | Type | Details |
---|---|---|

this: `dictionary` | Dictionary | |

`key` | String |

## ee.Dictionary.getString

Extracts a named string value from a dictionary.

Usage | Returns |
---|---|

`Dictionary.getString(key)` | String |

Argument | Type | Details |
---|---|---|

this: `dictionary` | Dictionary | |

`key` | String |

## 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, ` | 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, ` | 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, ` | 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. |

`legacy` | Boolean, optional | Enables legacy format. |

## ee.Dictionary.set

Set a value in a dictionary.

Usage | Returns |
---|---|

`Dictionary.set(key, value)` | Dictionary |

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(` | 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(` | 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(` | 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(` | 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, ` | 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 components (intersecting areas are counted multiple times).

Usage | Returns |
---|---|

`Feature.area(` | 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(` | 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, ` | 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(` | 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, ` | 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, ` | 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(` | 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(` | 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, ` | 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, ` | 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 |

## ee.Feature.disjoint

Returns true iff the feature geometries are disjoint.

Usage | Returns |
---|---|

`Feature.disjoint(right, ` | 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 |

## ee.Feature.dissolve

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

Usage | Returns |
---|---|

`Feature.dissolve(` | 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, ` | 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 |

## 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.getArray

Extract a property from a feature.

Usage | Returns |
---|---|

`Feature.getArray(property)` | Array |

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(` | 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 optional token, suitable for generating a Map overlay.

Returns an object which may be passed to ee.data.getTileUrl or ui.Map.addLayer, including an additional 'image' field, containing a Collection.draw image wrapping a FeatureCollection containing this feature. Undefined if a callback was specified.

Usage | Returns |
---|---|

`Feature.getMap(` | 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.getNumber

Extract a property from a feature.

Usage | Returns |
---|---|

`Feature.getNumber(property)` | Number |

Argument | Type | Details |
---|---|---|

this: `object` | Element | The feature to extract the property from. |

`property` | String | The property to extract. |

## ee.Feature.getString

Extract a property from a feature.

Usage | Returns |
---|---|

`Feature.getString(property)` | String |

Argument | Type | Details |
---|---|---|

this: `object` | Element | The feature to extract the property from. |

`property` | String | The property to extract. |

## ee.Feature.hersDescriptor

Creates a dictionary of Histogram Error Ring Statistic (HERS) descriptor arrays from square array properties of an element. The HERS radius is taken to be the array's (side_length - 1) / 2.

Usage | Returns |
---|---|

`Feature.hersDescriptor(` | Dictionary |

Argument | Type | Details |
---|---|---|

this: `element` | Element | The element with array properties. |

`selectors` | List, default: null | The array properties for which descriptors will be created. Selected array properties must be square, floating point arrays. Defaults to all array properties. |

`buckets` | Integer, default: 100 | The number of HERS buckets. Defaults to 100. |

`peakWidthScale` | Float, default: 1 | The HERS peak width scale. Defaults to 1.0. |

## 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, ` | 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 |

## ee.Feature.intersects

Returns true iff the feature geometries intersect.

Usage | Returns |
---|---|

`Feature.intersects(right, ` | 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 |

## 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(` | 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(` | 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, ` | 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. |

`legacy` | Boolean, optional | Enables legacy format. |

## 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(` | 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, ` | 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, ` | 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 |

## 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(` | 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(` | 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, ` | Feature |

Argument | Type | Details |
---|---|---|

this: `left` | Element | |

`right` | Element | |

`maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |

`proj` | Projection, default: null |

## ee.Feature.withinDistance

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

Usage | Returns |
---|---|

`Feature.withinDistance(right, distance, ` | 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 |

## ee.FeatureCollection

FeatureCollections can be constructed from the following arguments:

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

- A single geometry.

- A single feature.

- A list of features.

- A GeoJSON FeatureCollection

- A computed object: reinterpreted as a collection.

Usage | Returns |
---|---|

`ee.FeatureCollection(args, ` | 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 when working with a named collection. |

## 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)` | List |

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)` | Number |

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)` | Number |

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

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)` | Dictionary |

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

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)` | Number |

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

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)` | Number |

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)` | Number |

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)` | Number |

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)` | Dictionary |

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)` | Number |

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)` | Number |

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)` | Number |

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

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, ` | 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` | Classifier | The classifier to use. |

`outputName` | String, default: "classification" | The name of the output property to be added. This argument is ignored if the classifier has more than one output. |

## 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, ` | 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(` | 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 Point, LineString, or polygonal boundary in the collection. Note distance is also measured within interiors of polygons. 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(` | 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(properties)` | FeatureCollection |

Argument | Type | Details |
---|---|---|

this: `collection` | FeatureCollection | The input collection from which objects will be selected. |

`properties` | Object | A property name or a list of property names to use for comparison. The '.geo' property can be included to compare object geometries. |

## ee.FeatureCollection.draw

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

Usage | Returns |
---|---|

`FeatureCollection.draw(color, ` | 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 0 (the rows) of the matrix correspond to the actual values, and Axis 1 (the columns) to the predicted values.

Usage | Returns |
---|---|

`FeatureCollection.errorMatrix(actual, predicted, ` | 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

Usage | Returns |
---|---|

`FeatureCollection.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.FeatureCollection.filter

Apply a filter to this collection.

Returns the filtered collection.

Usage | Returns |
---|---|

`FeatureCollection.filter(filter)` | Collection |

Argument | Type | Details |
---|---|---|

this: `collection` | Collection | The Collection instance. |

`filter` | Filter | A filter to apply to this collection. |

## ee.FeatureCollection.filterBounds

Shortcut to filter a collection by intersection with geometry. Items in the collection with a footprint that fails to intersect the given geometry will be excluded.

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` | Geometry | The geometry to filter to. |

## ee.FeatureCollection.filterDate

Shortcut to filter a collection by a date range. The start and end may be Dates, numbers (interpreted as milliseconds since 1970-01-01T00:00:00Z), or strings (such as '1996-01-01T08:00'). Based on 'system:time_start'.

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

Returns the filtered collection.

Usage | Returns |
---|---|

`FeatureCollection.filterDate(start, ` | Collection |

Argument | Type | Details |
---|---|---|

this: `collection` | Collection | The Collection instance. |

`start` | Date|Number|String | The start date (inclusive). |

`end` | Date|Number|String, optional | The end date (exclusive). Optional. If not specified, a 1-millisecond range starting at 'start' is created. |

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

Usage | Returns |
---|---|

`FeatureCollection.geometry(` | 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.FeatureCollection.get

Extract a property from a feature.

Usage | Returns |
---|---|

`FeatureCollection.get(property)` |

Argument | Type | Details |
---|---|---|

this: `object` | Element | The feature to extract the property from. |

`property` | String | The property to extract. |

## ee.FeatureCollection.getArray

Extract a property from a feature.

Usage | Returns |
---|---|

`FeatureCollection.getArray(property)` | Array |

Argument | Type | Details |
---|---|---|

this: `object` | Element | The feature to extract the property from. |

`property` | String | The property to extract. |

## ee.FeatureCollection.getDownloadURL

Get a download URL.

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

Usage | Returns |
---|---|

`FeatureCollection.getDownloadURL(` | Object|String |

Argument | Type | Details |
---|---|---|

this: `featurecollection` | FeatureCollection | The FeatureCollection instance. |

`format` | String, optional | The format of download, one of: "csv", "json", "kml", "kmz". |

`selectors` | List, optional | Selectors that should be used to determine which attributes will be downloaded. |

`filename` | String, optional | Name of the file to be downloaded. |

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

## ee.FeatureCollection.getInfo

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

Returns a collection description whose fields include:

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

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

Usage | Returns |
---|---|

`FeatureCollection.getInfo(` | FeatureCollectionDescription |

Argument | Type | Details |
---|---|---|

this: `featurecollection` | FeatureCollection | The FeatureCollection 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.FeatureCollection.getMap

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

Returns an object which may be passed to ee.data.getTileUrl or ui.Map.addLayer, including an additional 'image' field, containing a Collection.draw image wrapping a FeatureCollection containing this feature. Undefined if a callback was specified.

Usage | Returns |
---|---|

`FeatureCollection.getMap(` | MapId|Object |

Argument | Type | Details |
---|---|---|

this: `featurecollection` | FeatureCollection | The FeatureCollection instance. |

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

`callback` | Function, optional | An async callback. If not supplied, the call is made synchronously. |

## ee.FeatureCollection.getNumber

Extract a property from a feature.

Usage | Returns |
---|---|

`FeatureCollection.getNumber(property)` | Number |

Argument | Type | Details |
---|---|---|

this: `object` | Element | The feature to extract the property from. |

`property` | String | The property to extract. |

## ee.FeatureCollection.getString

Extract a property from a feature.

Usage | Returns |
---|---|

`FeatureCollection.getString(property)` | String |

Argument | Type | Details |
---|---|---|

this: `object` | Element | The feature to extract the property from. |

`property` | String | The property to extract. |

## ee.FeatureCollection.inverseDistance

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

Usage | Returns |
---|---|

`FeatureCollection.inverseDistance(range, propertyName, mean, stdDev, ` | Image |

Argument | Type | Details |
---|---|---|

this: `collection` | FeatureCollection | Feature collection to use as source data for the estimation. |

`range` | Float | Size of the interpolation window (in meters). |

`propertyName` | String | Name of the numeric property to be estimated. |

`mean` | Float | Global expected mean. |

`stdDev` | Float | Global standard deviation. |

`gamma` | Float, default: 1 | Determines how quickly the estimates tend towards the global mean. |

`reducer` | Reducer, default: null | Reducer used to collapse the 'propertyName' value of overlapping points into a single value. |

## ee.FeatureCollection.iterate

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

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

Usage | Returns |
---|---|

`FeatureCollection.iterate(algorithm, ` | 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.FeatureCollection.kriging

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

Usage | Returns |
---|---|

`FeatureCollection.kriging(propertyName, shape, range, sill, nugget, ` | Image |

Argument | Type | Details |
---|---|---|

this: `collection` | FeatureCollection | Feature collection to use as source data for the estimation. |

`propertyName` | String | Property to be estimated (must be numeric). |

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

`range` | Float | Semivariogram range. |

`sill` | Float | Semivariogram sill. |

`nugget` | Float | Semivariogram nugget. |

`maxDistance` | Float, default: null | Radius which determines which features 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, ` | 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, ` | 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, ` | 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.

Elements from the first collection will have IDs prefixed with "1_" and elements from the second collection will have IDs prefixed with "2_".

Note: If many collections need to be merged, consider placing them all in a collection and using FeatureCollection.flatten() instead. Repeated use of FeatureCollection.merge() will result in increasingly long element IDs and reduced performance.

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 outputs are double-precision floating point numbers. When using the 'uniform' distribution (default), outputs are in the range of [0, 1). Using the 'normal' distribution, outputs have μ=0, 𝛔=1, but have no explicit limits.

Usage | Returns |
---|---|

`FeatureCollection.randomColumn(` | 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. |

`distribution` | String, default: "uniform" | The distribution type of random numbers to produce. One of 'uniform' or 'normal' |

## ee.FeatureCollection.randomPoints

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

Usage | Returns |
---|---|

`ee.FeatureCollection.randomPoints(region, ` | 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, ` | 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).

Returns the feature collection with selected properties.

Usage | Returns |
---|---|

`FeatureCollection.select(propertySelectors, ` | FeatureCollection |

Argument | Type | Details |
---|---|---|

this: `featurecollection` | FeatureCollection | The FeatureCollection instance. |

`propertySelectors` | List | A list of names or regexes specifying the attributes to select. |

`newProperties` | List, optional | A list of new names for the output properties. Must match the number of properties selected. |

`retainGeometry` | Boolean, optional | When false, the result will have a NULL geometry. Defaults to true. |

## ee.FeatureCollection.serialize

Returns the serialized representation of this object.

Usage | Returns |
---|---|

`FeatureCollection.serialize(` | String |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`legacy` | Boolean, optional | Enables legacy format. |

## ee.FeatureCollection.set

Overrides one or more metadata properties of an Element.

Returns the element with the specified properties overridden.

Usage | Returns |
---|---|

`FeatureCollection.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.FeatureCollection.setMulti

Overrides one or more metadata properties of an object.

Usage | Returns |
---|---|

`FeatureCollection.setMulti(properties)` | Element |

Argument | Type | Details |
---|---|---|

this: `object` | Element | The object whose properties to override. |

`properties` | Dictionary | The property values to override. |

## ee.FeatureCollection.size

Returns the number of elements in the collection.

Usage | Returns |
---|---|

`FeatureCollection.size()` | Integer |

Argument | Type | Details |
---|---|---|

this: `collection` | FeatureCollection | The collection to count. |

## ee.FeatureCollection.sort

Sort a collection by the specified property.

Returns the sorted collection.

Usage | Returns |
---|---|

`FeatureCollection.sort(property, ` | 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.FeatureCollection.style

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

Usage | Returns |
---|---|

`FeatureCollection.style(` | Image |

Argument | Type | Details |
---|---|---|

this: `collection` | FeatureCollection | The collection to draw. |

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

`pointSize` | Integer, default: 3 | The default size in pixels of the point markers. |

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

`width` | Float, default: 2 | 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. |

`lineType` | String, default: "solid" | The default line style for lines and outlines of polygons and point shapes. Defaults to 'solid'. One of: solid, dotted, dashed. |

## ee.FeatureCollection.toDictionary

Extract properties from a feature as a dictionary.

Usage | Returns |
---|---|

`FeatureCollection.toDictionary(` | 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, ` | 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(` | 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 |

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

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

Creates a filter that passes if the object's geometry intersects the given geometry.

Returns the constructed filter.

Usage | Returns |
---|---|

`ee.Filter.bounds(geometry, ` | Filter |

Argument | Type | Details |
---|---|---|

`geometry` | ComputedObject|FeatureCollection|Geometry | The geometry, feature or collection to intersect with. |

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

`field` | String, default: "day_of_year" | The calendar field to filter over. Options are: 'year', 'month', 'hour', 'minute', 'day_of_year', 'day_of_month', and 'day_of_week'. |

## ee.Filter.contains

Creates a unary or binary filter that passes if the left geometry contains the right geometry (empty geometries are not contained in anything).

Usage | Returns |
---|---|

`ee.Filter.contains(` | 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. |

`maxError` | ErrorMargin, optional | The maximum reprojection error allowed during filter application. |

## ee.Filter.date

Filter a collection by date range. The start and end may be Dates, numbers

(interpreted as milliseconds since 1970-01-01T00:00:00Z), or strings (such as '1996-01-01T08:00'). Based on 'system:time_start' property.

Returns the constructed filter.

Usage | Returns |
---|---|

`ee.Filter.date(start, ` | Filter |

Argument | Type | Details |
---|---|---|

`start` | Date|Number|String | The start date (inclusive). |

`end` | Date|Number|String, optional | The end date (exclusive). Optional. If not specified, a 1-millisecond range starting at 'start' is created. |

## ee.Filter.dateRangeContains

Creates a unary or binary filter that passes if the left operand, a date range, contains the right operand, a date.

Usage | Returns |
---|---|

`ee.Filter.dateRangeContains(` | 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.dayOfYear

Returns a filter that passes if the object's timestamp falls within the given day-of-year range.

Usage | Returns |
---|---|

`ee.Filter.dayOfYear(start, end)` | Filter |

Argument | Type | Details |
---|---|---|

`start` | Integer | The start of the desired day range, inclusive. |

`end` | Integer | The end of the desired day range, inclusive. |

## ee.Filter.disjoint

Creates a unary or binary filter that passes unless the left geometry intersects the right geometry.

Usage | Returns |
---|---|

`ee.Filter.disjoint(` | 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. |

`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(` | 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

Usage | Returns |
---|---|

`Filter.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.Filter.expression

Constructs a filter tree from a string.

Usage | Returns |
---|---|

`ee.Filter.expression(expression)` | Filter |

Argument | Type | Details |
---|---|---|

`expression` | String | A string to be parsed into a Filter object (e.g.: "property > value"). Supported operators include: >, >=, <, <=, ==, !=, (), !, && and ||. |

## 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(` | 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(` | 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.

Usage | Returns |
---|---|

`ee.Filter.greaterThanOrEquals(` | 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.gt

Filter on metadata greater than the given value.

Returns the constructed filter.

Usage | Returns |
---|---|

`ee.Filter.gt(name, value)` | Filter |

Argument | Type | Details |
---|---|---|

`name` | String | The property name to filter on. |

`value` | Object | The value to compare against. |

## ee.Filter.gte

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

Returns the constructed filter.

Usage | Returns |
---|---|

`ee.Filter.gte(name, value)` | Filter |

Argument | Type | Details |
---|---|---|

`name` | String | The property name to filter on. |

`value` | Object | The value to compare against. |

## ee.Filter.inList

Filter on metadata contained in a list.

Returns the constructed filter.

Usage | Returns |
---|---|

`ee.Filter.inList(` | Filter |

Argument | Type | Details |
---|---|---|

`leftField` | String, optional | A selector for the left operand. Should not be specified if leftValue is specified. |

`rightValue` | List, optional | The value of the right operand. Should not be specified if rightField is specified. |

`rightField` | String, optional | A selector for the right operand. Should not be specified if rightValue is specified. |

`leftValue` | List, optional | The value of the left operand. Should not be specified if leftField is specified. |

## ee.Filter.intersects

Creates a unary or binary filter that passes if the left geometry intersects the right geometry.

Usage | Returns |
---|---|

`ee.Filter.intersects(` | 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. |

`maxError` | ErrorMargin, optional | The maximum reprojection error allowed during filter application. |

## ee.Filter.isContained

Creates a unary or binary filter that passes if the right geometry contains the left geometry (empty geometries are not contained in anything).

Usage | Returns |
---|---|

`ee.Filter.isContained(` | 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. |

`maxError` | ErrorMargin, optional | The maximum reprojection error allowed during filter application. |

## ee.Filter.lessThan

Creates a unary or binary filter that passes if the left operand is less than the right operand.

Usage | Returns |
---|---|

`ee.Filter.lessThan(` | 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.lessThanOrEquals

Creates a unary or binary filter that passes unless the left operand is greater than the right operand.

Usage | Returns |
---|---|

`ee.Filter.lessThanOrEquals(` | 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.listContains

Creates a unary or binary filter that passes if the left operand, a list, contains the right operand.

Usage | Returns |
---|---|

`ee.Filter.listContains(` | 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.

Usage | Returns |
---|---|

`ee.Filter.maxDifference(difference, ` | Filter |

Argument | Type | Details |
---|---|---|

`difference` | Float | The maximum difference for which the filter will return true. |

`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.neq

Filter to metadata not equal to the given value.

Returns the constructed filter.

Usage | Returns |
---|---|

`ee.Filter.neq(name, value)` | Filter |

Argument | Type | Details |
---|---|---|

`name` | String | The property name to filter on. |

`value` | Object | The value to compare against. |

## ee.Filter.not

Returns the opposite of the input filter, i.e. the resulting filter will match if and only if the input filter doesn't match.

Usage | Returns |
---|---|

`Filter.not()` | Filter |

Argument | Type | Details |
---|---|---|

this: `filter` | Filter | The Filter instance. |

## ee.Filter.notEquals

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

Usage | Returns |
---|---|

`ee.Filter.notEquals(` | 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.notNull

Returns a filter that passes if all the named properties are not null.

Usage | Returns |
---|---|

`ee.Filter.notNull(properties)` | Filter |

Argument | Type | Details |
---|---|---|

`properties` | List |

## ee.Filter.or

Combine two or more filters using boolean OR.

Returns the constructed filter.

Usage | Returns |
---|---|

`ee.Filter.or(var_args)` | Filter |

Argument | Type | Details |
---|---|---|

`var_args` | VarArgs | The filters to combine. |

## ee.Filter.rangeContains

Returns a filter that passes if the value of the selected field is in the specified range (inclusive).

Usage | Returns |
---|---|

`ee.Filter.rangeContains(field, minValue, maxValue)` | Filter |

Argument | Type | Details |
---|---|---|

`field` | String | A selector for the property being tested. |

`minValue` | Object | The lower bound of the range. |

`maxValue` | Object | The upper bound of the range. |

## ee.Filter.serialize

Returns the serialized representation of this object.

Usage | Returns |
---|---|

`Filter.serialize(` | String |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`legacy` | Boolean, optional | Enables legacy format. |

## ee.Filter.stringContains

Creates a unary or binary filter that passes if the left operand, a string, contains the right operand, also a string.

Usage | Returns |
---|---|

`ee.Filter.stringContains(` | 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.stringEndsWith

Creates a unary or binary filter that passes if the left operand, a string, ends with the right operand, also a string.

Usage | Returns |
---|---|

`ee.Filter.stringEndsWith(` | 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.stringStartsWith

Creates a unary or binary filter that passes if the left operand, a string, starts with the right operand, also a string.

Usage | Returns |
---|---|

`ee.Filter.stringStartsWith(` | 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.withinDistance

Creates a unary or binary filter that passes if the left geometry is within a specified distance of the right geometry. If used as a join condition, this distance is used as a join measure.

Usage | Returns |
---|---|

`ee.Filter.withinDistance(distance, ` | Filter |

Argument | Type | Details |
---|---|---|

`distance` | Float | The maximum distance for which the filter will return true. |

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

`maxError` | ErrorMargin, optional | The maximum reprojection error allowed during filter application. |

## ee.Geometry

Creates a geometry.

Usage | Returns |
---|---|

`ee.Geometry(geoJson, ` | 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.BBox

Constructs a rectangle whose edges are lines of latitude and longitude.

The result is a planar WGS84 rectangle.

If (east - west) ≥ 360 then the longitude range will be normalized to -180 to

+180; otherwise they will be treated as designating points on a circle (e.g. east may be numerically less than west).

Usage | Returns |
---|---|

`ee.Geometry.BBox(west, south, east, north)` | Geometry.BBox |

Argument | Type | Details |
---|---|---|

`west` | Number | The westernmost enclosed longitude. Will be adjusted to lie in the range -180° to 180°. |

`south` | Number | The southernmost enclosed latitude. If less than -90° (south pole), will be treated as -90°. |

`east` | Number | The easternmost enclosed longitude. |

`north` | Number | The northernmost enclosed longitude. If greater than +90° (north pole), will be treated as +90°. |

## ee.Geometry.BBox.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 components (intersecting areas are counted multiple times).

Usage | Returns |
---|---|

`BBox.area(` | 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.BBox.aside

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

`BBox.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.BBox.bounds

Returns the bounding rectangle of the geometry.

Usage | Returns |
---|---|

`BBox.bounds(` | 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.BBox.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 |
---|---|

`BBox.buffer(distance, ` | 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.BBox.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 |
---|---|

`BBox.centroid(` | 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.BBox.containedIn

Returns true iff one geometry is contained in the other.

Usage | Returns |
---|---|

`BBox.containedIn(right, ` | 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 |

## ee.Geometry.BBox.contains

Returns true iff one geometry contains the other.

Usage | Returns |
---|---|

`BBox.contains(right, ` | 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 |

## ee.Geometry.BBox.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 |
---|---|

`BBox.convexHull(` | 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 |

## ee.Geometry.BBox.coordinates

Returns a GeoJSON-style list of the geometry's coordinates.

Usage | Returns |
---|---|

`BBox.coordinates()` | List |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.BBox.cutLines

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

Usage | Returns |
---|---|

`BBox.cutLines(distances, ` | 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.BBox.difference

Returns the result of subtracting the 'right' geometry from the 'left' geometry.

Usage | Returns |
---|---|

`BBox.difference(right, ` | 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 |

## ee.Geometry.BBox.disjoint

Returns true iff the geometries are disjoint.

Usage | Returns |
---|---|

`BBox.disjoint(right, ` | 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 |

## ee.Geometry.BBox.dissolve

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

Usage | Returns |
---|---|

`BBox.dissolve(` | 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.BBox.distance

Returns the minimum distance between two geometries.

Usage | Returns |
---|---|

`BBox.distance(right, ` | 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 |

## ee.Geometry.BBox.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 |
---|---|

`BBox.edgesAreGeodesics()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.BBox.evaluate

Usage | Returns |
---|---|

`BBox.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.Geometry.BBox.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 |
---|---|

`BBox.geodesic()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.BBox.geometries

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

Usage | Returns |
---|---|

`BBox.geometries()` | List |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.BBox.getInfo

Retrieves the value of this object from the server.

Returns the computed value of this object.

Usage | Returns |
---|---|

`BBox.getInfo(` | 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.BBox.intersection

Returns the intersection of the two geometries.

Usage | Returns |
---|---|

`BBox.intersection(right, ` | 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 |

## ee.Geometry.BBox.intersects

Returns true iff the geometries intersect.

Usage | Returns |
---|---|

`BBox.intersects(right, ` | 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 |

## ee.Geometry.BBox.isUnbounded

Returns whether the geometry is unbounded.

Usage | Returns |
---|---|

`BBox.isUnbounded()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.BBox.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 |
---|---|

`BBox.length(` | 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.BBox.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 |
---|---|

`BBox.perimeter(` | 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 |

## ee.Geometry.BBox.projection

Returns the projection of the geometry.

Usage | Returns |
---|---|

`BBox.projection()` | Projection |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.BBox.serialize

Returns the serialized representation of this object.

Usage | Returns |
---|---|

`BBox.serialize(` | String |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The Geometry instance. |

`legacy` | Boolean, optional | Enables legacy format. |

## ee.Geometry.BBox.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 |
---|---|

`BBox.simplify(maxError, ` | 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.BBox.symmetricDifference

Returns the symmetric difference between two geometries.

Usage | Returns |
---|---|

`BBox.symmetricDifference(right, ` | 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 |

## ee.Geometry.BBox.toGeoJSON

Returns a GeoJSON representation of the geometry.

Usage | Returns |
---|---|

`BBox.toGeoJSON()` | GeoJSONGeometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The Geometry instance. |

## ee.Geometry.BBox.toGeoJSONString

Returns a GeoJSON string representation of the geometry.

Usage | Returns |
---|---|

`BBox.toGeoJSONString()` | String |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The Geometry instance. |

## ee.Geometry.BBox.transform

Transforms the geometry to a specific projection.

Usage | Returns |
---|---|

`BBox.transform(` | 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.BBox.type

Returns the GeoJSON type of the geometry.

Usage | Returns |
---|---|

`BBox.type()` | String |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.BBox.union

Returns the union of the two geometries.

Usage | Returns |
---|---|

`BBox.union(right, ` | 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 |

## ee.Geometry.BBox.withinDistance

Returns true iff the geometries are within a specified distance.

Usage | Returns |
---|---|

`BBox.withinDistance(right, distance, ` | 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 |

## 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, ` | 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 | |

`maxError` | ErrorMargin, optional |

## 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 components (intersecting areas are counted multiple times).

Usage | Returns |
---|---|

`LineString.area(` | 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

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(` | 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, ` | 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(` | 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, ` | 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 |

## ee.Geometry.LineString.contains

Returns true iff one geometry contains the other.

Usage | Returns |
---|---|

`LineString.contains(right, ` | 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 |

## 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(` | 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 |

## 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, ` | 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, ` | 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 |

## ee.Geometry.LineString.disjoint

Returns true iff the geometries are disjoint.

Usage | Returns |
---|---|

`LineString.disjoint(right, ` | 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 |

## ee.Geometry.LineString.dissolve

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

Usage | Returns |
---|---|

`LineString.dissolve(` | 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, ` | 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 |

## 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

Usage | Returns |
---|---|

`LineString.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

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

Returns the computed value of this object.

Usage | Returns |
---|---|

`LineString.getInfo(` | 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, ` | 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 |

## ee.Geometry.LineString.intersects

Returns true iff the geometries intersect.

Usage | Returns |
---|---|

`LineString.intersects(right, ` | 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 |

## 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(` | 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 |

## 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(` | 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 |

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

`legacy` | Boolean, optional | Enables legacy format. |

## 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, ` | 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, ` | 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 |

## 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(` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry to reproject. |

`proj` | Projection, optional | |

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

## ee.Geometry.LineString.withinDistance

Returns true iff the geometries are within a specified distance.

Usage | Returns |
---|---|

`LineString.withinDistance(right, distance, ` | 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 |

## 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, ` | 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 | |

`maxError` | ErrorMargin, optional |

## 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 components (intersecting areas are counted multiple times).

Usage | Returns |
---|---|

`LinearRing.area(` | 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 |

## ee.Geometry.LinearRing.aside

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(` | 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

Usage | Returns |
---|---|

`LinearRing.buffer(distance, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry being buffered. |

`distance` | Float | |

`maxError` | ErrorMargin, default: null | |

`proj` | Projection, default: null |

## 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(` | 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, ` | 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 |

## ee.Geometry.LinearRing.contains

Returns true iff one geometry contains the other.

Usage | Returns |
---|---|

`LinearRing.contains(right, ` | 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 |

## 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(` | 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 |

## 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

Usage | Returns |
---|---|

`LinearRing.cutLines(distances, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | Cuts the lines of this geometry. |

`distances` | List | |

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

## ee.Geometry.LinearRing.disjoint

Returns true iff the geometries are disjoint.

Usage | Returns |
---|---|

`LinearRing.disjoint(right, ` | 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 |

## ee.Geometry.LinearRing.dissolve

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

Usage | Returns |
---|---|

`LinearRing.dissolve(` | 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 |

## ee.Geometry.LinearRing.distance

Returns the minimum distance between two geometries.

Usage | Returns |
---|---|

`LinearRing.distance(right, ` | 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 |

## 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

Usage | Returns |
---|---|

`LinearRing.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

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

Returns the computed value of this object.

Usage | Returns |
---|---|

`LinearRing.getInfo(` | 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, ` | 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 |

## ee.Geometry.LinearRing.intersects

Returns true iff the geometries intersect.

Usage | Returns |
---|---|

`LinearRing.intersects(right, ` | 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 |

## 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(` | 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 |

## 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(` | 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 |

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

`legacy` | Boolean, optional | Enables legacy format. |

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

Usage | Returns |
---|---|

`LinearRing.simplify(maxError, ` | 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 |

## ee.Geometry.LinearRing.symmetricDifference

Returns the symmetric difference between two geometries.

Usage | Returns |
---|---|

`LinearRing.symmetricDifference(right, ` | 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 |

## 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(` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry to reproject. |

`proj` | Projection, optional | |

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

## ee.Geometry.LinearRing.withinDistance

Returns true iff the geometries are within a specified distance.

Usage | Returns |
---|---|

`LinearRing.withinDistance(right, distance, ` | 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 | |

`maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |

`proj` | Projection, default: null |

## 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, ` | 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 | |

`maxError` | ErrorMargin, optional |

## ee.Geometry.MultiLineString.area

Usage | Returns |
---|---|

`MultiLineString.area(` | 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 |

## ee.Geometry.MultiLineString.aside

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(` | 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

Usage | Returns |
---|---|

`MultiLineString.buffer(distance, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry being buffered. |

`distance` | Float | |

`maxError` | ErrorMargin, default: null | |

`proj` | Projection, default: null |

## ee.Geometry.MultiLineString.centroid

Usage | Returns |
---|---|

`MultiLineString.centroid(` | 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, ` | 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 |

## ee.Geometry.MultiLineString.contains

Returns true iff one geometry contains the other.

Usage | Returns |
---|---|

`MultiLineString.contains(right, ` | 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 |

## ee.Geometry.MultiLineString.convexHull

Usage | Returns |
---|---|

`MultiLineString.convexHull(` | 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 |

## 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

Usage | Returns |
---|---|

`MultiLineString.cutLines(distances, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | Cuts the lines of this geometry. |

`distances` | List | |

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

## ee.Geometry.MultiLineString.disjoint

Returns true iff the geometries are disjoint.

Usage | Returns |
---|---|

`MultiLineString.disjoint(right, ` | 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 |

## ee.Geometry.MultiLineString.dissolve

Usage | Returns |
---|---|

`MultiLineString.dissolve(` | 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 |

## ee.Geometry.MultiLineString.distance

Returns the minimum distance between two geometries.

Usage | Returns |
---|---|

`MultiLineString.distance(right, ` | 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 |

## ee.Geometry.MultiLineString.edgesAreGeodesics

Usage | Returns |
---|---|

`MultiLineString.edgesAreGeodesics()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.MultiLineString.evaluate

Usage | Returns |
---|---|

`MultiLineString.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.Geometry.MultiLineString.geodesic

Usage | Returns |
---|---|

`MultiLineString.geodesic()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.MultiLineString.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.

Returns the computed value of this object.

Usage | Returns |
---|---|

`MultiLineString.getInfo(` | 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, ` | 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 |

## ee.Geometry.MultiLineString.intersects

Returns true iff the geometries intersect.

Usage | Returns |
---|---|

`MultiLineString.intersects(right, ` | 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 |

## 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

Usage | Returns |
---|---|

`MultiLineString.length(` | 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 |

## ee.Geometry.MultiLineString.perimeter

Usage | Returns |
---|---|

`MultiLineString.perimeter(` | 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 |

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

`legacy` | Boolean, optional | Enables legacy format. |

## ee.Geometry.MultiLineString.simplify

Usage | Returns |
---|---|

`MultiLineString.simplify(maxError, ` | 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 |

## ee.Geometry.MultiLineString.symmetricDifference

Returns the symmetric difference between two geometries.

Usage | Returns |
---|---|

`MultiLineString.symmetricDifference(right, ` | 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 |

## 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(` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry to reproject. |

`proj` | Projection, optional | |

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

## ee.Geometry.MultiLineString.withinDistance

Returns true iff the geometries are within a specified distance.

Usage | Returns |
---|---|

`MultiLineString.withinDistance(right, distance, ` | 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 | |

`maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |

`proj` | Projection, default: null |

## 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, ` | 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 |

## ee.Geometry.MultiPoint.area

Usage | Returns |
---|---|

`MultiPoint.area(` | 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 |

## ee.Geometry.MultiPoint.aside

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(` | 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

Usage | Returns |
---|---|

`MultiPoint.buffer(distance, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry being buffered. |

`distance` | Float | |

`maxError` | ErrorMargin, default: null | |

`proj` | Projection, default: null |

## ee.Geometry.MultiPoint.centroid

Usage | Returns |
---|---|

`MultiPoint.centroid(` | 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, ` | 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 |

## ee.Geometry.MultiPoint.contains

Returns true iff one geometry contains the other.

Usage | Returns |
---|---|

`MultiPoint.contains(right, ` | 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 |

## ee.Geometry.MultiPoint.convexHull

Usage | Returns |
---|---|

`MultiPoint.convexHull(` | 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 |

## 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

Usage | Returns |
---|---|

`MultiPoint.cutLines(distances, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | Cuts the lines of this geometry. |

`distances` | List | |

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

## ee.Geometry.MultiPoint.disjoint

Returns true iff the geometries are disjoint.

Usage | Returns |
---|---|

`MultiPoint.disjoint(right, ` | 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 |

## ee.Geometry.MultiPoint.dissolve

Usage | Returns |
---|---|

`MultiPoint.dissolve(` | 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 |

## ee.Geometry.MultiPoint.distance

Returns the minimum distance between two geometries.

Usage | Returns |
---|---|

`MultiPoint.distance(right, ` | 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 |

## ee.Geometry.MultiPoint.edgesAreGeodesics

Usage | Returns |
---|---|

`MultiPoint.edgesAreGeodesics()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.MultiPoint.evaluate

Usage | Returns |
---|---|

`MultiPoint.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.Geometry.MultiPoint.geodesic

Usage | Returns |
---|---|

`MultiPoint.geodesic()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.MultiPoint.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.

Returns the computed value of this object.

Usage | Returns |
---|---|

`MultiPoint.getInfo(` | 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, ` | 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 |

## ee.Geometry.MultiPoint.intersects

Returns true iff the geometries intersect.

Usage | Returns |
---|---|

`MultiPoint.intersects(right, ` | 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 |

## 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

Usage | Returns |
---|---|

`MultiPoint.length(` | 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 |

## ee.Geometry.MultiPoint.perimeter

Usage | Returns |
---|---|

`MultiPoint.perimeter(` | 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 |

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

`legacy` | Boolean, optional | Enables legacy format. |

## ee.Geometry.MultiPoint.simplify

Usage | Returns |
---|---|

`MultiPoint.simplify(maxError, ` | 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 |

## ee.Geometry.MultiPoint.symmetricDifference

Returns the symmetric difference between two geometries.

Usage | Returns |
---|---|

`MultiPoint.symmetricDifference(right, ` | 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 |

## 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(` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry to reproject. |

`proj` | Projection, optional | |

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

## ee.Geometry.MultiPoint.withinDistance

Returns true iff the geometries are within a specified distance.

Usage | Returns |
---|---|

`MultiPoint.withinDistance(right, distance, ` | 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 | |

`maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |

`proj` | Projection, default: null |

## 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, ` | 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 | |

`maxError` | ErrorMargin, optional | |

`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

Usage | Returns |
---|---|

`MultiPolygon.area(` | 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 |

## ee.Geometry.MultiPolygon.aside

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(` | 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

Usage | Returns |
---|---|

`MultiPolygon.buffer(distance, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry being buffered. |

`distance` | Float | |

`maxError` | ErrorMargin, default: null | |

`proj` | Projection, default: null |

## ee.Geometry.MultiPolygon.centroid

Usage | Returns |
---|---|

`MultiPolygon.centroid(` | 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, ` | 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 |

## ee.Geometry.MultiPolygon.contains

Returns true iff one geometry contains the other.

Usage | Returns |
---|---|

`MultiPolygon.contains(right, ` | 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 |

## ee.Geometry.MultiPolygon.convexHull

Usage | Returns |
---|---|

`MultiPolygon.convexHull(` | 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 |

## 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

Usage | Returns |
---|---|

`MultiPolygon.cutLines(distances, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | Cuts the lines of this geometry. |

`distances` | List | |

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

## ee.Geometry.MultiPolygon.disjoint

Returns true iff the geometries are disjoint.

Usage | Returns |
---|---|

`MultiPolygon.disjoint(right, ` | 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 |

## ee.Geometry.MultiPolygon.dissolve

Usage | Returns |
---|---|

`MultiPolygon.dissolve(` | 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 |

## ee.Geometry.MultiPolygon.distance

Returns the minimum distance between two geometries.

Usage | Returns |
---|---|

`MultiPolygon.distance(right, ` | 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 |

## ee.Geometry.MultiPolygon.edgesAreGeodesics

Usage | Returns |
---|---|

`MultiPolygon.edgesAreGeodesics()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.MultiPolygon.evaluate

Usage | Returns |
---|---|

`MultiPolygon.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.Geometry.MultiPolygon.geodesic

Usage | Returns |
---|---|

`MultiPolygon.geodesic()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.MultiPolygon.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.

Returns the computed value of this object.

Usage | Returns |
---|---|

`MultiPolygon.getInfo(` | 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, ` | 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 |

## ee.Geometry.MultiPolygon.intersects

Returns true iff the geometries intersect.

Usage | Returns |
---|---|

`MultiPolygon.intersects(right, ` | 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 |

## 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

Usage | Returns |
---|---|

`MultiPolygon.length(` | 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 |

## ee.Geometry.MultiPolygon.perimeter

Usage | Returns |
---|---|

`MultiPolygon.perimeter(` | 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 |

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

`legacy` | Boolean, optional | Enables legacy format. |

## ee.Geometry.MultiPolygon.simplify

Usage | Returns |
---|---|

`MultiPolygon.simplify(maxError, ` | 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 |

## ee.Geometry.MultiPolygon.symmetricDifference

Returns the symmetric difference between two geometries.

Usage | Returns |
---|---|

`MultiPolygon.symmetricDifference(right, ` | 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 |

## 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(` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry to reproject. |

`proj` | Projection, optional | |

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

## ee.Geometry.MultiPolygon.withinDistance

Returns true iff the geometries are within a specified distance.

Usage | Returns |
---|---|

`MultiPolygon.withinDistance(right, distance, ` | 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 | |

`maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |

`proj` | Projection, default: null |

## 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, ` | 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

Usage | Returns |
---|---|

`Point.area(` | 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 |

## ee.Geometry.Point.aside

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(` | 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

Usage | Returns |
---|---|

`Point.buffer(distance, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry being buffered. |

`distance` | Float | |

`maxError` | ErrorMargin, default: null | |

`proj` | Projection, default: null |

## ee.Geometry.Point.centroid

Usage | Returns |
---|---|

`Point.centroid(` | 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, ` | 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 |

## ee.Geometry.Point.contains

Returns true iff one geometry contains the other.

Usage | Returns |
---|---|

`Point.contains(right, ` | 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 |

## ee.Geometry.Point.convexHull

Usage | Returns |
---|---|

`Point.convexHull(` | 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 |

## 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

Usage | Returns |
---|---|

`Point.cutLines(distances, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | Cuts the lines of this geometry. |

`distances` | List | |

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

## ee.Geometry.Point.disjoint

Returns true iff the geometries are disjoint.

Usage | Returns |
---|---|

`Point.disjoint(right, ` | 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 |

## ee.Geometry.Point.dissolve

Usage | Returns |
---|---|

`Point.dissolve(` | 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 |

## ee.Geometry.Point.distance

Returns the minimum distance between two geometries.

Usage | Returns |
---|---|

`Point.distance(right, ` | 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 |

## ee.Geometry.Point.edgesAreGeodesics

Usage | Returns |
---|---|

`Point.edgesAreGeodesics()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.Point.evaluate

Usage | Returns |
---|---|

`Point.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.Geometry.Point.geodesic

Usage | Returns |
---|---|

`Point.geodesic()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.Point.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.

Returns the computed value of this object.

Usage | Returns |
---|---|

`Point.getInfo(` | 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, ` | 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 |

## ee.Geometry.Point.intersects

Returns true iff the geometries intersect.

Usage | Returns |
---|---|

`Point.intersects(right, ` | 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 |

## 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

Usage | Returns |
---|---|

`Point.length(` | 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 |

## ee.Geometry.Point.perimeter

Usage | Returns |
---|---|

`Point.perimeter(` | 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 |

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

`legacy` | Boolean, optional | Enables legacy format. |

## ee.Geometry.Point.simplify

Usage | Returns |
---|---|

`Point.simplify(maxError, ` | 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 |

## ee.Geometry.Point.symmetricDifference

Returns the symmetric difference between two geometries.

Usage | Returns |
---|---|

`Point.symmetricDifference(right, ` | 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 |

## 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(` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry to reproject. |

`proj` | Projection, optional | |

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

## ee.Geometry.Point.withinDistance

Returns true iff the geometries are within a specified distance.

Usage | Returns |
---|---|

`Point.withinDistance(right, distance, ` | 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 | |

`maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |

`proj` | Projection, default: null |

## 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, ` | 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 | |

`maxError` | ErrorMargin, optional | |

`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

Usage | Returns |
---|---|

`Polygon.area(` | 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 |

## ee.Geometry.Polygon.aside

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(` | 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

Usage | Returns |
---|---|

`Polygon.buffer(distance, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry being buffered. |

`distance` | Float | |

`maxError` | ErrorMargin, default: null | |

`proj` | Projection, default: null |

## ee.Geometry.Polygon.centroid

Usage | Returns |
---|---|

`Polygon.centroid(` | 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, ` | 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 |

## ee.Geometry.Polygon.contains

Returns true iff one geometry contains the other.

Usage | Returns |
---|---|

`Polygon.contains(right, ` | 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 |

## ee.Geometry.Polygon.convexHull

Usage | Returns |
---|---|

`Polygon.convexHull(` | 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 |

## 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

Usage | Returns |
---|---|

`Polygon.cutLines(distances, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | Cuts the lines of this geometry. |

`distances` | List | |

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

## ee.Geometry.Polygon.disjoint

Returns true iff the geometries are disjoint.

Usage | Returns |
---|---|

`Polygon.disjoint(right, ` | 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 |

## ee.Geometry.Polygon.dissolve

Usage | Returns |
---|---|

`Polygon.dissolve(` | 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 |

## ee.Geometry.Polygon.distance

Returns the minimum distance between two geometries.

Usage | Returns |
---|---|

`Polygon.distance(right, ` | 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 |

## ee.Geometry.Polygon.edgesAreGeodesics

Usage | Returns |
---|---|

`Polygon.edgesAreGeodesics()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.Polygon.evaluate

Usage | Returns |
---|---|

`Polygon.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.Geometry.Polygon.geodesic

Usage | Returns |
---|---|

`Polygon.geodesic()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.Polygon.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.

Returns the computed value of this object.

Usage | Returns |
---|---|

`Polygon.getInfo(` | 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, ` | 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 |

## ee.Geometry.Polygon.intersects

Returns true iff the geometries intersect.

Usage | Returns |
---|---|

`Polygon.intersects(right, ` | 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 |

## 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

Usage | Returns |
---|---|

`Polygon.length(` | 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 |

## ee.Geometry.Polygon.perimeter

Usage | Returns |
---|---|

`Polygon.perimeter(` | 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 |

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

`legacy` | Boolean, optional | Enables legacy format. |

## ee.Geometry.Polygon.simplify

Usage | Returns |
---|---|

`Polygon.simplify(maxError, ` | 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 |

## ee.Geometry.Polygon.symmetricDifference

Returns the symmetric difference between two geometries.

Usage | Returns |
---|---|

`Polygon.symmetricDifference(right, ` | 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 |

## 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(` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry to reproject. |

`proj` | Projection, optional | |

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

## ee.Geometry.Polygon.withinDistance

Returns true iff the geometries are within a specified distance.

Usage | Returns |
---|---|

`Polygon.withinDistance(right, distance, ` | 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 | |

`maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |

`proj` | Projection, default: null |

## 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, ` | 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 | |

`geodesic` | Boolean, optional | |

`evenOdd` | Boolean, optional |

## ee.Geometry.Rectangle.area

Usage | Returns |
---|---|

`Rectangle.area(` | 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 |

## ee.Geometry.Rectangle.aside

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(` | 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

Usage | Returns |
---|---|

`Rectangle.buffer(distance, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry being buffered. |

`distance` | Float | |

`maxError` | ErrorMargin, default: null | |

`proj` | Projection, default: null |

## ee.Geometry.Rectangle.centroid

Usage | Returns |
---|---|

`Rectangle.centroid(` | 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, ` | 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 |

## ee.Geometry.Rectangle.contains

Returns true iff one geometry contains the other.

Usage | Returns |
---|---|

`Rectangle.contains(right, ` | 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 |

## ee.Geometry.Rectangle.convexHull

Usage | Returns |
---|---|

`Rectangle.convexHull(` | 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 |

## 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

Usage | Returns |
---|---|

`Rectangle.cutLines(distances, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | Cuts the lines of this geometry. |

`distances` | List | |

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

## ee.Geometry.Rectangle.disjoint

Returns true iff the geometries are disjoint.

Usage | Returns |
---|---|

`Rectangle.disjoint(right, ` | 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 |

## ee.Geometry.Rectangle.dissolve

Usage | Returns |
---|---|

`Rectangle.dissolve(` | 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 |

## ee.Geometry.Rectangle.distance

Returns the minimum distance between two geometries.

Usage | Returns |
---|---|

`Rectangle.distance(right, ` | 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 |

## ee.Geometry.Rectangle.edgesAreGeodesics

Usage | Returns |
---|---|

`Rectangle.edgesAreGeodesics()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.Rectangle.evaluate

Usage | Returns |
---|---|

`Rectangle.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.Geometry.Rectangle.geodesic

Usage | Returns |
---|---|

`Rectangle.geodesic()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.Rectangle.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.

Returns the computed value of this object.

Usage | Returns |
---|---|

`Rectangle.getInfo(` | 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, ` | 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 |

## ee.Geometry.Rectangle.intersects

Returns true iff the geometries intersect.

Usage | Returns |
---|---|

`Rectangle.intersects(right, ` | 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 |

## 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

Usage | Returns |
---|---|

`Rectangle.length(` | 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 |

## ee.Geometry.Rectangle.perimeter

Usage | Returns |
---|---|

`Rectangle.perimeter(` | 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 |

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

`legacy` | Boolean, optional | Enables legacy format. |

## ee.Geometry.Rectangle.simplify

Usage | Returns |
---|---|

`Rectangle.simplify(maxError, ` | 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 |

## ee.Geometry.Rectangle.symmetricDifference

Returns the symmetric difference between two geometries.

Usage | Returns |
---|---|

`Rectangle.symmetricDifference(right, ` | 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 |

## 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(` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry to reproject. |

`proj` | Projection, optional | |

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

## ee.Geometry.Rectangle.withinDistance

Returns true iff the geometries are within a specified distance.

Usage | Returns |
---|---|

`Rectangle.withinDistance(right, distance, ` | 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 | |

`maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |

`proj` | Projection, default: null |

## ee.Geometry.area

Usage | Returns |
---|---|

`Geometry.area(` | 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 |

## ee.Geometry.aside

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(` | 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

Usage | Returns |
---|---|

`Geometry.buffer(distance, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry being buffered. |

`distance` | Float | |

`maxError` | ErrorMargin, default: null | |

`proj` | Projection, default: null |

## ee.Geometry.centroid

Usage | Returns |
---|---|

`Geometry.centroid(` | 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, ` | 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 |

## ee.Geometry.contains

Returns true iff one geometry contains the other.

Usage | Returns |
---|---|

`Geometry.contains(right, ` | 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 |

## ee.Geometry.convexHull

Usage | Returns |
---|---|

`Geometry.convexHull(` | 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 |

## 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

Usage | Returns |
---|---|

`Geometry.cutLines(distances, ` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | Cuts the lines of this geometry. |

`distances` | List | |

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

## ee.Geometry.disjoint

Returns true iff the geometries are disjoint.

Usage | Returns |
---|---|

`Geometry.disjoint(right, ` | 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 |

## ee.Geometry.dissolve

Usage | Returns |
---|---|

`Geometry.dissolve(` | 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 |

## ee.Geometry.distance

Returns the minimum distance between two geometries.

Usage | Returns |
---|---|

`Geometry.distance(right, ` | 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 |

## ee.Geometry.edgesAreGeodesics

Usage | Returns |
---|---|

`Geometry.edgesAreGeodesics()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.evaluate

Usage | Returns |
---|---|

`Geometry.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.Geometry.geodesic

Usage | Returns |
---|---|

`Geometry.geodesic()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.geometries

Usage | Returns |
---|---|

`Geometry.geometries()` | List |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.getInfo

Retrieves the value of this object from the server.

Returns the computed value of this object.

Usage | Returns |
---|---|

`Geometry.getInfo(` | 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, ` | 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 |

## ee.Geometry.intersects

Returns true iff the geometries intersect.

Usage | Returns |
---|---|

`Geometry.intersects(right, ` | 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 |

## ee.Geometry.isUnbounded

Returns whether the geometry is unbounded.

Usage | Returns |
---|---|

`Geometry.isUnbounded()` | Boolean |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry |

## ee.Geometry.length

Usage | Returns |
---|---|

`Geometry.length(` | 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 |

## ee.Geometry.perimeter

Usage | Returns |
---|---|

`Geometry.perimeter(` | 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 |

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

`legacy` | Boolean, optional | Enables legacy format. |

## ee.Geometry.simplify

Usage | Returns |
---|---|

`Geometry.simplify(maxError, ` | 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 |

## ee.Geometry.symmetricDifference

Returns the symmetric difference between two geometries.

Usage | Returns |
---|---|

`Geometry.symmetricDifference(right, ` | 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 |

## 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(` | Geometry |

Argument | Type | Details |
---|---|---|

this: `geometry` | Geometry | The geometry to reproject. |

`proj` | Projection, optional | |

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

## ee.Geometry.withinDistance

Returns true iff the geometries are within a specified distance.

Usage | Returns |
---|---|

`Geometry.withinDistance(right, distance, ` | 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 | |

`maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |

`proj` | Projection, default: null |

## 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 ee.Array: 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(` | 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, ` | 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, ` | 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.arrayArgmax

Computes the positional indices of the maximum value in image of array values. If there are multiple occurrences of the maximum, the indices reflect the first.

Usage | Returns |
---|---|

`Image.arrayArgmax()` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The input image. |

## 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, ` | 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-valued pixel is masked with another array-valued pixel, retaining only the elements where the mask 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.arrayPad

Pads the array values in each pixel to be a fixed length. The pad value will be appended to each array to extend it to given length along each axis. All bands of the image must be array-valued and have the same dimensions.

Usage | Returns |
---|---|

`Image.arrayPad(lengths, ` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | Array image to pad. |

`lengths` | List | A list of desired lengths for each axis in the output arrays. Arrays are already as large or larger than the given length will be unchanged along that axis |

`pad` | Number, default: 0 | The value to pad 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, ` | 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.arrayReshape

Converts array bands of an image with equally-shaped, possibly multidimensional pixels to an image of arrays with a new shape.

Usage | Returns |
---|---|

`Image.arrayReshape(lengths, dimensions)` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The image of arrays to reshape. |

`lengths` | Image | A 1 band image specifying the new lengths of each axis of the input image specified as a 1-D array per pixel. There should be 'dimensions' lengths values in each shape' array. If one of the lengths is -1, then the corresponding length for that axis will be computed such that the total size remains constant. In particular, a shape of [-1] flattens into 1-D. At most one component of shape can be -1. |

`dimensions` | Integer | The number of dimensions shared by all output array pixels. |

## 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(` | 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(` | 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(` | 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

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, ` | 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, ` | 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` | Classifier | The classifier to use. |

`outputName` | String, default: "classification" | The name of the band to be added. If the classifier produces more than 1 output, this name is ignored. |

## 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.clipToBoundsAndScale

Clips an image to the bounds of a Geometry, and scales the clipped image to a particular size or scale.

Usage | Returns |
---|---|

`Image.clipToBoundsAndScale(` | Image |

Argument | Type | Details |
---|---|---|

this: `input` | Image | The image to clip and scale. |

`geometry` | Geometry, default: null | The Geometry to clip the image to. The image will be clipped to the bounding box, in the image's projection, of this geometry. |

`width` | Integer, default: null | The width to scale the image to, in pixels. Must be provided along with "height". Exclusive with "maxDimension" and "scale". |

`height` | Integer, default: null | The height to scale the image to, in pixels. Must be provided along with "width". Exclusive with "maxDimension" and "scale". |

`maxDimension` | Integer, default: null | The maximum dimension to scale the image to, in pixels. Exclusive with "width", "height" and "scale". |

`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 image's projection. Exclusive with "width", "height" and "maxDimension". |

## 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, ` | 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(` | 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, ` | 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.

For each band of the input image, the output image will have two bands named with the suffixes '_x' and '_y', containing the respective derivatives.

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

For each zero-valued pixel in the source, get the distance to the nearest non-zero pixels in the given direction.

Returns a band of floating point distances called "distance".

Usage | Returns |
---|---|

`Image.directionalDistanceTransform(angle, maxDistance, ` | Image |

Argument | Type | Details |
---|---|---|

this: `source` | Image | The source image. |

`angle` | Float | The angle, in degrees, at which to search for non-zero pixels. |

`maxDistance` | Integer | The maximum distance, in pixels, over which to search. |

`labelBand` | String, default: null | If provided, multi-band inputs are permitted and only this band is used for searching. All other bands are returned and populated with the per-band values found at the searched non-zero pixels in the label band. |

## ee.Image.displace

Warps an image using an image of displacements.

Usage | Returns |
---|---|

`Image.displace(displacement, ` | 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.

Usage | Returns |
---|---|

`Image.displacement(referenceImage, maxOffset, ` | 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. |

`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(` | 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

Usage | Returns |
---|---|

`Image.evaluate(callback)` |

Argument | Type | Details |
---|---|---|

this: `computedobject` | ComputedObject | The ComputedObject instance. |

`callback` | Function |

## ee.Image.exp

Computes the Euler's number e raised to the power of the input.

Usage | Returns |
---|---|

`Image.exp()` | Image |

Argument | Type | Details |
---|---|---|

this: `value` | Image | The image to which the operation is applied. |

## ee.Image.expression

Evaluates an arithmetic expression on an image, possibly involving additional images.

The bands of the primary input image are available using the built-in function b(), as b(0) or b('band_name').

Variables in the expression are interpreted as additional image parameters which must be supplied in opt_map. The bands of each such image can be accessed like image.band_name or image[0].

Both b() and image[] allow multiple arguments, to specify multiple bands, such as b(1, 'name', 3). Calling b() with no arguments, or using a variable by itself, returns all bands of the image.

If the result of an expression is a single band, it can be assigned a name using the '=' operator (e.g.: x = a + b).

Returns the image computed by the provided expression.

Usage | Returns |
---|---|

`Image.expression(expression, ` | 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(` | 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.

Usage | Returns |
---|---|

`Image.focal_max(` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The image to which to apply the operations. |

`radius` | Float, default: 1.5 | The radius of the kernel to use. |

`kernelType` | String, default: "circle" | The type of kernel to use. Options include: 'circle', 'square', 'cross', 'plus', octagon' and 'diamond'. |

`units` | String, default: "pixels" | 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.focal_mean

Applies a morphological mean filter to each band of an image using a named or custom kernel.

Usage | Returns |
---|---|

`Image.focal_mean(` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The image to which to apply the operations. |

`radius` | Float, default: 1.5 | The radius of the kernel to use. |

`kernelType` | String, default: "circle" | The type of kernel to use. Options include: 'circle', 'square', 'cross', 'plus', octagon' and 'diamond'. |

`units` | String, default: "pixels" | 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.focal_median

Applies a morphological reducer() filter to each band of an image using a named or custom kernel.

Usage | Returns |
---|---|

`Image.focal_median(` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The image to which to apply the operations. |

`radius` | Float, default: 1.5 | The radius of the kernel to use. |

`kernelType` | String, default: "circle" | The type of kernel to use. Options include: 'circle', 'square', 'cross', 'plus', octagon' and 'diamond'. |

`units` | String, default: "pixels" | 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.focal_min

Applies a morphological reducer() filter to each band of an image using a named or custom kernel.

Usage | Returns |
---|---|

`Image.focal_min(` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The image to which to apply the operations. |

`radius` | Float, default: 1.5 | The radius of the kernel to use. |

`kernelType` | String, default: "circle" | |

`units` | String, default: "pixels" | 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.focal_mode

Applies a morphological reducer() filter to each band of an image using a named or custom kernel.

Usage | Returns |
---|---|

`Image.focal_mode(` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The image to which to apply the operations. |

`radius` | Float, default: 1.5 | The radius of the kernel to use. |

`kernelType` | String, default: "circle" | |

`units` | String, default: "pixels" | 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.getArray

Extract a property from a feature.

Usage | Returns |
---|---|

`Image.getArray(property)` | Array |

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 for the image, which always downloads a zipped GeoTIFF. Use getThumbURL for other file formats like PNG, JPG, or raw GeoTIFF.

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

Usage | Returns |
---|---|

`Image.getDownloadURL(params, ` | 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 an array 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 array of 6 numbers specifying an affine transform from the specified CRS, in row-major order: [xScale, xShearing, xTranslation, yShearing, yScale, yTranslation] + dimensions: an optional array 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. - filePerBand: Whether to produce a different GeoTIFF per band (boolean). Defaults to true. If false, a single GeoTIFF is produced and all band-level transformations will be ignored. |

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

- properties - a dictionary containing the image's metadata properties.

Usage | Returns |
---|---|

`Image.getInfo(` | ImageDescription |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The Image 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.Image.getMap

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

Returns an object which may be passed to ee.data.getTileUrl or ui.Map.addLayer. Undefined if a callback was specified.

Usage | Returns |
---|---|

`Image.getMap(` | 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.getNumber

Extract a property from a feature.

Usage | Returns |
---|---|

`Image.getNumber(property)` | Number |

Argument | Type | Details |
---|---|---|

this: `object` | Element | The feature to extract the property from. |

`property` | String | The property to extract. |

## ee.Image.getString

Extract a property from a feature.

Usage | Returns |
---|---|

`Image.getString(property)` | String |

Argument | Type | Details |
---|---|---|

this: `object` | Element | The feature to extract the property from. |

`property` | String | The property to extract. |

## ee.Image.getThumbId

Applies transformations and returns the thumbId.

Returns the thumb ID and optional token, or null if a callback is specified.

Usage | Returns |
---|---|

`Image.getThumbId(params, ` | ThumbnailId |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The Image instance. |

`params` | Object | Parameters identical to ee.data.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 Geospatial region of the image to render, it may be an ee.Geometry, GeoJSON, or an array of lat/lon points (E,S,W,N). If not set the default is the bounds image. |

`callback` | Function, optional | An optional 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, ` | Object|String |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The Image instance. |

`params` | Object | Parameters identical to ee.data.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 Geospatial region of the image to render, it may be an ee.Geometry, GeoJSON, or an array of lat/lon points (E,S,W,N). If not set the default is the bounds 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. The GLCM is a tabulation of how often different combinations of pixel brightness values (grey levels) occur in an image. It counts the number of times a pixel of value X lies next to a pixel of value Y, in a particular direction and distance. and then derives statistics from this tabulation.

This implementation computes the 14 GLCM metrics proposed by Haralick, and 4 additional metrics from Conners. Inputs are required to be integer valued.

The output consists of 18 bands per input band if directional averaging is on and 18 bands per directional pair in the kernel, if not:

ASM: f1, Angular Second Moment; measures the number of repeated pairs

CONTRAST: f2, Contrast; measures the local contrast of an image

CORR: f3, Correlation; measures the correlation between pairs of pixels

VAR: f4, Variance; measures how spread out the distribution of gray-levels is

IDM: f5, Inverse Difference Moment; measures the homogeneity

SAVG: f6, Sum Average

SVAR: f7, Sum Variance

SENT: f8, Sum Entropy

ENT: f9, Entropy. Measures the randomness of a gray-level distribution

DVAR: f10, Difference variance

DENT: f11, Difference entropy

IMCORR1: f12, Information Measure of Corr. 1

IMCORR2: f13, Information Measure of Corr. 2

MAXCORR: f14, Max Corr. Coefficient. (not computed)

DISS: Dissimilarity

INERTIA: Inertia

SHADE: Cluster Shade

PROM: Cluster prominence

More information can be found in the two papers: Haralick et. al, 'Textural Features for Image Classification', http://doi.org/10.1109/TSMC.1973.4309314 and Conners, et al, Segmentation of a high-resolution urban scene using texture operators', http://doi.org/10.1016/0734-189X(84)90197-X.

Usage | Returns |
---|---|

`Image.glcmTexture(` | 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.hersDescriptor

Creates a dictionary of Histogram Error Ring Statistic (HERS) descriptor arrays from square array properties of an element. The HERS radius is taken to be the array's (side_length - 1) / 2.

Usage | Returns |
---|---|

`Image.hersDescriptor(` | Dictionary |

Argument | Type | Details |
---|---|---|

this: `element` | Element | The element with array properties. |

`selectors` | List, default: null | The array properties for which descriptors will be created. Selected array properties must be square, floating point arrays. Defaults to all array properties. |

`buckets` | Integer, default: 100 | The number of HERS buckets. Defaults to 100. |

`peakWidthScale` | Float, default: 1 | The HERS peak width scale. Defaults to 1.0. |

## ee.Image.hersFeature

Computes the Histogram Error Ring Statistic (HERS) for each pixel in each band matching the keys in the descriptor. Only the bands for which HERS could be computed are returned.

Usage | Returns |
---|---|

`Image.hersFeature(reference, ` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The input image. |

`reference` | Dictionary | The reference descriptor computed with ee.Feature.hersDescriptor(...). |

`peakWidthScale` | Float, default: 1 | The HERS peak width scale. |

## ee.Image.hersImage

Computes the Histogram Error Ring Statistic (HERS) for each pair of pixels in each band present in both images. Only the bands for which HERS could be computed are returned.

Usage | Returns |
---|---|

`Image.hersImage(image2, radius, ` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The input image. |

`image2` | Image | The image to compare. |

`radius` | Integer | The radius of the window. |

`buckets` | Integer, default: 100 | The number of HERS buckets. |

`peakWidthScale` | Float, default: 1 | The HERS peak width scale. |

## ee.Image.hsvToRgb

Transforms the image from the HSV color space to the RGB color space. Expects a 3 band image in the range [0, 1], and produces three bands: red, green and blue with 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, ` | 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, ` | 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.loadGeoTIFF

Loads a GeoTIFF as an Image.

Usage | Returns |
---|---|

`ee.Image.loadGeoTIFF(uri)` | Image |

Argument | Type | Details |
---|---|---|

`uri` | String | The Cloud Storage URI of the GeoTIFF to load. |

## 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(` | 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(` | 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(` | 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, ` | 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.neighborhoodToArray

Turns the neighborhood of each pixel in a scalar image into a 2D array. Axes 0 and 1 of the output array correspond to Y and X axes of the image, respectively. The output image will have as many bands as the input; each output band has the same mask as the corresponding input band. The footprint and metadata of the input image are preserved.

Usage | Returns |
---|---|

`Image.neighborhoodToArray(kernel, ` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The image to get pixels from; must be scalar-valued. |

`kernel` | Kernel | The kernel specifying the shape of the neighborhood. Only fixed, square and rectangle kernels are supported. Weights are ignored; only the shape of the kernel is used. |

`defaultValue` | Float, default: 0 | The value to use in the output arrays to replace the invalid (masked) pixels of the input. If the band type is integral, the fractional part of this value is discarded; in all cases, the value is clamped to the value range of the band. |

## 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). Note that negative input values are forced to 0 so that the result is confined to the range (-1, 1).

Usage | Returns |
---|---|

`Image.normalizedDifference(` | 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, ` | 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. The returned image has a single band called "area."

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

## ee.Image.pixelLonLat

Creates an image with two bands named 'longitude' and 'latitude', 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 random number at each pixel location. When using the 'uniform' distribution, outputs are in the range of [0 to 1). Using the 'normal' distribution, the outputs have μ=0, 𝛔=1, but no explicit limits.

Usage | Returns |
---|---|

`ee.Image.random(` | Image |

Argument | Type | Details |
---|---|---|

`seed` | Long, default: 0 | Seed for the random number generator. |

`distribution` | String, default: "uniform" | The distribution type of random numbers to produce. One of 'uniform' or 'normal'. |

## 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 contain 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.reduceConnectedComponents

Applies a reducer to all of the pixels inside of each 'object'. Pixels are considered to belong to an object if they are connected (8-way) and have the same value in the 'label' band. The label band is only used to identify the connectedness; the rest are provided as inputs to the reducer.

Usage | Returns |
---|---|

`Image.reduceConnectedComponents(reducer, ` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The input image. |

`reducer` | Reducer | The reducer to apply to pixels within the connected component. |

`labelBand` | String, default: null | The name of the band to use to detect connectedness. If unspecified, the first band is used. |

`maxSize` | Integer, default: 256 | Size of the neighborhood to consider when aggregating values. Any objects larger than maxSize in either the horizontal or vertical dimension will be masked, since portions of the object might be outside of the neighborhood. |

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

Usage | Returns |
---|---|

`Image.reduceNeighborhood(reducer, kernel, ` | Image |

Argument | Type | Details |
---|---|---|

this: `image` | Image | The input image. |

`reducer` | Reducer | The reducer to apply to pixels within the neighborhood. |

`kernel` | Kernel | The kernel defining the neighborhood. |

`inputWeight` < |