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

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

All Implemented Interfaces:

GPTool

public class Diff
extends AbstractGPTool

Determines which values from the first input are logically different from the values of the second input on a cell-by-cell basis. The Diff tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The order of inputs is relevant for this tool.
• Two inputs are necessary for this logical evaluation to take place.
• If all the inputs are integers, the output raster will be integer. If any of the inputs are floating point, the output will be floating point.

Field Summary

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

vals

Constructor Summary

Diff()
Creates the Diff tool with defaults.

Diff(Object inRasterOrConstant1, Object inRasterOrConstant2, Object outRaster)
Creates the Diff 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

Diff

public Diff()

Creates the Diff tool with defaults.

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

Diff

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

Creates the Diff 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 - the input to which the second input will be compared. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.

inRasterOrConstant2 - the input to which the first input will be compared. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.

outRaster - the output raster. the values in the output will be either 0 if the two input values are the same, or the first input value if they are not.

Method Detail

getInRasterOrConstant1

public Object getInRasterOrConstant1()

Returns the Input raster or constant value 1 parameter of this tool . This parameter is the input to which the second input will be compared. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. 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 the input to which the second input will be compared. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:

inRasterOrConstant1 - the input to which the second input will be compared. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.

getInRasterOrConstant2

public Object getInRasterOrConstant2()

Returns the Input raster or constant value 2 parameter of this tool . This parameter is the input to which the first input will be compared. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. 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 the input to which the first input will be compared. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:

inRasterOrConstant2 - the input to which the first input will be compared. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, 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 values in the output will be either 0 if the two input values are the same, or the first input value if they are not. 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 values in the output will be either 0 if the two input values are the same, or the first input value if they are not. This is a required parameter.

Parameters:

outRaster - the output raster. the values in the output will be either 0 if the two input values are the same, or the first input value if they are not.

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