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

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

All Implemented Interfaces:

GPTool

public class ZonalStatistics
extends AbstractGPTool

Calculates statistics on values of a raster within the zones of another dataset. The Zonal Statistics tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Zonal Statistics works

Software restrictions: none

Usage tips:

• Zones are defined as areas that have identical values. If the zone input is a raster, it must be integer. If the zone input is a feature class, the zone field must be integer. A character field is also acceptable.
• When the zone and value inputs are both rasters of the same resolution, they will be used directly. If the resolutions are different, an internal resampling is applied to make them match before the zonal operation is performed. Should there be any NoData cells in the inputs, the resampling may cause there to be larger areas of NoData in your output than you might have expected. To avoid this situation, either Resample; the coarser input rasters to the resolution of the finer input raster, or set the Cell Size of the Raster Analysis Environment; to Minimum Of Inputs.
• If the zone input is a raster dataset, it must have an attribute table. The attribute table is usually created automatically for integer rasters, but may not be under certain circumstances. You can use Build Raster Attribute Table; (BuildRAT) to create one.
• If the zone input is feature dataset, a vector-to-raster conversion will be internally applied to it. To ensure that the results of the conversion will align properly with the value raster, it is recommended that you check that the extent and snap raster are set appropriately in the environment settings and the raster settings. Since the internal raster must have an attribute table, an error will occur if one was not created in the conversion. If this happens, convert your feature dataset directly with Feature To Raster; or Polygon To Raster; ( Point To Raster; and Polyline To Raster; also), generate an attribute table for it as described in the previous tip, and use the resulting raster as your Zone input.
• If the zone input is a point feature dataset, it is possible to have more than one point contained within any particular cell of the value input raster. For such cells, the zone value is determined by the point with the highest feature ID.
• If the zone feature input has overlapping polygons, the zonal analysis will not be performed for each individual polygon. Since the feature input is converted to a raster, each location can only have one value. An alternative method is to process the zonal statistics iteratively for each of the polygon zones and collate the results.
• It is recommended to only use rasters as the zone input, as it offers you greater control over the vector-to-raster conversion. This will help ensure you consistently get the expected results.
• The input value raster can be either integer or floating point. However, when it is floating-point type, the zonal calculations for majority, median, minority, and variety will not be computed.
• For majority and minority calculations, when there is a tie the output for all cell locations in the zone is assigned the lowest of the tied values.
• The data type of the output is dependent on the zonal calculation being performed and the input value raster type. See how Zonal Statistics works; for more information.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

ZonalStatistics()
Creates the Zonal Statistics tool with defaults.

ZonalStatistics(Object inZoneData, Object zoneField, Object inValueRaster, Object outRaster)
Creates the Zonal Statistics tool with the required parameters.

Method Summary

String	getIgnoreNodata() Returns the Ignore NoData in calculations parameter of this tool .
Object	getInValueRaster() Returns the Input value raster parameter of this tool .
Object	getInZoneData() Returns the Input raster or feature zone data 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.
Object	getZoneField() Returns the Zone field parameter of this tool .
void	setIgnoreNodata(String ignoreNodata) Sets the Ignore NoData in calculations parameter of this tool .
void	setInValueRaster(Object inValueRaster) Sets the Input value raster parameter of this tool .
void	setInZoneData(Object inZoneData) Sets the Input raster or feature zone data 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 .
void	setZoneField(Object zoneField) Sets the Zone field 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

ZonalStatistics

public ZonalStatistics()

Creates the Zonal Statistics tool with defaults.

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

ZonalStatistics

public ZonalStatistics(Object inZoneData,
                       Object zoneField,
                       Object inValueRaster,
                       Object outRaster)

Creates the Zonal 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:

inZoneData - Composite Geodataset, it can be a raster or feature dataset.

zoneField - Field, field that holds the values that define each zone.

inValueRaster - Composite Geodataset, raster that contains the values on which to calculate a statistic.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInZoneData

public Object getInZoneData()

Returns the Input raster or feature zone data parameter of this tool . This parameter is Composite Geodataset, it can be a raster or feature dataset. This is a required parameter.

Returns:

the Input raster or feature zone data

setInZoneData

public void setInZoneData(Object inZoneData)

Sets the Input raster or feature zone data parameter of this tool . This parameter is Composite Geodataset, it can be a raster or feature dataset. This is a required parameter.

Parameters:

inZoneData - Composite Geodataset, it can be a raster or feature dataset.

getZoneField

public Object getZoneField()

Returns the Zone field parameter of this tool . This parameter is Field, field that holds the values that define each zone. This is a required parameter.

Returns:

the Zone field

setZoneField

public void setZoneField(Object zoneField)

Sets the Zone field parameter of this tool . This parameter is Field, field that holds the values that define each zone. This is a required parameter.

Parameters:

zoneField - Field, field that holds the values that define each zone.

getInValueRaster

public Object getInValueRaster()

Returns the Input value raster parameter of this tool . This parameter is Composite Geodataset, raster that contains the values on which to calculate a statistic. This is a required parameter.

Returns:

the Input value raster

setInValueRaster

public void setInValueRaster(Object inValueRaster)

Sets the Input value raster parameter of this tool . This parameter is Composite Geodataset, raster that contains the values on which to calculate a statistic. This is a required parameter.

Parameters:

inValueRaster - Composite Geodataset, raster that contains the values on which to calculate a statistic.

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.

getStatisticsType

public String getStatisticsType()

Returns the Statistics type parameter of this tool . This parameter is String, statistic type to be calculated. 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, statistic type to be calculated. This is an optional parameter.

Parameters:

statisticsType - String, statistic type to be calculated.

getIgnoreNodata

public String getIgnoreNodata()

Returns the Ignore NoData in calculations parameter of this tool . This parameter is String, denotes whether NoData values on the Value input will influence the results of the zone that they fall within. 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 on the Value input will influence the results of the zone that they fall within. This is an optional parameter.

Parameters:

ignoreNodata - String, denotes whether NoData values on the Value input will influence the results of the zone that they fall within.

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