ee.Image.mask

Obtient ou définit le masque d'une image. L'image de sortie conserve les métadonnées et l'empreinte de l'image d'entrée. Les pixels où le masque passe de zéro à une autre valeur seront remplis de zéros ou des valeurs les plus proches de zéro dans la plage du type de pixel.

Remarque : La version qui définit un masque sera obsolète. Pour définir un masque à partir d'une image sur des pixels précédemment non masqués, utilisez Image.updateMask. Pour démasquer des pixels précédemment masqués, utilisez Image.unmask.

Utilisation	Renvoie
Image.mask(mask)	Image

Argument	Type	Détails
this: image	Image	Image d'entrée.
mask	Image, valeur par défaut : null	Image de masque. Si elle est spécifiée, l'image d'entrée est copiée dans la sortie, mais le masque est défini par les valeurs de cette image. S'il s'agit d'une seule bande, elle est utilisée pour toutes les bandes de l'image d'entrée. Si elle n'est pas spécifiée, renvoie une image créée à partir du masque de l'image d'entrée, mise à l'échelle dans la plage [0:1] (non valide = 0, valide = 1.0).

Exemples

Éditeur de code (JavaScript)

// A Sentinel-2 surface reflectance image.
var img = ee.Image('COPERNICUS/S2_SR/20210109T185751_20210109T185931_T10SEG');
var trueColorViz = {
  bands: ['B4', 'B3', 'B2'],
  min: 0,
  max: 2700,
  gamma: 1.3
};
print('Sentinel-2 image', img);
Map.setCenter(-122.36, 37.47, 10);
Map.addLayer(img, trueColorViz, 'Sentinel-2 image');

// Get masks for all image bands; each band has an independent mask.
// Valid pixels are value 1, invalid are 0.
var multiBandMaskImg = img.mask();
print('Multi-band mask image', multiBandMaskImg);
Map.addLayer(multiBandMaskImg, null, 'Multi-band mask image');

// Get the mask for a single image band.
var singleBandMaskImg = img.select('B1').mask();
print('Single-band mask image', singleBandMaskImg);
Map.addLayer(singleBandMaskImg, null, 'Single-band mask image');

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')
true_color_viz = {
    'bands': ['B4', 'B3', 'B2'],
    'min': 0,
    'max': 2700,
    'gamma': 1.3,
}
display('Sentinel-2 image', img)
m = geemap.Map()
m.set_center(-122.36, 37.47, 10)
m.add_layer(img, true_color_viz, 'Sentinel-2 image')

# Get masks for all image bands each band has an independent mask.
# Valid pixels are value 1, invalid are 0.
multi_band_mask_img = img.mask()
display('Multi-band mask image', multi_band_mask_img)
m.add_layer(multi_band_mask_img, None, 'Multi-band mask image')

# Get the mask for a single image band.
single_band_mask_img = img.select('B1').mask()
display('Single-band mask image', single_band_mask_img)
m.add_layer(single_band_mask_img, None, 'Single-band mask image')
m