ee.Image.rename
Rename the bands of an image.
Returns the renamed image.
Usage | Returns |
---|
Image.rename(var_args) | Image |
Argument | Type | Details |
---|
this: image | Image | The Image instance. |
var_args | List | The new names for the bands. Must match the number of bands in the Image. |
Examples
// A Sentinel-2 surface reflectance image.
var img = ee.Image('COPERNICUS/S2_SR/20210109T185751_20210109T185931_T10SEG')
.select(['B11', 'B8', 'B3']);
print('Original selected S2 image band names', img.bandNames());
print('Rename bands using a list (JavaScript array or ee.List)',
img.rename(['SWIR1', 'NIR', 'GREEN']).bandNames());
print('Rename bands using a series of string arguments',
img.rename('swir1', 'nir', 'green').bandNames());
Python setup
See the
Python Environment page for information on the Python API and using
geemap
for interactive development.
import ee
import geemap.core as geemap
# A Sentinel-2 surface reflectance image.
img = ee.Image(
'COPERNICUS/S2_SR/20210109T185751_20210109T185931_T10SEG'
).select(['B11', 'B8', 'B3'])
print('Original selected S2 image band names:', img.bandNames().getInfo())
print('Rename bands using a list (Python list or ee.List):',
img.rename(['SWIR1', 'NIR', 'GREEN']).bandNames().getInfo())
print('Rename bands using a series of string arguments:',
img.rename('swir1', 'nir', 'green').bandNames().getInfo())
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["The `Image.rename()` function allows you to change the names of bands in an Earth Engine image."],["You can provide new band names as a list or as individual string arguments."],["The number of new band names must match the number of bands in the image."],["`Image.rename()` returns a new image with the updated band names."]]],["The core functionality is to rename the bands of an image using the `Image.rename()` method. This method takes either a list or a series of string arguments as new band names. The number of new names provided must match the existing number of bands. The method returns the image with the updated band names. Examples demonstrate renaming bands of a Sentinel-2 image in both JavaScript and Python, using both a list and individual string arguments.\n"]]