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

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

All Implemented Interfaces:

GPTool

public class FocalStatistics
extends AbstractGPTool

Calculates for each input cell location a statistic of the values within a specified neighborhood around it. The Focal Statistics tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• If the input raster is of floating point type, only the Mean, Maximum, Minimum, Range, STD, and Sum statistics are available; the Majority, Minority, Median and Variety statistics are not permitted. If the input raster is of integer type, all the statistics types are available.
• The values on the output raster depend on the operation.
• When a circular, annulus-shaped, or wedge-shaped neighborhood is specified, and the center of the cell must be encompassed within the neighborhood, some of the outer diagonal cells may not be considered in the calculations. However, these cell locations will receive the resulting value from the calculations because they fall within the minimum-bounding rectangle (or the output neighborhood) of these circular neighborhood types.
• The Irregular and Weight Neighborhood types require a Kernel file be speciifed. Kernel files should have a ".txt" file extension.See the Irregular and Weight sections of for information on creating and using kernel files.
• Only for the statistics types of Mean, Standard Deviation, or Sum can the Neighborhood type can be set to Weight.

Field Summary

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

vals

Constructor Summary

FocalStatistics()
Creates the Focal Statistics tool with defaults.

FocalStatistics(Object inRaster, Object outRaster)
Creates the Focal Statistics tool with the required parameters.

Method Summary

String	getIgnoreNodata() Returns the Ignore NoData in calculations parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getNeighborhood() Returns the Neighborhood parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
String	getStatisticsType() Returns the Statistics type 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	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	setNeighborhood(Object neighborhood) Sets the Neighborhood parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setStatisticsType(String statisticsType) Sets the Statistics type 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

FocalStatistics

public FocalStatistics()

Creates the Focal Statistics tool with defaults.

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

FocalStatistics

public FocalStatistics(Object inRaster,
                       Object outRaster)

Creates the Focal Statistics 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 raster to perform the Focal Statistics calculations on.

outRaster - the output focal statistics raster.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the raster to perform the Focal Statistics calculations 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 the raster to perform the Focal Statistics calculations on. This is a required parameter.

Parameters:

inRaster - the raster to perform the Focal Statistics calculations on.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output focal statistics raster. 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 the output focal statistics raster. This is a required parameter.

Parameters:

outRaster - the output focal statistics raster.

getNeighborhood

public Object getNeighborhood()

Returns the Neighborhood parameter of this tool . This parameter is the Neighborhood class dictates the shape of the area around each cell used to calculate the statistic. the different types of neighborhood available are: NbrAnnulus, NbrCircle, NbrRectangle, NbrWedge, NbrIrregular, and NbrWeight. the following are the forms of the neighborhoods: the {CELL | MAP} parameter defines the distance units as either being Cell units or Map units. the default neighborhood is a square NbrRectangle with a width and height of 3 cells. This is an optional parameter.

Returns:

the Neighborhood

setNeighborhood

public void setNeighborhood(Object neighborhood)

Sets the Neighborhood parameter of this tool . This parameter is the Neighborhood class dictates the shape of the area around each cell used to calculate the statistic. the different types of neighborhood available are: NbrAnnulus, NbrCircle, NbrRectangle, NbrWedge, NbrIrregular, and NbrWeight. the following are the forms of the neighborhoods: the {CELL | MAP} parameter defines the distance units as either being Cell units or Map units. the default neighborhood is a square NbrRectangle with a width and height of 3 cells. This is an optional parameter.

Parameters:

neighborhood - the Neighborhood class dictates the shape of the area around each cell used to calculate the statistic. the different types of neighborhood available are: NbrAnnulus, NbrCircle, NbrRectangle, NbrWedge, NbrIrregular, and NbrWeight. the following are the forms of the neighborhoods: the {CELL | MAP} parameter defines the distance units as either being Cell units or Map units. the default neighborhood is a square NbrRectangle with a width and height of 3 cells.

getStatisticsType

public String getStatisticsType()

Returns the Statistics type parameter of this tool . This parameter is the statistic type to be calculated. the default statistic type is MEAN. This is an optional parameter.

Returns:

the Statistics type

setStatisticsType

public void setStatisticsType(String statisticsType)

Sets the Statistics type parameter of this tool . This parameter is the statistic type to be calculated. the default statistic type is MEAN. This is an optional parameter.

Parameters:

statisticsType - the statistic type to be calculated. the default statistic type is MEAN.

getIgnoreNodata

public String getIgnoreNodata()

Returns the Ignore NoData in calculations parameter of this tool . This parameter is denotes whether NoData values are ignored by the statistic 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 denotes whether NoData values are ignored by the statistic calculation. This is an optional parameter.

Parameters:

ignoreNodata - denotes whether NoData values are ignored by the statistic 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