API Reference

odc.stac

load(items[, bands, groupby, resampling, ...])	STAC Item to xarray.Dataset.
configure_rio(*[, cloud_defaults, verbose, aws])	Change GDAL/rasterio configuration.
configure_s3_access([profile, region_name, ...])	Credentialize for S3 bucket access or configure public access.
parse_item(item[, template, md_plugin])	Extract raster band information relevant for data loading.
parse_items(items[, cfg, md_plugin])	Parse sequence of STAC Items into internal representation.
extract_collection_metadata(item[, cfg, ...])	Use sample item to figure out raster bands within the collection.
output_geobox(items[, bands, crs, ...])	Used to compute output geobox from load parameters.

odc.stac.ParsedItem

ParsedItem(id, collection, bands[, ...])	Captures essentials parts for data loading from a STAC Item.
ParsedItem.assets()	Extract bands grouped by asset they belong to.
ParsedItem.crs([bands])	First non-null CRS across assets.
ParsedItem.geoboxes([bands])	Unique GeoBox s, highest resolution first.
ParsedItem.image_geometry([crs, bands])	Extract footprint of a given band(s) from proj metadata in a given projection.
ParsedItem.resolve_bands([bands])	Query bands taking care of aliases.
ParsedItem.safe_geometry([crs, bands])	Get item geometry footprint in desired projection or native.
ParsedItem.solar_date_at(lon)	Nominal datetime adjusted by longitude.
ParsedItem.strip()	Copy of self but with stripped bands.
RasterBandMetadata([data_type, nodata, ...])	Common raster metadata per band.
RasterCollectionMetadata(name, meta, ...)	Information about raster data in a collection.
RasterLoadParams([dtype, fill_value, ...])	Captures data loading configuration.
RasterSource(uri[, band, subdataset, ...])	Captures known information about a single band.

odc.stac.bench

BenchmarkContext(cluster_info, npix, nbytes, ...)	Benchmark Context Metadata.
BenchLoadParams([scenario, method, chunks, ...])	Per experiment configuration.
dump_site(site[, overwrite])	Prepare input for benchmarking.
load_from_json(geojson, params, **kw)	Turn passed in geojson into a Dask array.
run_bench(xx, client[, ntimes, col_width, ...])	Run same configuration multiple times and resport timing.
load_results(sources)	Load benchmark run results.

odc.stac.eo3

stac2ds(items[, cfg, product_cache])

STAC Item to Dataset stream converter.