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

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

All Implemented Interfaces:

GPTool

public class TabulateArea
extends AbstractGPTool

Calculates cross-tabulated areas between two datasets. The Tabulate Area tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

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 class 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.
• 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 a class raster input, it is recommended that you check that the extent and snap raster are set appropriately in the environment settings and the raster settings.
• If the class input is feature dataset, a vector-to-raster conversion will also be internally applied to it. The conditions listed in the previous tip for a feature zone input also apply to a feature class input.
• It is recommended to only use rasters as the zone and class inputs, as it offers you greater control over the vector-to-raster conversion. This will help ensure you consistently get the expected results.
• If a point or line dataset is used as the class data, the area intersected by those features will be reported.
• There will be a field in the output table for each unique value of the zone dataset.
• There will be a record in the output table for each unique value of the class dataset.
• Each record in the output table will store the area of each class within each zone.
• The output of the Tabulate Area tool is a table.
• See Working with Tabulate Area; for explanations of certain issues that may be encountered with this tool, and suggestions on how to work around them.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

TabulateArea()
Creates the Tabulate Area tool with defaults.

TabulateArea(Object inZoneData, Object zoneField, Object inClassData, Object classField, Object outTable)
Creates the Tabulate Area tool with the required parameters.

Method Summary

Object	getClassField() Returns the Class field parameter of this tool .
Object	getInClassData() Returns the Input raster or feature class data 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 .
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	setClassField(Object classField) Sets the Class field parameter of this tool .
void	setInClassData(Object inClassData) Sets the Input raster or feature class data 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

TabulateArea

public TabulateArea()

Creates the Tabulate Area tool with defaults.

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

TabulateArea

public TabulateArea(Object inZoneData,
                    Object zoneField,
                    Object inClassData,
                    Object classField,
                    Object outTable)

Creates the Tabulate Area 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 feature layer.

zoneField - Field, it can be an integer or a string field of the in_zone_data.

inClassData - Composite Geodataset, the class input can be an integer raster layer or a feature layer.

classField - Field, it can be an integer or a string field of the in_class_data.

outTable - Table, output table that will contain the summary of the area of each class in each zone.

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 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 feature layer. This is a required parameter.

Parameters:

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

getZoneField

public Object getZoneField()

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

Parameters:

zoneField - Field, it can be an integer or a string field of the in_zone_data.

getInClassData

public Object getInClassData()

Returns the Input raster or feature class data parameter of this tool . This parameter is Composite Geodataset, the class input can be an integer raster layer or a feature layer. This is a required parameter.

Returns:

the Input raster or feature class data

setInClassData

public void setInClassData(Object inClassData)

Sets the Input raster or feature class data parameter of this tool . This parameter is Composite Geodataset, the class input can be an integer raster layer or a feature layer. This is a required parameter.

Parameters:

inClassData - Composite Geodataset, the class input can be an integer raster layer or a feature layer.

getClassField

public Object getClassField()

Returns the Class field parameter of this tool . This parameter is Field, it can be an integer or a string field of the in_class_data. This is a required parameter.

Returns:

the Class field

setClassField

public void setClassField(Object classField)

Sets the Class field parameter of this tool . This parameter is Field, it can be an integer or a string field of the in_class_data. This is a required parameter.

Parameters:

classField - Field, it can be an integer or a string field of the in_class_data.

getOutTable

public Object getOutTable()

Returns the Output table parameter of this tool . This parameter is Table, output table that will contain the summary of the area of each class 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 Table, output table that will contain the summary of the area of each class in each zone. This is a required parameter.

Parameters:

outTable - Table, output table that will contain the summary of the area of each class in each zone.

getProcessingCellSize

public Object getProcessingCellSize()

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

setProcessingCellSize

public void setProcessingCellSize(Object processingCellSize)

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

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