Tasks

Collection of on-demand tasks

---

Gravity terrain correction task

Geophysics API

Version: 2.2.0

Preview

Gravity terrain correction compute task for geophysical surveys

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

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

A 2D regular grid with topography values as attributes and (optionally, if a water layer is present) elevations of the top of the solid earth (the base of any water layer) Supported schemas: regular-2d-grid/[>=1.2,<2]

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

A point set with gravity stations for which terrain corrections will be calculated. Supported schemas: pointset/[>=1.2,<2]

Examples: 2.501, 22.321, 27.503, 63.943, 73.647

Radius used for terrain correction [m]. Should ideally be small enough so that a horizontal circle of this radius around any observation point fits within the grid area.

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

Parameters for the terrain layer, including density and reference to elevation attribute. In the absence of a specified water layer, the terrain represents the topography. If a water layer is provided, the terrain represents the elevation of the top of the solid earth (the base of the water layer).

Density of the layer [kg/m^3]

Reference to an attribute of a 2D grid representing the elevations of a layer defining a stratigraphic surface. Elevations [m] correspond to the same third coordinate axis as used in the observation points.

Optional: Parameters for a water layer to be used in the model. If provided, the terrain layer represents the elevation of the top of the solid earth (the base of the water layer). At locations without water, terrain and water elevations should be identical. If not provided, no water layer is modeled.

Density of the layer [kg/m^3]

Reference to an attribute of a 2D grid representing the elevations of a layer defining a stratigraphic surface. Elevations [m] correspond to the same third coordinate axis as used in the observation points.

{
  "surfaces": "https://example.com",
  "observation_points": "https://example.com",
  "correction_radius": 0,
  "terrain_layer": {
    "density": 0,
    "elevation": "string"
  }
}

Returns

200

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

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

The object containing the computed terrain correction values.

Reference to a geoscience object. Supported schemas: pointset/[>=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 terrain correction associated with each location at the input observation points. The terrain correction corresponds to the vertical gravity component. Unit is in m/s² and corresponds to the coordinate system of the observation points where z-axis is positive upwards. This means that the terrain correction values should be multiplied by -1 if applied to gravity observations assuming a z-axis positive downwards.

Reference to the attribute in the geoscience object.

The name of the output attribute.

Endpoint

POST

/compute/orgs/{org_id}/geophysics/gravity-terrain-correction

Request

cURL

​

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geophysics/gravity-terrain-correction' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

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

---

Convert a regular 2D grid to a triangle mesh

Geophysics API

Version: 2.2.0

Preview

Convert a regular 2D grid to a triangle mesh using a cell-centered or vertex-centered scalar attribute as Z values. Supports optional NaN filtering.

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}

Source grid and attribute

Input regular 2D grid containing the scalar attribute to use as Z values Supported schemas: regular-2d-grid/[>=1.2,<2]

Scalar attribute to use as Z values for the triangle mesh

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

Optional settings for mesh generation

Reverse triangle winding order (flip normals)

Default: true

Exclude triangles that touch NaN attribute values

Add a centroid vertex to each quad and split into 4 triangles instead of 2, producing a smoother surface at the cost of twice as many triangles

Default: "2.2"

Triangle mesh schema version for output payload. Use 2.1 for Oasis Montaj compatibility or 2.2 for latest schema.

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

Where to create the output Triangle Mesh object

Reference to the targeted object. Supported schemas: triangle-mesh/[>=2.0,<3]

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"
  },
  "settings": {
    "flip_triangles": false,
    "drop_nan_patches": true,
    "use_centroids": false
  },
  "target": {
    "reference": "https://example.com",
    "overwrite": false,
    "tags": {
      "Additional properties": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  }
}

Returns

200

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

Reference to the created Triangle Mesh object.

Reference to a geoscience object. Supported schemas: triangle-mesh/[>=2.0,<3]

The name of the geoscience object.

The description of the geoscience object.

The ID of the Geoscience Object schema.

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

Summary statistics for the generated triangle mesh.

Number of triangles in the generated mesh

Number of vertices in the mesh vertex array

Whether the mesh has orphan vertices not referenced by any triangle

Always false — splitting a regular grid into triangles cannot produce edges shared by more than 2 triangles

Examples: true, false

True if the source attribute contains NaN values.

Examples: 11, 69, 75, 86, 94

Number of NaN values in the source attribute.

Examples: true, false

True if the source grid has a non-identity rotation.

Endpoint

POST

/compute/orgs/{org_id}/geophysics/regular-2d-grid-to-trimesh

Request

cURL

​

curl -X POST 'https://{service_host}/compute/orgs/{org_id}/geophysics/regular-2d-grid-to-trimesh' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "has_nan": true,
  "nan_count": 0,
  "is_rotated": false
}