Creates a batch task to export an Image as a raster to Drive. Tasks can be started from the Tasks tab. "crsTransform", "scale", and "dimensions" are mutually exclusive.
| Usage | Returns |
|---|---|
Export.image.toDrive(image, description, folder, fileNamePrefix, dimensions, region, scale, crs, crsTransform, maxPixels, shardSize, fileDimensions, skipEmptyTiles, fileFormat, formatOptions) |
| Argument | Type | Details |
|---|---|---|
image | Image | The image to export. |
description | String, optional | A human-readable name of the task. May contain letters, numbers, -, _ (no spaces). Defaults to "myExportImageTask". |
folder | String, optional | The Google Drive Folder that the export will reside in. Note: (a) if the folder name exists at any level, the output is written to it, (b) if duplicate folder names exist, output is written to the most recently modified folder, (c) if the folder name does not exist, a new folder will be created at the root, and (d) folder names with separators (e.g. 'path/to/file') are interpreted as literal strings, not system paths. Defaults to Drive root. |
fileNamePrefix | String, optional | The filename prefix. May contain letters, numbers, -, _ (no spaces). Defaults to the description. |
dimensions | Number|String, optional | The dimensions to use for the exported image. Takes either a single positive integer as the maximum dimension or "WIDTHxHEIGHT" where WIDTH and HEIGHT are each positive integers. |
region | Geometry.LinearRing|Geometry.Polygon|String, optional | A LinearRing, Polygon, or coordinates representing region to export. These may be specified as the Geometry objects or coordinates serialized as a string. If not specified, the region defaults to the viewport at the time of invocation. |
scale | Number, optional | Resolution in meters per pixel. Defaults to 1000. |
crs | String, optional | CRS to use for the exported image. |
crsTransform | List, optional | Affine transform to use for the exported image. Requires "crs" to be defined. |
maxPixels | Number, optional | Restrict the number of pixels in the export. By default, you will see an error if the export exceeds 1e8 pixels. Setting this value explicitly allows one to raise or lower this limit. |
shardSize | Number, optional | Size in pixels of the tiles in which this image will be computed. Defaults to 256. |
fileDimensions | List, optional | The dimensions in pixels of each image file, if the image is too large to fit in a single file. May specify a single number to indicate a square shape, or an array of two dimensions to indicate (width,height). Note that the image will still be clipped to the overall image dimensions. Must be a multiple of shardSize. |
skipEmptyTiles | Boolean, optional | If true, skip writing empty (i.e. fully-masked) image tiles. Defaults to false. |
fileFormat | String, optional | The string file format to which the image is exported. Currently only 'GeoTIFF' and 'TFRecord' are supported, defaults to 'GeoTIFF'. |
formatOptions | ImageExportFormatConfig, optional | A dictionary of string keys to format specific options. |