com.esri.arcgis.spatialanalyst
Class RasterNeighborhoodOp

java.lang.Object
  com.esri.arcgis.spatialanalyst.RasterNeighborhoodOp

All Implemented Interfaces:

IGeoAnalysisEnvironment, IRasterAnalysisEnvironment, com.esri.arcgis.interop.RemoteObjRef, INeighborhoodOp, ISupportErrorInfo, Serializable

public class RasterNeighborhoodOp
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, INeighborhoodOp, ISupportErrorInfo

A mechanism for performing neighbourhood operations on rasters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RasterNeighborhoodOp()
Constructs a RasterNeighborhoodOp using ArcGIS Engine.

RasterNeighborhoodOp(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterNeighborhoodOp theRasterNeighborhoodOp = (RasterNeighborhoodOp) obj;

Method Summary

IGeoDataset	blockStatistics(IGeoDataset geoDataset, int type, IRasterNeighborhood nbrhood, boolean ignoreNoData) Calculates statistics for a non-overlapping neighborhood.
boolean	equals(Object o) Compare this object with another
IGeoDataset	filter(IGeoDataset geoDataset, int type, boolean ignoreNoData) Performs a preset focal filter on the input.
IGeoDataset	focalFlow(IGeoDataset geoDataset, Object thresholdValue) Calculates the flow of the values in the surface within each cells immediate neighborhood.
IGeoDataset	focalStatistics(IGeoDataset geoDataset, int type, IRasterNeighborhood nbrhood, boolean ignoreNoData) Calculates statistics for an overlapping neighborhood.
void	getCellSize(int[] envType, double[] cellSize) Gets the type and value of cell size in the RasterAnalysis.
static String	getClsid() getClsid.
String	getDefaultOutputRasterPrefix() The default output raster prefix.
String	getDefaultOutputVectorPrefix() The default output vector prefix.
void	getExtent(int[] envType, IEnvelope[] extent) Gets the type and values of extent in the RasterAnalysis.
IGeoDataset	getMask() Mask allows processing to occur only for a selected set of cells.
ISpatialReference	getOutSpatialReference() The output spatial reference of GeoAnalysis.
IWorkspace	getOutWorkspace() The output workspace of GeoAnalysis.
int	getVerifyType() The verify type of the RasterAnalysis.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
IGeoDataset	lineStatistics(IGeoDataset lineDataset, int type, double radius) Calculates a statistic on the attributes of lines in a circular neighborhood around each output cell.
IGeoDataset	pointStatistics(IGeoDataset pointDataset, int type, IRasterNeighborhood nbrhood) Calculates a statistic on the points in a neighborhood around each output cell.
void	reset() Remove all previously stored default rasteranalysis environments.
void	restoreToPreviousDefaultEnvironment() Restores to the previous default raster analysis environment.
void	setAsNewDefaultEnvironment() Sets the raster analysis environment of the object as new default environment.
void	setCellSize(int envType, Object cellSizeProvider) Sets the type and value of cell size in the RasterAnalysis.
void	setDefaultOutputRasterPrefix(String rasterPrefix) The default output raster prefix.
void	setDefaultOutputVectorPrefix(String vectorPrefix) The default output vector prefix.
void	setExtent(int envType, Object extentProvider, Object snapRasterData) Sets the type and values of extent in the RasterAnalysis.
void	setMaskByRef(IGeoDataset mask) Mask allows processing to occur only for a selected set of cells.
void	setOutSpatialReferenceByRef(ISpatialReference spatialReference) The output spatial reference of GeoAnalysis.
void	setOutWorkspaceByRef(IWorkspace workspace) The output workspace of GeoAnalysis.
void	setVerifyType(int verifyType) The verify type of the RasterAnalysis.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RasterNeighborhoodOp

public RasterNeighborhoodOp()
                     throws IOException,
                            UnknownHostException

Constructs a RasterNeighborhoodOp using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterNeighborhoodOp

public RasterNeighborhoodOp(Object obj)
                     throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterNeighborhoodOp theRasterNeighborhoodOp = (RasterNeighborhoodOp) obj;

Construct a RasterNeighborhoodOp using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterNeighborhoodOp.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setCellSize

public void setCellSize(int envType,
                        Object cellSizeProvider)
                 throws IOException,
                        AutomationException

Sets the type and value of cell size in the RasterAnalysis.

Remarks

envType

An enumeration type specifying the raster cellsize environment settings for analysis. All subsequent results will be to the value specified. It can be of type esriRasterEnvMaxOf – The largest cell size of all input raster datasets that are specifed in the function. This is the default. This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead. esriRasterEnvMinOf - Smallest cell size of all input raster datasets. This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead esriRasterEnvValue - Any user specified value for the cell size. Use this option to specify a particular value for a cell size or for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only input.

[cellSizeProvider]

A specified value (double) or RasterDataset that is used to provide the cellsize environment value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCellSize in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)

