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

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

All Implemented Interfaces:

GPTool

public class ZonalGeometryAsTable
extends AbstractGPTool

Calculates for each zone in a dataset the geometry measures (area, perimeter, thickness, and the characteristics of ellipse) and reports the results as a table. The Zonal Geometry as Table tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• A zone is defined as all areas in the input that have the same value. The areas do not have to be contiguous. Both raster and feature datasets can be used for the zone input.
• If the input zone data is a feature dataset, a cell size must be set in either the dialog box or the environment.
• The calculations for each zone are recorded in the output table.
• In the output table, the value field always precedes the fields containing the zonal output calculations. The value field contains the values of the zones defined by the zone dataset.
• The values for the zonal calculations will be floating point.
• Other than the ORIENTATION item, all the results in the output table are presented in map units. The ORIENTATION item values are in degrees, with a possible range of 0 to 180. The ORIENTATION is defined as an angle between the x-axis and the major axis of the ellipse. The values of the orientation angle increase counterclockwise, starting at 0 in the east (horizontal, to the right) and going through 90 when the major axis is vertical.
• If a particular zone consists of only one cell or if the zone is a single square block of cells, the orientation of the ellipse (in this case a circle) is set to 90 degrees.

Field Summary

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

vals

Constructor Summary

ZonalGeometryAsTable()
Creates the Zonal Geometry as Table tool with defaults.

ZonalGeometryAsTable(Object inZoneData, Object zoneField, Object outTable)
Creates the Zonal Geometry as Table tool with the required parameters.

Method Summary

Object	getInZoneData() Returns the Input raster or feature zone data parameter of this tool .
Object	getOutTable() Returns the Output table parameter of this tool .
Object	getProcessingCellSize() Returns the Processing cell size 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	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	setProcessingCellSize(Object processingCellSize) Sets the Processing cell size 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

ZonalGeometryAsTable

public ZonalGeometryAsTable()

Creates the Zonal Geometry as Table tool with defaults.

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

ZonalGeometryAsTable

public ZonalGeometryAsTable(Object inZoneData,
                            Object zoneField,
                            Object outTable)

Creates the Zonal Geometry 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.

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.

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.

getProcessingCellSize

public Object getProcessingCellSize()

Returns the Processing cell size parameter of this tool . This parameter is the processing cell size for the zonal operation. this is the value in the environment if specifically set. If the environment is not set, the default for the cell size is determined by the type of the zone data as follows: This is an optional parameter.

Returns:

the Processing cell size

setProcessingCellSize

public void setProcessingCellSize(Object processingCellSize)

Sets the Processing cell size parameter of this tool . This parameter is the processing cell size for the zonal operation. this is the value in the environment if specifically set. If the environment is not set, the default for the cell size is determined by the type of the zone data as follows: This is an optional parameter.

Parameters:

processingCellSize - the processing cell size for the zonal operation. this is the value in the environment if specifically set. If the environment is not set, the default for the cell size is determined by the type of the zone data as follows:

• If the zone dataset is a raster, the cell size is the same as the zone raster.
• If zone dataset is feature, the cell size is the shorter of the width or height of the extent of zone feature dataset in the output spatial reference, divided by 250.

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