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

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

All Implemented Interfaces:

GPTool

public class FuzzyOverlay
extends AbstractGPTool

Combine fuzzy membership rasters data together, based on selected overlay type. The Fuzzy Overlay tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• This tool is to be applied to output rasters of fuzzy membership that vary between 0 and 1.
• The following lists the appropriate Overlay type to use for certain conditions.
  • Use OR when any of the input evidence rasters can have a high value in order for the output to be a high value.
  • Use AND when all of the input evidence rasters must have a high value in order for the output to be a high value.
  • Use PRODUCT when the combined evidence is less important than any single evidence.
  • Use SUM when the combined evidence is more important than any single evidence.
• The GAMMA Overlay type is typically used to combine fuzzy combinations of more basic data. When Gamma is 1 the result is the same as Fuzzy Sum. When Gamma is 0 the result is the same as Fuzzy Product. Values in between allow the user to combine evidence between these two extremes and possibly different than Fuzzy Or or Fuzzy And.

Field Summary

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

vals

Constructor Summary

FuzzyOverlay()
Creates the Fuzzy Overlay tool with defaults.

FuzzyOverlay(Object inRasters, Object outRaster)
Creates the Fuzzy Overlay tool with the required parameters.

Method Summary

double	getGamma() Returns the Gamma parameter of this tool .
Object	getInRasters() Returns the Input rasters parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
String	getOverlayType() Returns the Overlay type 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	setGamma(double gamma) Sets the Gamma parameter 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 .
void	setOverlayType(String overlayType) Sets the Overlay type 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

FuzzyOverlay

public FuzzyOverlay()

Creates the Fuzzy Overlay tool with defaults.

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

FuzzyOverlay

public FuzzyOverlay(Object inRasters,
                    Object outRaster)

Creates the Fuzzy 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:

inRasters - a list of input membership rasters to be combined in the overlay.

outRaster - the output raster which is the results of applying the fuzzy operator. This output will always have a value between 0 and 1.

Method Detail

getInRasters

public Object getInRasters()

Returns the Input rasters parameter of this tool . This parameter is a list of input membership rasters to be combined in the overlay. 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 a list of input membership rasters to be combined in the overlay. This is a required parameter.

Parameters:

inRasters - a list of input membership rasters to be combined in the overlay.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster which is the results of applying the fuzzy operator. This output will always have a value between 0 and 1. 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 which is the results of applying the fuzzy operator. This output will always have a value between 0 and 1. This is a required parameter.

Parameters:

outRaster - the output raster which is the results of applying the fuzzy operator. This output will always have a value between 0 and 1.

getOverlayType

public String getOverlayType()

Returns the Overlay type parameter of this tool . This parameter is specifies the method used to combine two or more membership data. This is an optional parameter.

Returns:

the Overlay type

setOverlayType

public void setOverlayType(String overlayType)

Sets the Overlay type parameter of this tool . This parameter is specifies the method used to combine two or more membership data. This is an optional parameter.

Parameters:

overlayType - specifies the method used to combine two or more membership data.

getGamma

public double getGamma()

Returns the Gamma parameter of this tool . This parameter is the gamma value to be used. This is only when the Overlay type is set to GAMMA. default value is 0.9. This is an optional parameter.

Returns:

the Gamma

setGamma

public void setGamma(double gamma)

Sets the Gamma parameter of this tool . This parameter is the gamma value to be used. This is only when the Overlay type is set to GAMMA. default value is 0.9. This is an optional parameter.

Parameters:

gamma - the gamma value to be used. This is only when the Overlay type is set to GAMMA. default value is 0.9.

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