cellSizeProvider - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSize

public void getCellSize(int[] envType,
                        double[] cellSize)
                 throws IOException,
                        AutomationException

Gets the type and value of cell size in the RasterAnalysis.

Remarks

envType	will return an enumeration type constant specifying the raster cellsize environment settings for analysis. It can be of type esriRasterEnvMaxOf - largest cell size of all input datasets. This is the default. esriRasterEnvMinOf - smallest cell size of all input datasets esriRasterEnvValue - User specified value.
cellsize	returns a value that specifying the current environment setting for cellsize

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCellSize in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)

cellSize - The cellSize (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(int envType,
                      Object extentProvider,
                      Object snapRasterData)
               throws IOException,
                      AutomationException

Sets the type and values of extent in the RasterAnalysis.

Remarks

envType	An enumeration type specifying the raster extent environment settings for analysis. All subsequent results will be to this extent. It can be of type esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default. esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used. esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.
[extentProvider]	An envelope object supporting IEnvelope interface or RasterDataset that is used to provide the environment values of the analysis extent.
[snapRasterData]	A RasterDataset that can be used to snap all output raster datasets to the cell registration of the specified raster. All subsequent results will share the lower-left corner and cell size of the specified raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExtent in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)

extentProvider - A Variant (in, optional, pass null if not required)

snapRasterData - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public void getExtent(int[] envType,
                      IEnvelope[] extent)
               throws IOException,
                      AutomationException

Gets the type and values of extent in the RasterAnalysis.

Remarks

envType

will return an enumeration constant specifying the raster extent environment settings for analysis. It can be of type, esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default. esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used. esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.

extent

An envelope object supporting IEnvelope interface used to describe the values of the analysis extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaskByRef

public void setMaskByRef(IGeoDataset mask)
                  throws IOException,
                         AutomationException

Mask allows processing to occur only for a selected set of cells.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaskByRef in interface IRasterAnalysisEnvironment

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMask

public IGeoDataset getMask()
                    throws IOException,
                           AutomationException

Mask allows processing to occur only for a selected set of cells.

Remarks

The mask can be a reference to a Raster, RasterDataset, RasterBand, or RasterDescriptor object or FeatureClass, FeatureClassDescriptor object.

The mask identifies only those cells within the analysis extent that will be considered when performing an action. Only the identified cells will be processed in subsequent output raster datasets. All other cells are characterized as nodata.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMask in interface IRasterAnalysisEnvironment

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.

setVerifyType

public void setVerifyType(int verifyType)
                   throws IOException,
                          AutomationException

The verify type of the RasterAnalysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVerifyType in interface IRasterAnalysisEnvironment

Parameters:

verifyType - A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerifyType

public int getVerifyType()
                  throws IOException,
                         AutomationException

The verify type of the RasterAnalysis.

Remarks

The value is an enumeration environment setting that contols the way that an output RasterDatasets are written to file when during analysis. The verify enumeration can be of type

esriRasterEnvVerifyOn - specifies that the user will be prompted to verify the output already exists and it is okay to overwrite it

esriRasterEnvVerifyOff - specifies that output data will be automatically overwritten if already exists. This is the default environment setting.

esriRasterEnvVerifyError - specifies that an error will be produced when the output already exists.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getVerifyType in interface IRasterAnalysisEnvironment

Returns:

A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputRasterPrefix

public String getDefaultOutputRasterPrefix()
                                    throws IOException,
                                           AutomationException

The default output raster prefix.

Remarks

The user specified prefix which is included to all temporary output RasterDatasets during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Returns:

The rasterPrefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputRasterPrefix

public void setDefaultOutputRasterPrefix(String rasterPrefix)
                                  throws IOException,
                                         AutomationException

The default output raster prefix.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Parameters:

rasterPrefix - The rasterPrefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputVectorPrefix

public String getDefaultOutputVectorPrefix()
                                    throws IOException,
                                           AutomationException

The default output vector prefix.

Remarks

The user specified prefix which is included to all temporary output Shapefiles during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Returns:

The vectorPrefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputVectorPrefix

public void setDefaultOutputVectorPrefix(String vectorPrefix)
                                  throws IOException,
                                         AutomationException

The default output vector prefix.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Parameters:

vectorPrefix - The vectorPrefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsNewDefaultEnvironment

public void setAsNewDefaultEnvironment()
                                throws IOException,
                                       AutomationException

Sets the raster analysis environment of the object as new default environment.

Remarks

Will set all current environment settings of the RasterAnalysis object as the new default environment. All subsequent analysis will use the set object properties unless otherwise specified.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAsNewDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreToPreviousDefaultEnvironment

