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

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

All Implemented Interfaces:

GPTool

public class Fill
extends AbstractGPTool

Fills sinks in a surface raster to remove small imperfections in the data. The Fill tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• A sink is a cell with an undefined drainage direction; no cells surrounding it are lower. The pour point is the boundary cell with the lowest elevation for the contributing area of a sink. If the sink were filled with water, this is the point where water would pour out.
• The z-limit specifies the maximum depth of a sink that will be filled. The z-limit is not the maximum depth to which a sink will be filled. Z-limit must be greater than zero.
• All sinks that are less than the z-limit, lower than their lowest adjacent neighbor, will be filled to the height of their pour points.
• Due to the iterative nature of Fill, it can be CPU and disk intensive. It can require up to four times the disk space of the input raster.
• The number of sinks found with the z-limit will determine the length of processing time. The more sinks, the longer the processing time.
• The tool can be used to find the number of sinks and help identify their depth. Knowing the depth of the sinks can help in determining an appropriate z-limit for Fill.
• Fill can also be used to remove peaks. A peak is a cell where no adjacent cells are higher. To remove peaks, the input surface raster must be inverted. This can be performed with the tool. Specify the highest value of the surface raster as the first input to Minus and surface raster as the second input. Perform a Fill. Invert the results to obtain a surface that has original surface raster values with the peaks removed. The z-limit can be applied to this process as well. If nothing is specified for z-limit, then all peaks will be removed. If it is specified, where the difference in z-value between a peak and its highest adjacent neighbor is greater than the z-limit, that peak will not be removed.

Field Summary

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

vals

Constructor Summary

Fill()
Creates the Fill tool with defaults.

Fill(Object inSurfaceRaster, Object outSurfaceRaster)
Creates the Fill tool with the required parameters.

Method Summary

Object	getInSurfaceRaster() Returns the Input surface raster parameter of this tool .
Object	getOutSurfaceRaster() Returns the Output surface 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.
double	getZLimit() Returns the Z limit parameter of this tool .
void	setInSurfaceRaster(Object inSurfaceRaster) Sets the Input surface raster parameter of this tool .
void	setOutSurfaceRaster(Object outSurfaceRaster) Sets the Output surface raster parameter of this tool .
void	setZLimit(double zLimit) Sets the Z limit 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

Fill

public Fill()

Creates the Fill tool with defaults.

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

Fill

public Fill(Object inSurfaceRaster,
            Object outSurfaceRaster)

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

inSurfaceRaster - the input raster representing a continuous surface.

outSurfaceRaster - the output surface raster after the sinks have been filled.

Method Detail

getInSurfaceRaster

public Object getInSurfaceRaster()

Returns the Input surface raster parameter of this tool . This parameter is the input raster representing a continuous surface. This is a required parameter.

Returns:

the Input surface raster

setInSurfaceRaster

public void setInSurfaceRaster(Object inSurfaceRaster)

Sets the Input surface raster parameter of this tool . This parameter is the input raster representing a continuous surface. This is a required parameter.

Parameters:

inSurfaceRaster - the input raster representing a continuous surface.

getOutSurfaceRaster

public Object getOutSurfaceRaster()

Returns the Output surface raster parameter of this tool . This parameter is the output surface raster after the sinks have been filled. This is a required parameter.

Returns:

the Output surface raster

setOutSurfaceRaster

public void setOutSurfaceRaster(Object outSurfaceRaster)

Sets the Output surface raster parameter of this tool . This parameter is the output surface raster after the sinks have been filled. This is a required parameter.

Parameters:

outSurfaceRaster - the output surface raster after the sinks have been filled.

getZLimit

public double getZLimit()

Returns the Z limit parameter of this tool . This parameter is maximum elevation difference between a sink and its pour point to be filled. if the difference in z-values between a sink and its pour point is greater than the z_limit that sink will not be filled. the default is to fill all sinks, regardless of depth. This is an optional parameter.

Returns:

the Z limit

setZLimit

public void setZLimit(double zLimit)

Sets the Z limit parameter of this tool . This parameter is maximum elevation difference between a sink and its pour point to be filled. if the difference in z-values between a sink and its pour point is greater than the z_limit that sink will not be filled. the default is to fill all sinks, regardless of depth. This is an optional parameter.

Parameters:

zLimit - maximum elevation difference between a sink and its pour point to be filled. if the difference in z-values between a sink and its pour point is greater than the z_limit that sink will not be filled. the default is to fill all sinks, regardless of depth.

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