geodesic.boson#

This module contains types for working with configuration of Boson Datasets

Dataset Classes and Utilities#

Datasets area a special type of Entanglement Object that are used to represent data. They store the metadata that Boson needs to provide decentralized data access.

Dataset(**obj)

Allows interaction with SeerAI datasets.

DatasetList(datasets[, names])

Dataset Utility Functions#

get_dataset(name[, domain, category, type, ...])

Gets a Dataset from Entanglement by name or by a combination of qualifers and name.

get_datasets([names, domain, category, ...])

Gets a DatasetList from by name or by a combination of qualifers and name.

list_datasets([names, domain, category, ...])

Deprecated in 1.0.0

Data Structures#

AssetBands(*args, **kwargs)

Specify and asset from a dataset as well as a list of bands.

BosonConfig(*args, **kwargs)

BosonConfig Provider Configuration.

BosonDescr(**kwargs)

A Boson Provider Config.

CacheConfig([enabled, ttl])

Cache Configuration.

Middleware(*args, **kwargs)

MiddlewareConfig(*args, **kwargs)

Configures the Middleware for a Dataset.

TileOptions(*args, **kwargs)

VectorTileOptions(*args, **kwargs)

RasterTileOptions(*args, **kwargs)

TimeEnable(*args, **kwargs)

ServicerSettings(*args, **kwargs)

Middleware and Utilities#

band_arithmetic(expression, asset_name[, ...])

Creates a new asset by applying a band arithmetic expression to an existing asset.

bounds([input_collection, output_collection])

Calculate the bounds of the queried geometry.

buffer([distance, distance_field, segments, ...])

Buffer the queried geometry.

calculate_field(new_field, expression[, ...])

Creates a new field in the search response based on an expression.

centroid([input_collection, output_collection])

Calculate the centroid of the queried geometry.

colormap(*, asset, band[, colormap_name, ...])

Apply a colormap to the pixels data from an existing asset in the dataset.

combine_fields(new_field, fields[, ...])

Combine fields in the properties of a search response.

compute_id([input_collection, output_collection])

Compute an ID for each feature in the search response.

convex_hull([input_collection, ...])

Calculate the convex hull of the queried geometry.

cql2_filter([input_collection, ...])

Adds CQL filtering to a provider that may not implement it natively.

create_asset(new_asset_bands, input_asset_bands)

Create a new asset from existing assets in a dataset.

datetime_difference(datetime1, datetime2, ...)

Creates a new asset by calculating the difference between two datetime bands.

datetime_filter(field[, input_collection, ...])

Adds datetime filtering to a provider that may not implement it natively.

default_asset_bands(default_asset_bands)

Sets the default value of asset_bands in a pixels request on a Dataset.

default_datetime_range([start, end, ...])

Sets the default datetime range in a search request on a Dataset.

h3(resolution[, return_all, ...])

Adds the H3 cell to properties.

inverse_distance_weighting(attribute_name, ...)

Creates an interpolated image from a feature collection using inverse distance weighting.

normalized_difference(asset_band_1, ...[, ...])

Creates a new asset by calculating the normalized difference between two bands.

points_to_polyline(track_id_field, sort_field)

Create polyline/linestring features from an ordered sequence of points.

rasterize([attribute_name, value, use_z, ...])

Creates a rasterized image from a feature collection as a new raster asset.

rename_fields([case, field_map, ...])

Rename fields in the properties of a search response.

rescale_shift(asset[, bands, scale, shift, ...])

Rescale the pixel values of an asset in a dataset.

s2(level[, return_all, input_collection, ...])

Adds the S2 cell to properties.

simplify(threshold[, stride, ...])

Simplify the queried geometry.

spatial_filter([input_collection, ...])

Adds spatial filtering to a provider that may not implement it natively.