Tasks

Collection of on-demand tasks

Break ties

Geostatistics Task API

Version: 0.6.7

Preview

For more information, please read the guide

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.

Parameters

The organisation identifier

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

Data in which ties will be broken.

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]

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

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

Object and attribute where the results will be written.

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]

The attribute to write the results to.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Examples: 3, 14, 35, 81, 94

Default: 38239342

Seed for the random number generator.

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.

The ellipsoid, to search for points within

The ranges of the ellipsoid

The major axis length of the ellipsoid

The semi major axis length of the ellipsoid

The minor axis length of the ellipsoid

The rotation of the ellipsoid

first rotation, about the z-axis, in degrees

second rotation, about the x-axis, in degrees

third rotation, about the z-axis, in degrees

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

Default: 1

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

{
  "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
  }
}

Returns

200

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

Examples: "example string", "another example"

A message that says what happened in the task.

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

The target that was created or updated.

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]

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Attribute containing the break ties result.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

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

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/break-ties' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

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

Conditional turning bands

Geostatistics Task API

Version: 0.6.7

Preview

Runs the turning band simulator using an existing continuous distribution. For more information, please read the guide

Preview API

Parameters

The organisation identifier

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

Reference to the Geoscience Object containing the source points used for conditioning the simulation. Supported schemas: pointset/[>=1.2,<2]

Examples: "name_of_an_attribute", "an_attribute", "an_example_attribute_name"

Reference to the attribute containing the source values.

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

Reference to the Geoscience Object containing the grid to evaluate the simulation onto. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

Optional filter to apply to the target grid. This allows the simulation to only be applied to a subset of grid locations, defined by filtering an attribute on the target grid.

A filter expression defining which locations to include. Use a FilterCondition for a single predicate, AllOfFilter for AND logic, AnyOfFilter for OR logic, or nest them to build compound predicates.

The filter operator. Use 'in' or 'not_in' for category/membership tests (pair with 'values'). Use 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to' for numeric comparisons (pair with 'threshold').

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

