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.

Usage tips:

• A useful way to add several rasters together is to input multiple rasters and set all weights equal to 1.
• 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.

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 - the Weighted Sum tool overlays several rasters, multiplying each by their given weight and summing them together. an Overlay class is used to define the table. The WSTable object is used to specify a pyton list of input rasters and weight them accordingly. the form of the WSTable object is:

• WSTable ([[inRaster, field, weight],...])

outRaster - the output suitability raster. it will be of floating point type.

Method Detail

getInRasters

public Object getInRasters()

Returns the Input rasters parameter of this tool . This parameter is the Weighted Sum tool overlays several rasters, multiplying each by their given weight and summing them together. an Overlay class is used to define the table. The WSTable object is used to specify a pyton list of input rasters and weight them accordingly. the form of the WSTable object is: 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 the Weighted Sum tool overlays several rasters, multiplying each by their given weight and summing them together. an Overlay class is used to define the table. The WSTable object is used to specify a pyton list of input rasters and weight them accordingly. the form of the WSTable object is: This is a required parameter.

Parameters:

inRasters - the Weighted Sum tool overlays several rasters, multiplying each by their given weight and summing them together. an Overlay class is used to define the table. The WSTable object is used to specify a pyton list of input rasters and weight them accordingly. the form of the WSTable object is:

• WSTable ([[inRaster, field, weight],...])

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output suitability raster. it will be of floating point type. 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 suitability raster. it will be of floating point type. This is a required parameter.

Parameters:

outRaster - the output suitability raster. it will be of floating point type.

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