The glossary provides information on UP42 data offerings. It helps you create orders.
Collections serve as the higher-level category, containing one or more data products related to the actual configuration of data available for ordering.
An enumeration class that defines types of geospatial collections.
Examples
Python
glossary = up42.glossary.ProductGlossary
tasking_collections = glossary.get_collections(
collection_type = up42.glossary.CollectionType.TASKING,
sort_by = up42.glossary.CollectionSorting.name.asc,
)
for collection in tasking_collections:
print(f"{collection.name}")
Constants
| Constant | Description | Value |
|---|---|---|
ARCHIVE | str A catalog collection. | ARCHIVE |
TASKING | str A tasking collection. | TASKING |
A data class that represents the resolution of data within a collection.
Attributes
| Attribute | Description |
|---|---|
minimum | float The best possible resolution available for the collection, in meters. |
description | Optional[str] A description of the resolution. |
maximum | Optional[float] The least detailed resolution available for the collection, in meters. The parameter is omitted if the collection has only one resolution value, specified in minimum. |
A data class that contains metadata related to a collection.
Attributes
| Attribute | Description |
|---|---|
product_type | Optional[Literal[“OPTICAL”, “SAR”, “ELEVATION”]] The type of product the collection delivers. |
resolution_class | Optional[Literal[“VERY_HIGH”, “HIGH”, “MEDIUM”, “LOW”]] The spatial resolution class. |
resolution_value | Optional[ResolutionValue] The level of detail achievable for the collection. |
A data class that represents a provider in the system.
Attributes
| Attribute | Description |
|---|---|
name | str The name of the provider. |
title | str The title of the provider. |
description | str The description of the provider. |
roles | list[Literal[“PRODUCER”, “HOST”]] Provider roles:
|
A data class that represents a data product in the system.
Attributes
| Attribute | Description |
|---|---|
name | str The data product name. |
title | str The title of the data product. |
description | str The description of the data product. |
id | Optional[str] The data product ID. |
eula_id | Optional[str] The EULA ID. |
A data class that represents a collection in the system.
Attributes
| Attribute | Description |
|---|---|
name | str The name of the collection. |
title | str The title of the collection. |
description | str The description of the collection. |
type | CollectionType The type of the collection. |
integrations | list[IntegrationValue] Integration values. |
providers | list[Provider] Providers. |
data_products | list[DataProduct] Data products. |
metadata | Optional[CollectionMetadata] The collection metadata. |
A class that contains predefined sorting fields.
Examples
Python
glossary = up42.glossary.ProductGlossary
tasking_collections = glossary.get_collections(
collection_type = up42.glossary.CollectionType.TASKING,
sort_by = up42.glossary.CollectionSorting.name.asc,
)
for collection in tasking_collections:
print(f"{collection.name}")
Attributes
| Attribute | Description |
|---|---|
name | utils.SortingField Sorts by collection name. The default order is ascending. |
title | utils.SortingField Sorts by collection title. The default order is ascending. |
description | utils.SortingField Sorts by collection description. The default order is ascending. |
type | utils.SortingField Sorts by collection type. The default order is ascending. |
A data class that represents product glossary in the system.
Examples
Python
glossary = up42.glossary.ProductGlossary
tasking_collections = glossary.get_collections(
collection_type = up42.glossary.CollectionType.TASKING,
sort_by = up42.glossary.CollectionSorting.name.asc,
)
catalog_collections = glossary.get_collections(
collection_type = up42.glossary.CollectionType.ARCHIVE,
sort_by = up42.glossary.CollectionSorting.name.asc,
)
print(f"Tasking collections")
for collection in tasking_collections:
print(f" {collection.title}: {collection.name}")
print(f" {collection.description}")
print(f"")
print(f"Catalog collections")
for collection in catalog_collections:
print(f" {collection.title}: {collection.name}")
print(f" {collection.description}")
print(f"")
Functions
get_collections
Retrieves a list of geospatial collections. Returns Iterator[Collection].
| Parameter | Description |
|---|---|
collection_type | Optional[CollectionType] The type of the collection. |
sort_by | Optional[utils.SortingField] The results sorting method that arranges elements in ascending or descending order based on a chosen field. |