Method: projects.assets.getPixels

从图片素材资源提取像素。借助此自定义方法,调用方可以请求从图片中获取任意像素图块,并可选择指定波段和地图投影。经过脱敏处理或缺失的数据将编码为零。

每个请求的未压缩数据量限制为 48MB,计算方式为请求尺寸(以像素为单位)、请求的图像波段数以及每个波段的每个像素字节数的乘积。请求的任一尺寸不得超过 32K 像素,且不得超过 1024 个波段。超出这些限制的请求将导致错误代码为 400 (BAD_REQUEST)。

如果成功,响应正文将包含请求的像素数据,采用请求的 fileFormat 字段中指定的编码。

HTTP 请求

POST https://earthengine.googleapis.com/v1/{name=projects/*/assets/**}:getPixels

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要从中获取像素的图片素材资源的名称。name 的格式为“projects/*/assets/**”(例如“projects/earthengine-legacy/assets/users/[USER]/[ASSET]”)。所有用户拥有的资产都位于项目“earthengine-legacy”下(例如,“projects/earthengine-legacy/assets/users/foo/bar”)。所有其他资产均位于项目“earthengine-public”下(例如"projects/earthengine-public/assets/LANDSAT").

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • earthengine.assets.get

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "fileFormat": enum (ImageFileFormat),
  "grid": {
    object (PixelGrid)
  },
  "region": {
    object
  },
  "bandIds": [
    string
  ],
  "visualizationOptions": {
    object (VisualizationOptions)
  },
  "workloadTag": string
}
字段
fileFormat

enum (ImageFileFormat)

用于返回像素值的输出文件格式。

grid

object (PixelGrid)

用于描述要提取数据的像素网格的参数。默认为数据的原生像素网格。

region

object (Struct format)

要返回的数据区域(如果有),以 GeoJSON 几何图形对象的形式指定(请参阅 RFC 7946)。由于返回的图像始终是矩形,因此实际上会使用输出坐标系中给定几何图形的边界框。如果还指定了 grid.dimensions,则网格最终会按请求的大小重新缩放。

bandIds[]

string

如果存在,则指定要从中获取像素的一组特定波段。频段由 ID 标识,如 ImageBand proto 的 id 字段所示。

visualizationOptions

object (VisualizationOptions)

一组可视化选项(如果有),用于生成数据的 8 位 RGB 可视化图表,而不是返回原始数据。

workloadTag

string

用户提供的用于跟踪此计算的代码。

响应正文

如果成功,则响应为通用 HTTP 响应,其格式由方法定义。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/earthengine
  • https://www.googleapis.com/auth/earthengine.readonly
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

如需了解详情,请参阅 OAuth 2.0 Overview