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

Partitions the input into non-overlapping blocks and calculates the statistic of the values within each block. The value is assigned to all of the cells in each block in the output. The Block Statistics tool is contained in the Spatial Analyst Tools tool box.

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 - the raster on which to perform the Block Statistics calculations.
outRaster - the output block statistics raster.
Method Detail

getInRaster

public Object getInRaster()
Returns the Input raster parameter of this tool . This parameter is the raster on which to perform the Block Statistics calculations. 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 on which to perform the Block Statistics calculations. This is a required parameter.

Parameters:
inRaster - the raster on which to perform the Block Statistics calculations.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is the output block 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 block statistics raster. This is a required parameter.

Parameters:
outRaster - the output block 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