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

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

public class ZonalStatisticsAsTable
extends AbstractGPTool

Summarizes the values of a raster within the zones of another dataset and reports the results to a table. The Zonal Statistics as Table 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
ZonalStatisticsAsTable()
          Creates the Zonal Statistics as Table tool with defaults.
ZonalStatisticsAsTable(Object inZoneData, Object zoneField, Object inValueRaster, Object outTable)
          Creates the Zonal Statistics as Table 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 getOutTable()
          Returns the Output table 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 setOutTable(Object outTable)
          Sets the Output table 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

ZonalStatisticsAsTable

public ZonalStatisticsAsTable()
Creates the Zonal Statistics as Table tool with defaults.

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


ZonalStatisticsAsTable

public ZonalStatisticsAsTable(Object inZoneData,
                              Object zoneField,
                              Object inValueRaster,
                              Object outTable)
Creates the Zonal Statistics as Table 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 - dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer.
zoneField - field that holds the values that define each zone. it can be an integer or a string field of the zone dataset.
inValueRaster - raster that contains the values on which to calculate a statistic.
outTable - output table that will contain the summary of the values in each zone.
Method Detail

getInZoneData

public Object getInZoneData()
Returns the Input raster or feature zone data parameter of this tool . This parameter is dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer. 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 dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer. This is a required parameter.

Parameters:
inZoneData - dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer.

getZoneField

public Object getZoneField()
Returns the Zone field parameter of this tool . This parameter is field that holds the values that define each zone. it can be an integer or a string field of the zone dataset. 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 that holds the values that define each zone. it can be an integer or a string field of the zone dataset. This is a required parameter.

Parameters:
zoneField - field that holds the values that define each zone. it can be an integer or a string field of the zone dataset.

getInValueRaster

public Object getInValueRaster()
Returns the Input value raster parameter of this tool . This parameter is 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 raster that contains the values on which to calculate a statistic. This is a required parameter.

Parameters:
inValueRaster - raster that contains the values on which to calculate a statistic.

getOutTable

public Object getOutTable()
Returns the Output table parameter of this tool . This parameter is output table that will contain the summary of the values in each zone. This is a required parameter.

Returns:
the Output table

setOutTable

public void setOutTable(Object outTable)
Sets the Output table parameter of this tool . This parameter is output table that will contain the summary of the values in each zone. This is a required parameter.

Parameters:
outTable - output table that will contain the summary of the values in each zone.

getIgnoreNodata

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

Parameters:
ignoreNodata - denotes whether NoData values in 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