ee.Image.sampleRegions

Convertit chaque pixel d'une image (à une échelle donnée) qui croise une ou plusieurs régions en une caractéristique, puis les renvoie sous forme de FeatureCollection. Chaque caractéristique de sortie aura une propriété par bande de l'image d'entrée, ainsi que toutes les propriétés spécifiées copiées à partir de la caractéristique d'entrée.

Notez que les géométries seront alignées sur les centres des pixels.

Utilisation	Renvoie
Image.sampleRegions(collection, properties, scale, projection, tileScale, geometries)	FeatureCollection

Argument	Type	Détails
this: image	Image	Image à échantillonner.
collection	FeatureCollection	Régions à échantillonner.
properties	Liste, valeur par défaut : null	Liste des propriétés à copier à partir de chaque caractéristique d'entrée. Valeur par défaut : toutes les propriétés non système.
scale	Flottant, valeur par défaut : null	Échelle nominale en mètres de la projection à échantillonner. Si aucune valeur n'est spécifiée, l'échelle de la première bande de l'image est utilisée.
projection	Projection, valeur par défaut : null	Projection dans laquelle effectuer l'échantillonnage. Si aucune valeur n'est spécifiée, la projection de la première bande de l'image est utilisée. Si elle est spécifiée en plus de l'échelle, elle est redimensionnée à l'échelle spécifiée.
tileScale	Flottant, valeur par défaut : 1	Facteur d'échelle utilisé pour réduire la taille des tuiles d'agrégation. L'utilisation d'une valeur tileScale plus élevée (par exemple, 2 ou 4) peut permettre d'effectuer des calculs qui manquent de mémoire avec la valeur par défaut.
geometries	Booléen, valeur par défaut : false	Si la valeur est "true", les résultats incluront une géométrie de point par pixel échantillonné. Sinon, les géométries seront omises (ce qui permet d'économiser de la mémoire).

Exemples

Éditeur de code (JavaScript)

// A Sentinel-2 surface reflectance image.
var img = ee.Image('COPERNICUS/S2_SR/20210109T185751_20210109T185931_T10SEG');
Map.setCenter(-122.503881, 37.765588, 18);
Map.addLayer(img, {bands: ['B11', 'B8', 'B3'], min: 100, max: 4500}, 'img');

// A feature collection with two polygon regions each intersecting 36
// pixels at 10 m scale.
var fcPolygon = ee.FeatureCollection([
  ee.Feature(ee.Geometry.Rectangle(
    -122.50620929, 37.76502806, -122.50552264, 37.76556663), {id: 0}),
  ee.Feature(ee.Geometry.Rectangle(
    -122.50530270, 37.76565568, -122.50460533, 37.76619425), {id: 1})
]);
Map.addLayer(fcPolygon, {color: 'yellow'}, 'fcPolygon');

var fcPolygonSamp = img.sampleRegions({
  collection: fcPolygon,
  scale: 10,
  geometries: true
});
// Note that 7 pixels are missing from the sample. If a pixel contains a masked
// band value it will be excluded from the sample. In this case, the TCI_B band
// is masked for each unsampled pixel.
print('A feature per pixel (at given scale) in each region', fcPolygonSamp);
Map.addLayer(fcPolygonSamp, {color: 'purple'}, 'fcPolygonSamp');

// A feature collection with two points intersecting two different pixels.
// This example is included to show the behavior for point geometries. In
// practice, if the feature collection is all points, ee.Image.reduceRegions
// should be used instead to save memory.
var fcPoint = ee.FeatureCollection([
  ee.Feature(ee.Geometry.Point([-122.50309256, 37.76605006]), {id: 0}),
  ee.Feature(ee.Geometry.Point([-122.50344661, 37.76560903]), {id: 1})
]);
Map.addLayer(fcPoint, {color: 'cyan'}, 'fcPoint');

var fcPointSamp = img.sampleRegions({
  collection: fcPoint,
  scale: 10
});
print('A feature per point', fcPointSamp);

Configuration de Python

Pour en savoir plus sur l'API Python et sur l'utilisation de geemap pour le développement interactif, consultez la page Environnement Python.

import ee
import geemap.core as geemap

Colab (Python)

# A Sentinel-2 surface reflectance image.
img = ee.Image('COPERNICUS/S2_SR/20210109T185751_20210109T185931_T10SEG')
m = geemap.Map()
m.set_center(-122.503881, 37.765588, 18)
m.add_layer(
    img, {'bands': ['B11', 'B8', 'B3'], 'min': 100, 'max': 4500}, 'img'
)
display(m)

# A feature collection with two polygon regions each intersecting 36
# pixels at 10 m scale.
fc_polygon = ee.FeatureCollection([
    ee.Feature(
        ee.Geometry.Rectangle(
            -122.50620929, 37.76502806, -122.50552264, 37.76556663
        ),
        {'id': 0},
    ),
    ee.Feature(
        ee.Geometry.Rectangle(
            -122.50530270, 37.76565568, -122.50460533, 37.76619425
        ),
        {'id': 1},
    ),
])
m.add_layer(fc_polygon, {'color': 'yellow'}, 'fc_polygon')

fc_polygon_samp = img.sampleRegions(
    collection=fc_polygon, scale=10, geometries=True
)
# Note that 7 pixels are missing from the sample. If a pixel contains a masked
# band value it will be excluded from the sample. In this case, the TCI_B band
# is masked for each unsampled pixel.
display('A feature per pixel (at given scale) in each region', fc_polygon_samp)
m.add_layer(fc_polygon_samp, {'color': 'purple'}, 'fc_polygon_samp')

# A feature collection with two points intersecting two different pixels.
# This example is included to show the behavior for point geometries. In
# practice, if the feature collection is all points, ee.Image.reduceRegions
# should be used instead to save memory.
fc_point = ee.FeatureCollection([
    ee.Feature(ee.Geometry.Point([-122.50309256, 37.76605006]), {'id': 0}),
    ee.Feature(ee.Geometry.Point([-122.50344661, 37.76560903]), {'id': 1}),
])
m.add_layer(fc_point, {'color': 'cyan'}, 'fc_point')

fc_point_samp = img.sampleRegions(collection=fc_point, scale=10)
display('A feature per point', fc_point_samp)