Geostatistics Task API

Version: 0.1.4

Preview

K-Nearest neighbors (KNN)

POST

/compute/orgs/{org_id}/geostat/knn

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

sourceKNNSource

Required

type"geoscience-object-reference"

Examples: "example string", "another example"

Default: "geoscience-object-reference"

keystring | null

key of the attribute you want to save/retrieve the data to/from.

object_referencestring

Required

Examples: "example string", "another example"

A Geoscience object:

• Pointset_V1_0_1
• Pointset_V1_1_0
• Pointset_V1_2_0
• Pointset_V1_3_0
• DownholeIntervals_V1_0_1
• DownholeIntervals_V1_1_0
• DownholeIntervals_V1_2_0
• DownholeIntervals_V1_3_0

object_elementGORefElement[]

Required

A Geoscience object:

• ContinuousAttribute

type"element"

Examples: "example string", "another example"

Default: "element"

pathstring

Examples: "example string", "another example"

The attribute path that contains the values to be processed. It must contain the full path and the filter e.g:

• /cell_attributes/@name=attr-name
• /locations/attributes/@name=attr-name

targetKNNTarget

Required

type"geoscience-object-reference"

Examples: "example string", "another example"

Default: "geoscience-object-reference"

keystring | null

key of the attribute you want to save/retrieve the data to/from.

object_referencestring

Required

Examples: "example string", "another example"

A Geoscience object:

• Pointset_V1_0_1
• Pointset_V1_1_0
• Pointset_V1_2_0
• Pointset_V1_3_0
• DownholeIntervals_V1_0_1
• DownholeIntervals_V1_1_0
• DownholeIntervals_V1_2_0
• DownholeIntervals_V1_3_0
• Regular3DGrid_V1_0_1
• Regular3DGrid_V1_1_0
• Regular3DGrid_V1_2_0
• Regular3DGrid_V1_3_0
• RegularMasked3DGrid_V1_0_1
• RegularMasked3DGrid_V1_1_0
• RegularMasked3DGrid_V1_2_0
• RegularMasked3DGrid_V1_3_0

object_elementGORefElement[]

Required

A Geoscience object:

• ContinuousAttribute

type"element"

Examples: "example string", "another example"

Default: "element"

pathstring

Examples: "example string", "another example"

The attribute path that contains the values to be processed. It must contain the full path and the filter e.g:

• /cell_attributes/@name=attr-name
• /locations/attributes/@name=attr-name

neighborhoodNeighborhood

Required

Search neighborhood for conditioning.

max-samplesinteger

Required

Examples: 49, 50, 60, 68, 77

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

anisotropyEllipsoid

Required

The ellipsoid, to search for points within

ellipsoid_rangesEllipsoid Ranges

Required

The ranges of the ellipsoid

majornumber

Required

Examples: 16.26540971560848, 35.52707002275215, 67.01751743776934, 68.35476655366672, 70.18203134585514

The major axis length of the ellipsoid

semi_majornumber

Required

Examples: 7.140250957854832, 24.48109251514262, 46.22602118511158, 53.4139877029708, 63.49782881970603

The semi major axis length of the ellipsoid

minornumber

Required

Examples: 21.961517397026896, 26.994782678427796, 32.428273441532184, 68.81619584333131, 92.53911796212178

The minor axis length of the ellipsoid

rotationRotation

Required

The rotation of the ellipsoid

dip_azimuthnumber

Required

Examples: 134.43138091054578, 143.6372279990745, 241.8073054697819, 248.3523475558637, 256.66163021488387

first rotation, about the z-axis, in degrees

dipnumber

Required

Examples: 3.7861668012705985, 11.524661338742085, 44.62301045988143, 81.26750545040335, 161.9305352357302

second rotation, about the x-axis, in degrees

pitchnumber

Required

Examples: 2.588702034633674, 21.194556075476424, 199.4117480728127, 211.83844118772637, 254.82274075744348

third rotation, about the z-axis, in degrees

min-samplesinteger

Examples: 2, 33, 71, 88, 93

Default: 1

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

Example body

{
  "source": {
    "type": "geoscience-object-reference",
    "key": "string",
    "object_reference": "string",
    "object_element": [
      {
        "type": "element",
        "path": "string"
      }
    ]
  },
  "target": {
    "type": "geoscience-object-reference",
    "key": "string",
    "object_reference": "string",
    "object_element": [
      {
        "type": "element",
        "path": "string"
      }
    ]
  },
  "neighborhood": {
    "max-samples": 0,
    "anisotropy": {
      "ellipsoid_ranges": {
        "major": 0,
        "semi_major": 0,
        "minor": 0
      },
      "rotation": {
        "dip_azimuth": 0,
        "dip": 0,
        "pitch": 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"

Concise summary of the completed job

object_modifiedModifiedResult

Modified geoscience object

type"geoscience-object-reference"

Examples: "example string", "another example"

Default: "geoscience-object-reference"

keystring | null

key of the attribute you want to save/retrieve the data to/from.

object_referencestring

Examples: "example string", "another example"

object_elementGORefElement[] | null

Example response

{
  "message": "string",
  "object_modified": {
    "type": "geoscience-object-reference",
    "key": "string",
    "object_reference": "string",
    "object_element": [
      {
        "type": "element",
        "path": "string"
      }
    ]
  }
}

303

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