Geostatistics Task API

Version: 0.1.4

Preview

Declustering

POST

/compute/orgs/{org_id}/geostat/declustering

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

sourceDeclusteringSource

Required

Unweighted composites for declustering

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

targetDeclusteringTarget

Required

Attribute to save the result

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

cell_sizesCellSizes

Required

Cell sizes for declustering

min_sizenumber

Required

Examples: 27.819070823066273, 41.95198209616587, 44.92090462838536, 70.13249735902359, 71.60196129224035

max_sizenumber

Required

Examples: 15.965931637689012, 27.787134167164183, 42.26143981535026, 75.88073671297673, 86.9300320792934

n_sizesinteger

Required

Examples: 11, 13, 27, 43, 97

y_anisotropynumber

Examples: 4.345044292309719, 26.452086722201308, 34.39557224789711, 35.89793804846284, 37.99273006373374

Default: 1

z_anisotropynumber

Examples: 7.880019807845818, 12.482616285320935, 29.317828140709288, 45.942487967184256, 92.22953720281599

Default: 1

n_offsetsinteger

Examples: 24, 46, 73, 79, 80

Default: 100

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"
      }
    ]
  },
  "cell_sizes": {
    "min_size": 0,
    "max_size": 0,
    "n_sizes": 0,
    "y_anisotropy": 1,
    "z_anisotropy": 1,
    "n_offsets": 100
  }
}

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