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

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

All Implemented Interfaces:

GPTool

public class Shrink
extends AbstractGPTool

Shrinks the selected zones by a specified number of cells by replacing them with the value of the cell that is most frequent in its neighborhood. The Shrink tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The specified zone values are considered to be foreground zones, while the remaining zone values are considered to be background zones. With this tool, cells in the foreground zones are allowed to be replaced by cells in the background zones.
• When two adjacent regions are part of the selected set to shrink, there is no change at the boundary between them.
• NoData has the same priority as any valid value to invade areas vacated by shrinking selected values. Therefore, if a selected value is adjacent to NoData, it may become NoData after shrinking.

Field Summary

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

vals

Constructor Summary

Shrink()
Creates the Shrink tool with defaults.

Shrink(Object inRaster, Object outRaster, int numberCells, Object zoneValues)
Creates the Shrink tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
int	getNumberCells() Returns the Number of cells 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.
Object	getZoneValues() Returns the Zone values parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setNumberCells(int numberCells) Sets the Number of cells parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setZoneValues(Object zoneValues) Sets the Zone values 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

Shrink

public Shrink()

Creates the Shrink tool with defaults.

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

Shrink

public Shrink(Object inRaster,
              Object outRaster,
              int numberCells,
              Object zoneValues)

Creates the Shrink 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 identified zones are to be shrunk. it must be of integer type.

outRaster - the output generalized raster. the specified zones of the input raster will be shrunk by the specified number of cells.

numberCells - the number of cells by which to shrink each specified zone. the value must be an integer greater than 0.

zoneValues - the list of zone values to shrink. the zone values must be integers. They can be in any order.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster for which the identified zones are to be shrunk. 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 identified zones are to be shrunk. it must be of integer type. This is a required parameter.

Parameters:

inRaster - the input raster for which the identified zones are to be shrunk. 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 specified zones of the input raster will be shrunk by the specified number of cells. 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 specified zones of the input raster will be shrunk by the specified number of cells. This is a required parameter.

Parameters:

outRaster - the output generalized raster. the specified zones of the input raster will be shrunk by the specified number of cells.

getNumberCells

public int getNumberCells()

Returns the Number of cells parameter of this tool . This parameter is the number of cells by which to shrink each specified zone. the value must be an integer greater than 0. This is a required parameter.

Returns:

the Number of cells

setNumberCells

public void setNumberCells(int numberCells)

Sets the Number of cells parameter of this tool . This parameter is the number of cells by which to shrink each specified zone. the value must be an integer greater than 0. This is a required parameter.

Parameters:

numberCells - the number of cells by which to shrink each specified zone. the value must be an integer greater than 0.

getZoneValues

public Object getZoneValues()

Returns the Zone values parameter of this tool . This parameter is the list of zone values to shrink. the zone values must be integers. They can be in any order. This is a required parameter.

Returns:

the Zone values

setZoneValues

public void setZoneValues(Object zoneValues)

Sets the Zone values parameter of this tool . This parameter is the list of zone values to shrink. the zone values must be integers. They can be in any order. This is a required parameter.

Parameters:

zoneValues - the list of zone values to shrink. the zone values must be integers. They can be in any order.

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