Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
Method: projects.image.computePixels
Stay organized with collections
Save and categorize content based on your preferences.
Computes a tile of pixels by performing an arbitrary computation on image data.
Requests are limited to 48MB in uncompressed data per request, computed as the product of the request dimensions in pixels, the number of image bands requested, and the number of bytes per pixel for each band. Requests are also limited to at most 32K pixels in either dimension and at most 1024 bands. Requests exceeding these limits will result in an error code of 400 (BAD_REQUEST).
If successful, the response body contains the requested pixel data in the encoding specified in the fileFormat field of the request.
HTTP request
POST https://earthengine.googleapis.com/v1/{project=projects/*}/image:computePixels
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
project |
string
The project id or project number of the Google Cloud Platform project that should be treated as the service consumer for this request. Format is projects/{project-id}.
Authorization requires the following IAM permission on the specified resource project:
earthengine.computations.create
|
Request body
The request body contains data with the following structure:
| Fields |
expression |
object (Expression)
The expression to compute.
|
fileFormat |
enum (ImageFileFormat)
The output file format in which to return the pixel values.
|
grid |
object (PixelGrid)
Parameters describing how the image computed by expression should be reprojected and clipped. If not present, the full computed image is returned in its native projection.
|
bandIds[] |
string
If present, specifies a specific set of bands that will be selected from the result of evaluating expression. If not present, all bands resulting from expression will be selected.
|
visualizationOptions |
object (VisualizationOptions)
If present, a set of visualization options to apply to produce an 8-bit RGB visualization of the data.
|
workloadTag |
string
User supplied tag to track this computation.
|
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
Authorization scopes
Requires one of the following OAuth scopes:
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
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-06 UTC.
[null,null,["Last updated 2025-03-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eimage:computePixels\u003c/code\u003e method computes a tile of pixels by performing an arbitrary computation on image data provided as an expression.\u003c/p\u003e\n"],["\u003cp\u003eRequest size is limited to 48MB of uncompressed data, 32K pixels in each dimension, and 1024 bands, with exceeding requests resulting in a 400 (BAD_REQUEST) error.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses contain the requested pixel data in the specified file format.\u003c/p\u003e\n"],["\u003cp\u003eUsers can customize output through parameters like \u003ccode\u003efileFormat\u003c/code\u003e, \u003ccode\u003egrid\u003c/code\u003e, \u003ccode\u003ebandIds\u003c/code\u003e, and \u003ccode\u003evisualizationOptions\u003c/code\u003e to control the data format, projection, bands selection, and visualization, respectively.\u003c/p\u003e\n"],["\u003cp\u003eProper authorization with specific OAuth scopes, such as \u003ccode\u003ehttps://www.googleapis.com/auth/earthengine\u003c/code\u003e, is required for accessing this API.\u003c/p\u003e\n"]]],["This content details the process of computing a tile of pixels from image data via a `POST` request to `https://earthengine.googleapis.com/v1/{project=projects/*}/image:computePixels`. Requests specify an `expression`, `fileFormat`, `grid`, optional `bandIds`, `visualizationOptions`, and a `workloadTag`. The request is limited to 48MB of uncompressed data, 32K pixels per dimension, and 1024 bands. Successful responses return requested pixel data in the specified format, with various authorization scopes available.\n"],null,["# Method: projects.image.computePixels\n\nComputes a tile of pixels by performing an arbitrary computation on image data.\n\nRequests are limited to 48MB in uncompressed data per request, computed as the product of the request dimensions in pixels, the number of image bands requested, and the number of bytes per pixel for each band. Requests are also limited to at most 32K pixels in either dimension and at most 1024 bands. Requests exceeding these limits will result in an error code of 400 (BAD_REQUEST).\n\nIf successful, the response body contains the requested pixel data in the encoding specified in the `fileFormat` field of the request.\n\n### HTTP request\n\n`POST https://earthengine.googleapis.com/v1/{project=projects/*}/image:computePixels`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `project` | `string` The project id or project number of the Google Cloud Platform project that should be treated as the service consumer for this request. Format is `projects/{project-id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `project`: - `earthengine.computations.create` |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"expression\": { object (/earth-engine/reference/rest/v1/Expression) }, \"fileFormat\": enum (/earth-engine/reference/rest/v1/ImageFileFormat), \"grid\": { object (/earth-engine/reference/rest/v1/PixelGrid) }, \"bandIds\": [ string ], \"visualizationOptions\": { object (/earth-engine/reference/rest/v1/VisualizationOptions) }, \"workloadTag\": string } ``` |\n\n| Fields ||\n|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `expression` | `object (`[Expression](/earth-engine/reference/rest/v1/Expression)`)` The expression to compute. |\n| `fileFormat` | `enum (`[ImageFileFormat](/earth-engine/reference/rest/v1/ImageFileFormat)`)` The output file format in which to return the pixel values. |\n| `grid` | `object (`[PixelGrid](/earth-engine/reference/rest/v1/PixelGrid)`)` Parameters describing how the image computed by `expression` should be reprojected and clipped. If not present, the full computed image is returned in its native projection. |\n| `bandIds[]` | `string` If present, specifies a specific set of bands that will be selected from the result of evaluating `expression`. If not present, all bands resulting from `expression` will be selected. |\n| `visualizationOptions` | `object (`[VisualizationOptions](/earth-engine/reference/rest/v1/VisualizationOptions)`)` If present, a set of visualization options to apply to produce an 8-bit RGB visualization of the data. |\n| `workloadTag` | `string` User supplied tag to track this computation. |\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/earthengine`\n- `\n https://www.googleapis.com/auth/earthengine.readonly`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/cloud-platform.read-only`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]