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

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

All Implemented Interfaces:

GPTool

public class ZonalGeometry
extends AbstractGPTool

Calculates for each zone in a dataset the specified geometry measure (area, perimeter, thickness, or the characteristics of ellipse). The Zonal Geometry tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Zonal Geometry works

Software restrictions: none

Usage tips:

• Zones are created by identical integer values. If the input is a raster, it must be integer. If the input is a feature class, the zone field must be integer.
• If the zone dataset is a feature dataset, it is recommended that you ensure the extent and snap raster are set appropriately in the environment settings or raster settings. This will ensure that the results of the vector-to-raster conversion will align properly with the value raster.
• The data type of the output raster for each of the geometry types will be floating point.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

ZonalGeometry()
Creates the Zonal Geometry tool with defaults.

ZonalGeometry(Object inZoneData, Object zoneField, Object outRaster)
Creates the Zonal Geometry tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
String	getGeometryType() Returns the Geometry type 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	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	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setGeometryType(String geometryType) Sets the Geometry type 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	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

ZonalGeometry

public ZonalGeometry()

Creates the Zonal Geometry tool with defaults.

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

ZonalGeometry

public ZonalGeometry(Object inZoneData,
                     Object zoneField,
                     Object outRaster)

Creates the Zonal Geometry 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, the zones can be defined as an integer raster layer or a polygon feature layer.

zoneField - Field, this can be an integer or string field of in_zone_data.

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, the zones can be defined as an integer raster layer 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 Composite Geodataset, the zones can be defined as an integer raster layer or a polygon feature layer. This is a required parameter.

Parameters:

inZoneData - Composite Geodataset, the zones can be defined as an integer raster layer or a polygon feature layer.

getZoneField

public Object getZoneField()

Returns the Zone field parameter of this tool . This parameter is Field, this can be an integer or string field of in_zone_data. 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, this can be an integer or string field of in_zone_data. This is a required parameter.

Parameters:

zoneField - Field, this can be an integer or string field of in_zone_data.

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.

getGeometryType

public String getGeometryType()

Returns the Geometry type parameter of this tool . This parameter is String, geometry type to be calculated. This is an optional parameter.

Returns:

the Geometry type

setGeometryType

public void setGeometryType(String geometryType)

Sets the Geometry type parameter of this tool . This parameter is String, geometry type to be calculated. This is an optional parameter.

Parameters:

geometryType - String, geometry type to be calculated.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is Analysis cell size, this is the value in the environment if specifically set. If the environment is not set and in_zone_data is raster, the cell size is the same as in_zone_data. If the environment is not set and in_zone_data is feature, the cell size is the shorter of the width or height of the extent of in_zone_data in the output spatial reference, divided by 250. This is an optional parameter.

Returns:

the Output cell size

setCellSize

public void setCellSize(Object cellSize)

Sets the Output cell size parameter of this tool . This parameter is Analysis cell size, this is the value in the environment if specifically set. If the environment is not set and in_zone_data is raster, the cell size is the same as in_zone_data. If the environment is not set and in_zone_data is feature, the cell size is the shorter of the width or height of the extent of in_zone_data in the output spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - Analysis cell size, this is the value in the environment if specifically set. If the environment is not set and in_zone_data is raster, the cell size is the same as in_zone_data. If the environment is not set and in_zone_data is feature, the cell size is the shorter of the width or height of the extent of in_zone_data 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