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

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

All Implemented Interfaces:

GPTool

public class Filter
extends AbstractGPTool

Performs either a smoothing (Low pass) or edge-enhancing (High pass) filter on a raster. The Filter tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The LOW filter option is an averaging (smoothing) filter. The HIGH filter option is an edge-enhancement filter.
• All input raster cells with NoData value are assigned NoData value in the output raster.

Field Summary

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

vals

Constructor Summary

Filter()
Creates the Filter tool with defaults.

Filter(java.lang.Object inRaster, java.lang.Object outRaster)
Creates the Filter tool with the required parameters.

Method Summary

java.lang.String	getFilterType() Returns the Filter type parameter of this tool .
java.lang.String	getIgnoreNodata() Returns the Ignore NoData in calculations parameter of this tool .
java.lang.Object	getInRaster() Returns the Input raster parameter of this tool .
java.lang.Object	getOutRaster() Returns the Output raster parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setFilterType(java.lang.String filterType) Sets the Filter type parameter of this tool .
void	setIgnoreNodata(java.lang.String ignoreNodata) Sets the Ignore NoData in calculations parameter of this tool .
void	setInRaster(java.lang.Object inRaster) Sets the Input raster parameter of this tool .
void	setOutRaster(java.lang.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

Filter

public Filter()

Creates the Filter tool with defaults.

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

Filter

public Filter(java.lang.Object inRaster,
              java.lang.Object outRaster)

Creates the Filter 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 on which to perform the filter operation.

outRaster - the output filtered raster.

Method Detail

getInRaster

public java.lang.Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster on which to perform the filter operation. This is a required parameter.

Returns:

the Input raster

setInRaster

public void setInRaster(java.lang.Object inRaster)

Sets the Input raster parameter of this tool . This parameter is the input raster on which to perform the filter operation. This is a required parameter.

Parameters:

inRaster - the input raster on which to perform the filter operation.

getOutRaster

public java.lang.Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output filtered raster. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(java.lang.Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output filtered raster. This is a required parameter.

Parameters:

outRaster - the output filtered raster.

getFilterType

public java.lang.String getFilterType()

Returns the Filter type parameter of this tool . This parameter is the type of filter operation to perform. This is an optional parameter.

Returns:

the Filter type

setFilterType

public void setFilterType(java.lang.String filterType)

Sets the Filter type parameter of this tool . This parameter is the type of filter operation to perform. This is an optional parameter.

Parameters:

filterType - the type of filter operation to perform.

getIgnoreNodata

public java.lang.String getIgnoreNodata()

Returns the Ignore NoData in calculations parameter of this tool . This parameter is denotes whether NoData values are ignored by the filter calculation. This is an optional parameter.

Returns:

the Ignore NoData in calculations

setIgnoreNodata

public void setIgnoreNodata(java.lang.String ignoreNodata)

Sets the Ignore NoData in calculations parameter of this tool . This parameter is denotes whether NoData values are ignored by the filter calculation. This is an optional parameter.

Parameters:

ignoreNodata - denotes whether NoData values are ignored by the filter calculation.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias