Normal score forward

Preview API

This endpoint is marked as a preview API. 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 endpoint.

This task transforms data into values that follow a standard normal distribution, also known as a gaussian distribution. It preserves the values' rank order. It comes in handy because some geostatistical methods are designed to work with gaussian data.

Parameters

• source (geoscience object reference)
  • A geoscience object reference that points to a one-dimensional continuous attribute inside a pointset or downhole-intervals object.
• target (geoscience object reference)
  • A geoscience object reference that tells the task where to save the result. It must point to an attribute inside a pointset, downhole-intervals, regular-3d-grid, or regular-masked-3d-grid object.
• distribution (geoscience object reference)
  • A geoscience object reference that points to a non-parametric-continuous-cumulative-distribution object. This should be the distribution of your source data.

Example

Request

requests.post(
    "https://{hub}.api.seequent.com/compute/orgs/{org_id}]/geostat/normal-score-forward",
    headers={"Authorization": "Bearer {token}"},
    json={
        "parameters": {
            "source": {
                "type": "geoscience-object-reference",
                "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-pointset.json",
                "object_element": [
                    {
                        "type": "element",
                        "path": "/locations/attributes/@name=my-data",
                    },
                ],
            },
            "target": {
                "type": "geoscience-object-reference",
                "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-pointset.json",
                "object_element": [
                    {
                        "type": "element",
                        "path": "/locations/attributes/@name=my-gaussian-data",
                    },
                ],
            },
            "distribution": {
                "type": "geoscience-object-reference",
                "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-distribution.json",
            },
        },
    },
)

Result

{
    "message": "Forward normal-score transformation completed.",
    "object_modified": {
        "type": "geoscience-object-reference",
        "object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-pointset.json",
        "object_element": [
            {
                "type": "element",
                "path": "/locations/attributes/@name=my-gaussian-data",
            },
        ],
    },
}

Tips

• The source and target can use the same object, but they don't have to.