API reference

API reference#

This page provides an auto-generated summary of eomatch’s API. For more details and examples, refer to the relevant chapters in the user guide.

Domain model#

`MatchupEvent`(collections, platforms, ...[, ...])	Interface event of satellites crossing each other
`MatchupEvent.to_stac_item`()	Return a STAC Item representing this matchup event.
`MatchupEvent.from_stac_item`(item)	Reconstruct a MatchupEvent from a STAC Item.
`MatchupEvent.get_scrappi_queries`()	Prepare one scrappi query per collection/platform pair in this MatchupEvent.
`MatchupEvent.stac_id`	STAC Item ID for this matchup event.
`MatchupEvent.platformstring`	Return platform names joined by underscore.
`MatchupEventSet`([events])	Container for `MatchupEvent` objects
`Matchup`([products, context, assets])	Interface collocated products
`Matchup.collocation_region`	Returns polygon of collocation region for matchup products
`Matchup.product_time_bounds`	Returns earliest start time and latest stop time of matchup products
`Matchup.time_diff_abs`	Returns the absolute time difference between matchup product start times in seconds
`Matchup.time_diff`([collection1, collection2])	Returns the time difference `collection2 - collection1` in total seconds.
`Matchup.return_matchup_dataset`([...])	Return match-up dataset by downloading the products if required, reading in data for each product and assembling a match-up DataTree.
`Matchup.to_stac_item`([event_id])	Return a STAC Item representing this matchup.
`Matchup.from_stac_item`(item)	Reconstruct a Matchup from a STAC Item.
`Matchup.stac_id`	STAC Item ID for this matchup, or `None` if no products are set.
`MatchupSet`([matchups])	Container for `Matchup` objects
`MatchupSet.collections`	Returns collection sets of matchups within matchup set

Discovery#

`Sat2SatMUFinder`(args, *kwargs)	Finder for collocated pairs of satellite image products.
`Sat2SatMUFinder.finder`()	Run the full matchup discovery pipeline.
`Sat2SatMUFinder.get_orbitx_ds`()	Return an `orbitx` matchup dataset, either from a cached NetCDF or by running the propagator.
`Sat2SatMUFinder.filter_events`(data)	Filter a list of raw orbitx events against the bounds in the context config.
`Sat2SatMUFinder.to_matchup_event`(events)	Convert raw orbitx event dicts to `MatchupEvent` objects.
`Sat2SatMUFinder.to_matchup_set`(mu_events)	Query scrappi for each event and build per-event `MatchupSet` objects.

Cataloguing#

`MatchupCatalogue`([id, description, path, ...])	STAC catalogue organising matchup events and matchup items.
`MatchupCatalogue.add_event`(event)	Add a MatchupEvent to the catalogue, returning its STAC Item.
`MatchupCatalogue.add_matchup`(matchup[, event_id])	Add a Matchup and its source products to the catalogue, returning its STAC Item.
`MatchupCatalogue.get_events`([collections, ...])	Return MatchupEvents from the catalogue, each with its MatchupSet populated.
`MatchupCatalogue.save`([path, catalog_type])	Normalise hrefs and write the catalogue to disk.
`MatchupCatalogue.open`(path)	Open an existing catalogue from a root `catalog.json` path.
`MatchupCatalogue.download_products`([...])	Download all source products for the given events and register each as a `"data"` STAC asset on the matching product Item in the catalogue.
`MatchupCatalogue.add_product_asset`(product, ...)	Add or replace a STAC asset on a product Item in the catalogue.
`MatchupCatalogue.add_event_asset`(event, ...)	Add or replace a STAC asset on a matchup event Item in the catalogue.
`MatchupCatalogue.add_matchup_asset`(matchup, ...)	Add or replace a STAC asset on a matchup Item in the catalogue.
`MatchupCatalogue.add_matchup_collection_asset`(...)	Add or replace a STAC asset on the matchup Collection (e.g. `LANDSAT_C2L1-vs-S3_EFR`).
`MatchupCatalogue.add_event_collection_asset`(...)	Add or replace a STAC asset on the matchup-events Collection (e.g. `matchup-events-LANDSAT_C2L1-vs-S3_EFR`).
`MatchupCatalogue.remove_product_asset`(...[, ...])	Remove a STAC asset from a product Item, optionally deleting the local file.
`MatchupCatalogue.remove_event_asset`(event, ...)	Remove a STAC asset from a matchup event Item, optionally deleting the local file.
`MatchupCatalogue.remove_matchup_asset`(...[, ...])	Remove a STAC asset from a matchup Item, optionally deleting the local file.
`MatchupCatalogue.remove_matchup_collection_asset`(...)	Remove a STAC asset from the matchup Collection, optionally deleting the local file.
`MatchupCatalogue.remove_event_collection_asset`(...)	Remove a STAC asset from the matchup-events Collection, optionally deleting the local file.