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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.BlockStatistics
All Implemented Interfaces:
GPTool

public class BlockStatistics
extends AbstractGPTool

Calculates statistics for a non-overlapping neighborhood. The Block Statistics tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Block Statistics works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
BlockStatistics()
          Creates the Block Statistics tool with defaults.
BlockStatistics(Object inRaster, Object outRaster)
          Creates the Block 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

BlockStatistics

public BlockStatistics()
Creates the Block Statistics tool with defaults.

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


BlockStatistics

public BlockStatistics(Object inRaster,
                       Object outRaster)
Creates the Block 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 - Composite Geodataset, the raster to perform the Block Statistics calculations 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 raster to perform the Block 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 Composite Geodataset, the raster to perform the Block Statistics calculations on. This is a required parameter.

Parameters:
inRaster - Composite Geodataset, the raster to perform the Block Statistics calculations 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.

getNeighborhood

public Object getNeighborhood()
Returns the Neighborhood parameter of this tool . This parameter is Neighborhood, the default neighborhood is a square RECTANGLE with a width and height of three 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 Neighborhood, the default neighborhood is a square RECTANGLE with a width and height of three cells. This is an optional parameter.

Parameters:
neighborhood - Neighborhood, the default neighborhood is a square RECTANGLE with a width and height of three cells.

getStatisticsType

public String getStatisticsType()
Returns the Statistics type parameter of this tool . This parameter is String, 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 String, the default statistic type is MEAN. This is an optional parameter.

Parameters:
statisticsType - String, the default statistic type is MEAN.

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 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 String, denotes whether NoData values are ignored by the statistic calculation. This is an optional parameter.

Parameters:
ignoreNodata - String, 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