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

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

All Implemented Interfaces:

GPTool

public class Minus
extends AbstractGPTool

Subtracts the value of the second input raster from the value of the first input raster on a cell-by-cell basis within the Analysis window. The Minus tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• The order of input is relevant in the subtraction expression.
• If both input values are integers, the output values will be integers; otherwise, the output will be a floating-point value.
• A number can be used as an input; however, the cell size and extent must first be set in the environment.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

Minus()
Creates the Minus tool with defaults.

Minus(Object inRasterOrConstant1, Object inRasterOrConstant2, Object outRaster)
Creates the Minus tool with the required parameters.

Method Summary

Object	getInRasterOrConstant1() Returns the Input raster or constant value 1 parameter of this tool .
Object	getInRasterOrConstant2() Returns the Input raster or constant value 2 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	setInRasterOrConstant1(Object inRasterOrConstant1) Sets the Input raster or constant value 1 parameter of this tool .
void	setInRasterOrConstant2(Object inRasterOrConstant2) Sets the Input raster or constant value 2 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

Minus

public Minus()

Creates the Minus tool with defaults.

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

Minus

public Minus(Object inRasterOrConstant1,
             Object inRasterOrConstant2,
             Object outRaster)

Creates the Minus 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:

inRasterOrConstant1 - Composite Geodataset, the input raster or constant value from which to subtract.

inRasterOrConstant2 - Composite Geodataset, the input raster or constant value to subtract.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRasterOrConstant1

public Object getInRasterOrConstant1()

Returns the Input raster or constant value 1 parameter of this tool . This parameter is Composite Geodataset, the input raster or constant value from which to subtract. This is a required parameter.

Returns:

the Input raster or constant value 1

setInRasterOrConstant1

public void setInRasterOrConstant1(Object inRasterOrConstant1)

Sets the Input raster or constant value 1 parameter of this tool . This parameter is Composite Geodataset, the input raster or constant value from which to subtract. This is a required parameter.

Parameters:

inRasterOrConstant1 - Composite Geodataset, the input raster or constant value from which to subtract.

getInRasterOrConstant2

public Object getInRasterOrConstant2()

Returns the Input raster or constant value 2 parameter of this tool . This parameter is Composite Geodataset, the input raster or constant value to subtract. This is a required parameter.

Returns:

the Input raster or constant value 2

setInRasterOrConstant2

public void setInRasterOrConstant2(Object inRasterOrConstant2)

Sets the Input raster or constant value 2 parameter of this tool . This parameter is Composite Geodataset, the input raster or constant value to subtract. This is a required parameter.

Parameters:

inRasterOrConstant2 - Composite Geodataset, the input raster or constant value to subtract.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. 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 Raster Dataset, the raster to be created. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the raster to be created.

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