public void restoreToPreviousDefaultEnvironment()
                                         throws IOException,
                                                AutomationException

Restores to the previous default raster analysis environment.

Remarks

This will restore the default environment to the settings of the "previous" RasterAnalysisEnvironment object used to set the default environement. Note: If multiple default environments have been set it will reference the past settings one at a time in order of sequence.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

restoreToPreviousDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Remove all previously stored default rasteranalysis environments.

Remarks

This method can be used to restore the system default raster environment settings for extent, cell size, precision, spatial reference and/or current workspace for analysis. This will change all previously altered environment settings made to the RasterAnlaysis object back to the original settings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IRasterAnalysisEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutWorkspaceByRef

public void setOutWorkspaceByRef(IWorkspace workspace)
                          throws IOException,
                                 AutomationException

The output workspace of GeoAnalysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutWorkspaceByRef in interface IGeoAnalysisEnvironment

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutWorkspace

public IWorkspace getOutWorkspace()
                           throws IOException,
                                  AutomationException

The output workspace of GeoAnalysis.

Remarks

The variable is an object specifying the directory or subdirectory to contain the output rasterdataset

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutWorkspace in interface IGeoAnalysisEnvironment

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutSpatialReferenceByRef

public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
                                 throws IOException,
                                        AutomationException

The output spatial reference of GeoAnalysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironment

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutSpatialReference

public ISpatialReference getOutSpatialReference()
                                         throws IOException,
                                                AutomationException

The output spatial reference of GeoAnalysis.

Remarks

The variable references an object that specifies the output features spatial reference. If not explicitly set the spatial reference of the input features will be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutSpatialReference in interface IGeoAnalysisEnvironment

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

blockStatistics

public IGeoDataset blockStatistics(IGeoDataset geoDataset,
                                   int type,
                                   IRasterNeighborhood nbrhood,
                                   boolean ignoreNoData)
                            throws IOException,
                                   AutomationException

Calculates statistics for a non-overlapping neighborhood.

Remarks

geoDataset	an input integer or floating-point Raster, RasterDataset, RasterBand, or RasterDescriptor that identifies the values of the cells in a specified neighborhood If no neighborhood is specified, the default neighborhood is a 3-x 3-rectangle.
type	an esriGeoAnalysisStatisticsEnum defining the block statitistic to calculate within each block 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.
nbrhood	an IRasterNeighborhood defining the configuration of the blocks within which the block statistics will be calculated INeighborhood::BlockStatistics supports any neighborhood supported by IRasterNeighborhood. They include a rectangle, circle, annulus, wedge, and an irregular shaped neighborhood. The block will be defined by the minimum-bounding rectangle of the specified neighborhood. The minimum-bounding rectangle will include more cells then the specified neighborhood in certain cases such as with a circle, annulus, and wedge.
ignoreNoData	a Boolean defining the manner in which NoData values within a neighborhood will influence the output results If True, then if a NoData value exists within a neighborhood, then the NoData value will be ignored. Only cells within the neighborhood that have data values will be used in determining the statistics of the values. If False, then if any cell in a neighborhood has a value of NoData, then the output for each cell in the corresponding block will receive NoData. When the Boolean is False, the presence of a NoData value implies that there is insufficient information to determine the statistics of the values of the neighborhood.

• 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

Specified by:

blockStatistics in interface INeighborhoodOp

Parameters:

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

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

