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 and should be human
readable.
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
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 containing geojson features or STAC items
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_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
()load
([uid])Load an object given a UID.
pop
(k[,d])If key is not found, default is returned if given, otherwise KeyError is raised
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.
setdefault
(key[, default])Insert key with a value of default if key is not in the dictionary.
share
(servicer[, ttl])Shares a dataset, producing a token that will allow unauthenticated users to run a proxied boson request
share_as_arcgis_service
([ttl])Share a dataset as a GeoServices/ArcGIS service
share_as_ogc_tiles_service
([ttl])Share a dataset as a OGC Tiles service
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