circular(AnyOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

circular(AnyOfFilter)

Optional filter to apply to the source object. This allows the simulation to use only a subset of the source data, defined by filtering an attribute on the source object.

A filter expression defining which locations to include. Use a FilterCondition for a single predicate, AllOfFilter for AND logic, AnyOfFilter for OR logic, or nest them to build compound predicates.

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

circular(SourceAnyOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

circular(SourceAnyOfFilter)

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

Search neighborhood for conditioning.

The ellipsoid, to search for points within Alias: anisotropy

The ranges of the ellipsoid

The major axis length of the ellipsoid

The semi major axis length of the ellipsoid

The minor axis length of the ellipsoid

The rotation of the ellipsoid

first rotation, about the z-axis, in degrees

second rotation, about the x-axis, in degrees

third rotation, about the z-axis, in degrees

The maximum number of samples to use for each evaluation point. Alias: max-samples

Default: 1

The minimum number of samples to use for each evaluation point. Alias: min-samples

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

A non-parametric continuous cumulative distribution used for the normal-score transformation. Created by the continuous-distribution task. Supported schemas: non-parametric-continuous-cumulative-distribution/[>=1.0,<2]

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

Reference to the variogram model used to model the covariance within the domain. Supported schemas: variogram/[>=1.1,<2]

Default: "simple"

The kriging method to use for the conditioning step.

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

Sub-block discretization used for support correction within each grid block.

Default: 1

Number of subdivisions in the x direction

Default: 1

Number of subdivisions in the y direction

Default: 1

Number of subdivisions in the z direction

Examples: 105, 143, 229, 251, 755

Default: 500

Number of lines to use for the turning-band simulation.

Examples: 12, 70, 76, 87, 95

Default: 1

Number of realizations (simulations) to run. All realizations will be saved.

Examples: 3, 4, 11, 27, 54

Default: 38239342

Random seed for simulation and tie-breaking.

{
  "source": "https://example.com",
  "source_attribute": "string",
  "target": "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,
    "min_samples": 1
  },
  "distribution": "https://example.com",
  "variogram_model": "https://example.com",
  "block_discretization": {
    "nx": 1,
    "ny": 1,
    "nz": 1
  },
  "number_of_lines": 500,
  "realizations": 1,
  "random_seed": 38239342
}

Returns

200

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

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

The target grid with simulation results.

Reference to a geoscience object. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Attribute containing the block simulation results.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/conditional-turning-bands

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/conditional-turning-bands' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

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

Conditional simulation workflow

Geostatistics Task API

Version: 0.6.7

For more information, please read the guide

Parameters

The organisation identifier

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

Reference to the Geoscience Object containing the source points used for conditioning the simulation. Supported schemas: pointset/[>=1.2,<2]

Examples: "name_of_an_attribute", "an_attribute", "an_example_attribute_name"

Reference to the attribute containing the source values. The values are transformed to normal-score space using the provided distribution.

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

Reference to the Geoscience Object containing the grid to evaluate the simulation onto. A new attribute will be created on this object. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

Optional filter to apply to the target grid. This allows the simulation to only be applied to a subset of grid locations, defined by filtering an attribute on the target grid.

A filter expression defining which locations to include. Use a FilterCondition for a single predicate, AllOfFilter for AND logic, AnyOfFilter for OR logic, or nest them to build compound predicates.

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

circular(AnyOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

circular(AnyOfFilter)

Optional filter to apply to the source object. This allows the simulation to use only a subset of the source data, defined by filtering an attribute on the source object.

A filter expression defining which locations to include. Use a FilterCondition for a single predicate, AllOfFilter for AND logic, AnyOfFilter for OR logic, or nest them to build compound predicates.

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

circular(SourceAnyOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

circular(SourceAnyOfFilter)

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

Search neighborhood for conditioning.

The ellipsoid, to search for points within Alias: anisotropy

The ranges of the ellipsoid

The major axis length of the ellipsoid

The semi major axis length of the ellipsoid

The minor axis length of the ellipsoid

The rotation of the ellipsoid

first rotation, about the z-axis, in degrees

second rotation, about the x-axis, in degrees

third rotation, about the z-axis, in degrees

The maximum number of samples to use for each evaluation point. Alias: max-samples

Default: 1

The minimum number of samples to use for each evaluation point. Alias: min-samples

Parameters for a continuous distribution used for normal-score transformation.

Tail extrapolation

Power model for extrapolating the upper tail of the distribution.

Denominator of the exponent for the power model (between 0 exclusive and 1 inclusive).

Maximum extent of tail, must be greater than the maximum value in the data.

Power model for extrapolating the lower tail of the distribution. Optional.

Denominator of the exponent for the power model (between 0 exclusive and 1 inclusive).

Minimum extent of tail, must be less than the minimum value in the data.

Optional weights attribute for weighted distribution

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

Reference to the variogram model used to model the covariance within the domain. Supported schemas: variogram/[>=1.1,<2]

Default: "simple"

The kriging method to use for the conditioning step.

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

Sub-block discretization used for support correction within each grid block.

Default: 1

Number of subdivisions in the x direction

Default: 1

Number of subdivisions in the y direction

Default: 1

Number of subdivisions in the z direction

Examples: 28, 239, 518, 575, 617

Default: 500

Number of lines to use for the turning-band simulation.

Examples: 26, 70, 84, 90, 92

Default: 1

Number of simulations to run.

Examples: 28, 35, 53, 57, 75

Default: 38239342

Random seed for simulation and tie-breaking.

Examples: 0, 20, 54, 89, 97

Default: 5

Number of simulations to publish to the output object. If perform_validation is true, the minimum value must be at least 1.

Settings for loss calculations.

Ordered list of material categories, from lowest to highest cutoff grade

Cutoff grade for the category

Price of the metal per unit

Label for the material category

Processing cost per unit of material

Mining cost per unit of waste material

Mining cost per unit of ore material

Fraction of metal expected to be recovered during processing

The target attribute that will be created or updated with loss calculation results.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Examples: [0.15547949981178155,0.3402505165179919,0.9572130722067812], [0.09274584338014791,0.09671637683346401,0.33659454511262676]

List of quantiles to compute for each location.

List of cutoff values to compute probability above for each location. If None, this calculation is not performed.

List of cutoff values to compute mean above for each location. If None, this calculation is not performed.

Examples: true, false

Whether to run validation and generate a validation report.

Context for the validation report.

Title that will appear on the report.

Key-value pairs of details to appear on the report.

Label of the context item, which will appear on the report.

Value of the context item.

Thresholds for the mean comparison in the validation report.

Threshold for the percentage difference between the reference and simulated means that is considered acceptable.

Threshold for the percentage difference between the reference and simulated means that is considered marginal.

{
  "source_object": "https://example.com",
  "source_attribute": "string",
  "target_object": "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,
    "min_samples": 1
  },
  "variogram_model": "https://example.com",
  "block_discretization": {
    "nx": 1,
    "ny": 1,
    "nz": 1
  },
  "number_of_lines": 500,
  "number_of_simulations": 1,
  "random_seed": 38239342,
  "number_of_simulations_to_save": 5,
  "location_wise_quantiles": [
    0
  ],
  "perform_validation": false
}

Returns

200

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

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

The target grid with simulation results.

Reference to a geoscience object. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Attribute containing summary statistics of the simulation results.

Attribute containing the mean of the simulations.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the variance of the simulations.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the minimum of the simulations.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the maximum of the simulations.

Reference to the attribute in the geoscience object.

The name of the output attribute.

List of attributes containing quantiles of the simulation results.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Quantile of the simulations, that this attribute represents.

Attribute containing the simulation results.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the simulation results in normal score space.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the point simulation results.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the point simulation results in normal score space.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the loss calculation results.

Reference to the attribute in the geoscience object.

The name of the output attribute.

List of attributes containing probability above cutoff values.

Reference to the attribute in the geoscience object.

The name of the output attribute.

The cutoff value that this attribute represents.

List of attributes containing mean above cutoff values.

Reference to the attribute in the geoscience object.

The name of the output attribute.

The cutoff value that this attribute represents.

Summary of the validation results.

Mean of the input values.

Mean of the simulated values.

Link to the validation report file.

Reference to a file.

The name of the file, typically the terminal segment of the path.

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

Links related to the simulation task.

Link to the validation dashboard.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/consim

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/consim' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "target": {
    "reference": "https://example.com",
    "name": "string",
    "schema_id": "string",
    "summary_attributes": {
      "mean": {
        "reference": "string",
        "name": "string"
      },
      "variance": {
        "reference": "string",
        "name": "string"
      },
      "min": {
        "reference": "string",
        "name": "string"
      },
      "max": {
        "reference": "string",
        "name": "string"
      }
    },
    "quantile_attributes": [
      {
        "reference": "string",
        "name": "string",
        "quantile": 0
      }
    ],
    "probability_above_cutoff_attributes": [
      {
        "reference": "string",
        "name": "string",
        "cutoff": 0
      }
    ],
    "mean_above_cutoff_attributes": [
      {
        "reference": "string",
        "name": "string",
        "cutoff": 0
      }
    ]
  },
  "links": {}
}

