ImageFileExportOptions

Options for exporting images as files outside Earth Engine.

JSON representation
{
  "fileFormat": enum (ImageFileFormat),

  // Union field destination can be only one of the following:
  "driveDestination": {
    object (DriveDestination)
  },
  "gcsDestination": {
    object (GcsDestination)
  }
  // End of list of possible types for union field destination.

  // Union field format_options can be only one of the following:
  "geoTiffOptions": {
    object (GeoTiffImageExportOptions)
  },
  "tfRecordOptions": {
    object (TfRecordImageExportOptions)
  }
  // End of list of possible types for union field format_options.
}
Fields
fileFormat

enum (ImageFileFormat)

The file format in which to export the image(s).

Union field destination. Where to write the results. destination can be only one of the following:
driveDestination

object (DriveDestination)

If specified, configures export to Google Drive.

gcsDestination

object (GcsDestination)

If specified, configures export to Google Cloud Storage.

Union field format_options. File-format-specific options. format_options can be only one of the following:
geoTiffOptions

object (GeoTiffImageExportOptions)

File-format-specific options for GEO_TIFF exports.

tfRecordOptions

object (TfRecordImageExportOptions)

File-format-specific options for TF_RECORD_IMAGE exports.

GeoTiffImageExportOptions

Options for encoding images as GeoTIFF files.

JSON representation
{
  "cloudOptimized": boolean,
  "tileDimensions": {
    object (GridDimensions)
  },
  "skipEmptyFiles": boolean
}
Fields
cloudOptimized

boolean

If true, generates 'cloud optimized' GeoTIFF files for more efficient access in cloud environments (see www.cogeo.org).

tileDimensions

object (GridDimensions)

Optional explicit dimensions in pixels into which to split the image if it is too large to fit in a single file.

skipEmptyFiles

boolean

If true, skip writing empty (i.e. fully-masked) image files.

TfRecordImageExportOptions

Options for encoding images as TFRecord files.

JSON representation
{
  "tileDimensions": {
    object (GridDimensions)
  },
  "marginDimensions": {
    object (GridDimensions)
  },
  "compress": boolean,
  "maxSizeBytes": string,
  "defaultValue": number,
  "tensorDepths": {
    string: number,
    ...
  },
  "sequenceData": boolean,
  "collapseBands": boolean,
  "maxMaskedRatio": number
}
Fields
tileDimensions

object (GridDimensions)

Dimensions tiled over the export area, covering every pixel in the bounding box exactly once (except when the patch dimensions do not evenly divide the bounding box in which case border tiles along the greatest x/y edges will be dropped). Dimensions must be > 0.

marginDimensions

object (GridDimensions)

If specified, tiles will be buffered by the margin dimensions both positively and negatively, resulting in overlap between neighboring patches.

compress

boolean

If true, compresses the .tfrecord files with gzip and appends the ".gz" suffix.

maxSizeBytes

string (Int64Value format)

Maximum size, in bytes, for an exported .tfrecord (before compression). A smaller file size will result in greater sharding (and, thus, more output files). Defaults to 1GiB.

defaultValue

number

The value set in each band of a pixel that is partially or completely masked, and, the value set at each value in an output 3D feature made from an array band where the array length at the source pixel was less than the depth of the feature value. The fractional part is dropped for integer type bands, and clamped to the range of the band type. Defaults to 0.

tensorDepths

map (key: string, value: number)

Mapping from the names of input array bands to the depth of the 3D tensors they create. Arrays will be truncated, or padded with default values to fit the shape specified. For each array band, this must have a corresponding entry.

sequenceData

boolean

If true, each pixel is output as a SequenceExample mapping scalar bands to the context and array bands to the example’s sequences. The SequenceExamples are output in row-major order of pixels in each patch, and then by row-major order of area patches in the file sequence.

collapseBands

boolean

If true, all bands will be combined into a single 3D tensor, taking on the name of the first band in the image. All bands are promoted to bytes, int64s, then floats in that order depending on the type furthest in that sequence within all bands. Array bands are allowed as long as tensorDepths is specified.

maxMaskedRatio

number

Maximum allowed proportion of masked pixels in a patch. Patches which exceed this allowance will be dropped rather than written to files. If this field is set to anything but 1, the JSON sidecar will not be produced. Defaults to 1.