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

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

public class BoundaryClean
extends AbstractGPTool

Smoothes the boundary between zones by expanding and shrinking it. The Boundary Clean tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Boundary Clean works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
BoundaryClean()
          Creates the Boundary Clean tool with defaults.
BoundaryClean(Object inRaster, Object outRaster)
          Creates the Boundary Clean tool with the required parameters.
 
Method Summary
 Object getInRaster()
          Returns the Input raster parameter of this tool .
 String getNumberOfRuns()
          Returns the Run expansion and shrinking twice parameter of this tool .
 Object getOutRaster()
          Returns the Output raster parameter of this tool .
 String getSortType()
          Returns the Sorting technique 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 setInRaster(Object inRaster)
          Sets the Input raster parameter of this tool .
 void setNumberOfRuns(String numberOfRuns)
          Sets the Run expansion and shrinking twice parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output raster parameter of this tool .
 void setSortType(String sortType)
          Sets the Sorting technique 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

BoundaryClean

public BoundaryClean()
Creates the Boundary Clean tool with defaults.

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


BoundaryClean

public BoundaryClean(Object inRaster,
                     Object outRaster)
Creates the Boundary Clean 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:
inRaster - Composite Geodataset, the input raster to which Boundary Clean is applied.
outRaster - Raster Dataset, the raster to be created.
Method Detail

getInRaster

public Object getInRaster()
Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, the input raster to which Boundary Clean is applied. This is a required parameter.

Returns:
the Input raster

setInRaster

public void setInRaster(Object inRaster)
Sets the Input raster parameter of this tool . This parameter is Composite Geodataset, the input raster to which Boundary Clean is applied. This is a required parameter.

Parameters:
inRaster - Composite Geodataset, the input raster to which Boundary Clean is applied.

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.

getSortType

public String getSortType()
Returns the Sorting technique parameter of this tool . This parameter is String, this determines the priority of cells to expand into their neighbors. This is an optional parameter.

Returns:
the Sorting technique

setSortType

public void setSortType(String sortType)
Sets the Sorting technique parameter of this tool . This parameter is String, this determines the priority of cells to expand into their neighbors. This is an optional parameter.

Parameters:
sortType - String, this determines the priority of cells to expand into their neighbors.

getNumberOfRuns

public String getNumberOfRuns()
Returns the Run expansion and shrinking twice parameter of this tool . This parameter is String, specifies the number of directions in which the expansion and shrinking will take place. This is an optional parameter.

Returns:
the Run expansion and shrinking twice

setNumberOfRuns

public void setNumberOfRuns(String numberOfRuns)
Sets the Run expansion and shrinking twice parameter of this tool . This parameter is String, specifies the number of directions in which the expansion and shrinking will take place. This is an optional parameter.

Parameters:
numberOfRuns - String, specifies the number of directions in which the expansion and shrinking will take place.

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