Collection.find | tilebox.datasets

python

def Collection.find(
    datapoint_id: str,
    skip_data: bool = False
) -> xarray.Dataset

Find a specific datapoint in a collection by its id.

Parameters

datapoint_id str

The id of the datapoint to find.

skip_data bool

If True, the response contains only the ID and the timestamp for the datapoint. Defaults to False.

Returns

An xarray.Dataset containing the requested data point.

Since it returns only a single data point, the output xarray dataset does not include a time dimension.

Errors

NotFoundError No such datapoint: <id>

The specified datapoint does not exist in this collection.

Usage example

python

data = collection.find(
    "0186d6b6-66cc-fcfd-91df-bbbff72499c3",
)


# check if a datapoint exists
from tilebox.datasets.sync.dataset import (
    NotFoundError,
)

try:
    collection.find(
        "0186d6b6-66cc-fcfd-91df-bbbff72499c3",
        skip_data=True,
    )
    exists = True
except NotFoundError:
    exists = False