Glossary in SDK

Overview

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.

View repository

Class: CollectionType

An enumeration class that defines types of geospatial collections.

Constants

Constant	Description	Value
`ARCHIVE`	str A catalog collection.	`ARCHIVE`
`TASKING`	str A tasking collection.	`TASKING`

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}")

Class: ResolutionValue

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`.

Class: CollectionMetadata

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.

Class: Scene

A data class that represents a scene in the system.

Attributes

Attribute	Description
`bbox`	Optional[BoundingBox] The bounding box.
`geometry`	Union[geojson.Polygon, geojson.MultiPolygon] The geometry in the GeoJSON format.
`id`	str The scene ID.
`datetime`	Optional[str] The date and time when the sensor acquired the data.
`start_datetime`	Optional[str] The date and time when the sensor started the acquisition process.
`end_datetime`	Optional[str] The date and time when the sensor finished the acquisition process.
`constellation`	str The name of the sensor.
`collection`	str The name of the collection.
`cloud_coverage`	Optional[float] The percentage of cloud coverage.
`resolution`	Optional[float] The spatial resolution, in meters.
`delivery_time`	Optional[Literal[“MINUTES”, “HOURS”, “DAYS”]] The unit of data delivery time.
`producer`	str The name of the producer. Data producers are companies that initially acquired and processed the source data. Data acquired by a producer can be distributed to various hosts.
`quicklook`	utils.ImageFile The quicklook file. Quicklooks are low-resolution scene previews.

Class: Provider

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: `PRODUCER`: A provider that initially acquired and processed the source data. Data acquired by a producer can be distributed to various hosts. `HOST`: A provider that offers access to data acquired by a producer.

Properties

is_host

Checks if the provider has the HOST role. Returns bool.

Methods

search

Searches the catalog and retrieves scenes. Returns Iterator[Scene]. Use itertools.islice to offset and limit the results.

Parameter	Description
`bbox`	Optional[BoundingBox] A search geometry in the GeoJSON format. Returns images that intersect with the defined rectangle and may not fully cover it. Use only if `intersects` isn’t specified.
`intersects`	Optional[geojson.Polygon] A polygon in the GeoJSON format.
`start_date`	Optional[str] Search for full scenes that were acquired after the given start date, in the `YYYY-MM-DD` format.
`end_date`	Optional[str] Search for full scenes that were acquired before the given end date, in the `YYYY-MM-DD` format.
`query`	Optional[dict] A STAC query object.
`collections`	Optional[list[str]] The names of the collections whose full scenes you want to include in search results.

Python

    # Retrieve catalog collections
catalog_collections = up42.ProductGlossary.get_collections(collection_type=up42.CollectionType.ARCHIVE)

# Retrieve providers
providers = collection.providers

# Filter out providers that are also hosts
host_providers = [provider for provider in providers if provider.is_host]

# Perform search on each host provider
all_scenes = itertools.chain(host.search(start_date="2025-01-06") for host in host_providers)

Class: DataProduct

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.

Properties

schema

Retrieves the schema of the data product. Returns Optional[dict].

Class: Collection

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.

Class: CollectionSorting

A class that contains predefined sorting fields.

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.

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}")

Class: ProductGlossary

A data class that represents product glossary in the system.

Methods

get_collections

Retrieves a list of geospatial collections. Returns Iterator[Collection]. Use itertools.islice to offset and limit the results.

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.

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"")

Glossary in SDK

Choose data offerings from the glossary using the SDK.

Overview

Class: CollectionType

Class: ResolutionValue

Class: CollectionMetadata

Class: Scene

Class: Provider

is_host

search

Class: DataProduct

schema

Class: Collection

Class: CollectionSorting

Class: ProductGlossary

get_collections

Learn more

API docs | Glossary