geedim.mask.MaskedImage.export

MaskedImage.export(filename: str, type: ExportType = ExportType.drive, folder: str = None, wait: bool = True, **kwargs) → Task

Export the encapsulated image to Google Drive, Earth Engine asset or Google Cloud Storage.

Export bounds and resolution can be specified with region and scale / shape, or crs_transform and shape. If no bounds are specified (with either region, or crs_transform & shape), the entire image granule is exported.

When crs, scale, crs_transform & shape are not specified, the pixel grid of the exported image will coincide with that of the encapsulated image.

Parameters:

  • filename (str) – Name of the export task, and destination file or asset name.

  • type (ExportType, optional) – Export type.

  • folder (str, optional) – Google Drive folder (when type is drive), Earth Engine asset project (when type is asset), or Google Cloud Storage bucket (when type is cloud), to export to. If type is asset and folder is not specified, filename should be a valid Earth Engine asset ID.

  • wait (bool) – Wait for the export to complete before returning.

  • crs (str, optional) – WKT or EPSG specification of CRS to export to. Where image bands have different CRSs, all are re-projected to this CRS. Defaults to use the CRS of the minimum scale band if available.

  • crs_transform (tuple of float, list of float, rio.Affine, optional) – List of 6 numbers specifying an affine transform in the specified CRS. In row-major order: [xScale, xShearing, xTranslation, yShearing, yScale, yTranslation]. All bands are re-projected to this transform.

  • shape (tuple of int, optional) – (height, width) dimensions to export (pixels).

  • region (dict, geojson, ee.Geometry, optional) – Region of interest (WGS84) to export. Defaults to the image footprint, when available.

  • scale (float, optional) – Pixel scale (m) to export to. Where image bands have different scales, all are re-projected to this scale. Ignored if crs and crs_transform are specified. Defaults to use the minimum scale of image bands if available.

  • resampling (ResamplingMethod, optional) – Resampling method - see ResamplingMethod for available options.

  • dtype (str, optional) – Convert to this data type (uint8, int8, uint16, int16, uint32, int32, float32 or float64). Defaults to auto select a minimal type that can represent the range of pixel values.

  • scale_offset (bool, optional) – Whether to apply any EE band scales and offsets to the image.

  • bands (list of str, optional) – List of band names to export.

Returns:

The Earth Engine export task, started if wait is False, or completed if wait is True.

Return type:

ee.batch.Task