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

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

All Implemented Interfaces:

GPTool

public class RegionGroup
extends AbstractGPTool

For each cell in the output, Regiongroup records the identity of the connected region to which that cell belongs. A unique number is assigned to each region. The Region Group tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• The input raster must be of integer type.
• The output raster will always be integer.
• The first region scanned (scan moves from left to right, top to bottom) receives the value one, the second two, and so forth, until all regions are assigned a value. The values assigned to the output zones are based on when they are encountered in the scanning process. You cannot control the scanning process.
• By default, the Add Link option is True. This will create an item called LINK in the attribute table of the output raster, which retains the original value for each cell from the input raster.
• The LINK field allows you to trace the parentage of each of the newly created regions for queries or analysis.
• Setting the Add Link option to False will significantly speed up processing. This is helpful when the original value of each region is no longer needed.
• If a mask has been set, those cells that have been masked will receive NoData on the output RegionGroup raster. With a mask, the spatial configuration and the number of regions may be altered on the output raster. If a region was continuous and the imposition of a mask breaks the continuity, the region will be divided into two regions with different values or grouping identifiers on the output raster. The mask can not only create additional regions by dividing a region into two or more separate regions, it can also reduce the number of regions on the output. If a mask totally covers or eliminates a potential region of connected cells, these cells will not be considered as a new zone on the output; they will receive NoData values.
• Region Group is especially useful when the analysis is on regions and not on zones. Since the input zone value is maintained, the original zonal class can also be used in the analysis.
• Cell locations that contain the excluded value receive zero on the output so that these zones are not confused with existing NoData cell locations. Since the Region Group begins numbering with the value one, the cells that are excluded from the regroup are considered background. These background cells can be reclassed or manipulated as any other value. The locations containing excluded values can easily be converted to NoData using the Con function.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

RegionGroup()
Creates the Region Group tool with defaults.

RegionGroup(Object inRaster, Object outRaster)
Creates the Region Group tool with the required parameters.

Method Summary

String	getAddLink() Returns the Add link field to output parameter of this tool .
int	getExcludedValue() Returns the Excluded value parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
String	getNumberNeighbors() Returns the Number of neighbors to use 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.
String	getZoneConnectivity() Returns the Zone grouping method parameter of this tool .
void	setAddLink(String addLink) Sets the Add link field to output parameter of this tool .
void	setExcludedValue(int excludedValue) Sets the Excluded value parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setNumberNeighbors(String numberNeighbors) Sets the Number of neighbors to use parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setZoneConnectivity(String zoneConnectivity) Sets the Zone grouping method 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

RegionGroup

public RegionGroup()

Creates the Region Group tool with defaults.

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

RegionGroup

public RegionGroup(Object inRaster,
                   Object outRaster)

Creates the Region Group 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, it must be of integer type.

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, 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 Composite Geodataset, it must be of integer type. This is a required parameter.

Parameters:

inRaster - Composite Geodataset, it must be of integer type.

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.

getNumberNeighbors

public String getNumberNeighbors()

Returns the Number of neighbors to use parameter of this tool . This parameter is String, the number of neighboring cells to use in evaluating connectivity between cells. This is an optional parameter.

Returns:

the Number of neighbors to use

setNumberNeighbors

public void setNumberNeighbors(String numberNeighbors)

Sets the Number of neighbors to use parameter of this tool . This parameter is String, the number of neighboring cells to use in evaluating connectivity between cells. This is an optional parameter.

Parameters:

numberNeighbors - String, the number of neighboring cells to use in evaluating connectivity between cells.

getZoneConnectivity

public String getZoneConnectivity()

Returns the Zone grouping method parameter of this tool . This parameter is String, defines which cell values should be considered when testing for connectivity. This is an optional parameter.

Returns:

the Zone grouping method

setZoneConnectivity

public void setZoneConnectivity(String zoneConnectivity)

Sets the Zone grouping method parameter of this tool . This parameter is String, defines which cell values should be considered when testing for connectivity. This is an optional parameter.

Parameters:

zoneConnectivity - String, defines which cell values should be considered when testing for connectivity.

getAddLink

public String getAddLink()

Returns the Add link field to output parameter of this tool . This parameter is String, specifies whether a link field is added to the table of the output. This is an optional parameter.

Returns:

the Add link field to output

setAddLink

public void setAddLink(String addLink)

Sets the Add link field to output parameter of this tool . This parameter is String, specifies whether a link field is added to the table of the output. This is an optional parameter.

Parameters:

addLink - String, specifies whether a link field is added to the table of the output.

getExcludedValue

public int getExcludedValue()

Returns the Excluded value parameter of this tool . This parameter is Long, cells with the excluded value will be treated as NoData and are eliminated from calculations. Cell locations that contain an excluded value will receive zero for the location on the output raster. The excluded value is similar to the concept of a background value or setting a mask for a single function on the Environment Settings/Raster Settings dialog box. It is particularly useful in conjunction with the CROSS keyword and must be specified if the CROSS keyword is specified. This is an optional parameter.

Returns:

the Excluded value

setExcludedValue

public void setExcludedValue(int excludedValue)

Sets the Excluded value parameter of this tool . This parameter is Long, cells with the excluded value will be treated as NoData and are eliminated from calculations. Cell locations that contain an excluded value will receive zero for the location on the output raster. The excluded value is similar to the concept of a background value or setting a mask for a single function on the Environment Settings/Raster Settings dialog box. It is particularly useful in conjunction with the CROSS keyword and must be specified if the CROSS keyword is specified. This is an optional parameter.

Parameters:

excludedValue - Long, cells with the excluded value will be treated as NoData and are eliminated from calculations. Cell locations that contain an excluded value will receive zero for the location on the output raster. The excluded value is similar to the concept of a background value or setting a mask for a single function on the Environment Settings/Raster Settings dialog box. It is particularly useful in conjunction with the CROSS keyword and must be specified if the CROSS keyword is specified.

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