Method: projects.assets.getPixels

從圖片素材資源擷取像素。這個自訂方法可讓呼叫端要求圖片的任意像素圖塊,並可選擇指定頻帶和地圖投影。經過遮蓋或缺少的資料會編碼為零。

每項要求的未壓縮資料大小上限為 48 MB,計算方式為要求的像素尺寸、要求的圖像頻帶數量,以及每個頻帶的位元組數相乘。要求的大小也受到限制,每個維度的像素不得超過 32K,頻帶不得超過 1024 個。如果要求超出這些限制,就會傳回 400 (BAD_REQUEST) 錯誤代碼。

如果成功,回應主體會包含要求的像素資料,並以要求中 fileFormat 欄位指定的編碼方式呈現。

HTTP 要求

POST https://earthengine.googleapis.com/v1beta/{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 原型檔的 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