Negate (Image Analyst)

Available with Spatial Analyst license.

Available with Image Analyst license.

Summary

Changes the sign (multiplies by -1) of the cell values of the input raster on a cell-by-cell basis.

Illustration

OutRas = Negate(InRas1)

Usage

• If the input is integer, the output raster will be integer type. If the input is floating point, the output raster will be floating point.

• If the input is a multiband raster, the output will be a multiband raster. The tool will perform the operation on each band in the input.

• In ArcPy, if the input is a multidimensional raster, all slices from all variables will be processed, and the output will be a multidimensional raster.

Parameters

Dialog

Label	Explanation	Data Type
Input raster or constant value	The input raster to be negated (multiplied by -1). To use a number as an input for this parameter, 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 input values negated (multiplied by -1).	Raster

Python

Negate(in_raster_or_constant)

Name	Explanation	Data Type
in_raster_or_constant	The input raster to be negated (multiplied by -1). To use a number as an input for this parameter, 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 input values negated (multiplied by -1).	Raster

Code sample

Negate example 1 (Python window)

This example changes the sign of the values in the input raster and outputs a Grid raster.

import arcpy
from arcpy import env
from arcpy.ia import *
env.workspace = "C:/iapyexamples/data"
outNegate = Negate("degs")
outNegate.save("C:/iapyexamples/output/outneg")

Negate example 2 (stand-alone script)

This example changes the sign of the values in the input raster and outputs a Grid raster.

# Name: Negate_Ex_02.py
# Description: Changes the sign (multiplies by -1) of the cell values
#              of the input raster 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 = "degs"

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

# Execute Negate
outNegate = Negate(inRaster)

# Save the output 
outNegate.save("C:/iapyexamples/output/outnegate")

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
• Standard: Requires Image Analyst or Spatial Analyst
• Advanced: Requires Image Analyst or Spatial Analyst