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

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

All Implemented Interfaces:

GPTool

public class ZonalFill
extends AbstractGPTool

Fills zones using the minimum cell value from a weight raster along the zone boundary. The Zonal Fill tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Zonal Fill can be used to fill sinks to the minimum elevation of their watershed boundary. This is a step in determining the depth of sinks before filling to create a depressionless digital elevation model (DEM).
• The input zone raster can be integer or floating point. Note that this is an exception to the other zonal tools, which require the zone input raster to be integer type.
• The data type of the output is the same as that of the input weight raster. If the values on the weight raster are floating point, the resultant output raster will be floating point. If the weight raster is integer, the output will be integer.

Field Summary

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

vals

Constructor Summary

ZonalFill()
Creates the Zonal Fill tool with defaults.

ZonalFill(Object inZoneRaster, Object inWeightRaster, Object outRaster)
Creates the Zonal Fill tool with the required parameters.

Method Summary

Object	getInWeightRaster() Returns the Input weight raster parameter of this tool .
Object	getInZoneRaster() Returns the Input zone raster 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.
void	setInWeightRaster(Object inWeightRaster) Sets the Input weight raster parameter of this tool .
void	setInZoneRaster(Object inZoneRaster) Sets the Input zone raster parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster 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

ZonalFill

public ZonalFill()

Creates the Zonal Fill tool with defaults.

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

ZonalFill

public ZonalFill(Object inZoneRaster,
                 Object inWeightRaster,
                 Object outRaster)

Creates the Zonal Fill 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:

inZoneRaster - the input raster that defines the zones to be filled.

inWeightRaster - weight to be assigned to each zone.

outRaster - the output raster for which the zones have been filled.

Method Detail

getInZoneRaster

public Object getInZoneRaster()

Returns the Input zone raster parameter of this tool . This parameter is the input raster that defines the zones to be filled. This is a required parameter.

Returns:

the Input zone raster

setInZoneRaster

public void setInZoneRaster(Object inZoneRaster)

Sets the Input zone raster parameter of this tool . This parameter is the input raster that defines the zones to be filled. This is a required parameter.

Parameters:

inZoneRaster - the input raster that defines the zones to be filled.

getInWeightRaster

public Object getInWeightRaster()

Returns the Input weight raster parameter of this tool . This parameter is weight to be assigned to each zone. This is a required parameter.

Returns:

the Input weight raster

setInWeightRaster

public void setInWeightRaster(Object inWeightRaster)

Sets the Input weight raster parameter of this tool . This parameter is weight to be assigned to each zone. This is a required parameter.

Parameters:

inWeightRaster - weight to be assigned to each zone.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster for which the zones have been filled. 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 raster for which the zones have been filled. This is a required parameter.

Parameters:

outRaster - the output raster for which the zones have been filled.

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