Dataset#
- class geodesic.entanglement.dataset.Dataset(**obj)[source]#
Allows interaction with SeerAI datasets.
Dataset provides a way to interact with datasets in the SeerAI.
- Parameters:
**obj (dict) – Dictionary with all properties in the dataset.
- Variables:
alias (str) – Alternative name for the dataset. This name has fewer restrictions on characters
readable. (and should be human)
Attributes
alias
(str) - the alias of this object, anything you wish it to be
boson_config
(
BosonConfig
, dict) - boson configuration for this datasetcategory
(str) - the category of this object
data_api
(str) - the api to access the data
description
(str) - a text description of this object
domain
(str) - the domain of this object
extent
(
Extent
, dict) - spatiotemporal extent of this Datasetfull_name
Full name for an object.
geometry
(str, dict, bytes,
BaseGeometry
) - a geometry for this object.graph
If this object belongs to a graph, will return that parent graph.
hash
(str) - hash of this dataset
item
(dict) - an arbitrary dictionary of info about this object.
item_assets
(dict,
Asset
) - information about assets contained in this datasetitem_type
(str) - the api to access the data
links
list of links
metadata
(dict) - arbitrary metadata for this dataset
name
(str) - the name of this object, unique to the project
object_class
project
the project/subgraph this object belongs to
providers
list of providers for this dataset
services
(str) - list of services that expose the data for this dataset
stac_extensions
list of STAC extensions this dataset uses
type
(str) - the type of this object
uid
Get the object's UID, if set, None otherwise.
xid
(str) - An external reference id to another graph or system that references this object.
Methods
append_middleware
(middleware)Adds a middleware to the end of the middleware chain.
clear
()clear_store
([prefix])Clears the persistent store for this dataset.
clear_tile_cache
([cache_prefix])Clears the tile cache for this dataset.
command
(command, **kwargs)Issue a command to this dataset's provider.
connect_with
(predicate, object[, overwrite])Adds a connection from this Object to another using the specified Predicate.
connections
([version_datetime])Deprecated in v1.0.0
copy
()create
()Deprecated in 1.0.0
Returns information about this Dataset.
delete
([hard, show_prompt])Deletes this object from Entanglement.
from_arcgis_item
(name, item_id[, ...])Creates a new Dataset from an ArcGIS Online/Enterprise item.
from_arcgis_layer
(name, url[, ...])Creates a new Dataset from an ArcGIS Online/Enterprise Service URL.
from_arcgis_service
(name, url[, ...])Creates a new Dataset from an ArcGIS Online/Enterprise Service URL.
from_bucket
(name, url[, pattern, region, ...])Creates a new Dataset from a Cloud Storage Bucket (S3/GCP/Azure).
from_csv
(name, url[, index_data, crs, ...])Create a new Dataset from a CSV file in cloud storage.
from_elasticsearch_index
(name, url, ...[, ...])Create a new Dataset from an elasticsearch index.
from_geoparquet
(name, url[, feature_limit, ...])Creates a dataset from Hive-partitioned GeoParquet files in cloud storage.
from_google_earth_engine
(name, asset, credential)Creates a new Dataset from a Google Earth Engine Asset.
from_image_tiles
(name, url[, layer, ...])Creates a new Dataset from a WMTS server, ArcGIS Map Service Tiles, XYZ, or TMS service.
from_remote_provider
(name, url[, data_api, ...])Creates a dataset from a server implementing the Boson remote provider interface.
from_snowflake_table
(name, account, ...[, ...])Create a
Dataset
from a Snowflake table.from_stac
(item[, object_class])Derive a new Object from a STAC item.
from_stac_collection
(name, url[, ...])Create a new Dataset from a STAC Collection.
from_tabular_data
(name, url[, index_data, ...])Create a new Dataset from a vector file in cloud storage.
fromkeys
([value])Create a new dictionary with keys from iterable and values set to value.
get
(key[, default])Return the value for key if key is in the dictionary, else default.
get_connections
([version_datetime])Returns nearest neighbor connections to this object.
get_pixels
(*, bbox[, datetime, pixel_size, ...])Get pixel data or an image from this Dataset.
items
()join
(name, right_dataset[, field, ...])Creates a left join of this dataset with another dataset.
keys
()latest_token
(servicer[, persistent_only])Returns the latest token created for a dataset.
load
([uid])Load an object given a UID.
pop
(k[,d])If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem
()Remove and return a (key, value) pair as a 2-tuple.
query
([bbox, datetime, limit, page_size, ...])Deprecated in 1.0.0
reindex
([timeout])Issue a reindex command to this dataset's provider.
save
()Create or update a Dataset in Boson.
search
([bbox, datetime, limit, page_size, ...])Search the dataset for items.
set_cache_settings
([enable_persistence, ttl])Configure the cache for this dataset.
set_middleware
(middleware)Sets the middleware on this BosonConfig.
set_tile_min_max_zoom
([min_zoom, max_zoom])Set the min and max zoom levels for the tile provider.
set_time_enabled
(interval, interval_unit[, ...])Set the datetime fields for the dataset.
setdefault
(key[, default])Insert key with a value of default if key is not in the dictionary.
share
(servicer[, ttl, create_new])Shares a dataset, producing a token for unauthenticated users and apps.
share_as_arcgis_service
([ttl, create_new])Share a dataset as a GeoServices/ArcGIS service.
share_as_ogc_api_features
([ttl, create_new])Share a dataset as a OGC API: Features service or STAC API, depending on the dataset.
share_as_ogc_tiles_service
([ttl, create_new])Share a dataset as a OGC Tiles service.
share_as_stac_service
([ttl, create_new])Share a dataset as a OGC API: Features service or STAC API, depending on the dataset.
tokens
([servicer, persistent_only])Returns all share tokens a user has created for this dataset.
union
(name[, others, feature_limit, ...])Creates a union of this dataset with a list of others.
update
(*mapping, **kwargs)values
()view
(name[, bbox, intersects, datetime, ...])Creates a curated view of a
Dataset
.warp
(*, bbox[, datetime, pixel_size, shape, ...])Deprecated in 1.0.0