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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.WeightedOverlay
All Implemented Interfaces:
GPTool

public class WeightedOverlay
extends AbstractGPTool

Overlays several rasters using a common measurement scale and weights each according to its importance. The Weighted Overlay tool is contained in the Spatial Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
WeightedOverlay()
          Creates the Weighted Overlay tool with defaults.
WeightedOverlay(Object inWeightedOverlayTable, Object outRaster)
          Creates the Weighted Overlay tool with the required parameters.
 
Method Summary
 Object getInWeightedOverlayTable()
          Returns the Weighted overlay table 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 setInWeightedOverlayTable(Object inWeightedOverlayTable)
          Sets the Weighted overlay table 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

WeightedOverlay

public WeightedOverlay()
Creates the Weighted Overlay tool with defaults.

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


WeightedOverlay

public WeightedOverlay(Object inWeightedOverlayTable,
                       Object outRaster)
Creates the Weighted Overlay 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:
inWeightedOverlayTable - the Weighted Overlay tool allows the calculation of a multiple-criteria analysis between several rasters. an Overlay class is used to define the table. The WOTable object is used to specify the criteria rasters and their respective properties. the form of the object is:
  • WOTable([[inRaster, influence, field, remap],...], [from, to, by])
outRaster - the output suitability raster.
Method Detail

getInWeightedOverlayTable

public Object getInWeightedOverlayTable()
Returns the Weighted overlay table parameter of this tool . This parameter is the Weighted Overlay tool allows the calculation of a multiple-criteria analysis between several rasters. an Overlay class is used to define the table. The WOTable object is used to specify the criteria rasters and their respective properties. the form of the object is: This is a required parameter.

Returns:
the Weighted overlay table

setInWeightedOverlayTable

public void setInWeightedOverlayTable(Object inWeightedOverlayTable)
Sets the Weighted overlay table parameter of this tool . This parameter is the Weighted Overlay tool allows the calculation of a multiple-criteria analysis between several rasters. an Overlay class is used to define the table. The WOTable object is used to specify the criteria rasters and their respective properties. the form of the object is: This is a required parameter.

Parameters:
inWeightedOverlayTable - the Weighted Overlay tool allows the calculation of a multiple-criteria analysis between several rasters. an Overlay class is used to define the table. The WOTable object is used to specify the criteria rasters and their respective properties. the form of the object is:
  • WOTable([[inRaster, influence, field, remap],...], [from, to, by])

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is the output suitability raster. 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. This is a required parameter.

Parameters:
outRaster - the output suitability raster.

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