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

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

All Implemented Interfaces:

GPTool

public class WeightedSum
extends AbstractGPTool

Overlays several rasters multiplying each by their given weight and summing them together. The Weighted Sum tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Weighted Sum works

Software restrictions: none

Illustration:

Usage tips:

• In the illustration above, the cell values are multiplied by their weight factor, and the results are added together to create the output raster. For example, consider the top left cell. The values for the two inputs become (2.2 * 0.75) = 1.65 and (3 * 0.25) = 0.75. The sum of 1.5 and 0.75 is 2.4.
• Input rasters can be integer or floating point.
• The weight values can be any positive or negative decimal value. It is not restricted to a relative percentage or equal to 1.0.
• The weight will be applied to the specified field for the input raster. Fields can be of type, short or long integer, double or float.
• The output raster will always be of floating-point type.
• A useful way to add several rasters together is to input multiple rasters and set all weights equal to 1.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

WeightedSum()
Creates the Weighted Sum tool with defaults.

WeightedSum(Object inRasters, Object outRaster)
Creates the Weighted Sum tool with the required parameters.

Method Summary

Object	getInRasters() Returns the Input rasters 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	setInRasters(Object inRasters) Sets the Input rasters 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

WeightedSum

public WeightedSum()

Creates the Weighted Sum tool with defaults.

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

WeightedSum

public WeightedSum(Object inRasters,
                   Object outRaster)

Creates the Weighted Sum 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:

inRasters - (Composite Geodataset Field String; Composite Geodataset Field String;...), the weighted sum table allows the calculation of a several rasters.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRasters

public Object getInRasters()

Returns the Input rasters parameter of this tool . This parameter is (Composite Geodataset Field String; Composite Geodataset Field String;...), the weighted sum table allows the calculation of a several rasters. This is a required parameter.

Returns:

the Input rasters

setInRasters

public void setInRasters(Object inRasters)

Sets the Input rasters parameter of this tool . This parameter is (Composite Geodataset Field String; Composite Geodataset Field String;...), the weighted sum table allows the calculation of a several rasters. This is a required parameter.

Parameters:

inRasters - (Composite Geodataset Field String; Composite Geodataset Field String;...), the weighted sum table allows the calculation of a several rasters.

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