com.esri.arcgis.spatialanalyst
Interface ILocalOp

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterLocalOp

public interface ILocalOp
extends Serializable

Provides access to members that control the local statistical 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

IGeoDataset	combine(IGeoDataset localData) Combines the Local GeoDatasets.
IGeoDataset	equalTo(IGeoDataset valueData, IGeoDataset localData) Calculates the local equal-to values between GeoDatasets.
IGeoDataset	greaterThan(IGeoDataset valueData, IGeoDataset localData) Calculates the local greater-than values between GeoDatasets.
IGeoDataset	highestPosition(IGeoDataset localData) Calculates the local highest position within GeoDatasets.
IGeoDataset	lessThan(IGeoDataset valueData, IGeoDataset localData) Calculates the local less-than values between GeoDatasets.
IGeoDataset	localStatistics(IGeoDataset localData, int type) Calculates the local statistics of the GeoDataset.
IGeoDataset	lowestPosition(IGeoDataset localData) Calculates the local lowest position within GeoDatasets.
IGeoDataset	popularity(IGeoDataset valueData, IGeoDataset localData) Calculates the local popularity between GeoDatasets.
IGeoDataset	rank(IGeoDataset valueData, IGeoDataset localData) Calculates the local rank between GeoDatasets.

Method Detail

localStatistics

IGeoDataset localStatistics(IGeoDataset localData,
                            int type)
                            throws IOException,
                                   AutomationException

Calculates the local statistics of the GeoDataset.

Remarks

LocalData

a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor that identifies the values for the local processing

type

an esriGeoAnalysisStatisticsEnum defining the local statistic to calculate for each location on the input Rasters 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.

• The method returns a reference to a Raster object.
• 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.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

type - A com.esri.arcgis.geoanalyst.esriGeoAnalysisStatisticsEnum 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.

equalTo

IGeoDataset equalTo(IGeoDataset valueData,
                    IGeoDataset localData)
                    throws IOException,
                           AutomationException

Calculates the local equal-to values between GeoDatasets.

Remarks

valueData	an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the values that will be used to determine the number of times that the value occurs in each Raster in the LocalData multiband Raster for each cell location
localData	a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the list of Rasters that is used to evaluate the number of occurrences the values in the list of Rasters are equal to the first argument (valueData) for each cell location

• The method returns a reference to a Raster object.
• 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.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

greaterThan

IGeoDataset greaterThan(IGeoDataset valueData,
                        IGeoDataset localData)
                        throws IOException,
                               AutomationException

Calculates the local greater-than values between GeoDatasets.

Remarks

valueDataset	an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the value that will be used to determine the number of times that values in the argument list, the localDataset, are greater than the specified input for each cell location
localDataset	a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the argument list that is used to evaluate the number of occurrences the values of the argument list are greater than in the valueDataset for each cell location

• The method returns a reference to a Raster object.
• 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.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

lessThan

IGeoDataset lessThan(IGeoDataset valueData,
                     IGeoDataset localData)
                     throws IOException,
                            AutomationException

Calculates the local less-than values between GeoDatasets.

Remarks

valueDataset	an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the value that will be used to determine the number of times that values in the argument list, the localDataset, are less than the specified input for each cell location
localDataset	a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the argument list that is used to evaluate the number of occurrences the values of the argument list are less than in the valueDataset for each cell location

• The method returns a reference to a Raster object.
• 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.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

popularity

IGeoDataset popularity(IGeoDataset valueData,
                       IGeoDataset localData)
                       throws IOException,
                              AutomationException

Calculates the local popularity between GeoDatasets.

Remarks

valueData	an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the popularity position of the specified inputs in the argument list defined by localData that will be returned
localData	a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the argument list that is used to evaluate the popularity of the values for each cell location

• The method returns a reference to a Raster object.
• 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.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

rank

IGeoDataset rank(IGeoDataset valueData,
                 IGeoDataset localData)
                 throws IOException,
                        AutomationException

Calculates the local rank between GeoDatasets.

Remarks

valueData	an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the position in the rank order of the specified inputs in the argument list defined by localData to derive the output value
localData	a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the argument list to identify the value for the rank, defined by the first argument for each cell location

• The method returns a reference to a Raster object.
• 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.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

lowestPosition

IGeoDataset lowestPosition(IGeoDataset localData)
                           throws IOException,
                                  AutomationException

Calculates the local lowest position within GeoDatasets.

Remarks

LocalData

a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor that identifies the values used in defining the argument list for the local processing

• The method returns a reference to a Raster object.
• 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.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

highestPosition

IGeoDataset highestPosition(IGeoDataset localData)
                            throws IOException,
                                   AutomationException

Calculates the local highest position within GeoDatasets.

Remarks

localData

a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the list of Rasters that is used to evaluate the position of the input Raster with the highest value for each cell within the analysis window

• The method returns a reference to a Raster object.
• 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.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

combine

IGeoDataset combine(IGeoDataset localData)
                    throws IOException,
                           AutomationException

Combines the Local GeoDatasets.

Remarks

LocalData

a multiband Raster, RasterDataset, RasterBand, or RasterDescriptor

• The method returns a reference to a Raster object.
• 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.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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