ee.Image.mask

获取或设置图片的蒙版。输出图片会保留输入图片的元数据和覆盖区。蒙版从零更改为其他值的像素将填充零，或像素类型范围内最接近零的值。

注意：设置蒙版的版本将被弃用。如需从图片中为之前未遮盖的像素设置蒙版，请使用 Image.updateMask。如需取消遮盖之前遮盖的像素，请使用 Image.unmask。

用法返回
Image.mask(mask)图片
实参类型详细信息
this：image图片输入图片。
mask图片，默认值：null蒙版图片。如果指定了此图片，则输入图片会复制到输出，但会根据此图片的值设置蒙版。如果这是单波段图片，则会用于输入图片中的所有波段。如果未指定，则返回根据输入图片的蒙版创建的图片，缩放至范围 [0:1]（无效 = 0，有效 = 1.0）。

示例

代码编辑器 (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');

Python 设置

如需了解 Python API 和如何使用 geemap 进行交互式开发，请访问 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