Glossary module

Collection class

The Collection data class represents a data product within a collection.

Collection class attributes

Attribute	Description
`name`	str \| required The name of the collection.
`title`	str \| required The title of the collection.
`description`	str \| required The description of the collection.
`type`	CollectionType \| required The type of the collection.
`integrations`	list[IntegrationValue] \| required Integration values.
`providers`	list[Provider] \| required Providers.
`data_products`	list[DataProduct] \| required Data products.
`metadata`	CollectionMetadata The collection metadata.

CollectionMetadata class

The CollectionMetadata data class contains metadata related to a collection.

ResolutionValue class attributes

Attribute	Description
`product_type`	literal[“OPTICAL”, “SAR”, “ELEVATION”] The type of product the collection delivers.
`resolution_class`	literal[“VERY_HIGH”, “HIGH”, “MEDIUM”, “LOW”] The spatial resolution class.
`resolution_value`	ResolutionValue The level of detail achievable for the collection.

CollectionSorting class

The CollectionSorting class contains possible sorting parameters for the ProductGlossary::get_collections method.

Sorting field	Description
`name`	Sorts by collection name. The default order is ascending.
`title`	Sorts by collection title. The default order is ascending.
`description`	Sorts by collection description. The default order is ascending.
`type`	Sorts by collection type. The default order is ascending.

CollectionType

The CollectionType class contains product types for geospatial collections.

CollectionType class properties

Enum member	Description
`ARCHIVE`	str A ctalog collection.
`TASKING`	str A tasking collection.

DataProduct class

The DataProduct data class represents a data product within a collection.

DataProduct class attributes

Attribute	Description
`name`	str \| required The data product name.
`title`	str \| required The title of the data product.
`description`	str \| required The description of the data product.
`id`	str The data product ID.
`eula_id`	str The EULA ID.

IntegrationValue

Integration values indicate mandatory ordering steps, available actions, and mandatory or optional operations for a given collection.

ProductGlossary class

get_collections

The get_collections class method allows you to get a list of geospatial collections.

The returned data type is Iterator[Collection].

Argument	Description
`collection_type`	CollectionType The type of the collection.
`sort_by`	utils.SortingField The results sorting method that arranges elements in ascending or descending order based on a chosen field. To view the list of possible values, see `CollectionSorting`.

An example with get_collections

Python

    # Catalog collections
catalog_collections = up42.glossary.ProductGlossary.get_collections(
    collection_type=up42.glossary.CollectionType.ARCHIVE
)

next(catalog_collections)

# Tasking collections
tasking_collections = up42.glossary.ProductGlossary.get_collections(
    collection_type=up42.glossary.CollectionType.TASKING
)

next(tasking_collections)

Provider class

The Provider data class represents a provider associated with a collection.

Provider class attributes

Attribute	Description
`name`	str \| required The name of the provider.
`title`	str \| required The title of the provider.
`description`	str \| required The description of the provider.
`roles`	list[Literal[“PRODUCER”, “HOST”]] Provider roles: `PRODUCER`: a producer is a provider that initially acquired and processed the source data. Data acquired by a producer can be distributed to various hosts. `HOST`: a host is a provider that offers access to data acquired by a producer.

ResolutionValue class

The ResolutionValue data class represents the resolution of data within a collection.

ResolutionValue class attributes

Attribute	Description
`minimum`	float \| required The best possible resolution available for the collection, in meters.
`maximum`	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`.
`description`	str A description of the resolution.