ee.Image.mask

Obtiene o establece la máscara de una imagen. La imagen de salida conserva los metadatos y la huella de la imagen de entrada. Los píxeles en los que la máscara cambia de cero a otro valor se completarán con ceros o con los valores más cercanos a cero dentro del rango del tipo de píxel.

Nota: La versión que establece una máscara quedará obsoleta. Para establecer una máscara a partir de una imagen en píxeles que no se enmascararon anteriormente, usa Image.updateMask. Para quitar la máscara de los píxeles a los que se les aplicó una máscara anteriormente, usa Image.unmask.

Uso	Muestra
Image.mask(mask)	Imagen

Argumento	Tipo	Detalles
este: image	Imagen	Es la imagen de entrada.
mask	Imagen, valor predeterminado: null	Es la imagen de la máscara. Si se especifica, la imagen de entrada se copia en la imagen de salida, pero se le aplica la máscara según los valores de esta imagen. Si se trata de una sola banda, se usa para todas las bandas de la imagen de entrada. Si no se especifica, devuelve una imagen creada a partir de la máscara de la imagen de entrada, ajustada al rango [0:1] (inválida = 0, válida = 1.0).

Ejemplos

Editor de código (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');

Configuración de Python

Consulta la página Entorno de Python para obtener información sobre la API de Python y el uso de geemap para el desarrollo interactivo.

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