Geostatistics Task API

Version: 0.1.9

Preview

Break ties

POST

/compute/orgs/{org_id}/geostatistics/break-ties

Preview API

This API functionality is currently in preview. 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 functionality.

For more information, please read the guide

Request

Path parameters

org_iduuid

Required

The organisation identifier

Body parameters

sourceSource

Required

Examples: {"key":"value"}, {"another_key":123}

Data in which ties will be broken.

objecturi

Required

Object that contains the data in which ties will be broken. Supported schemas: block-model/[>=1.0,<2], downhole-intervals/[>=1.2,<2], pointset/[>=1.2,<2], regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2], tensor-3d-grid/[>=1.2,<2]

attributestring

Required

The known values, used to estimate values at unknown locations.

targetTarget

Required

Examples: {"key":"value"}, {"another_key":123}

Object and attribute where the results will be written.

objecturi

Required

Object where the results will be written. Supported schemas: block-model/[>=1.0,<2], downhole-intervals/[>=1.2,<2], pointset/[>=1.2,<2], regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2], tensor-3d-grid/[>=1.2,<2]

attribute |

Required

The attribute to write the results to.

One of:

object

operationunknown

Required

The operation to perform on the attribute.

namestring

Required

The name of the attribute to create.

object

operationunknown

Required

The operation to perform on the attribute.

referencestring

Required

Reference to an existing attribute to update.

seedinteger

Examples: 1, 14, 70, 87, 92

Default: 38239342

Seed for the random number generator.

neighborhoodBreakTiesSearch

Required

Examples: {"key":"value"}, {"another_key":123}

Search parameters.

In this break ties algorithm, the final value of each tied point is influenced by the mean of nearby points. The search parameters determines which nearby points to use.

ellipsoidEllipsoid

Required

The ellipsoid, to search for points within

ellipsoid_rangesEllipsoid Ranges

Required

The ranges of the ellipsoid

majornumber

Required

The major axis length of the ellipsoid

semi_majornumber

Required

The semi major axis length of the ellipsoid

minornumber

Required

The minor axis length of the ellipsoid

rotationRotation

Required

The rotation of the ellipsoid

dip_azimuthnumber

first rotation, about the z-axis, in degrees

dipnumber

second rotation, about the x-axis, in degrees

pitchnumber

third rotation, about the z-axis, in degrees

max_samplesinteger

Required

The maximum number of neighbors to find for each tied point.

min_samplesinteger

Default: 1

The minimum number of samples to use for each evaluation point.

Example body

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "object": "https://example.com",
    "attribute": {
      "name": "string"
    }
  },
  "seed": 38239342,
  "neighborhood": {
    "ellipsoid": {
      "ellipsoid_ranges": {
        "major": 0,
        "semi_major": 0,
        "minor": 0
      },
      "rotation": {
        "dip_azimuth": 0,
        "dip": 0,
        "pitch": 0
      }
    },
    "max_samples": 0,
    "min_samples": 1
  }
}

Responses

200

The task result returned by the Compute API Result endpoint when the task is done

Response schema

messagestring

Examples: "example string", "another example"

A message that says what happened in the task.

targetTarget

Examples: {"key":"value"}, {"another_key":123}

The target that was created or updated.

referenceuri

Reference to a geoscience object. Supported schemas: block-model/[>=1.0,<2], downhole-intervals/[>=1.2,<2], pointset/[>=1.2,<2], regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2], tensor-3d-grid/[>=1.2,<2]

namestring

The name of the geoscience object.

descriptionstring | null

The description of the geoscience object.

schema_idstring

The ID of the Geoscience Object schema.

attributeAttribute

Attribute containing the break ties result.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

Example response

{
  "message": "string",
  "target": {
    "reference": "https://example.com",
    "name": "string",
    "schema_id": "string",
    "attribute": {
      "reference": "string",
      "name": "string"
    }
  }
}

303

303 response, see Compute API Execute Task documentation for more details