Geostatistics Task API

Version: 0.0.2

Kriging Interpolation

POST

/compute/orgs/{org_id}/geostatistics/kriging

For more information, please read the guide

Request

Path parameters

org_iduuid

Required

The organisation identifier

Body parameters

source_objecturi

Required

Spatial locations of known values.

source_attributestring

Required

Examples: "example string", "another example"

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

kriging_methodSimpleKriging | OrdinaryKriging

Required

The kriging method to use. Either simple or ordinary kriging.

One of:

SimpleKrigingobject

type"simple"

Required

Examples: "example string", "another example"

The type of kriging to use.

meannumber

Required

Examples: 26.58603143720213, 42.43551012702056, 63.298320780730435, 64.31117696653659, 89.17354752655707

The mean value, assumed to be constant across the domain.

OrdinaryKrigingobject

type"ordinary"

Required

Examples: "example string", "another example"

The type of kriging to use.

variogramuri

Required

Example: "/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/{object_id}"

Model of the covariance within the domain.

neighborhoodSearch

Required

Search parameters.

In Kriging, the value of each evaluation point is determined by a set of nearby points with known values. 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

Examples: 23.42893768505807, 24.798395530970964, 29.367797014890364, 35.86712007904666, 59.04798961774967

The major axis length of the ellipsoid

semi_majornumber

Required

Examples: 3.1664405537027984, 24.133902894558645, 66.01607411644424, 90.32421743131444, 98.13468858620787

The semi major axis length of the ellipsoid

minornumber

Required

Examples: 29.957537905170174, 43.06791371476946, 56.472145452632496, 87.60303317239814, 89.50283420464866

The minor axis length of the ellipsoid

rotationRotation

Required

The rotation of the ellipsoid

dip_azimuthnumber

Examples: 49.57025166304916, 84.02309081677619, 168.1438948949981, 219.09204944393724, 231.61528441477378

first rotation, about the z-axis, in degrees

dipnumber

Examples: 9.145763231395543, 19.95481552469866, 45.49151143660519, 60.13622813271782, 110.90742475619062

second rotation, about the x-axis, in degrees

pitchnumber

Examples: 113.52756349066578, 140.2778528927207, 287.9705244681351, 304.9260122034788, 318.07187067492356

third rotation, about the z-axis, in degrees

max_samplesinteger

Required

Examples: 5, 8, 50, 52, 74

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

target_objectEvaluation Target

Required

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

Object to evaluate onto.

referenceuri

Required

Reference to the targeted object.

overwriteboolean

Whether to overwrite the existing object.

descriptionstring | null

Description to put into the target object.

tagsTags

Tags to put into the target object.

Additional propertiesstring

This schema accepts user-defined additional properties along with the documented schema. The additional properties must match the specified type where one is provided.

target_attribute |

Required

Name of the attribute to create or update on the target object

One of:

object

operation"create"

Required

The operation to perform on the attribute.

namestring

Required

The name of the attribute to create.

object

operation"update"

Required

The operation to perform on the attribute.

referencestring

Required

Reference to an existing attribute to update.

Example body

{
  "source_object": "https://example.com",
  "source_attribute": "string",
  "kriging_method": {
    "type": "string",
    "mean": 0
  },
  "variogram": "https://example.com",
  "neighborhood": {
    "ellipsoid": {
      "ellipsoid_ranges": {
        "major": 0,
        "semi_major": 0,
        "minor": 0
      },
      "rotation": {
        "dip_azimuth": 0,
        "dip": 0,
        "pitch": 0
      }
    },
    "max_samples": 0
  },
  "target_object": {
    "reference": "https://example.com",
    "overwrite": false,
    "description": "string",
    "tags": {
      "Additional properties": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  },
  "target_attribute": {
    "operation": "string",
    "name": "string"
  }
}

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

The target that was created or updated.

referenceuri

Example: "/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/{object_id}"

Reference to a geoscience object.

namestring

Examples: "Sample Name", "A name for the thing"

The name of the geoscience object.

descriptionstring | null

Examples: "This is a sample description. It describes a thing for which we need a description", "An example description, which could be quite long and detailed."

The description of the geoscience object.

schema_idstring

Examples: "123e4567-e89b-12d3-a456-426614174000", "987e6543-e21b-12d3-a456-426614174999"

The ID of the Geoscience Object schema.

attributeAttribute

Attribute containing the kriging result.

referencestring

Examples: "example string", "another example"

Reference to the attribute in the geoscience object.

namestring

Examples: "Sample Name", "A name for the thing"

The name of the output attribute.

Example response

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

303

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