Class: QgsStacCollection¶
Class for storing a STAC Collection’s data.
Added in version 3.44.
Class Hierarchy¶
Base classes¶
Class for storing a STAC Catalog’s data. |
|
Abstract base class for storing STAC objects. |
Methods
Returns a dictionary of asset objects in the catalog, each with a unique id key. |
|
Returns the collection's spatial and temporal extent |
|
Returns the list of keywords describing the Collection |
|
Returns the Collection's license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases. |
|
Returns a list of providers, which may include all organizations capturing or processing the data or the hosting provider. |
|
Sets the asset objects in the catalog, each with a unique id key. |
|
Sets the collection's spatial and temporal extent |
|
Sets the list of keywords describing the Collection |
|
Sets the Collection's license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases. |
|
Sets a list of providers, which may include all organizations capturing or processing the data or the hosting provider. |
|
Sets the map of property summaries to the collection |
|
Returns a map of property summaries from the collection |
- class qgis.core.QgsStacCollection[source]¶
Bases:
QgsStacCatalog
- __init__(id: str | None, version: str | None, description: str | None, links: Iterable[QgsStacLink], license: str | None, extent: QgsStacExtent)
Constructs a valid QgsStacCollection
- Parameters:
id (Optional[str]) – Identifier for the Collection that is unique across the provider.
version (Optional[str]) – The STAC version the Collection implements.
description (Optional[str]) – Detailed multi-line description to fully explain the Collection. CommonMark 0.29 syntax MAY be used for rich text representation.
links (Iterable[QgsStacLink]) – A list of references to other documents.
license (Optional[str]) – Collection’s license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases.
extent (QgsStacExtent) – Spatial and temporal extents of the collection.
- __init__(a0: QgsStacCollection)
- Parameters:
a0 (QgsStacCollection)
- assets(self) Dict[str, QgsStacAsset] ¶
Returns a dictionary of asset objects in the catalog, each with a unique id key.
- Return type:
Dict[str, QgsStacAsset]
- extent(self) QgsStacExtent [source]¶
Returns the collection’s spatial and temporal extent
- Return type:
- keywords(self) List[str] [source]¶
Returns the list of keywords describing the Collection
- Return type:
List[str]
- license(self) str [source]¶
Returns the Collection’s license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases.
- Return type:
str
- providers(self) List[QgsStacProvider] ¶
Returns a list of providers, which may include all organizations capturing or processing the data or the hosting provider. Providers should be listed in chronological order with the most recent provider being the last element of the list.
- Return type:
List[QgsStacProvider]
- setAssets(self, assets: Dict[str | None, QgsStacAsset])[source]¶
Sets the asset objects in the catalog, each with a unique id key.
- Parameters:
assets (Dict[Optional[str], QgsStacAsset])
- setExtent(self, extent: QgsStacExtent)[source]¶
Sets the collection’s spatial and temporal extent
- Parameters:
extent (QgsStacExtent)
- setKeywords(self, keywords: Iterable[str | None])[source]¶
Sets the list of
keywords
describing the Collection- Parameters:
keywords (Iterable[Optional[str]])
- setLicense(self, license: str | None)[source]¶
Sets the Collection’s license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases.
- Parameters:
license (Optional[str])
- setProviders(self, providers: Iterable[QgsStacProvider])[source]¶
Sets a list of
providers
, which may include all organizations capturing or processing the data or the hosting provider. Providers should be listed in chronological order with the most recent provider being the last element of the list.- Parameters:
providers (Iterable[QgsStacProvider])