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
class Sentinel2Extension(
    Generic[T],
    PropertiesExtension,
    ExtensionManagementMixin[pystac.Item | pystac.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.
    """

    name: Literal["s2"] = "s2"

    # Preserve the existing PySTAC-style bulk API, including positional callers.
    def apply(  # noqa: PLR0913, PLR0917
        self,
        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:
            ValueError: If a percentage, solar angle, processing baseline, or
                MGRS tile fails the corresponding setter constraint.
        """
        self.tile_id = tile_id
        self.granule_id = granule_id
        self.datatake_id = datatake_id
        self.product_uri = product_uri
        self.datastrip_id = datastrip_id
        self.product_type = product_type
        self.datatake_type = datatake_type
        self.generation_time = generation_time
        self.processing_baseline = processing_baseline
        self.water_percentage = water_percentage
        self.mean_solar_zenith = mean_solar_zenith
        self.mean_solar_azimuth = mean_solar_azimuth
        self.snow_ice_percentage = snow_ice_percentage
        self.vegetation_percentage = vegetation_percentage
        self.thin_cirrus_percentage = thin_cirrus_percentage
        self.cloud_shadow_percentage = cloud_shadow_percentage
        self.nodata_pixel_percentage = nodata_pixel_percentage
        self.unclassified_percentage = unclassified_percentage
        self.dark_features_percentage = dark_features_percentage
        self.not_vegetated_percentage = not_vegetated_percentage
        self.degraded_msi_data_percentage = degraded_msi_data_percentage
        self.high_proba_clouds_percentage = high_proba_clouds_percentage
        self.medium_proba_clouds_percentage = medium_proba_clouds_percentage
        self.saturated_defective_pixel_percentage = saturated_defective_pixel_percentage
        self.reflectance_conversion_factor = reflectance_conversion_factor
        self.mgrs_tile = mgrs_tile

    def _get_str(self, prop: str) -> str | None:
        return self._get_property(prop, str)

    def _set_str(self, prop: str, value: str | None) -> None:
        self._set_property(prop, value)

    def _get_float(self, prop: str) -> float | None:
        return self._get_property(prop, float)

    def _set_float(self, prop: str, value: float | None) -> None:
        if prop in PERCENTAGE_PROPS:
            value = _validate_percentage(prop, value)
        if (
            prop in {MEAN_SOLAR_ZENITH_PROP, MEAN_SOLAR_AZIMUTH_PROP}
            and value is not None
            and not 0 <= value <= MAX_SOLAR_ANGLE
        ):
            raise ValueError(f"{prop} must be between 0 and {MAX_SOLAR_ANGLE}. Got: {value}")
        self._set_property(prop, value)

    @property
    def tile_id(self) -> str | None:
        """Identifier of the Sentinel-2 tile product."""
        return self._get_str(TILE_ID_PROP)

    @tile_id.setter
    def tile_id(self, value: str | None) -> None:
        self._set_str(TILE_ID_PROP, value)

    @property
    def granule_id(self) -> str | None:
        """Legacy granule identifier stored independently of the tile identifier. Deprecated; prefer s2:tile_id."""
        return self._get_str(GRANULE_ID_PROP)

    @granule_id.setter
    def granule_id(self, value: str | None) -> None:
        self._set_str(GRANULE_ID_PROP, value)

    @property
    def datatake_id(self) -> str | None:
        """Identifier of the acquisition datatake."""
        return self._get_str(DATATAKE_ID_PROP)

    @datatake_id.setter
    def datatake_id(self, value: str | None) -> None:
        self._set_str(DATATAKE_ID_PROP, value)

    @property
    def product_uri(self) -> str | None:
        """URI identifying the source Sentinel-2 product."""
        return self._get_str(PRODUCT_URI_PROP)

    @product_uri.setter
    def product_uri(self, value: str | None) -> None:
        self._set_str(PRODUCT_URI_PROP, value)

    @property
    def datastrip_id(self) -> str | None:
        """Identifier of the source datastrip."""
        return self._get_str(DATASTRIP_ID_PROP)

    @datastrip_id.setter
    def datastrip_id(self, value: str | None) -> None:
        self._set_str(DATASTRIP_ID_PROP, value)

    @property
    def product_type(self) -> str | None:
        """Legacy product classification. Deprecated; prefer product:type."""
        return self._get_str(PRODUCT_TYPE_PROP)

    @product_type.setter
    def product_type(self, value: str | None) -> None:
        self._set_str(PRODUCT_TYPE_PROP, value)

    @property
    def datatake_type(self) -> str | None:
        """Acquisition datatake type, such as ``INS-NOBS``."""
        return self._get_str(DATATAKE_TYPE_PROP)

    @datatake_type.setter
    def datatake_type(self, value: str | None) -> None:
        self._set_str(DATATAKE_TYPE_PROP, value)

    @property
    def generation_time(self) -> datetime | None:
        """Product generation timestamp, serialized as an RFC 3339 string. Deprecated; prefer processing:datetime."""
        return map_opt(str_to_datetime, self._get_property(GENERATION_TIME_PROP, str))

    @generation_time.setter
    def generation_time(self, value: datetime | None) -> None:
        self._set_property(GENERATION_TIME_PROP, map_opt(datetime_to_str, value))

    @property
    def processing_baseline(self) -> str | None:
        """Processing baseline matching ``NN.NN``. Deprecated; prefer processing:version."""
        return self._get_str(PROCESSING_BASELINE_PROP)

    @processing_baseline.setter
    def processing_baseline(self, value: str | None) -> None:
        self._set_property(PROCESSING_BASELINE_PROP, _validate_processing_baseline(value))

    @property
    def water_percentage(self) -> float | None:
        """Water percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(WATER_PERCENTAGE_PROP)

    @water_percentage.setter
    def water_percentage(self, value: float | None) -> None:
        self._set_float(WATER_PERCENTAGE_PROP, value)

    @property
    def mean_solar_zenith(self) -> float | None:
        """Mean solar zenith in degrees (0 to 180 in the upstream schema). Deprecated; prefer view:sun_elevation (90 minus zenith)."""
        return self._get_float(MEAN_SOLAR_ZENITH_PROP)

    @mean_solar_zenith.setter
    def mean_solar_zenith(self, value: float | None) -> None:
        self._set_float(MEAN_SOLAR_ZENITH_PROP, value)

    @property
    def mean_solar_azimuth(self) -> float | None:
        """Mean solar azimuth in degrees (0 to 180 in the upstream schema). Deprecated; prefer view:sun_azimuth."""
        return self._get_float(MEAN_SOLAR_AZIMUTH_PROP)

    @mean_solar_azimuth.setter
    def mean_solar_azimuth(self, value: float | None) -> None:
        self._set_float(MEAN_SOLAR_AZIMUTH_PROP, value)

    @property
    def snow_ice_percentage(self) -> float | None:
        """Snow ice percentage in the inclusive range 0 to 100. Deprecated; prefer eo:snow_cover."""
        return self._get_float(SNOW_ICE_PERCENTAGE_PROP)

    @snow_ice_percentage.setter
    def snow_ice_percentage(self, value: float | None) -> None:
        self._set_float(SNOW_ICE_PERCENTAGE_PROP, value)

    @property
    def vegetation_percentage(self) -> float | None:
        """Vegetation percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(VEGETATION_PERCENTAGE_PROP)

    @vegetation_percentage.setter
    def vegetation_percentage(self, value: float | None) -> None:
        self._set_float(VEGETATION_PERCENTAGE_PROP, value)

    @property
    def thin_cirrus_percentage(self) -> float | None:
        """Thin cirrus percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(THIN_CIRRUS_PERCENTAGE_PROP)

    @thin_cirrus_percentage.setter
    def thin_cirrus_percentage(self, value: float | None) -> None:
        self._set_float(THIN_CIRRUS_PERCENTAGE_PROP, value)

    @property
    def cloud_shadow_percentage(self) -> float | None:
        """Cloud shadow percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(CLOUD_SHADOW_PERCENTAGE_PROP)

    @cloud_shadow_percentage.setter
    def cloud_shadow_percentage(self, value: float | None) -> None:
        self._set_float(CLOUD_SHADOW_PERCENTAGE_PROP, value)

    @property
    def nodata_pixel_percentage(self) -> float | None:
        """Nodata pixel percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(NODATA_PIXEL_PERCENTAGE_PROP)

    @nodata_pixel_percentage.setter
    def nodata_pixel_percentage(self, value: float | None) -> None:
        self._set_float(NODATA_PIXEL_PERCENTAGE_PROP, value)

    @property
    def unclassified_percentage(self) -> float | None:
        """Unclassified percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(UNCLASSIFIED_PERCENTAGE_PROP)

    @unclassified_percentage.setter
    def unclassified_percentage(self, value: float | None) -> None:
        self._set_float(UNCLASSIFIED_PERCENTAGE_PROP, value)

    @property
    def dark_features_percentage(self) -> float | None:
        """Dark features percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(DARK_FEATURES_PERCENTAGE_PROP)

    @dark_features_percentage.setter
    def dark_features_percentage(self, value: float | None) -> None:
        self._set_float(DARK_FEATURES_PERCENTAGE_PROP, value)

    @property
    def not_vegetated_percentage(self) -> float | None:
        """Not vegetated percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(NOT_VEGETATED_PERCENTAGE_PROP)

    @not_vegetated_percentage.setter
    def not_vegetated_percentage(self, value: float | None) -> None:
        self._set_float(NOT_VEGETATED_PERCENTAGE_PROP, value)

    @property
    def degraded_msi_data_percentage(self) -> float | None:
        """Degraded msi data percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(DEGRADED_MSI_DATA_PERCENTAGE_PROP)

    @degraded_msi_data_percentage.setter
    def degraded_msi_data_percentage(self, value: float | None) -> None:
        self._set_float(DEGRADED_MSI_DATA_PERCENTAGE_PROP, value)

    @property
    def high_proba_clouds_percentage(self) -> float | None:
        """High proba clouds percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(HIGH_PROBA_CLOUDS_PERCENTAGE_PROP)

    @high_proba_clouds_percentage.setter
    def high_proba_clouds_percentage(self, value: float | None) -> None:
        self._set_float(HIGH_PROBA_CLOUDS_PERCENTAGE_PROP, value)

    @property
    def medium_proba_clouds_percentage(self) -> float | None:
        """Medium proba clouds percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(MEDIUM_PROBA_CLOUDS_PERCENTAGE_PROP)

    @medium_proba_clouds_percentage.setter
    def medium_proba_clouds_percentage(self, value: float | None) -> None:
        self._set_float(MEDIUM_PROBA_CLOUDS_PERCENTAGE_PROP, value)

    @property
    def saturated_defective_pixel_percentage(self) -> float | None:
        """Saturated defective pixel percentage in the inclusive range 0 to 100. Deprecated; prefer statistics."""
        return self._get_float(SATURATED_DEFECTIVE_PIXEL_PERCENTAGE_PROP)

    @saturated_defective_pixel_percentage.setter
    def saturated_defective_pixel_percentage(self, value: float | None) -> None:
        self._set_float(SATURATED_DEFECTIVE_PIXEL_PERCENTAGE_PROP, value)

    @property
    def reflectance_conversion_factor(self) -> float | None:
        """Numeric factor used for reflectance conversion."""
        return self._get_float(REFLECTANCE_CONVERSION_FACTOR_PROP)

    @reflectance_conversion_factor.setter
    def reflectance_conversion_factor(self, value: float | None) -> None:
        self._set_float(REFLECTANCE_CONVERSION_FACTOR_PROP, value)

    @property
    def mgrs_tile(self) -> str | None:
        """MGRS tile identifier matching the upstream pattern, such as ``32TQM``. Deprecated; prefer MGRS fields and grid:code."""
        return self._get_str(MGRS_TILE_PROP)

    @mgrs_tile.setter
    def mgrs_tile(self, value: str | None) -> None:
        self._set_property(MGRS_TILE_PROP, _validate_mgrs_tile(value))

    @classmethod
    def get_schema_uri(cls) -> str:
        """The versioned upstream JSON Schema identifier."""
        return SCHEMA_URI

    @classmethod
    def ext(cls, obj: T, add_if_missing: bool = False) -> Sentinel2Extension[T]:
        """Wrap an Item, optionally declaring the extension on it.

        Args:
            obj: Item whose properties will be read and mutated.
            add_if_missing: Add the schema URI if the extension is not declared.

        Raises:
            pystac.ExtensionNotImplemented: If the extension is missing and
                ``add_if_missing`` is false.
            pystac.ExtensionTypeError: If the object is not an Item.
        """
        if isinstance(obj, pystac.Item):
            cls.ensure_has_extension(obj, add_if_missing)
            return cast("Sentinel2Extension[T]", ItemSentinel2Extension(obj))
        raise pystac.ExtensionTypeError(cls._ext_error_message(obj))

    @classmethod
    def summaries(
        cls, obj: pystac.Collection, add_if_missing: bool = False
    ) -> SummariesSentinel2Extension:
        """Wrap Collection summaries, optionally declaring the extension.

        Args:
            obj: Collection whose summaries will be read and mutated.
            add_if_missing: Add the schema URI if it is not already declared.

        Raises:
            pystac.ExtensionNotImplemented: If the extension is missing and
                ``add_if_missing`` is false.
        """
        cls.ensure_has_extension(obj, add_if_missing)
        return SummariesSentinel2Extension(obj)

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:
  • ValueError –

    If a percentage, solar angle, processing baseline, or MGRS tile fails the corresponding setter constraint.

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
def apply(  # noqa: PLR0913, PLR0917
    self,
    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:
        ValueError: If a percentage, solar angle, processing baseline, or
            MGRS tile fails the corresponding setter constraint.
    """
    self.tile_id = tile_id
    self.granule_id = granule_id
    self.datatake_id = datatake_id
    self.product_uri = product_uri
    self.datastrip_id = datastrip_id
    self.product_type = product_type
    self.datatake_type = datatake_type
    self.generation_time = generation_time
    self.processing_baseline = processing_baseline
    self.water_percentage = water_percentage
    self.mean_solar_zenith = mean_solar_zenith
    self.mean_solar_azimuth = mean_solar_azimuth
    self.snow_ice_percentage = snow_ice_percentage
    self.vegetation_percentage = vegetation_percentage
    self.thin_cirrus_percentage = thin_cirrus_percentage
    self.cloud_shadow_percentage = cloud_shadow_percentage
    self.nodata_pixel_percentage = nodata_pixel_percentage
    self.unclassified_percentage = unclassified_percentage
    self.dark_features_percentage = dark_features_percentage
    self.not_vegetated_percentage = not_vegetated_percentage
    self.degraded_msi_data_percentage = degraded_msi_data_percentage
    self.high_proba_clouds_percentage = high_proba_clouds_percentage
    self.medium_proba_clouds_percentage = medium_proba_clouds_percentage
    self.saturated_defective_pixel_percentage = saturated_defective_pixel_percentage
    self.reflectance_conversion_factor = reflectance_conversion_factor
    self.mgrs_tile = mgrs_tile

ext(obj: T, add_if_missing: bool = False) -> Sentinel2Extension[T] classmethod

Wrap an Item, optionally declaring the extension on it.

Parameters:
  • obj (T) –

    Item whose properties will be read and mutated.

  • add_if_missing (bool, default: False ) –

    Add the schema URI if the extension is not declared.

Raises:
  • ExtensionNotImplemented –

    If the extension is missing and add_if_missing is false.

  • ExtensionTypeError –

    If the object is not an Item.

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
@classmethod
def ext(cls, obj: T, add_if_missing: bool = False) -> Sentinel2Extension[T]:
    """Wrap an Item, optionally declaring the extension on it.

    Args:
        obj: Item whose properties will be read and mutated.
        add_if_missing: Add the schema URI if the extension is not declared.

    Raises:
        pystac.ExtensionNotImplemented: If the extension is missing and
            ``add_if_missing`` is false.
        pystac.ExtensionTypeError: If the object is not an Item.
    """
    if isinstance(obj, pystac.Item):
        cls.ensure_has_extension(obj, add_if_missing)
        return cast("Sentinel2Extension[T]", ItemSentinel2Extension(obj))
    raise pystac.ExtensionTypeError(cls._ext_error_message(obj))

get_schema_uri() -> str classmethod

The versioned upstream JSON Schema identifier.

Source code in src/pystac/extensions/sentinel2.py
471
472
473
474
@classmethod
def get_schema_uri(cls) -> str:
    """The versioned upstream JSON Schema identifier."""
    return SCHEMA_URI

summaries(obj: pystac.Collection, add_if_missing: bool = False) -> SummariesSentinel2Extension classmethod

Wrap Collection summaries, optionally declaring the extension.

Parameters:
  • obj (Collection) –

    Collection whose summaries will be read and mutated.

  • add_if_missing (bool, default: False ) –

    Add the schema URI if it is not already declared.

Raises:
  • ExtensionNotImplemented –

    If the extension is missing and add_if_missing is false.

Source code in src/pystac/extensions/sentinel2.py
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
@classmethod
def summaries(
    cls, obj: pystac.Collection, add_if_missing: bool = False
) -> SummariesSentinel2Extension:
    """Wrap Collection summaries, optionally declaring the extension.

    Args:
        obj: Collection whose summaries will be read and mutated.
        add_if_missing: Add the schema URI if it is not already declared.

    Raises:
        pystac.ExtensionNotImplemented: If the extension is missing and
            ``add_if_missing`` is false.
    """
    cls.ensure_has_extension(obj, add_if_missing)
    return SummariesSentinel2Extension(obj)

ItemSentinel2Extension

Bases: Sentinel2Extension[Item]

Read and mutate an Item through its existing properties mapping.

Attributes:
  • item (Item) –

    The wrapped Item; changes are applied directly to it.

Source code in src/pystac/extensions/sentinel2.py
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
class ItemSentinel2Extension(Sentinel2Extension[pystac.Item]):
    """Read and mutate an Item through its existing properties mapping.

    Attributes:
        item: The wrapped Item; changes are applied directly to it.
    """

    item: pystac.Item

    def __init__(self, item: pystac.Item) -> None:
        """Bind the adapter to the Item without copying its properties."""
        self.item = item
        self.properties = item.properties

    def __repr__(self) -> str:
        return f"<ItemSentinel2Extension Item id={self.item.id}>"

__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
def __init__(self, item: pystac.Item) -> None:
    """Bind the adapter to the Item without copying its properties."""
    self.item = item
    self.properties = item.properties

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
class SummariesSentinel2Extension(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.
    """

    # PySTAC returns untyped summary contents; these casts describe the field contract.
    def _get_list(self, prop: str) -> list[str] | None:
        return cast("list[str] | None", self.summaries.get_list(prop))

    def _get_range(self, prop: str) -> RangeSummary[float] | None:
        return cast("RangeSummary[float] | None", self.summaries.get_range(prop))

    @property
    def tile_id(self) -> list[str] | None:
        """Distinct tile id values represented by the Collection."""
        return self._get_list(TILE_ID_PROP)

    @tile_id.setter
    def tile_id(self, value: list[str] | None) -> None:
        self._set_summary(TILE_ID_PROP, value)

    @property
    def granule_id(self) -> list[str] | None:
        """Distinct granule id values represented by the Collection."""
        return self._get_list(GRANULE_ID_PROP)

    @granule_id.setter
    def granule_id(self, value: list[str] | None) -> None:
        self._set_summary(GRANULE_ID_PROP, value)

    @property
    def datatake_id(self) -> list[str] | None:
        """Distinct datatake id values represented by the Collection."""
        return self._get_list(DATATAKE_ID_PROP)

    @datatake_id.setter
    def datatake_id(self, value: list[str] | None) -> None:
        self._set_summary(DATATAKE_ID_PROP, value)

    @property
    def product_uri(self) -> list[str] | None:
        """Distinct product uri values represented by the Collection."""
        return self._get_list(PRODUCT_URI_PROP)

    @product_uri.setter
    def product_uri(self, value: list[str] | None) -> None:
        self._set_summary(PRODUCT_URI_PROP, value)

    @property
    def datastrip_id(self) -> list[str] | None:
        """Distinct datastrip id values represented by the Collection."""
        return self._get_list(DATASTRIP_ID_PROP)

    @datastrip_id.setter
    def datastrip_id(self, value: list[str] | None) -> None:
        self._set_summary(DATASTRIP_ID_PROP, value)

    @property
    def product_type(self) -> list[str] | None:
        """Distinct product type values represented by the Collection."""
        return self._get_list(PRODUCT_TYPE_PROP)

    @product_type.setter
    def product_type(self, value: list[str] | None) -> None:
        self._set_summary(PRODUCT_TYPE_PROP, value)

    @property
    def datatake_type(self) -> list[str] | None:
        """Distinct datatake type values represented by the Collection."""
        return self._get_list(DATATAKE_TYPE_PROP)

    @datatake_type.setter
    def datatake_type(self, value: list[str] | None) -> None:
        self._set_summary(DATATAKE_TYPE_PROP, value)

    @property
    def generation_time(self) -> RangeSummary[datetime] | None:
        """Range of product generation timestamps represented by the Collection."""
        return map_opt(
            lambda summary: RangeSummary(
                str_to_datetime(summary.minimum), str_to_datetime(summary.maximum)
            ),
            self.summaries.get_range(GENERATION_TIME_PROP),
        )

    @generation_time.setter
    def generation_time(self, value: RangeSummary[datetime] | None) -> None:
        self._set_summary(
            GENERATION_TIME_PROP,
            map_opt(
                lambda summary: RangeSummary(
                    datetime_to_str(summary.minimum), datetime_to_str(summary.maximum)
                ),
                value,
            ),
        )

    @property
    def processing_baseline(self) -> list[str] | None:
        """Distinct processing baseline values represented by the Collection."""
        return self._get_list(PROCESSING_BASELINE_PROP)

    @processing_baseline.setter
    def processing_baseline(self, value: list[str] | None) -> None:
        self._set_summary(PROCESSING_BASELINE_PROP, value)

    @property
    def water_percentage(self) -> RangeSummary[float] | None:
        """Range of water percentage values represented by the Collection."""
        return self._get_range(WATER_PERCENTAGE_PROP)

    @water_percentage.setter
    def water_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(WATER_PERCENTAGE_PROP, value)

    @property
    def mean_solar_zenith(self) -> RangeSummary[float] | None:
        """Range of mean solar zenith values represented by the Collection."""
        return self._get_range(MEAN_SOLAR_ZENITH_PROP)

    @mean_solar_zenith.setter
    def mean_solar_zenith(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(MEAN_SOLAR_ZENITH_PROP, value)

    @property
    def mean_solar_azimuth(self) -> RangeSummary[float] | None:
        """Range of mean solar azimuth values represented by the Collection."""
        return self._get_range(MEAN_SOLAR_AZIMUTH_PROP)

    @mean_solar_azimuth.setter
    def mean_solar_azimuth(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(MEAN_SOLAR_AZIMUTH_PROP, value)

    @property
    def snow_ice_percentage(self) -> RangeSummary[float] | None:
        """Range of snow ice percentage values represented by the Collection."""
        return self._get_range(SNOW_ICE_PERCENTAGE_PROP)

    @snow_ice_percentage.setter
    def snow_ice_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(SNOW_ICE_PERCENTAGE_PROP, value)

    @property
    def vegetation_percentage(self) -> RangeSummary[float] | None:
        """Range of vegetation percentage values represented by the Collection."""
        return self._get_range(VEGETATION_PERCENTAGE_PROP)

    @vegetation_percentage.setter
    def vegetation_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(VEGETATION_PERCENTAGE_PROP, value)

    @property
    def thin_cirrus_percentage(self) -> RangeSummary[float] | None:
        """Range of thin cirrus percentage values represented by the Collection."""
        return self._get_range(THIN_CIRRUS_PERCENTAGE_PROP)

    @thin_cirrus_percentage.setter
    def thin_cirrus_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(THIN_CIRRUS_PERCENTAGE_PROP, value)

    @property
    def cloud_shadow_percentage(self) -> RangeSummary[float] | None:
        """Range of cloud shadow percentage values represented by the Collection."""
        return self._get_range(CLOUD_SHADOW_PERCENTAGE_PROP)

    @cloud_shadow_percentage.setter
    def cloud_shadow_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(CLOUD_SHADOW_PERCENTAGE_PROP, value)

    @property
    def nodata_pixel_percentage(self) -> RangeSummary[float] | None:
        """Range of nodata pixel percentage values represented by the Collection."""
        return self._get_range(NODATA_PIXEL_PERCENTAGE_PROP)

    @nodata_pixel_percentage.setter
    def nodata_pixel_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(NODATA_PIXEL_PERCENTAGE_PROP, value)

    @property
    def unclassified_percentage(self) -> RangeSummary[float] | None:
        """Range of unclassified percentage values represented by the Collection."""
        return self._get_range(UNCLASSIFIED_PERCENTAGE_PROP)

    @unclassified_percentage.setter
    def unclassified_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(UNCLASSIFIED_PERCENTAGE_PROP, value)

    @property
    def dark_features_percentage(self) -> RangeSummary[float] | None:
        """Range of dark features percentage values represented by the Collection."""
        return self._get_range(DARK_FEATURES_PERCENTAGE_PROP)

    @dark_features_percentage.setter
    def dark_features_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(DARK_FEATURES_PERCENTAGE_PROP, value)

    @property
    def not_vegetated_percentage(self) -> RangeSummary[float] | None:
        """Range of not vegetated percentage values represented by the Collection."""
        return self._get_range(NOT_VEGETATED_PERCENTAGE_PROP)

    @not_vegetated_percentage.setter
    def not_vegetated_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(NOT_VEGETATED_PERCENTAGE_PROP, value)

    @property
    def degraded_msi_data_percentage(self) -> RangeSummary[float] | None:
        """Range of degraded msi data percentage values represented by the Collection."""
        return self._get_range(DEGRADED_MSI_DATA_PERCENTAGE_PROP)

    @degraded_msi_data_percentage.setter
    def degraded_msi_data_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(DEGRADED_MSI_DATA_PERCENTAGE_PROP, value)

    @property
    def high_proba_clouds_percentage(self) -> RangeSummary[float] | None:
        """Range of high proba clouds percentage values represented by the Collection."""
        return self._get_range(HIGH_PROBA_CLOUDS_PERCENTAGE_PROP)

    @high_proba_clouds_percentage.setter
    def high_proba_clouds_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(HIGH_PROBA_CLOUDS_PERCENTAGE_PROP, value)

    @property
    def medium_proba_clouds_percentage(self) -> RangeSummary[float] | None:
        """Range of medium proba clouds percentage values represented by the Collection."""
        return self._get_range(MEDIUM_PROBA_CLOUDS_PERCENTAGE_PROP)

    @medium_proba_clouds_percentage.setter
    def medium_proba_clouds_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(MEDIUM_PROBA_CLOUDS_PERCENTAGE_PROP, value)

    @property
    def saturated_defective_pixel_percentage(self) -> RangeSummary[float] | None:
        """Range of saturated defective pixel percentage values represented by the Collection."""
        return self._get_range(SATURATED_DEFECTIVE_PIXEL_PERCENTAGE_PROP)

    @saturated_defective_pixel_percentage.setter
    def saturated_defective_pixel_percentage(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(SATURATED_DEFECTIVE_PIXEL_PERCENTAGE_PROP, value)

    @property
    def reflectance_conversion_factor(self) -> RangeSummary[float] | None:
        """Range of reflectance conversion factor values represented by the Collection."""
        return self._get_range(REFLECTANCE_CONVERSION_FACTOR_PROP)

    @reflectance_conversion_factor.setter
    def reflectance_conversion_factor(self, value: RangeSummary[float] | None) -> None:
        self._set_summary(REFLECTANCE_CONVERSION_FACTOR_PROP, value)

    @property
    def mgrs_tile(self) -> list[str] | None:
        """Distinct mgrs tile values represented by the Collection."""
        return self._get_list(MGRS_TILE_PROP)

    @mgrs_tile.setter
    def mgrs_tile(self, value: list[str] | None) -> None:
        self._set_summary(MGRS_TILE_PROP, value)

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
class Sentinel2ExtensionHooks(ExtensionHooks):
    """Identify legacy Sentinel-2 declarations for PySTAC migration.

    These hooks do not migrate deprecated properties into other extensions.
    """

    schema_uri: str = SCHEMA_URI
    prev_extension_ids: ClassVar[set[str]] = {"sentinel-2"}
    stac_object_types: ClassVar[set[pystac.STACObjectType]] = {
        pystac.STACObjectType.COLLECTION,
        pystac.STACObjectType.ITEM,
    }