energy_data_retrieval.sources.orbitalpv_imagery.client#
Reuse Orbital PV for satellite imagery; add bounded Maxar Open Data discovery.
- class energy_data_retrieval.sources.orbitalpv_imagery.client.ImagerySearch(provider, items, bounds_wgs84, time_min, time_max, complete, requests, metadata)[source]#
Bases:
objectSearch scope and completeness, not a promise of global finest imagery.
- Parameters:
provider (str)
items (tuple[dict[str, Any], ...])
bounds_wgs84 (Bounds)
time_min (str)
time_max (str)
complete (bool)
requests (tuple[RequestRecord, ...])
metadata (dict[str, Any])
- provider: str#
- items: tuple[dict[str, Any], ...]#
- bounds_wgs84: Bounds#
- time_min: str#
- time_max: str#
- complete: bool#
- requests: tuple[RequestRecord, ...]#
- metadata: dict[str, Any]#
- class energy_data_retrieval.sources.orbitalpv_imagery.client.AssetResolution(scene_id, asset_key, product_kind, native_gsd_m, grid_spacing_m, detail_limit_m, acquisition_utc, platform)[source]#
Bases:
objectKeep sensor sampling separate from the delivered raster/display grid.
detail_limit_mis a conservative sampling bound, not measured resolving power or positional accuracy. Unknown native GSD remains None. A finer display grid cannot improve this bound; panchromatic GSD must not be used as the native spectral resolution of multispectral bands.- Parameters:
scene_id (str)
asset_key (str)
product_kind (str)
native_gsd_m (float | None)
grid_spacing_m (tuple[float, float] | None)
detail_limit_m (float | None)
acquisition_utc (str)
platform (str)
- scene_id: str#
- asset_key: str#
- product_kind: str#
- native_gsd_m: float | None#
- grid_spacing_m: tuple[float, float] | None#
- detail_limit_m: float | None#
- acquisition_utc: str#
- platform: str#
- energy_data_retrieval.sources.orbitalpv_imagery.client.describe_asset(item, asset='visual')[source]#
Inspect a STAC asset without opening its pixels or inventing native GSD.
- Parameters:
item (dict[str, Any])
asset (str)
- Return type:
- energy_data_retrieval.sources.orbitalpv_imagery.client.select_finest(search, *, asset='pan_analytic', maximum_detail_m=None, allow_incomplete=False)[source]#
Choose finest declared native detail for the same asset across matching scenes.
This ranks the specified event/date/AOI search, not all imagery worldwide. Search caps and missing GSD cannot silently establish a finest-image claim. Ties use acquisition time then item ID; cloud/validity still need inspection.
- Parameters:
search (ImagerySearch)
asset (str)
maximum_detail_m (float | None)
allow_incomplete (bool)
- Return type:
dict[str, Any]
- class energy_data_retrieval.sources.orbitalpv_imagery.client.OrbitalPVImageryClient(http)[source]#
Bases:
objectSentinel-2 and event-limited Maxar satellite imagery using Orbital PV.
Public native pixels are read and persisted by Orbital PV, not copied implementations. No accounts, purchases, tasking or commercial entitlements are created. Maxar Open Data carries CC-BY-NC-4.0 at the event level; preserve original lower-level licence declarations as well.
- Parameters:
http (HTTPClient)
- search_sentinel(bounds_wgs84, *, time_min, time_max, max_cloud_cover=20.0, max_items=100, cache_path=None)[source]#
Delegate bounded search and its query-bound cache to Orbital PV.
- Parameters:
bounds_wgs84 (Bounds)
time_min (str)
time_max (str)
max_cloud_cover (float)
max_items (int)
cache_path (str | None)
- Return type:
- events()[source]#
List the provider’s explicit public event catalogue and licence.
- Return type:
dict[str, Any]
- search_maxar(event, bounds_wgs84, *, time_min, time_max, acquisition_ids=None, maximum_documents=512, maximum_items=500)[source]#
Traverse one bounded event, pruning by collection extent and dates.
Filters are inclusive UTC instants. An optional acquisition selection narrows the claim to those acquisitions. Any traversal/item budget breach raises, so a partial traversal cannot masquerade as a finest selection. Full scene/asset metadata and every visited document’s receipt survive.
- Parameters:
event (str)
bounds_wgs84 (Bounds)
time_min (str)
time_max (str)
acquisition_ids (tuple[str, ...] | None)
maximum_documents (int)
maximum_items (int)
- Return type:
- read_image(item, bounds_wgs84, *, asset='visual', maximum_samples=4000000)[source]#
Use Orbital PV’s native COG reader; return its full GroundImage object.
maximum_samplesbounds bands times rows times columns before reading. GDAL may transfer whole compressed blocks; this is not a network-byte limit. No resize, overview selection, sharpening or implicit cloud mask is requested. Declared grid spacing is checked against the actual TIFF.- Parameters:
item (dict[str, Any])
bounds_wgs84 (Bounds)
asset (str)
maximum_samples (int)
- Return type:
Any