1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
|
# pylint: disable=line-too-long,useless-suppression
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------
"""
FILE: planetarycomputer_stac_specification.py
DESCRIPTION:
This sample demonstrates STAC API conformance, catalog operations, and item management:
- Checking API conformance
- Getting the landing page
- Searching collections
- Searching and querying items with filters, bounding boxes, temporal ranges
- Working with queryables
- Creating, updating, and deleting STAC items
- Creating or replacing STAC items (idempotent operations)
- Deleting STAC items
USAGE:
python planetarycomputer_stac_specification.py
Set the environment variable PLANETARYCOMPUTER_ENDPOINT with your endpoint URL.
Set the environment variable AZURE_COLLECTION_ID with your collection ID.
"""
import os
import json
import time
import asyncio
from azure.planetarycomputer.aio import PlanetaryComputerProClient
from azure.identity.aio import DefaultAzureCredential
from azure.planetarycomputer.models import (
StacSearchParameters,
FilterLanguage,
StacSearchSortingDirection,
StacSortExtension,
StacItem,
)
from azure.core.exceptions import (
HttpResponseError,
ResourceExistsError,
ResourceNotFoundError,
)
import logging
# Enable HTTP request/response logging
logging.getLogger("azure.core.pipeline.policies.http_logging_policy").setLevel(
logging.ERROR
)
logging.basicConfig(level=logging.INFO)
async def get_landing_page(client: "PlanetaryComputerProClient"):
"""Get the STAC landing page."""
landing_page = await client.stac.get_landing_page()
for link in landing_page.links[:5]: # Show first 5 links
logging.info(f" - {link.rel}: {link.href}")
async def search_collections(client: "PlanetaryComputerProClient"):
"""Search and list STAC collections."""
collections = await client.stac.list_collections()
# Show first few collections
for collection in collections.collections[:3]:
if collection.description:
desc = (
collection.description[:100] + "..."
if len(collection.description) > 100
else collection.description
)
logging.info(f" - {collection.id}: {desc}")
async def search_items(client: PlanetaryComputerProClient, collection_id):
"""Search STAC items with filters and sorting."""
# Create Search using StacSearchParameters
# Using date_time with range format instead of CQL2-JSON temporal filter
search_post_request = StacSearchParameters(
collections=[collection_id],
filter_lang=FilterLanguage.CQL2_JSON,
filter={
"op": "s_intersects",
"args": [
{"property": "geometry"},
{
"type": "Polygon",
"coordinates": [
[
[-84.46416308610219, 33.6033686729869],
[-84.38815071170247, 33.6033686729869],
[-84.38815071170247, 33.6713179813099],
[-84.46416308610219, 33.6713179813099],
[-84.46416308610219, 33.6033686729869],
]
],
},
],
},
date_time="2021-01-01T00:00:00Z/2022-12-31T00:00:00Z",
sort_by=[
StacSortExtension(
field="datetime", direction=StacSearchSortingDirection.DESC
)
],
limit=50,
)
# Create Search
search_post_response = await client.stac.search(body=search_post_request)
logging.info(f"Search returned {len(search_post_response.features)} items")
logging.info(json.dumps(search_post_response.as_dict()))
def get_sample_stac_item(collection_id: str, item_id: str) -> StacItem:
"""Create a sample STAC item."""
return StacItem(
{
"stac_version": "1.0.0",
"type": "Feature",
"id": item_id,
"collection": collection_id,
"bbox": [-84.44157, 33.621853, -84.370894, 33.690654],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[-84.372943, 33.621853],
[-84.370894, 33.689211],
[-84.439575, 33.690654],
[-84.44157, 33.623293],
[-84.372943, 33.621853],
]
],
},
"properties": {
"gsd": 0.6,
"datetime": "2021-11-14T16:00:00Z",
"naip:year": "2021",
"proj:bbox": [737334.0, 3723324.0, 743706.0, 3730800.0],
"proj:epsg": 26916,
"providers": [
{
"url": "https://www.fsa.usda.gov/programs-and-services/aerial-photography/imagery-programs/naip-imagery/",
"name": "USDA Farm Service Agency",
"roles": ["producer", "licensor"],
}
],
"naip:state": "ga",
"proj:shape": [12460, 10620],
"proj:transform": [
0.6,
0.0,
737334.0,
0.0,
-0.6,
3730800.0,
0.0,
0.0,
1.0,
],
},
"links": [
{
"rel": "collection",
"type": "application/json",
"href": "https://planetarycomputer.microsoft.com/api/stac/v1/collections/naip",
},
{
"rel": "root",
"href": "./catalog.json",
"type": "application/json",
"title": "NAIP: National Agriculture Imagery Program",
},
{
"rel": "parent",
"href": "./catalog.json",
"type": "application/json",
"title": "NAIP: National Agriculture Imagery Program",
},
],
"assets": {
"image": {
"href": "https://naipeuwest.blob.core.windows.net/naip/v002/ga/2021/ga_060cm_2021/33084/m_3308421_se_16_060_20211114.tif",
"type": "image/tiff; application=geotiff; profile=cloud-optimized",
"roles": ["data"],
"title": "RGBIR COG tile",
"eo:bands": [
{"name": "Red", "common_name": "red"},
{"name": "Green", "common_name": "green"},
{"name": "Blue", "common_name": "blue"},
{
"name": "NIR",
"common_name": "nir",
"description": "near-infrared",
},
],
},
"thumbnail": {
"href": "https://naipeuwest.blob.core.windows.net/naip/v002/ga/2021/ga_060cm_2021/33084/m_3308421_se_16_060_20211114.200.jpg",
"type": "image/jpeg",
"roles": ["thumbnail"],
"title": "Thumbnail",
},
"tilejson": {
"title": "TileJSON with default rendering",
"href": "https://planetarycomputer.microsoft.com/api/data/v1/item/tilejson.json?collection=naip&item=ga_m_3308421_se_16_060_20211114&assets=image&asset_bidx=image%7C1%2C2%2C3&format=png",
"type": "application/json",
"roles": ["tiles"],
},
"rendered_preview": {
"title": "Rendered preview",
"rel": "preview",
"href": "https://planetarycomputer.microsoft.com/api/data/v1/item/preview.png?collection=naip&item=ga_m_3308421_se_16_060_20211114&assets=image&asset_bidx=image%7C1%2C2%2C3&format=png",
"roles": ["overview"],
"type": "image/png",
},
},
"stac_extensions": [
"https://stac-extensions.github.io/eo/v1.0.0/schema.json",
"https://stac-extensions.github.io/projection/v1.0.0/schema.json",
],
}
)
async def create_stac_item(client: PlanetaryComputerProClient, collection_id, item_id):
"""Create a STAC item."""
stac_item = get_sample_stac_item(collection_id, item_id)
stac_item_get_items_response = await client.stac.get_item_collection(
collection_id=collection_id
)
for item in stac_item_get_items_response.features:
logging.error(item.id)
if any(item.id == stac_item.id for item in stac_item_get_items_response.features):
logging.info(
f"Item {stac_item.id} already exists. Deleting it before creating a new one."
)
delete_poller = await client.stac.begin_delete_item(
collection_id=collection_id, item_id=stac_item.id, polling=True
)
await delete_poller.result()
logging.info(f"Deleted item {stac_item.id}. Proceeding to create a new one.")
else:
logging.info(f"Item {stac_item.id} does not exist. Proceeding to create it.")
stac_item.collection = collection_id
try:
stac_item_create_response = await client.stac.begin_create_item(
collection_id=collection_id, body=stac_item, polling=True
)
await stac_item_create_response.result()
print(f"Created item {item_id}")
except HttpResponseError as e:
logging.error(f"Failed to create item {stac_item.id}: {e.message}")
pass
async def update_stac_item(client: PlanetaryComputerProClient, collection_id, item_id):
"""Update a STAC item."""
stac_item = get_sample_stac_item(collection_id, item_id)
stac_item.properties["platform"] = "Imagery"
stac_item_create_or_update_response = await client.stac.begin_update_item(
collection_id=collection_id, item_id=stac_item.id, body=stac_item, polling=True
)
await stac_item_create_or_update_response.result()
logging.info(
f"Updated item {stac_item.id}, platform: {stac_item.properties['platform']}"
)
async def create_or_replace_stac_item(
client: PlanetaryComputerProClient, collection_id, item_id
):
"""Create or replace a STAC item (idempotent operation).
This demonstrates using begin_create_or_replace_item which is idempotent:
- First ensures item exists by creating it with begin_create_item
- Then demonstrates replace using begin_create_or_replace_item
- Multiple calls with the same data produce the same result
"""
# First, create the item using begin_create_item
stac_item = get_sample_stac_item(collection_id, item_id)
try:
create_poller = await client.stac.begin_create_item(
collection_id=collection_id, body=stac_item, polling=True
)
await create_poller.result()
logging.info(f"Created item {item_id}")
except ResourceExistsError:
logging.info(f"Item {item_id} already exists, continuing...")
# Verify creation
created_item = await client.stac.get_item(
collection_id=collection_id, item_id=item_id
)
logging.info(f"Verified item {created_item.id}")
# Now demonstrate create_or_replace (replace since item exists)
stac_item.properties["platform"] = "Imagery Updated"
stac_item.properties["processing_level"] = "L2"
replace_poller = await client.stac.begin_create_or_replace_item(
collection_id=collection_id, item_id=item_id, body=stac_item, polling=True
)
await replace_poller.result()
logging.info(f"Replaced item {item_id} using create_or_replace")
# Verify replacement
replaced_item = await client.stac.get_item(
collection_id=collection_id, item_id=item_id
)
logging.info(
f"Verified replaced item, platform: {replaced_item.properties.get('platform', 'N/A')}"
)
async def delete_stac_item(client: PlanetaryComputerProClient, collection_id, item_id):
"""Delete a STAC item.
This demonstrates using begin_delete_item to remove an item from a collection.
The operation is asynchronous and returns a poller that can be used to track completion.
"""
try:
# Check if item exists before attempting deletion
existing_item = await client.stac.get_item(
collection_id=collection_id, item_id=item_id
)
logging.info(f"Found item {existing_item.id} to delete")
# Delete the item using begin_delete_item
delete_poller = await client.stac.begin_delete_item(
collection_id=collection_id, item_id=item_id, polling=True
)
await delete_poller.result()
logging.info(f"Successfully deleted item {item_id}")
# Verify deletion by attempting to retrieve the item
try:
await client.stac.get_item(collection_id=collection_id, item_id=item_id)
logging.warning(
f"Item {item_id} still exists after deletion (may take time to propagate)"
)
except ResourceNotFoundError:
logging.info(f"Verified item {item_id} was successfully deleted")
except ResourceNotFoundError:
logging.info(f"Item {item_id} does not exist, nothing to delete")
except HttpResponseError as e:
logging.error(f"Failed to delete item {item_id}: {e.message}")
raise
async def get_collection(client: PlanetaryComputerProClient, collection_id):
"""Get a STAC collection."""
collection = await client.stac.get_collection(collection_id=collection_id)
logging.info(f"Retrieved collection: {collection.id}")
async def query_items(client: PlanetaryComputerProClient, collection_id):
"""Query items using CQL2 filters."""
# Query with filter
query_options = StacSearchParameters(
collections=[collection_id],
filter_lang=FilterLanguage.CQL2_JSON,
filter={"op": "<", "args": [{"property": "eo:cloud_cover"}, 10]},
limit=5,
)
query_results = await client.stac.search(body=query_options)
if query_results.features:
for item in query_results.features:
if item.properties and item.properties.date_time:
logging.info(f" - {item.id}: {item.properties.date_time}")
# Sorted query
sorted_options = StacSearchParameters(
collections=[collection_id],
sort_by=[
StacSortExtension(
field="eo:cloud_cover", direction=StacSearchSortingDirection.ASC
)
],
limit=3,
)
sorted_results = await client.stac.search(body=sorted_options)
if sorted_results.features:
for item in sorted_results.features:
if item.properties and item.properties.date_time:
logging.info(f" - {item.id}: {item.properties.date_time}")
async def get_queryables(client: PlanetaryComputerProClient, collection_id):
"""Get queryable properties for a collection."""
queryables = await client.stac.get_collection_queryables(
collection_id=collection_id
)
properties = queryables.get("properties")
if properties:
for prop_name in list(properties.keys())[:10]: # Show first 10
logging.info(
f" - {prop_name}: {properties[prop_name].get('description', '')}"
)
async def main():
# Get configuration from environment
endpoint = os.environ.get("PLANETARYCOMPUTER_ENDPOINT")
collection_id = os.environ.get("PLANETARYCOMPUTER_COLLECTION_ID")
item_id = os.environ.get("PLANETARYCOMPUTER_ITEM_ID")
if not endpoint:
raise ValueError("PLANETARYCOMPUTER_ENDPOINT environment variable must be set")
# Create client
credential = DefaultAzureCredential()
client = PlanetaryComputerProClient(
endpoint=endpoint, credential=credential, logging_enable=False
)
# Execute STAC specification operations
await get_landing_page(client)
await search_collections(client)
await search_items(client, collection_id)
await query_items(client, collection_id)
await get_queryables(client, collection_id)
# Execute STAC item operations
await create_stac_item(client, collection_id, item_id)
await update_stac_item(client, collection_id, item_id)
await create_or_replace_stac_item(client, collection_id, f"{item_id}_replace_demo")
await delete_stac_item(
client, collection_id, f"{item_id}_replace_demo"
) # Clean up the item created above
await get_collection(client, collection_id)
await client.close()
await credential.close()
if __name__ == "__main__":
asyncio.run(main())
|