Location-wise quantiles

Preview API

This endpoint is marked as a preview API. Preview APIs may be unstable within the preview period: they may change without notice. You must set the header API-Preview: opt-in to opt into using this endpoint.

An ensemble is an attribute where every location has multiple values. The location-wise quantiles task computes one or more quantiles of all the values at each location, and saves each quantile as a geoscience object attribute.

Parameters

• ensemble (geoscience object reference)
  • A geoscience object reference that points to a multi-dimensional continuous attribute inside a regular-3d-grid or regular-masked-3d-grid object. This is the ensemble you want to aggregate.
• target (geoscience object reference)
  • A geoscience object reference that tells the task where to save the result. It must point to a regular-3d-grid or regular-masked-3d-grid object. The task will save one attribute to that object for each quantile. It will name them like this: "Quantile: {quantile}".
• quantiles (array of numbers)
  • One or more quantiles that you want to calculate.

Example

Request

requests.post(
    "https://{hub}.api.seequent.com/compute/orgs/{org_id}/geostat/location-wise-quantiles",
    headers={"Authorization": "Bearer {token}"},
    json={
        "parameters": {
            "ensemble": {
                "type": "geoscience-object-reference",
                "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json",
                "object_element": [
                    {
                        "type": "element",
                        "path": "/cell_attributes/@name=my-ensemble",
                    },
                ],
            },
            "target": {
                "type": "geoscience-object-reference",
                "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json",
            },
            "quantiles": [0.25, 0.5, 0.75],
        },
    },
)

Result

{
    "message": "Location-wise ensemble calculation completed.",
    "object_modified": {
        "type": "geoscience-object-reference",
        "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json",
        "object_element": [
            {
                "type": "element",
                "path": "/cell_attributes/@name=Quantile: 0.25",
            },
            {
                "type": "element",
                "path": "/cell_attributes/@name=Quantile: 0.5",
            },
            {
                "type": "element",
                "path": "/cell_attributes/@name=Quantile: 0.75",
            },
        ],
    },
}

Tips

• The ensemble and target can use the same object, but they don't have to.