com.esri.arcgis.spatialanalyst
Interface IDistanceOp

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IDistanceOpProxy, RasterDistanceOp

public interface IDistanceOp
extends java.io.Serializable

COM Interface 'IDistanceOp'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSpatialAnalyst.olb'

Description: 'Provides access to members that control the distance operations.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID4606f16d_b47d_11d2_9f3b_00c04f8ed1d7
static int	xxDummy Deprecated. Internal use only

Method Summary

IGeoDataset	corridor(IGeoDataset distance1, IGeoDataset distance2) Calculates for each cell location the sum of the accumulative costs for two input accumulative-cost datasets.
IGeoDataset	costAllocation(IGeoDataset sourceData, IGeoDataset costRaster, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each output cell the zone that could be reached with the least accumulative cost.
IGeoDataset	costBackLink(IGeoDataset sourceData, IGeoDataset costRaster, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates the neighbor that is the next cell on the least-accumulative-cost path from a cell to a source cell.
IGeoDataset	costDistance(IGeoDataset sourceData, IGeoDataset costRaster, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell the least-accumulative-cost distance over a cost surface to a source cell or a set of source cells.
IGeoDataset	costDistanceFull(IGeoDataset sourceData, IGeoDataset costRaster, boolean distance, boolean backlink, boolean allocation, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell the least-accumulative-cost distance, backlink, and allocation over a cost surface to a source cell or a set of source cells.
IGeoDataset	costPath(IGeoDataset fromData, IGeoDataset distance, IGeoDataset backlink, int pathType) Calculates the least-cost path(s) from selected cell(s) in the input data to the closest source cell.
IGeometryCollection	costPathAsPolyline(IPointCollection sourcePoints, IGeoDataset distance, IGeoDataset backlink) Calculates the least-cost path(s) from selected points in the input data and returns it as a polyline.
IGeoDataset	eucAllocation(IGeoDataset sourceData, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell the zone of the closest source cell (in Euclidean distance).
IGeoDataset	eucDirection(IGeoDataset sourceData, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates the direction in degrees from each cell center to the cell center of the closest source.
IGeoDataset	eucDistance(IGeoDataset sourceData, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell the Euclidean distance to the closest source.
IGeoDataset	eucDistanceFull(IGeoDataset sourceData, boolean distance, boolean direction, boolean allocation, java.lang.Object maxDistance, java.lang.Object valueRaster) Calculates for each cell optionally the Euclidean distance, direction, and allocation to the closest source.

Field Detail

IID4606f16d_b47d_11d2_9f3b_00c04f8ed1d7

static final int IID4606f16d_b47d_11d2_9f3b_00c04f8ed1d7

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

eucDistance

IGeoDataset eucDistance(IGeoDataset sourceData,
                        java.lang.Object maxDistance,
                        java.lang.Object valueRaster)
                        throws java.io.IOException,
                               AutomationException

Calculates for each cell the Euclidean distance to the closest source.

Parameters:

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

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

eucDistanceFull

IGeoDataset eucDistanceFull(IGeoDataset sourceData,
                            boolean distance,
                            boolean direction,
                            boolean allocation,
                            java.lang.Object maxDistance,
                            java.lang.Object valueRaster)
                            throws java.io.IOException,
                                   AutomationException

Calculates for each cell optionally the Euclidean distance, direction, and allocation to the closest source.

Parameters:

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

distance - The distance (in)

direction - The direction (in)

allocation - The allocation (in)

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

eucAllocation

IGeoDataset eucAllocation(IGeoDataset sourceData,
                          java.lang.Object maxDistance,
                          java.lang.Object valueRaster)
                          throws java.io.IOException,
                                 AutomationException

Calculates for each cell the zone of the closest source cell (in Euclidean distance).

Parameters:

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

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

eucDirection

IGeoDataset eucDirection(IGeoDataset sourceData,
                         java.lang.Object maxDistance,
                         java.lang.Object valueRaster)
                         throws java.io.IOException,
                                AutomationException

Calculates the direction in degrees from each cell center to the cell center of the closest source.

Parameters:

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

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

costDistance

IGeoDataset costDistance(IGeoDataset sourceData,
                         IGeoDataset costRaster,
                         java.lang.Object maxDistance,
                         java.lang.Object valueRaster)
                         throws java.io.IOException,
                                AutomationException

Calculates for each cell the least-accumulative-cost distance over a cost surface to a source cell or a set of source cells.

Parameters:

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

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

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

costAllocation

IGeoDataset costAllocation(IGeoDataset sourceData,
                           IGeoDataset costRaster,
                           java.lang.Object maxDistance,
                           java.lang.Object valueRaster)
                           throws java.io.IOException,
                                  AutomationException

Calculates for each output cell the zone that could be reached with the least accumulative cost.

Parameters:

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

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

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

costBackLink

IGeoDataset costBackLink(IGeoDataset sourceData,
                         IGeoDataset costRaster,
                         java.lang.Object maxDistance,
                         java.lang.Object valueRaster)
                         throws java.io.IOException,
                                AutomationException

Calculates the neighbor that is the next cell on the least-accumulative-cost path from a cell to a source cell.

Parameters:

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

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

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

costDistanceFull

IGeoDataset costDistanceFull(IGeoDataset sourceData,
                             IGeoDataset costRaster,
                             boolean distance,
                             boolean backlink,
                             boolean allocation,
                             java.lang.Object maxDistance,
                             java.lang.Object valueRaster)
                             throws java.io.IOException,
                                    AutomationException

Calculates for each cell the least-accumulative-cost distance, backlink, and allocation over a cost surface to a source cell or a set of source cells.

Parameters:

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

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

distance - The distance (in)

backlink - The backlink (in)

allocation - The allocation (in)

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

corridor

IGeoDataset corridor(IGeoDataset distance1,
                     IGeoDataset distance2)
                     throws java.io.IOException,
                            AutomationException

Calculates for each cell location the sum of the accumulative costs for two input accumulative-cost datasets.

Parameters:

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

costPath

IGeoDataset costPath(IGeoDataset fromData,
                     IGeoDataset distance,
                     IGeoDataset backlink,
                     int pathType)
                     throws java.io.IOException,
                            AutomationException

Calculates the least-cost path(s) from selected cell(s) in the input data to the closest source cell.

Parameters:

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

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

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

pathType - A com.esri.arcgis.spatialanalyst.esriGeoAnalysisPathEnum constant (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

costPathAsPolyline

IGeometryCollection costPathAsPolyline(IPointCollection sourcePoints,
                                       IGeoDataset distance,
                                       IGeoDataset backlink)
                                       throws java.io.IOException,
                                              AutomationException

Calculates the least-cost path(s) from selected points in the input data and returns it as a polyline.

Parameters:

sourcePoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

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

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.