Skip to main content

Grayscale

Summary

Converts a multiband image to a single-band grayscale image. Specified weights are applied to each of the input bands, and a normalization is applied for output.

Discussion

For more information about how this function works, see the Grayscale raster function.

The referenced raster dataset for the raster object is temporary. To make it permanent, you can call the raster object's save method.

Syntax

Grayscale(raster, {conversion_parameters})

Parameter Explanation Data Type

raster

The input raster.

Raster

conversion_parameters

The weights for each of the bands comprising the input raster.

The default value is None.

List

Return value

Data Type Explanation

Raster

The output raster.

Code sample

Grayscale example 1

This example applies the Grayscale function to the input imagery.

from arcpy.sa import *
out_grayscale_raster = Grayscale("imagery.tif")
out_grayscale_raster.save("C:/arcpyExamples/outputs/grayscale.tif")
Grayscale example 2

This example applies the Grayscale function to the input imagery.

# Import the system modules
import arcpy
from arcpy.sa import *

# Set the analysis environments
arcpy.env.workspace = "C:/arcpyExamples/data"

# Set the local variables
in_raster = "imagery.tif"

# Run the Grayscale function
out_grayscale_raster = Grayscale(in_raster)

# Save the output
out_grayscale_raster.save("C:/arcpyExamples/outputs/grayscale.tif")