You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: add item coverage and asset management in DataClient (#1109)
* support data api clear coverage
- async client
- cli
* add to sync client
* sync test
* async test
* cli test
* update CLI doc
* add to cli docs
* minor code tweak and doc refresh
* doc example update
* improve CLI documentation
Co-authored-by: Steve Hillier <[email protected]>
---------
Co-authored-by: Steve Hillier <[email protected]>
Just pipe the results to `jq '.buckets | map(.count) | add'` and it’ll give you the total of all the values.
426
426
427
+
## Get Item Details and Assess Item Clear Coverage
428
+
429
+
Once you've found items of interest through search, you may want to examine a specific item in detail. The CLI provides a command to retrieve and display detailed information about a single item.
430
+
431
+
### Get Item
432
+
433
+
The `item-get` command allows you to retrieve detailed information about a specific item by its Type and ID:
434
+
435
+
```sh
436
+
planet data item-get PSScene 20230310_083933_71_2431
437
+
```
438
+
439
+
### Get Item Coverage
440
+
441
+
The `item-coverage` command estimates the clear coverage of an item within a specified area of interest (AOI). This is useful for determining how much of your area of interest is covered by clouds or other obstructions:
442
+
443
+
```sh
444
+
planet data item-coverage PSScene 20250304_162555_90_24f2 --geom='{"type":"Polygon","coordinates":[[[-81.45,30.31],[-81.45,30.23],[-81.38,30.23],[-81.45,30.31]]]}'
445
+
```
446
+
447
+
You can also specify additional parameters:
448
+
449
+
*`--mode`: The mode for coverage calculation
450
+
*`UDM2`: calculate clear coverage using a UDM2 asset [default]
451
+
*`estimate`: estimate clear coverage based on preview imagery
452
+
453
+
*`--band`: The band to use for coverage calculation
454
+
455
+
See [Data API documentation](https://docs.planet.com/develop/apis/data/items/#estimate-clear-coverage-over-an-individual-item-with-a-custom-aoi) for an overview of coverage options.
456
+
457
+
For example:
458
+
459
+
```sh
460
+
planet data item-coverage PSScene 20250304_162555_90_24f2 --geom='{"type":"Polygon","coordinates":[[[-81.45,30.31],[-81.45,30.23],[-81.38,30.23],[-81.45,30.31]]]}' --band='snow'
461
+
```
462
+
463
+
## Item Asset Management
464
+
465
+
The CLI provides several commands for managing and working with item assets.
466
+
467
+
### List Available Assets
468
+
469
+
To see all available assets for a specific item:
470
+
471
+
```sh
472
+
planet data asset-list PSScene 20230310_083933_71_2431
473
+
```
474
+
475
+
This will show you all asset available for the item, including their status and activation requirements.
476
+
477
+
### Get Asset Details
478
+
479
+
To get detailed information about a specific asset:
480
+
481
+
```sh
482
+
planet data asset-get PSScene 20230310_083933_71_2431 ortho_analytic_8b
483
+
```
484
+
485
+
This command provides information about the asset's status download availability.
486
+
427
487
## Asset Activation and Download
428
488
429
489
While we recommend using the Orders or Subscriptions API’s to deliver Planet data, the Data API has the capability
0 commit comments