Power (Image Analyst)

Summary

Raises the cell values in a raster to the power of the values found in another raster.

Illustration

OutRas = Power(InRas1, 2)

Usage

• The output raster from this tool is always floating-point type, regardless of the input value type.

• If both inputs are single-band rasters or one of the inputs is a constant, the output will be a single-band raster.

• If both inputs are multiband rasters, the tool will perform the operation on each band from one input, and the output will be a multiband raster. The number of bands in each multiband input must be the same.

• If one of the inputs is a multiband raster and the other input is a constant, the tool will perform the operation using the constant value for each band in the multiband input, and the output will be a multiband raster.

• If both inputs are multidimensional raster data with the same number of variables, the tool will perform the operation for all slices with the same dimension value. The output will be a multidimensional raster in CRF format. The variables in the inputs must have at least one common dimension and one common dimensional value for this tool to process; otherwise, an error will occur.

  If both inputs have one variable but different names, uncheck the Match Multidimensional Variable geoprocessing environment (set arcpy.env.matchMultidimensionalVariable = False in Python) before running the tool.

  If one of the inputs is a multidimensional raster and the other input is a constant, the tool will perform the operation for all slices for all variables using the constant value, and the output will be a multidimensional raster.

• In map algebra, the equivalent operator symbol for this tool is "**" (link).

Parameters

Dialog

Label	Explanation	Data Type
Input raster or constant value 1	The input values to be raised to the power defined by the second input. A number can be used as an input for this parameter, provided a raster is specified for the other parameter. To specify a number for both inputs, the cell size and extent must first be set in the environment.	Raster Layer; Constant
Input raster or constant value 2	The input that determines the power the values in the first input will be raised to. A number can be used as an input for this parameter, provided a raster is specified for the other parameter. To specify a number for both inputs, the cell size and extent must first be set in the environment.	Raster Layer; Constant

Return Value

Label	Explanation	Data Type
Output raster	The output raster. The cell values are the result of raising the values in the first input to the power of the values in the second input.	Raster

Python

Power(in_raster_or_constant1, in_raster_or_constant2)

Name	Explanation	Data Type
in_raster_or_constant1	The input values to be raised to the power defined by the second input. A number can be used as an input for this parameter, provided a raster is specified for the other parameter. To specify a number for both inputs, the cell size and extent must first be set in the environment.	Raster Layer; Constant
in_raster_or_constant2	The input that determines the power the values in the first input will be raised to. A number can be used as an input for this parameter, provided a raster is specified for the other parameter. To specify a number for both inputs, the cell size and extent must first be set in the environment.	Raster Layer; Constant

Return Value

Name	Explanation	Data Type
out_raster	The output raster. The cell values are the result of raising the values in the first input to the power of the values in the second input.	Raster

Code sample

Power example 1 (Python window)

This example uses the values in the second input raster as the power to raise the values in the first input raster by, and outputs the result as an IMG raster.

import arcpy
from arcpy import env
from arcpy.ia import *
env.workspace = "C:/iapyexamples/data"
outPower = Power("degs", "cost")
outPower.save("C:/iapyexamples/output/outpower.img")

Power example 2 (stand-alone script)

This example uses the values in the second input raster as the power to raise the values in the first input raster by, and outputs the result as an IMG raster.

# Name: Power_Ex_02.py
# Description: Raises the pixels in a raster to the power of the values
#              found in another raster
# Requirements: Image Analyst Extension

# Import system modules
import arcpy
from arcpy import env
from arcpy.ia import *

# Set environment settings
env.workspace = "C:/iapyexamples/data"

# Set local variables
inRaster1 = "degs"
inRaster2 = "cost"

# Check out the ArcGIS Image Analyst extension license
arcpy.CheckOutExtension("ImageAnalyst")

# Execute Power
outPower = Power(inRaster1, inRaster2)

# Save the output 
outPower.save("C:/iapyexamples/output/outpower.img")

Environments

Auto Commit, Cell Size, Cell Size Projection Method, Current Workspace, Extent, Geographic Transformations, Mask, Output CONFIG Keyword, Output Coordinate System, Scratch Workspace, Snap Raster, Tile Size