com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class Negate

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.Negate

All Implemented Interfaces:

GPTool

public class Negate
extends AbstractGPTool

Changes the sign (multiplies by -1) of the cell values of the input raster on a cell-by-cell basis. The Negate tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• If the input values are integer, the output raster will be integer type. If the input values are floating point, the output raster will be floating point.
• In Map Algebra, the equivalent symbol for this tool is "-" ().

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

Negate()
Creates the Negate tool with defaults.

Negate(Object inRasterOrConstant, Object outRaster)
Creates the Negate tool with the required parameters.

Method Summary

Object	getInRasterOrConstant() Returns the Input raster or constant value parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setInRasterOrConstant(Object inRasterOrConstant) Sets the Input raster or constant value parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Negate

public Negate()

Creates the Negate tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

Negate

public Negate(Object inRasterOrConstant,
              Object outRaster)

Creates the Negate tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inRasterOrConstant - the input raster to be negated (multiplied by -1). in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment.

outRaster - the output raster. the cell values are the input values negated (multiplied by -1).

Method Detail

getInRasterOrConstant

public Object getInRasterOrConstant()

Returns the Input raster or constant value parameter of this tool . This parameter is the input raster to be negated (multiplied by -1). in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. This is a required parameter.

Returns:

the Input raster or constant value

setInRasterOrConstant

public void setInRasterOrConstant(Object inRasterOrConstant)

Sets the Input raster or constant value parameter of this tool . This parameter is the input raster to be negated (multiplied by -1). in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:

inRasterOrConstant - the input raster to be negated (multiplied by -1). in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. the cell values are the input values negated (multiplied by -1). This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output raster. the cell values are the input values negated (multiplied by -1). This is a required parameter.

Parameters:

outRaster - the output raster. the cell values are the input values negated (multiplied by -1).

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias