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.
Learn more about how Boundary Clean works

Software restrictions: none

Illustration:

Usage tips:

• The input raster must be integer.
• All regions of less than three cells in the x- or y-direction will be changed.
• The shrinking when run expansion and shrinking twice is off (ONE_WAY) and the first pass when run expansion and shrinking twice is on (TWO_WAY) differs from that of the second pass when TWO_WAY is enabled. 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.
• Expansion is identical for the first and second pass.
• In the ONE_WAY or first pass of the TWO_WAY, cells of NoData have the lowest priority. In the second pass of the TWO_WAY, 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(java.lang.Object inRaster, java.lang.Object outRaster)
Creates the Boundary Clean tool with the required parameters.

Method Summary

java.lang.Object	getInRaster() Returns the Input raster parameter of this tool .
java.lang.String	getNumberOfRuns() Returns the Run expansion and shrinking twice parameter of this tool .
java.lang.Object	getOutRaster() Returns the Output raster parameter of this tool .
java.lang.String	getSortType() Returns the Sorting technique parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setInRaster(java.lang.Object inRaster) Sets the Input raster parameter of this tool .
void	setNumberOfRuns(java.lang.String numberOfRuns) Sets the Run expansion and shrinking twice parameter of this tool .
void	setOutRaster(java.lang.Object outRaster) Sets the Output raster parameter of this tool .
void	setSortType(java.lang.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(java.lang.Object inRaster,
                     java.lang.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, input raster.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRaster

public java.lang.Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, input raster. This is a required parameter.

Returns:

the Input raster

setInRaster

public void setInRaster(java.lang.Object inRaster)

Sets the Input raster parameter of this tool . This parameter is Composite Geodataset, input raster. This is a required parameter.

Parameters:

inRaster - Composite Geodataset, input raster.

getOutRaster

public java.lang.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(java.lang.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 java.lang.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(java.lang.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.

• NO_SORT — Does no sorting by size. Zones with larger values have a higher priority to expand into zones with smaller values. This is the default.
• DESCEND — Sorts zones in descending order by size. Zones with larger total areas have a higher priority to expand into zones with smaller total areas.
• ASCEND — Sorts zones in ascending order by size. Zones with smaller total areas have a higher priority to expand into zones with larger total areas.

getNumberOfRuns

public java.lang.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(java.lang.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.

• TWO_WAY — Performs expansion and shrinking according to sorting type, then performs an additional shrinking and expansion with the priority reversed. This is the default.
• ONE_WAY — Performs expansion and shrinking once, according to sorting type.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias