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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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.

Usage tips:

• All regions of less than three cells in the x- or y-direction will be changed.
• The shrinking that occurs with the ONE_WAY smoothing process (expansion-shrinking process run once) or the first pass when the TWO_WAY smoothing process is different than the shrinking that occurs with the second pass of the TWO_WAY smoothing.In the first pass, for any processing cell in the expanded raster that has a neighbor of the original value of the processing cell, the original value of the processing cell will be recovered. In the second pass of TWO_WAY, any cell in the expanded raster that is not completely surrounded by eight cells of the same value will recover its original value.
• The expansion is identical for the first and second pass.
• Input cells of NoData have the lowest prioroty in the ONE_WAY sorting type, or in the first pass of TWO_WAY sorting. In the second pass of TWO_WAY sorting, cells of NoData have the highest priority.

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 - the input raster for which the boundary between zones will be smoothed. it must be of integer type.

outRaster - the output generalized raster. the boundaries between zones in the input will be smoothed.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster for which the boundary between zones will be smoothed. it must be of integer type. 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 the input raster for which the boundary between zones will be smoothed. it must be of integer type. This is a required parameter.

Parameters:

inRaster - the input raster for which the boundary between zones will be smoothed. it must be of integer type.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output generalized raster. the boundaries between zones in the input will be smoothed. 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 generalized raster. the boundaries between zones in the input will be smoothed. This is a required parameter.

Parameters:

outRaster - the output generalized raster. the boundaries between zones in the input will be smoothed.

getSortType

public String getSortType()

Returns the Sorting technique parameter of this tool . This parameter is specifies the type of sorting to use in the smoothing process. this determines the priority by which cells can 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 specifies the type of sorting to use in the smoothing process. this determines the priority by which cells can expand into their neighbors. This is an optional parameter.

Parameters:

sortType - specifies the type of sorting to use in the smoothing process. this determines the priority by which cells can expand into their neighbors.

getNumberOfRuns

public String getNumberOfRuns()

Returns the Run expansion and shrinking twice parameter of this tool . This parameter is specifies the number of directions in which the smoothing process 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 specifies the number of directions in which the smoothing process will take place. This is an optional parameter.

Parameters:

numberOfRuns - specifies the number of directions in which the smoothing process 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