com.esri.arcgis.spatialanalyst
Interface IZonalOp

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterZonalOp

public interface IZonalOp
extends Serializable

Provides access to members that control the zonal analysis operations.

Remarks

Read the Working with ArcGIS Spatial Analyst objects technical document for general information on implementing Spatial Analyst operations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Method Summary

ITable	tabulateArea(IGeoDataset zoneDataset, IGeoDataset classDataset) Calculates cross tabulated areas between two datasets.
IGeoDataset	zonalFill(IGeoDataset zoneDataset, IGeoDataset weightDataset) Fills zones using the minimum cell value from the 'weightRaster', along the zone boundary.
IGeoDataset	zonalGeometry(IGeoDataset zoneDataset, int type) Calculates for each zone of the input zone Dataset the specified geometry measure.
ITable	zonalGeometryAsTable(IGeoDataset geoDataset) Calculates all geometry characteristics for each zone in a table.
IGeoDataset	zonalStatistics(IGeoDataset zone, IGeoDataset value, int type, boolean ignoreNoData) Calculates in each output cell the statistic of the values of all cells in the value raster that belongs to the same zone.
ITable	zonalStatisticsAsTable(IGeoDataset zone, IGeoDataset value, boolean ignoreNoData) Calculates all statistics for each zone in a table.

Method Detail

zonalStatistics

IGeoDataset zonalStatistics(IGeoDataset zone,
                            IGeoDataset value,
                            int type,
                            boolean ignoreNoData)
                            throws IOException,
                                   AutomationException

Calculates in each output cell the statistic of the values of all cells in the value raster that belongs to the same zone.

Remarks

zone	an input Raster, RasterDataset, RasterBand, or RasterDescriptor or FeatureClass, FeatureClassDescriptor that identifies the zone for each cell location
value	an input integer or floating-point Raster, RasterDataset, RasterBand, or RasterDescriptor defining the values of the cells that are to be used in the zonal calculations
type	an esriGeoAnalysisStatisticsEnum defining the zonal statitistic to calculate within each zone The enumeration types are: esriGeoAnalysisStatsMajority for the majority value, esriGeoAnalysisStatsMaximum for the maximum value, esriGeoAnalysisStatsMean for the mean, esriGeoAnalysisStatsMedian for the median, esriGeoAnalysisStatsMinimum for the minimum value, esriGeoAnalysisStatsMinority for the minority value, esriGeoAnalysisStatsRange for the range of values, esriGeoAnalysisStatsStd for the standard deviation, esriGeoAnalysisStatsSum for the sum of the values, or esriGeoAnalysisStatsVariety for the variety of the values.
ignoreNoData	a Boolean defining the manner in which NoData values on the valueDataset that fall within a zone defined by the zoneDataset will influence the output results If True, then if a NoData value exists in a cell on the value Raster within any particular zone defined by zoneDataset, the cell will be ignored and only cells on the value Raster that have data values within the zone will be used in the processing for the output. If False, then if a NoData value exists on the value Raster within any particular zone defined by zoneDataset, there is insufficient information to complete the computation of the values for all of the cells within the zone, therefore, the entire zone will receive the NoData value on the output Raster and will not appear in the output table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:

zone - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

value - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

type - A com.esri.arcgis.geoanalyst.esriGeoAnalysisStatisticsEnum constant (in)

ignoreNoData - The ignoreNoData (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeoDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zonalStatisticsAsTable

ITable zonalStatisticsAsTable(IGeoDataset zone,
                              IGeoDataset value,
                              boolean ignoreNoData)
                              throws IOException,
                                     AutomationException

Calculates all statistics for each zone in a table.

Remarks

zone	an input Raster, RasterDataset, RasterBand, or RasterDescriptor or FeatureClass, FeatureClassDescriptor that identifies the zone for each cell location
value	an input integer or floating-point Raster, RasterDataset, RasterBand, or RasterDescriptor defining the values of the cells that are to be used in the zonal calculations
ignoreNoData	a Boolean defining the manner in which NoData values on the valueDataset that fall within a zone defined by the zoneDataset will influence the output results If True, then if a NoData value exists in a cell on the value Raster within any particular zone defined by zoneDataset, the cell will be ignored and only cells on the value Raster that have data values within the zone will be used in the processing for the output. If False, then if a NoData value exists on the value Raster within any particular zone defined by zoneDataset, there is insufficient information to complete the computation of the values for all of the cells within the zone, therefore, the entire zone will receive the NoData value on the output Raster and will not appear in the output table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:

zone - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

value - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

ignoreNoData - The ignoreNoData (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zonalGeometry

IGeoDataset zonalGeometry(IGeoDataset zoneDataset,
                          int type)
                          throws IOException,
                                 AutomationException

Calculates for each zone of the input zone Dataset the specified geometry measure.

Remarks

zoneDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor or FeatureClass, FeatureClassDescriptor that identifies the zone for each cell location

type

an esriGeoAnalysisZonalGeometryEnum that defines which zonal calculations will be performed on the zoneDataset The esriGeoAnalysisZonalGeometryEnums are: esriGeoAnalysisZonalGeometryArea for zonal area calculations. esriGeoAnalysisZonalGeometryCentroid for zone centroid calculations. esriGeoAnalysisZonalGeometryPerimeter for zonal perimeter calculations. esriGeoAnalysisZonalGeometryThickness for zonal thickness calculations. For complete information on the zonal calculations performed by each esriGeoAnalysisZonalGeometryEnum, refer to the individual command reference.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:

zoneDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

type - A com.esri.arcgis.spatialanalyst.esriGeoAnalysisZonalGeometryEnum constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeoDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zonalGeometryAsTable

ITable zonalGeometryAsTable(IGeoDataset geoDataset)
                            throws IOException,
                                   AutomationException

Calculates all geometry characteristics for each zone in a table.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor or FeatureClass, FeatureClassDescriptor that identifies zones

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:

geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zonalFill

IGeoDataset zonalFill(IGeoDataset zoneDataset,
                      IGeoDataset weightDataset)
                      throws IOException,
                             AutomationException

Fills zones using the minimum cell value from the 'weightRaster', along the zone boundary.

Remarks

zoneDataset	an input Raster, RasterDataset, RasterBand, or RasterDescriptor or FeatureClass, FeatureClassDescriptor defining the zones to be filled
weightDataset	an input Raster, RasterDataset, RasterBand, or RasterDescriptor whose values will be used to fill the zones

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:

zoneDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

weightDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeoDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

tabulateArea

ITable tabulateArea(IGeoDataset zoneDataset,
                    IGeoDataset classDataset)
                    throws IOException,
                           AutomationException

Calculates cross tabulated areas between two datasets.

Remarks

zoneDataset	an input Raster, RasterDataset, RasterBand, or RasterDescriptor or FeatureClass, FeatureClassDescriptor defining the zones to be filled The zones can be defined as an integer raster layer or a polygon feature layer.
classDataset	an input Raster, RasterDataset, RasterBand, or RasterDescriptor or FeatureClass, FeatureClassDescriptor that defines the classes that will have their area summarized within each zone

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:

zoneDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

classDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.