Python API¶
Import from pystac.extensions.sentinel2. Use Sentinel2Extension.ext() for Items and Sentinel2Extension.summaries() for Collections.
sentinel2
¶
Read and write Sentinel-2 v1.0.0 Item properties and Collection summaries.
SENTINEL2_EXTENSION_HOOKS: ExtensionHooks = Sentinel2ExtensionHooks()
module-attribute
¶
SCHEMA_URI = 'https://stac-extensions.github.io/sentinel-2/v1.0.0/schema.json'
module-attribute
¶
Sentinel2Extension
¶
Bases: Generic[T], PropertiesExtension, ExtensionManagementMixin[Item | Collection]
Adapt Sentinel-2 metadata stored on a PySTAC Item.
Use ext() for Items and summaries() for Collections.
Optional properties return None when absent; assigning None removes them.
Deprecated fields are preserved without automatic migration.
Source code in src/pystac/extensions/sentinel2.py
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 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 | |
cloud_shadow_percentage: float | None
property
writable
¶
Cloud shadow percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
dark_features_percentage: float | None
property
writable
¶
Dark features percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
datastrip_id: str | None
property
writable
¶
Identifier of the source datastrip.
datatake_id: str | None
property
writable
¶
Identifier of the acquisition datatake.
datatake_type: str | None
property
writable
¶
Acquisition datatake type, such as INS-NOBS.
degraded_msi_data_percentage: float | None
property
writable
¶
Degraded msi data percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
generation_time: datetime | None
property
writable
¶
Product generation timestamp, serialized as an RFC 3339 string. Deprecated; prefer processing:datetime.
granule_id: str | None
property
writable
¶
Legacy granule identifier stored independently of the tile identifier. Deprecated; prefer s2:tile_id.
high_proba_clouds_percentage: float | None
property
writable
¶
High proba clouds percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
mean_solar_azimuth: float | None
property
writable
¶
Mean solar azimuth in degrees (0 to 180 in the upstream schema). Deprecated; prefer view:sun_azimuth.
mean_solar_zenith: float | None
property
writable
¶
Mean solar zenith in degrees (0 to 180 in the upstream schema). Deprecated; prefer view:sun_elevation (90 minus zenith).
medium_proba_clouds_percentage: float | None
property
writable
¶
Medium proba clouds percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
mgrs_tile: str | None
property
writable
¶
MGRS tile identifier matching the upstream pattern, such as 32TQM. Deprecated; prefer MGRS fields and grid:code.
nodata_pixel_percentage: float | None
property
writable
¶
Nodata pixel percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
not_vegetated_percentage: float | None
property
writable
¶
Not vegetated percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
processing_baseline: str | None
property
writable
¶
Processing baseline matching NN.NN. Deprecated; prefer processing:version.
product_type: str | None
property
writable
¶
Legacy product classification. Deprecated; prefer product:type.
product_uri: str | None
property
writable
¶
URI identifying the source Sentinel-2 product.
reflectance_conversion_factor: float | None
property
writable
¶
Numeric factor used for reflectance conversion.
saturated_defective_pixel_percentage: float | None
property
writable
¶
Saturated defective pixel percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
snow_ice_percentage: float | None
property
writable
¶
Snow ice percentage in the inclusive range 0 to 100. Deprecated; prefer eo:snow_cover.
thin_cirrus_percentage: float | None
property
writable
¶
Thin cirrus percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
tile_id: str | None
property
writable
¶
Identifier of the Sentinel-2 tile product.
unclassified_percentage: float | None
property
writable
¶
Unclassified percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
vegetation_percentage: float | None
property
writable
¶
Vegetation percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
water_percentage: float | None
property
writable
¶
Water percentage in the inclusive range 0 to 100. Deprecated; prefer statistics.
apply(tile_id: str | None = None, granule_id: str | None = None, datatake_id: str | None = None, product_uri: str | None = None, datastrip_id: str | None = None, product_type: str | None = None, datatake_type: str | None = None, generation_time: datetime | None = None, processing_baseline: str | None = None, water_percentage: float | None = None, mean_solar_zenith: float | None = None, mean_solar_azimuth: float | None = None, snow_ice_percentage: float | None = None, vegetation_percentage: float | None = None, thin_cirrus_percentage: float | None = None, cloud_shadow_percentage: float | None = None, nodata_pixel_percentage: float | None = None, unclassified_percentage: float | None = None, dark_features_percentage: float | None = None, not_vegetated_percentage: float | None = None, degraded_msi_data_percentage: float | None = None, high_proba_clouds_percentage: float | None = None, medium_proba_clouds_percentage: float | None = None, saturated_defective_pixel_percentage: float | None = None, reflectance_conversion_factor: float | None = None, mgrs_tile: str | None = None) -> None
¶
Replace all supported fields, removing omitted or None values.
Parameters correspond to the properties of this wrapper. Use timezone-aware generation times and percentages in the inclusive range 0 to 100. Assignments are sequential; a failure can leave earlier fields changed. This method does not perform full JSON Schema validation.
| Raises: |
|
|---|
Source code in src/pystac/extensions/sentinel2.py
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 | |
ext(obj: T, add_if_missing: bool = False) -> Sentinel2Extension[T]
classmethod
¶
Wrap an Item, optionally declaring the extension on it.
| Parameters: |
|
|---|
| Raises: |
|
|---|
Source code in src/pystac/extensions/sentinel2.py
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 | |
get_schema_uri() -> str
classmethod
¶
The versioned upstream JSON Schema identifier.
Source code in src/pystac/extensions/sentinel2.py
471 472 473 474 | |
summaries(obj: pystac.Collection, add_if_missing: bool = False) -> SummariesSentinel2Extension
classmethod
¶
Wrap Collection summaries, optionally declaring the extension.
| Parameters: |
|
|---|
| Raises: |
|
|---|
Source code in src/pystac/extensions/sentinel2.py
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 | |
ItemSentinel2Extension
¶
Bases: Sentinel2Extension[Item]
Read and mutate an Item through its existing properties mapping.
| Attributes: |
|
|---|
Source code in src/pystac/extensions/sentinel2.py
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 | |
__init__(item: pystac.Item) -> None
¶
Bind the adapter to the Item without copying its properties.
Source code in src/pystac/extensions/sentinel2.py
521 522 523 524 | |
SummariesSentinel2Extension
¶
Bases: SummariesExtension
Read and replace Collection summaries without aggregating Items.
String fields use lists, numeric fields use ranges, and generation times
use datetime ranges. Assigning None removes a summary. Summary setters
do not apply the Item field validators.
Source code in src/pystac/extensions/sentinel2.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 | |
cloud_shadow_percentage: RangeSummary[float] | None
property
writable
¶
Range of cloud shadow percentage values represented by the Collection.
dark_features_percentage: RangeSummary[float] | None
property
writable
¶
Range of dark features percentage values represented by the Collection.
datastrip_id: list[str] | None
property
writable
¶
Distinct datastrip id values represented by the Collection.
datatake_id: list[str] | None
property
writable
¶
Distinct datatake id values represented by the Collection.
datatake_type: list[str] | None
property
writable
¶
Distinct datatake type values represented by the Collection.
degraded_msi_data_percentage: RangeSummary[float] | None
property
writable
¶
Range of degraded msi data percentage values represented by the Collection.
generation_time: RangeSummary[datetime] | None
property
writable
¶
Range of product generation timestamps represented by the Collection.
granule_id: list[str] | None
property
writable
¶
Distinct granule id values represented by the Collection.
high_proba_clouds_percentage: RangeSummary[float] | None
property
writable
¶
Range of high proba clouds percentage values represented by the Collection.
mean_solar_azimuth: RangeSummary[float] | None
property
writable
¶
Range of mean solar azimuth values represented by the Collection.
mean_solar_zenith: RangeSummary[float] | None
property
writable
¶
Range of mean solar zenith values represented by the Collection.
medium_proba_clouds_percentage: RangeSummary[float] | None
property
writable
¶
Range of medium proba clouds percentage values represented by the Collection.
mgrs_tile: list[str] | None
property
writable
¶
Distinct mgrs tile values represented by the Collection.
nodata_pixel_percentage: RangeSummary[float] | None
property
writable
¶
Range of nodata pixel percentage values represented by the Collection.
not_vegetated_percentage: RangeSummary[float] | None
property
writable
¶
Range of not vegetated percentage values represented by the Collection.
processing_baseline: list[str] | None
property
writable
¶
Distinct processing baseline values represented by the Collection.
product_type: list[str] | None
property
writable
¶
Distinct product type values represented by the Collection.
product_uri: list[str] | None
property
writable
¶
Distinct product uri values represented by the Collection.
reflectance_conversion_factor: RangeSummary[float] | None
property
writable
¶
Range of reflectance conversion factor values represented by the Collection.
saturated_defective_pixel_percentage: RangeSummary[float] | None
property
writable
¶
Range of saturated defective pixel percentage values represented by the Collection.
snow_ice_percentage: RangeSummary[float] | None
property
writable
¶
Range of snow ice percentage values represented by the Collection.
thin_cirrus_percentage: RangeSummary[float] | None
property
writable
¶
Range of thin cirrus percentage values represented by the Collection.
tile_id: list[str] | None
property
writable
¶
Distinct tile id values represented by the Collection.
unclassified_percentage: RangeSummary[float] | None
property
writable
¶
Range of unclassified percentage values represented by the Collection.
vegetation_percentage: RangeSummary[float] | None
property
writable
¶
Range of vegetation percentage values represented by the Collection.
water_percentage: RangeSummary[float] | None
property
writable
¶
Range of water percentage values represented by the Collection.
Sentinel2ExtensionHooks
¶
Bases: ExtensionHooks
Identify legacy Sentinel-2 declarations for PySTAC migration.
These hooks do not migrate deprecated properties into other extensions.
Source code in src/pystac/extensions/sentinel2.py
793 794 795 796 797 798 799 800 801 802 803 804 | |