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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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.
Learn more about how Fill works

Software restrictions: none

Usage tips:


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 - Composite Geodataset, the input raster representing a continuous surface.
outSurfaceRaster - Raster Dataset, 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 Composite Geodataset, 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 Composite Geodataset, the input raster representing a continuous surface. This is a required parameter.

Parameters:
inSurfaceRaster - Composite Geodataset, the input raster representing a continuous surface.

getOutSurfaceRaster

public Object getOutSurfaceRaster()
Returns the Output surface raster parameter of this tool . This parameter is Raster Dataset, 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 Raster Dataset, the output surface raster after the sinks have been filled. This is a required parameter.

Parameters:
outSurfaceRaster - Raster Dataset, 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 Double, 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 Double, the default is to fill all sinks, regardless of depth. This is an optional parameter.

Parameters:
zLimit - Double, 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