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

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

All Implemented Interfaces:

GPTool

public class MajorityFilter
extends AbstractGPTool

Replaces cells in a raster based on the majority of their contiguous neighboring cells. The Majority Filter tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The Majority Filter tool must satisfy two criteria before a replacement can occur: the number of neighboring cells of a similar value must be large enough (either by being the majority of, or half of, all the cells), and those cells must be contiguous about the center of the filter kernel. The second criteria concerning the spatial connectivity of the cells minimizes the corruption of cellular spatial patterns.
• The use of FOUR for the number of neighbors will retain the corners of rectangular regions. The use of EIGHT will smooth the corners of rectangular regions.
• Contiguous is defined as sharing an edge for a kernel of EIGHT and sharing a corner for a kernel of FOUR.
• If the replacement threshold HALF is specified and two values occur as equal halves, a replacement will not occur if the value of the processing cell is the same as one of the halves. HALF allows more extensive filtering than MAJORITY.
• While the contiguity criterion is the same for edge and corner raster cells, they obey different MAJORITY and HALF rules. Using a kernel of FOUR, an edge or corner cell always requires two matching neighbors before replacement will occur. With a kernel of EIGHT, a corner cell must have all neighbors of the same value before it is changed, while an edge cell requires three contiguous neighbors, including one along the edge, before any change will occur.
• The output raster will be stabilized (will no longer change) after a few runs of Majority Filter.

Field Summary

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

vals

Constructor Summary

MajorityFilter()
Creates the Majority Filter tool with defaults.

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

Method Summary

java.lang.Object	getInRaster() Returns the Input raster parameter of this tool .
java.lang.String	getMajorityDefinition() Returns the Replacement threshold parameter of this tool .
java.lang.String	getNumberNeighbors() Returns the Number of neighbors to use 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	setInRaster(java.lang.Object inRaster) Sets the Input raster parameter of this tool .
void	setMajorityDefinition(java.lang.String majorityDefinition) Sets the Replacement threshold parameter of this tool .
void	setNumberNeighbors(java.lang.String numberNeighbors) Sets the Number of neighbors to use 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

MajorityFilter

public MajorityFilter()

Creates the Majority Filter tool with defaults.

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

MajorityFilter

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

Creates the Majority 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 to be filtered based on the the majority of contiguous neighboring cells. it must be of integer type.

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 to be filtered based on the the majority of contiguous neighboring cells. it must be of integer type. 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 to be filtered based on the the majority of contiguous neighboring cells. it must be of integer type. This is a required parameter.

Parameters:

inRaster - the input raster to be filtered based on the the majority of contiguous neighboring cells. it must be of integer type.

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.

getNumberNeighbors

public java.lang.String getNumberNeighbors()

Returns the Number of neighbors to use parameter of this tool . This parameter is determines the number of neighboring cells to use in the kernel of the filter. This is an optional parameter.

Returns:

the Number of neighbors to use

setNumberNeighbors

public void setNumberNeighbors(java.lang.String numberNeighbors)

Sets the Number of neighbors to use parameter of this tool . This parameter is determines the number of neighboring cells to use in the kernel of the filter. This is an optional parameter.

Parameters:

numberNeighbors - determines the number of neighboring cells to use in the kernel of the filter.

getMajorityDefinition

public java.lang.String getMajorityDefinition()

Returns the Replacement threshold parameter of this tool . This parameter is specifies the number of contiguous (spatially connected) cells that must be of the same value before a replacement will occur. This is an optional parameter.

Returns:

the Replacement threshold

setMajorityDefinition

public void setMajorityDefinition(java.lang.String majorityDefinition)

Sets the Replacement threshold parameter of this tool . This parameter is specifies the number of contiguous (spatially connected) cells that must be of the same value before a replacement will occur. This is an optional parameter.

Parameters:

majorityDefinition - specifies the number of contiguous (spatially connected) cells that must be of the same value before a replacement will occur.

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