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.

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.
• The data type of the output raster for each of the geometry types will be floating point.
• 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

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 - 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.

outRaster - the output zonal geometry raster.

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.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output zonal geometry 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 zonal geometry raster. This is a required parameter.

Parameters:

outRaster - the output zonal geometry raster.

getGeometryType

public String getGeometryType()

Returns the Geometry type parameter of this tool . This parameter is 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 geometry type to be calculated. This is an optional parameter.

Parameters:

geometryType - geometry type to be calculated.

getCellSize

public Object getCellSize()

Returns the Output 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 Output cell size

setCellSize

public void setCellSize(Object cellSize)

Sets the Output 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:

cellSize - 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