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

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

All Implemented Interfaces:

GPTool

public class SingleOutputMapAlgebra
extends AbstractGPTool

Runs a single expression built with the Map Algebra language. The Single Output Map Algebra tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Usage tips:

• Only Map Algebra expressions that generate a raster as output are supported. Following are the functions that are not supported by SOMA, grouped functionally:
• The Map Algebra expression does not support the "out_dataset = function (parameters)" syntax of traditional Map Algebra. Simply specify the function and its parameters. For example, type "slope (D:\data\surf_1, percentrise, 2)" instead of "out_slope = slope (D:\data\surf_1, percentrise, 2)".
• Inputs with different spatial references can be used with Single Output Map Algebra (SOMA). The datasets will be projected on the fly to complete the analysis.
• Spaces should be used between operators. For example, use "inras + 2" instead of "inras+2".
• A hypen ("-") cannot be used in a dataset path or computer name. It will be interpreted as a subtract or negate operator. For example, having a machine named "serv2-ryan" would cause a problem with the following function: int (\\serv2-ryan\data\ras1 - \\serv1\data\ras2)Similarly, a command with a hyphen in a raster name is also invalid: int (ras-1 - ras2)
• Click the Usage button to display the command line usage for all supported functions. In addition to the scroll bar, the list of functions can be scrolled with the Up and Down arrows or by typing the initial letter or letters of the command. If the function name has already been entered in the expression box, select it or place the cursor anywhere before the last character and click the Usage button to see it.
• The first term in the usage display indicates the data type of the output. This includes:
• Where "" is listed in the usage, any supported raster or layer can be used.
• If the dataset is identified in the input raster or feature data list, it is not necessary to specify the path in the Map Algebra expression.
• You can use the Browse tool to add a path to an input dataset instead of typing it out.
• When building a Con or SetNull Map Algebra statement with the Single Output Map Algebra tool, use the "==" or "EQ" symbol for the equals condition. An example is: CON (C:\data\in_ras1 == 5, 1)An SQL query used with the Con or SetNull tools will not work in the expression of the Single Output Map Algebra tool.
• The results from Single Output Map Algebra are added to the table of contents for the active ArcMap session.
• The maximum length of the expression is 4096 characters.

Field Summary

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

vals

Constructor Summary

SingleOutputMapAlgebra()
Creates the Single Output Map Algebra tool with defaults.

SingleOutputMapAlgebra(Object expressionString, Object outRaster)
Creates the Single Output Map Algebra tool with the required parameters.

Method Summary

Object	getExpressionString() Returns the Map Algebra expression parameter of this tool .
Object	getInData() Returns the Input raster or feature data 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	setExpressionString(Object expressionString) Sets the Map Algebra expression parameter of this tool .
void	setInData(Object inData) Sets the Input raster or feature data 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

SingleOutputMapAlgebra

public SingleOutputMapAlgebra()

Creates the Single Output Map Algebra tool with defaults.

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

SingleOutputMapAlgebra

public SingleOutputMapAlgebra(Object expressionString,
                              Object outRaster)

Creates the Single Output Map Algebra 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:

expressionString - MapAlgebra Expression, slope (D:\data\surf_1, percentrise, 2)

outRaster - Raster Dataset, the output raster to be created from the Map Algebra expression.

Method Detail

getExpressionString

public Object getExpressionString()

Returns the Map Algebra expression parameter of this tool . This parameter is MapAlgebra Expression, slope (D:\data\surf_1, percentrise, 2) This is a required parameter.

Returns:

the Map Algebra expression

setExpressionString

public void setExpressionString(Object expressionString)

Sets the Map Algebra expression parameter of this tool . This parameter is MapAlgebra Expression, slope (D:\data\surf_1, percentrise, 2) This is a required parameter.

Parameters:

expressionString - MapAlgebra Expression, slope (D:\data\surf_1, percentrise, 2)

getOutRaster

public Object getOutRaster()

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

Parameters:

outRaster - Raster Dataset, the output raster to be created from the Map Algebra expression.

getInData

public Object getInData()

Returns the Input raster or feature data parameter of this tool . This parameter is Composite Geodataset, the inputs can be raster or feature data. This is an optional parameter.

Returns:

the Input raster or feature data

setInData

public void setInData(Object inData)

Sets the Input raster or feature data parameter of this tool . This parameter is Composite Geodataset, the inputs can be raster or feature data. This is an optional parameter.

Parameters:

inData - Composite Geodataset, the inputs can be raster or feature data.

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