Continuous distribution

Geostatistics Task API

Version: 0.6.7

Preview

For more information, please read the guide

Preview API

Parameters

The organisation identifier

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

Source data to create the distribution from.

Object containing the data to create a distribution from. Supported schemas: 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]

The attribute containing the values to create a distribution from.

Optional weights for creating a weighted (declustered) distribution.

Object containing the weights data. Supported schemas: 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]

The attribute containing the weights values.

Optional tail extrapolation parameters for extending the distribution beyond the data range.

Power model for extrapolating the upper tail of the distribution.

Denominator of the exponent for the power model (between 0 exclusive and 1 inclusive).

Maximum extent of tail, must be greater than the maximum value in the data.

Power model for lower tail extrapolation. The min value must be less than the minimum value in the data.

Denominator of the exponent for the power model (between 0 exclusive and 1 inclusive).

Minimum extent of tail, must be less than the minimum value in the data.

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

Target specifying where to create the continuous distribution object.

Reference to the targeted object. Supported schemas: non-parametric-continuous-cumulative-distribution/[>=1.0,<2]

Whether to overwrite the existing object.

Description to put into the target object.

Tags to put into the target object.

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

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "reference": "https://example.com",
    "overwrite": false,
    "tags": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  }
}

Returns

200

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

Examples: "example string", "another example"

A message describing the result of the task.

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

Reference to the created continuous distribution object.

Reference to a geoscience object. Supported schemas: non-parametric-continuous-cumulative-distribution/[>=1.0,<2]

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/continuous-distribution

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/continuous-distribution' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

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

Grid-Based Declustering

Geostatistics Task API

Version: 0.6.7

Preview

Computes grid-based declustering weights by measuring each sample's influence on evaluation locations. Supports both KNN (arithmetic mean) and IDW (inverse-distance weighted) modes via an optional power parameter.

Preview API

Parameters

The organisation identifier

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

The source sample locations.

Spatial locations of samples to compute declustering weights for. 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]

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

The evaluation grid for measuring sample influence.

Regular grid or set of evaluation locations used to measure each sample's spatial influence. 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]

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

The target object and attribute to write declustering weights to.

Object to write the declustering weight attribute onto. Typically the same object as the source. 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]

Name of the attribute to create or update with the computed declustering weights.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

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

Search neighborhood parameters. The search ellipsoid and sample limits control which samples influence each grid location during the estimation used to compute declustering weights.

The ellipsoid, to search for points within Alias: anisotropy

The ranges of the ellipsoid

The major axis length of the ellipsoid

The semi major axis length of the ellipsoid

The minor axis length of the ellipsoid

The rotation of the ellipsoid

first rotation, about the z-axis, in degrees

second rotation, about the x-axis, in degrees

third rotation, about the z-axis, in degrees

The maximum number of samples to use for each evaluation point. Alias: max-samples

Default: 1

The minimum number of samples to use for each evaluation point. Alias: min-samples

Default: 8

The maximum number of empty octants (aka sectors) allowed when searching for neighbors. Omitting this, or a value of 8, disables the octant check.

The maximum number of samples to use from each octant.

The maximum number of samples to use from each drillhole (defined by drillhole ID)

The maximum number of empty quadrants (2D sectors, ignoring Z) allowed when searching for neighbors. If not specified, quadrant filtering is disabled.

The maximum number of samples to use from each quadrant (2D sectors, ignoring Z).

The maximum number of drillholes to be used in each estimate.

Default: 2

Inverse-distance weighting power. Controls how strongly distance affects influence: higher values give nearer samples more weight. The default (2.0) uses standard inverse-distance-squared weighting. Set to null to use arithmetic-mean KNN (equal neighbour votes, no distance weighting).

{
  "source": {
    "object": "https://example.com"
  },
  "grid": {
    "object": "https://example.com"
  },
  "target": {
    "object": "https://example.com",
    "attribute": {
      "name": "string"
    }
  },
  "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,
    "max_empty_octants": 8
  },
  "power": 2
}

Returns

200

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

Examples: "example string", "another example"

A message that says what happened in the task.

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

The target that was created or updated with declustering weights.

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Attribute containing the declustering weights.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/declustering

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/declustering' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

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

