ee.Image.mask

Recebe ou define a máscara de uma imagem. A imagem de saída retém os metadados e a área da imagem de entrada. Os pixels em que a máscara muda de zero para outro valor serão preenchidos com zeros ou os valores mais próximos de zero dentro do intervalo do tipo de pixel.

Observação: a versão que define uma máscara será descontinuada. Para definir uma máscara de uma imagem em pixels que não estavam mascarados, use Image.updateMask. Para remover a máscara de pixels que estavam mascarados, use Image.unmask.

Uso	Retorna
Image.mask(mask)	Imagem

Argumento	Tipo	Detalhes
isto: image	Imagem	A imagem de entrada.
mask	Imagem, padrão: null	A imagem da máscara. Se especificado, a imagem de entrada será copiada para a saída, mas receberá a máscara pelos valores dessa imagem. Se for uma única banda, ela será usada para todas as bandas na imagem de entrada. Se não for especificado, vai retornar uma imagem criada com base na máscara da imagem de entrada, dimensionada para o intervalo [0:1] (inválido = 0, válido = 1,0).

Exemplos

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');

Configuração do Python

Consulte a página Ambiente Python (em inglês) para informações sobre a API Python e como usar geemap para desenvolvimento interativo.

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