Times (Image Analyst)

Available with Spatial Analyst license.

Available with Image Analyst license.

Available with 3D Analyst license.

Summary

Multiplies the values of two rasters on a cell-by-cell basis.

Illustration

OutRas = Times (InRas1, InRas2)

Usage

• The order of inputs is irrelevant for this tool.

• If both inputs are integer, the output will be an integer raster; otherwise, it will be a floating-point raster.

• 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.

• In ArcPy, if both inputs are multidimensional rasters with the same number of variables, the tool will perform the operation for all slices with the same dimension value, and the output will be a multidimensional raster. The variables in the inputs must have the same dimensions or common dimension but no uncommon dimensions.

  If both inputs have one variable but different names, set the matchMultidimensionalVariable geoprocessing environment to False to perform the operation.

  In ArcPy, 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.

Parameters

Dialog

Label	Explanation	Data Type
Input raster or constant value 1	The input containing the values to be multiplied. 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 containing the values by which the first input will be multiplied. 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 product of the first input multiplied by the second.	Raster

Python

Times(in_raster_or_constant1, in_raster_or_constant2)

Name	Explanation	Data Type
in_raster_or_constant1	The input containing the values to be multiplied. 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 containing the values by which the first input will be multiplied. 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 product of the first input multiplied by the second.	Raster

Code sample

Times example 1 (Python window)

This example multiplies the values of an input elevation raster by a constant value to convert the elevation values from feet to meters.

import arcpy
from arcpy import env
from arcpy.ia import *
env.workspace = "C:/iapyexamples/data"
outTimes = Times("elevation", "0.3048")
outTimes.save("C:/iapyexamples/output/outtimes")

Times example 2 (stand-alone script)

This example multiplies the values of an input elevation raster by a constant value to convert the elevation values from feet to meters.

# Name: Times_Ex_02.py
# Description: Multiplies the values of two rasters on a pixel-by-pixel basis.
# 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
inRaster = "elevation"
inConstant = 0.3048

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

# Execute Times
outTimes = Times(inRaster, inConstant)

# Save the output 
outTimes.save("C:/iapyexamples/output/timesout")

Environments

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

Licensing information

• Basic: Requires Image Analyst or Spatial Analyst or 3D Analyst
• Standard: Requires Image Analyst or Spatial Analyst or 3D Analyst
• Advanced: Requires Image Analyst or Spatial Analyst or 3D Analyst