Page Summary
-
The
Image.renamefunction changes the names of the bands in an image. -
It returns the image with the renamed bands.
-
The new names for the bands must be provided as a list of strings or a series of string arguments, and the number of new names must match the number of bands in the image.
Returns the renamed image.
| Usage | Returns |
|---|---|
Image.
rename
(var_args)
|
Image |
| Argument | Type | Details |
|---|---|---|
|
this:
image
|
Image | The Image instance. |
var_args
|
List<String>|Object|VarArgs<String> | The new names for the bands. Must match the number of bands in the Image. |
Examples
Code Editor (JavaScript)
// 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 ());
import ee import geemap.core as geemap
Colab (Python)
# A Sentinel-2 surface reflectance image. img = ee . Image ( 'COPERNICUS/S2_SR/20210109T185751_20210109T185931_T10SEG' ) . select ([ 'B11' , 'B8' , 'B3' ]) display ( 'Original selected S2 image band names:' , img . bandNames ()) display ( 'Rename bands using a list (Python list or ee.List):' , img . rename ([ 'SWIR1' , 'NIR' , 'GREEN' ]) . bandNames ()) display ( 'Rename bands using a series of string arguments:' , img . rename ( 'swir1' , 'nir' , 'green' ) . bandNames ())