nbrhood - A reference to a com.esri.arcgis.geoanalyst.IRasterNeighborhood (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.

filter

public IGeoDataset filter(IGeoDataset geoDataset,
                          int type,
                          boolean ignoreNoData)
                   throws IOException,
                          AutomationException

Performs a preset focal filter on the input.

Remarks

geoDataset	the input Raster, RasterDataset, RasterBand, or RasterDescriptor
Type	the esriGeoAnalysisFilterEnum constant whose value represents the filter type to perform. It can be of type esriGeoAnalysisFilter3x3LowPass - Traverses a low-pass filter over the raster. This option smoothes the entire input and reduces the significance of anomalous cells. This is the default option. estiGeoAnalysisFilter3x3HighPass - Traverses a high-pass filter over the raster. This option enhances the edges of subdued features in a raster.
ignoreNoDatat	a Boolean specifying where NODATA values are ignored by the filter calculation If TRUE, when a NoData value exists within the filter, then the NoData value will be ignored. Only cells within the filter that have data values will be used in determining the output. If FALSE, when a NoData value exists within the filter, then the output for the processing cell will be NoData.

• 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

Specified by:

filter in interface INeighborhoodOp

Parameters:

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

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

focalStatistics

public IGeoDataset focalStatistics(IGeoDataset geoDataset,
                                   int type,
                                   IRasterNeighborhood nbrhood,
                                   boolean ignoreNoData)
                            throws IOException,
                                   AutomationException

Calculates statistics for an overlapping neighborhood.

Remarks

geoDataset	an input Raster, RasterDataset, RasterBand, or RasterDescriptor that identifies the values of the focal or processing cell and the values of the cells in its specified neighborhood
type	an esriGeoAnalysisStatisticsEnum defining the focal statistic to calculate within each neighborhood The enumeration types are: esriGeoAnalysisStatsMajority Majority esriGeoAnalysisStatsMaximum Maximum esriGeoAnalysisStatsMean Mean esriGeoAnalysisStatsMedian Median esriGeoAnalysisStatsMinimum Minimum esriGeoAnalysisStatsMinority Minority esriGeoAnalysisStatsRange Range esriGeoAnalysisStatsStd Standard Deviation EsriGeoAnalysisStatsSum Sum esriGeoAnalysisStatsVariety Variety
nbrhood	an RasterNeighborhood defining the configuration of the neighborhoods within which the focal statistics will be calculated INeighborhoodOp::FocalStatistics supports any neighborhood supported by IRasterNeighborhood. They include a rectangle, circle, annulus, wedge, and an irregular shaped neighborhood. The neighborhood will be defined by the minimum-bounding rectangle of the specified neighborhood. The minimum-bounding rectangle will include more cells than the specified neighborhood in certain cases such as with a circle, annulus, and wedge.
ignoreNoData	a Boolean defining the manner in which NoData values within a neighborhood will influence the output results If True, then if a NoData value exists within the neighborhood of the processing cell, then the NoData value will be ignored. Only cells within the neighborhood that have data values will be used in determining the statistic. If False, then if any cell in a neighborhood has a value of NoData, then the output for the processing cell of the neighborhood will be NoData. When False, the presence of a NoData value implies that there is insufficient information to determine the statistic of the values of the neighborhood.

• 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

Specified by:

focalStatistics in interface INeighborhoodOp

Parameters:

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

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

nbrhood - A reference to a com.esri.arcgis.geoanalyst.IRasterNeighborhood (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.

focalFlow

public IGeoDataset focalFlow(IGeoDataset geoDataset,
                             Object thresholdValue)
                      throws IOException,
                             AutomationException

Calculates the flow of the values in the surface within each cells immediate neighborhood.

Remarks

geoDataset	an input integer or floating-point grid that identifies the values of the focal or processing cell and the values of the cells in its specified neighborhood INeighborhood::FocalFlow evaluates the eight immediate neighbors of a cell to determine flow.
[thresholdValue]	defines a value that constitutes the threshold, which must be equalled or exceeded before flow can occur If the difference between the value at a neighboring cell location and the value of the processing cell is less than or equal to the threshold value, the output will be ‘0’ (or no flow). The data type for thresholdValue can be either integer or floating point.

• 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

Specified by:

focalFlow in interface INeighborhoodOp

Parameters:

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

thresholdValue - A Variant (in, optional, pass null if not required)

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.

pointStatistics

public IGeoDataset pointStatistics(IGeoDataset pointDataset,
                                   int type,
                                   IRasterNeighborhood nbrhood)
                            throws IOException,
                                   AutomationException

Calculates a statistic on the points in a neighborhood around each output cell.

Remarks

pointDataset	input FeatureClass or FeatureClassDescriptor containing point features
type	an esriGeoAnalysisStatisticsEnum to determine which statistic will be calculated on the values of points in the neighborhood of each output Raster cell 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.
nbrhood	an IRasterNeighborhood defining the configuration of the neighborhoods within which the point statistics will be calculated INeighborhood::PointStatistics supports any neighborhood supported by IRasterNeighborhood. They include a rectangle, circle, annulus, wedge, and an irregular shaped neighborhood. The neighborhood will be defined by the minimum-bounding rectangle of the specified neighborhood. The minimum-bounding rectangle will include more cells then the specified neighborhood in certain cases such as with a circle, annulus, and wedge.

• 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

Specified by:

pointStatistics in interface INeighborhoodOp

Parameters:

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

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

nbrhood - A reference to a com.esri.arcgis.geoanalyst.IRasterNeighborhood (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.

lineStatistics

public IGeoDataset lineStatistics(IGeoDataset lineDataset,
                                  int type,
                                  double radius)
                           throws IOException,
                                  AutomationException

Calculates a statistic on the attributes of lines in a circular neighborhood around each output cell.

Remarks

lineDataset	input FeatureClass or FeatureClassDescriptor containing line features
type	an esriGeoAnalysisStatisticsEnum indicating which statistic will be calculated for all lines in the neighborhood 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.
radius	the radius of the circular neighborhood around each output grid cell, expressed in map units A commonly used radius is 5 times the output cell size.

• 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

Specified by:

lineStatistics in interface INeighborhoodOp

Parameters:

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

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

radius - The radius (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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.