Inverse Distance Weighting Estimation

Geostatistics Task API

Version: 0.6.7

Preview

Inverse distance weighting estimation using weighted average of nearby sample values, where weights are inversely proportional to distance raised to a specified power.

Preview API

Parameters

The organisation identifier

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

The source object and attribute containing known values.

Spatial locations of known values. 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]

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

Optional filter to apply to the source object. This allows IDW to use only a subset of the known data, defined by filtering an attribute on the source object.

A filter expression defining which locations to include. Use a FilterCondition for a single predicate, AllOfFilter for AND logic, AnyOfFilter for OR logic, or nest them to build compound predicates.

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

circular(SourceAnyOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

circular(SourceAnyOfFilter)

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

The target object and attribute to create or update with IDW results.

Object to evaluate onto. 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]

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

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Optional filter to apply to the target object. This allows the estimation to only be applied to a subset of the target object, defined by filtering an attribute on the target object.

A filter expression defining which locations to include. Use a FilterCondition for a single predicate, AllOfFilter for AND logic, AnyOfFilter for OR logic, or nest them to build compound predicates.

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

circular(AnyOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

circular(AnyOfFilter)

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

In IDW estimation, the value of each evaluation point is determined by a weighted average of nearby points with known values, where weights are inversely proportional to distance raised to the specified power. The search parameters determine which nearby points to use.

The ellipsoid, to search for points within Alias: anisotropy

The ranges of the ellipsoid

The major axis length of the ellipsoid

The semi major axis length of the ellipsoid

The minor axis length of the ellipsoid

The rotation of the ellipsoid

first rotation, about the z-axis, in degrees

second rotation, about the x-axis, in degrees

third rotation, about the z-axis, in degrees

The maximum number of samples to use for each evaluation point. Alias: max-samples

Default: 1

The minimum number of samples to use for each evaluation point. Alias: min-samples

Default: 8

The maximum number of empty octants (aka sectors) allowed when searching for neighbors. Omitting this, or a value of 8, disables the octant check.

The maximum number of samples to use from each octant.

The maximum number of samples to use from each drillhole (defined by drillhole ID)

The maximum number of empty quadrants (2D sectors, ignoring Z) allowed when searching for neighbors. If not specified, quadrant filtering is disabled.

The maximum number of samples to use from each quadrant (2D sectors, ignoring Z).

The maximum number of drillholes to be used in each estimate.

Examples: 53.623, 60.373, 72.973, 80.713, 84.749

IDW power parameter. Controls how quickly influence decreases with distance. Common values: 1.0, 2.0.

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "object": "https://example.com",
    "attribute": {
      "name": "string"
    }
  },
  "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,
    "max_empty_octants": 8
  },
  "power": 0
}

Returns

200

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

Examples: "example string", "another example"

A message that says what happened in the task.

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

The target that was created or updated.

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Attribute containing the IDW result.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/idw

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/idw' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

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

K-Nearest Neighbor Estimation

Geostatistics Task API

Version: 0.6.7

Preview

Nearest neighbor estimation using arithmetic mean of nearby sample values.

Preview API

Parameters

The organisation identifier

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

The source object and attribute containing known values.

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

Optional filter to apply to the source object. This allows KNN to use only a subset of the known data, defined by filtering an attribute on the source object.

A filter expression defining which locations to include. Use a FilterCondition for a single predicate, AllOfFilter for AND logic, AnyOfFilter for OR logic, or nest them to build compound predicates.

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

circular(SourceAnyOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

circular(SourceAnyOfFilter)

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

The target object and attribute to create or update with KNN results.

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

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Optional filter to apply to the target object. This allows the estimation to only be applied to a subset of the target object, defined by filtering an attribute on the target object.

A filter expression defining which locations to include. Use a FilterCondition for a single predicate, AllOfFilter for AND logic, AnyOfFilter for OR logic, or nest them to build compound predicates.

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

circular(AnyOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

circular(AnyOfFilter)

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

In KNN estimation, the value of each evaluation point is determined by the arithmetic mean of a set of nearby points with known values. The search parameters determines which nearby points to use.

The ellipsoid, to search for points within Alias: anisotropy

The ranges of the ellipsoid

The major axis length of the ellipsoid

The semi major axis length of the ellipsoid

The minor axis length of the ellipsoid

The rotation of the ellipsoid

first rotation, about the z-axis, in degrees

second rotation, about the x-axis, in degrees

third rotation, about the z-axis, in degrees

The maximum number of samples to use for each evaluation point. Alias: max-samples

Default: 1

The minimum number of samples to use for each evaluation point. Alias: min-samples

Default: 8

The maximum number of empty octants (aka sectors) allowed when searching for neighbors. Omitting this, or a value of 8, disables the octant check.

The maximum number of samples to use from each octant.

The maximum number of samples to use from each drillhole (defined by drillhole ID)

The maximum number of empty quadrants (2D sectors, ignoring Z) allowed when searching for neighbors. If not specified, quadrant filtering is disabled.

The maximum number of samples to use from each quadrant (2D sectors, ignoring Z).

The maximum number of drillholes to be used in each estimate.

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "object": "https://example.com",
    "attribute": {
      "name": "string"
    }
  },
  "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,
    "max_empty_octants": 8
  }
}

Returns

200

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

Examples: "example string", "another example"

A message that says what happened in the task.

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

The target that was created or updated.

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Attribute containing the KNN result.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/knn

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/knn' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

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

Kriging

Geostatistics Task API

Version: 0.6.7

Preview

For more information, please read the guide

Preview API

Parameters

The organisation identifier

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

The source object and attribute containing known values.

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

Optional filter to apply to the source object. This allows kriging to use only a subset of the known data, defined by filtering an attribute on the source object.

A filter expression defining which locations to include. Use a FilterCondition for a single predicate, AllOfFilter for AND logic, AnyOfFilter for OR logic, or nest them to build compound predicates.

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

circular(SourceAnyOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(SourceAllOfFilter)

circular(SourceAnyOfFilter)

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

The target object and attribute to create or update with kriging results.

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

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the validity flag: 1 where an estimate was produced and 0 where the neighbourhood search found no usable samples (the estimate is left blank there).

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the kriging variance (estimation uncertainty).

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the slope of regression (a diagnostic for conditional bias).

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the kriging efficiency (proportion of point/intra-block variance explained by kriging weights).

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the GLS mean for ordinary kriging, or the supplied constant mean for simple kriging.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the number of data samples used in the estimate.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the number of distinct drillholes contributing to the estimate. Requires a DownholeIntervals source object.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the number of duplicate sample locations used in the estimate.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the number of equidistant samples (samples at the same distance from the query point) used in the estimate.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the sum of kriging weights applied to data samples.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the sum of positive kriging weights applied to data samples.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the sum of negative kriging weights applied to data samples (zero when negative-weight removal is enabled).

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the minimum isotropic Euclidean distance from query point to any neighbour.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the mean isotropic Euclidean distance from query point to all neighbours.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the minimum anisotropic (ellipsoid-space) distance from query point to any neighbour.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Attribute to create or update with the mean anisotropic (ellipsoid-space) distance from query point to all neighbours.

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

Optional filter to apply to the target object. This allows the kriging to only be applied to a subset of the target object, defined by filtering an attribute on the target object.

A filter expression defining which locations to include. Use a FilterCondition for a single predicate, AllOfFilter for AND logic, AnyOfFilter for OR logic, or nest them to build compound predicates.

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

circular(AnyOfFilter)

Identifies this as an OR composite filter.

At least one of these filters must be satisfied (OR logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

Identifies this as an AND composite filter.

All of these filters must be satisfied (AND logic).

Category values to match. Required when operator is 'in' or 'not_in'. Use strings for string/category-name attributes; use integers for integer-coded attributes.

Numeric threshold for comparison. Required when operator is 'equal', 'not_equal', 'greater_than', 'greater_than_or_equal_to', 'less_than', or 'less_than_or_equal_to'.

Identifies this as a leaf filter condition.

Attribute used to filter locations.

circular(AllOfFilter)

circular(AnyOfFilter)

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

The type of kriging to use.

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

The type of kriging to use.

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

Model of the covariance within the domain. Supported schemas: variogram/[>=1.1,<2]

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

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.

The ellipsoid, to search for points within Alias: anisotropy

The ranges of the ellipsoid

The major axis length of the ellipsoid

The semi major axis length of the ellipsoid

The minor axis length of the ellipsoid

The rotation of the ellipsoid

first rotation, about the z-axis, in degrees

second rotation, about the x-axis, in degrees

third rotation, about the z-axis, in degrees

The maximum number of samples to use for each evaluation point. Alias: max-samples

Default: 1

The minimum number of samples to use for each evaluation point. Alias: min-samples

Default: 8

The maximum number of empty octants (aka sectors) allowed when searching for neighbors. Omitting this, or a value of 8, disables the octant check.

The maximum number of samples to use from each octant.

The maximum number of samples to use from each drillhole (defined by drillhole ID)

The maximum number of empty quadrants (2D sectors, ignoring Z) allowed when searching for neighbors. If not specified, quadrant filtering is disabled.

The maximum number of samples to use from each quadrant (2D sectors, ignoring Z).

The maximum number of drillholes to be used in each estimate.

Outlier restrictions.

The action to take on outliers. Clamp the value, or discard the point.

The distance to the outlier limit.

Specify the distance as a fraction of the search radius.

The distance to the outlier limit, as a fraction of the search radius (0.0 to 1.0). For example, a value of 0.5 means the outlier boundary is at 50% of the search radius.

Specify the distance as an absolute value.

The absolute distance to the outlier limit. This cannot be used yet.

The maximum allowed value for the outlier limit. Values exceeding this threshold are either discarded or clamped.

Default: 0.000001

The maximum randomly-applied delta value for clamped outlier values.Random delta values in the range [0.0...clamp_limit) are added to clamped values toavoid identical values occurring throughout the samples.

Sub-block discretization for block kriging. When provided, each target block is subdivided into nx * ny * nz sub-cells and the kriged value is averaged across these sub-cells. When omitted, point kriging is performed. Only applicable when the target is a 3D grid or block model.

Default: 1

Number of subdivisions in the x direction

Default: 1

Number of subdivisions in the y direction

Default: 1

Number of subdivisions in the z direction

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "object": "https://example.com",
    "attribute": {
      "name": "string"
    },
    "valid_attribute": {
      "name": "string"
    },
    "variance_attribute": {
      "name": "string"
    },
    "slope_attribute": {
      "name": "string"
    },
    "efficiency_attribute": {
      "name": "string"
    },
    "mean_attribute": {
      "name": "string"
    },
    "sample_count_attribute": {
      "name": "string"
    },
    "num_drillholes_attribute": {
      "name": "string"
    },
    "num_duplicates_attribute": {
      "name": "string"
    },
    "num_equidistant_attribute": {
      "name": "string"
    },
    "sum_weights_attribute": {
      "name": "string"
    },
    "sum_positive_weights_attribute": {
      "name": "string"
    },
    "sum_negative_weights_attribute": {
      "name": "string"
    },
    "min_distance_attribute": {
      "name": "string"
    },
    "mean_distance_attribute": {
      "name": "string"
    },
    "aniso_min_distance_attribute": {
      "name": "string"
    },
    "aniso_mean_distance_attribute": {
      "name": "string"
    }
  },
  "kriging_method": {
    "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,
    "min_samples": 1,
    "max_empty_octants": 8
  }
}

Returns

200

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

Examples: "example string", "another example"

A message that says what happened in the task.

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

The target that was created or updated.

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Attribute containing the kriging result.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the validity flag: 1 where an estimate was produced and 0 where the neighbourhood search found no usable samples.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the kriging variance (estimation uncertainty).

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the diagnostic for conditional bias.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the proportion of point/intra-block variance explained by kriging weights.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the GLS mean for ordinary kriging, or the supplied constant mean for simple kriging.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the number of data samples used in the estimate.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the number of distinct drillholes contributing to the estimate.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the number of duplicate sample locations used in the estimate.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the number of equidistant samples used in the estimate.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the sum of kriging weights applied to data samples.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the sum of positive kriging weights applied to data samples.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the sum of negative kriging weights applied to data samples (zero when negative-weight removal is enabled).

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the minimum isotropic Euclidean distance from query point to any neighbor.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the mean isotropic Euclidean distance from query point to all neighbors.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the minimum anisotropic (ellipsoid-space) distance from query point to any neighbor.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Attribute containing the mean anisotropic (ellipsoid-space) distance from query point to all neighbors.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

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

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/kriging' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

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

Loss calculation

Geostatistics Task API

Version: 0.6.7

Preview

Calculate loss given block model and economic parameters

Preview API

Parameters

The organisation identifier

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

The source object and attribute containing known values.

Example: "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json"

The location of a regular or masked 3D grid with known values. Should be one of Regular3DGrid_V1_2_0, Regular3DGrid_V1_3_0, RegularMasked3DGrid_V1_2_0, or RegularMasked3DGrid_V1_3_0. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

Example: "cell_attributes[?attribute_type=='ensemble_continuous']"

The original values, used to calculate grade categories.

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

The target object and attribute to create or update with grade calculation results.

Example: "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json"

Object to evaluate onto. Can be the same as the source object. Should be one of Regular3DGrid_V1_2_0, Regular3DGrid_V1_3_0, RegularMasked3DGrid_V1_2_0, or RegularMasked3DGrid_V1_3_0. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

Examples: {"name":"grade-category","operation":"create"}, {"name":"existing-grade-category","operation":"update"}

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

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

List of material categories, sorted from lowest to highest cutoff grade

Examples: 0.16, 0.5, 0.9

The cutoff grade

Examples: 134.23, 245.12, 9876.34

The metal price

Examples: "ore", "waste"

Default: "waste"

The category label

Examples: 37.85, 55.2, 61.85, 82.94, 97.31

Processing cost per unit of material

Examples: 4.58, 22.79, 57.74, 70.46, 86.17

Mining cost per unit of waste material

Examples: 7.98, 10.1, 23.28, 27.8, 28.94

Mining cost per unit of ore material

Examples: 0.21, 0.267, 0.365, 0.37, 0.636

Fraction of metal expected to be recovered during processing

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "object": "https://example.com",
    "attribute": {
      "name": "string"
    }
  },
  "material_categories": [
    {
      "cutoff_grade": 0,
      "metal_price": 0,
      "label": "waste"
    }
  ],
  "processing_cost": 0,
  "mining_waste_cost": 0,
  "mining_ore_cost": 0,
  "metal_recovery_fraction": 0
}

Returns

200

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

Examples: "Success", "Failed"

Description of the result

The target that was created or updated.

Reference to a geoscience object. Supported schemas: 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]

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Attribute containing the material category results from the grade calculation.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/loss-calculation

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/loss-calculation' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "message": "string"
}

Normal score transformation

Geostatistics Task API

Version: 0.6.7

Preview

For more information, please read the guide

Preview API

Parameters

The organisation identifier

The direction of the normal-score transformation. 'forward' transforms data from the source distribution to a standard Gaussian (mean=0, std=1). 'backward' transforms data from a standard Gaussian back to the source distribution.

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

