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 a preset focal filter on a raster. The Filter tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Filter works

Software restrictions: none

Usage tips:

• The LOW filter option is an averaging 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.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

Filter()
Creates the Filter tool with defaults.

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

Method Summary

String	getFilterType() Returns the Filter type parameter of this tool .
String	getIgnoreNodata() Returns the Ignore NoData in calculations parameter of this tool .
Object	getInRaster() Returns the Input 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	setFilterType(String filterType) Sets the Filter type parameter of this tool .
void	setIgnoreNodata(String ignoreNodata) Sets the Ignore NoData in calculations parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input 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

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(Object inRaster,
              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 - Composite Geodataset, the input raster to perform the Filter operation on.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, the input raster to perform the Filter operation on. 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 Composite Geodataset, the input raster to perform the Filter operation on. This is a required parameter.

Parameters:

inRaster - Composite Geodataset, the input raster to perform the Filter operation on.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. 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 Raster Dataset, the raster to be created. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the raster to be created.

getFilterType

public String getFilterType()

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

Returns:

the Filter type

setFilterType

public void setFilterType(String filterType)

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

Parameters:

filterType - String, the type of Filter operation to perform.

getIgnoreNodata

public String getIgnoreNodata()

Returns the Ignore NoData in calculations parameter of this tool . This parameter is String, 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(String ignoreNodata)

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

Parameters:

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

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