The source object and attribute containing the values to transform.

Object containing the values to transform. Supported schemas: 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]

The numeric attribute to apply the normal-score transformation to.

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

A non-parametric continuous cumulative distribution that defines the source distribution for the transformation. Created by the continuous-distribution task. Supported schemas: non-parametric-continuous-cumulative-distribution/[>=1.0,<2]

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

The target object and attribute to write the transformed values to.

Object to write the transformed values to. Supported schemas: 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]

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

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "distribution": "https://example.com",
  "target": {
    "object": "https://example.com",
    "attribute": {
      "name": "string"
    }
  }
}

Returns

200

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

Examples: "example string", "another example"

A message describing what happened in the task.

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

The target object that was created or updated.

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Attribute containing the transformed values.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/normal-score

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/normal-score' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

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

Profit calculation

Geostatistics Task API

Version: 0.6.7

Preview

Calculate profit given block model and economic parameters

Preview API

Parameters

The organisation identifier

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

The source object and attribute containing known values.

Example: "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json"

Example: "cell_attributes[?attribute_type=='ensemble_continuous']"

The original values, used to calculate grade categories.

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

The target object and attribute to create or update with grade calculation results.

Example: "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json"

Examples: {"name":"grade-category","operation":"create"}, {"name":"existing-grade-category","operation":"update"}

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

The operation to perform on the attribute.

The name of the attribute to create.

The operation to perform on the attribute.

Reference to an existing attribute to update.

List of material categories, sorted from lowest to highest cutoff grade

Examples: 0.16, 0.5, 0.9

The cutoff grade

Examples: 134.23, 245.12, 9876.34

The metal price

Examples: "ore", "waste"

Default: "waste"

The category label

Examples: 37.85, 55.2, 61.85, 82.94, 97.31

Processing cost per unit of material

Examples: 4.58, 22.79, 57.74, 70.46, 86.17

Mining cost per unit of waste material

Examples: 7.98, 10.1, 23.28, 27.8, 28.94

Mining cost per unit of ore material

Examples: 0.21, 0.267, 0.365, 0.37, 0.636

Fraction of metal expected to be recovered during processing

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "object": "https://example.com",
    "attribute": {
      "name": "string"
    }
  },
  "material_categories": [
    {
      "cutoff_grade": 0,
      "metal_price": 0,
      "label": "waste"
    }
  ],
  "processing_cost": 0,
  "mining_waste_cost": 0,
  "mining_ore_cost": 0,
  "metal_recovery_fraction": 0
}

Returns

200

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

Examples: "Success", "Failed"

Description of the result

The target that was created or updated.

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Attribute containing the material category results from the grade calculation.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/profit-calculation

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/profit-calculation' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "message": "string"
}

Simulation post-processing

Geostatistics Task API

Version: 0.6.7

Preview

For more information, please read the guide

Preview API

Parameters

The organisation identifier

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

Source object and attribute containing ensemble values.

Spatial locations of known values. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2], tensor-3d-grid/[>=1.2,<2]

Reference to the ensemble to be processed.

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

Target object to save summary statistics.

Object to evaluate onto. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2], tensor-3d-grid/[>=1.2,<2]

Examples: "A summary, typically short and to the point.", "An abridged summary of the description."

If true, compute summary statistics (min, max, mean, variance).

Example: [0.1,0.5,0.9]

List of quantiles between 0.0 and 1.0 to compute.

Compute P(value > cutoff) per location for each cutoff.

Example: [0.1,0.43,1.2]

List of cutoff values to compute P(value > cutoff) per location.

Compute E[value | value > cutoff] per location for each cutoff.

Example: [0.12,0.67]

List of cutoff values to compute E[value | value > cutoff] per location.

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "object": "https://example.com"
  }
}

Returns

200

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

Examples: "example string", "another example"

A message that says what happened in the task.

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

The target that was created or updated.

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

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

Computed location-wise values.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/location-wise

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/location-wise' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

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

Simulation validation report

Geostatistics Task API

Version: 0.6.7

Preview

For more information, please read the guide

Preview API

Parameters

The organisation identifier

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

Reference to the Geoscience Object containing the source points used for conditioning the simulation. Supported schemas: pointset/[>=1.2,<2]

Examples: "name_of_an_attribute", "an_attribute", "an_example_attribute_name"

Reference to the attribute containing the source values.

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

Reference to the Geoscience Object containing the grid that already has simulation results. The report will be placed next to this object. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

Examples: "example string", "another example"

Reference to the point-scale simulation results ensemble attribute on the target grid.

Examples: "example string", "another example"

Reference to the point-scale normal-score simulation results ensemble attribute on the target grid.

Examples: "example string", "another example"

Reference to the block-scale simulation results ensemble attribute on the target grid.

Examples: "example string", "another example"

Reference to the block-scale normal-score simulation results ensemble attribute on the target grid.

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

Reference to the variogram model used to model the covariance within the domain. Supported schemas: variogram/[>=1.1,<2]

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

Search neighborhood for conditioning.

The ellipsoid, to search for points within Alias: anisotropy

The ranges of the ellipsoid

The major axis length of the ellipsoid

The semi major axis length of the ellipsoid

The minor axis length of the ellipsoid

The rotation of the ellipsoid

first rotation, about the z-axis, in degrees

second rotation, about the x-axis, in degrees

third rotation, about the z-axis, in degrees

The maximum number of samples to use for each evaluation point. Alias: max-samples

Default: 1

The minimum number of samples to use for each evaluation point. Alias: min-samples

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

Sub-block discretization used for support correction within each grid block.

Default: 1

Number of subdivisions in the x direction

Default: 1

Number of subdivisions in the y direction

Default: 1

Number of subdivisions in the z direction

Parameters for a continuous distribution used for normal-score transformation.

Tail extrapolation

Power model for extrapolating the upper tail of the distribution.

Denominator of the exponent for the power model (between 0 exclusive and 1 inclusive).

Maximum extent of tail, must be greater than the maximum value in the data.

Power model for extrapolating the lower tail of the distribution. Optional.

Denominator of the exponent for the power model (between 0 exclusive and 1 inclusive).

Minimum extent of tail, must be less than the minimum value in the data.

Optional weights attribute for weighted distribution

Default: "simple"

The kriging method used for the conditioning step.

Examples: 74, 624, 664, 700, 960

Default: 500

Number of lines used for the turning-band simulation.

Examples: 22, 32, 69, 82, 94

The total number of simulations that were performed.

Examples: 20, 34, 48, 59, 81

Default: 38239342

Random seed for tie-breaking.

Material cost and category information for loss calculations.

Material cost parameters.

Processing cost per unit of material.

Mining cost per unit of ore material.

Mining cost per unit of waste material.

Fraction of metal expected to be recovered during processing.

List of material categories.

Name of the material category.

Cutoff grade for the material category.

Minimum metal price for the material category.

Context for the validation report.

Title that will appear on the report.

Key-value pairs of details to appear on the report.

Label of the context item, which will appear on the report.

Value of the context item.

Thresholds for the mean comparison in the validation report.

Threshold for the percentage difference between the reference and simulated means that is considered acceptable.

Threshold for the percentage difference between the reference and simulated means that is considered marginal.

{
  "simulation_source": "https://example.com",
  "source_attribute": "string",
  "simulation_target": "https://example.com",
  "point_simulations": "string",
  "point_simulations_normal_score": "string",
  "block_simulations": "string",
  "block_simulations_normal_score": "string",
  "variogram_model": "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,
    "min_samples": 1
  },
  "block_discretization": {
    "nx": 1,
    "ny": 1,
    "nz": 1
  },
  "number_of_lines": 500,
  "number_of_simulations": 0,
  "random_seed": 38239342
}

Returns

200

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

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

Summary of the validation results.

Mean of the input values.

Mean of the simulated values.

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

Link to the validation report file.

Reference to a file.

The name of the file, typically the terminal segment of the path.

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

Links related to the simulation report task.

Link to the validation dashboard.

Endpoint

POST

/compute/orgs/{org_id}/geostatistics/simulation-report

Request

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geostatistics/simulation-report' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "validation_summary": {
    "reference_mean": 0,
    "mean": 0
  },
  "validation_report": {
    "reference": "https://example.com",
    "name": "string"
  },
  "links": {}
}

Break ties​

Parameters

Path parameters

Path parameters

org_iduuidRequired

Body parameters

Body parameters

sourceSourceRequired

objecturiRequired

attributestringRequired

targetTargetRequired

objecturiRequired

attribute | Required

One of:

object

operationunknownRequired

namestringRequired

object

operationunknownRequired

referencestringRequired

seedinteger

neighborhoodBreakTiesSearchRequired

ellipsoidEllipsoidRequired

ellipsoid_rangesEllipsoid RangesRequired

majornumberRequired

semi_majornumberRequired

minornumberRequired

rotationRotationRequired

dip_azimuthnumber

dipnumber

pitchnumber

max_samplesintegerRequired

min_samplesinteger

Example body

Example body

Returns

200

Schema

messagestring

targetTarget

referenceuri

namestring

descriptionstring | null

schema_idstring

attributeAttribute

referencestring

namestring

Endpoint

Request

Response

Conditional turning bands​

Parameters

Path parameters

Path parameters

org_iduuidRequired

Body parameters

Body parameters

sourceuriRequired

source_attributestringRequired

targeturiRequired

filterobject | null

whereFilterCondition | AllOfFilter | AnyOfFilterRequired

One of:

FilterConditionobject

operator"in" | "not_in" | "equal" | "not_equal" | "greater_than" | "greater_than_or_equal_to" | "less_than" | "less_than_or_equal_to"Required

valuesarray | null

thresholdnumber | null

typeunknown

attributestringRequired

AllOfFilterobject

typeunknown

filtersFilter Expression[]Required

One of:

FilterConditionobject

operator"in" | "not_in" | "equal" | "not_equal" | "greater_than" | "greater_than_or_equal_to" | "less_than" | "less_than_or_equal_to"Required

valuesarray | null

thresholdnumber | null

typeunknown

attributestringRequired

AnyOfFilterobject

Break ties

Conditional turning bands