com.esri.arcgis.spatialanalyst
Interface IHydrologyOp

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IHydrologyOpProxy, RasterHydrologyOp

public interface IHydrologyOp
extends java.io.Serializable

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

Description: 'Provides access to members that control the hydrological 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 IID768f40da_de80_11d3_9f8a_00c04f8ef00e
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IGeoDataset basin(IGeoDataset directionRaster)
          Creates a raster delineating all drainage basins.
 IGeoDataset fill(IGeoDataset surfaceRaster, java.lang.Object zLimit)
          Fills sinks in a surface to remove small imperfections in the data.
 IGeoDataset flowAccumulation(IGeoDataset directionRaster, java.lang.Object weightRaster)
          Creates a raster of accumulated flow to each cell.
 IGeoDataset flowDirection(IGeoDataset surfaceRaster, boolean createDrop, boolean forceFlowAtEdge)
          Creates a raster of flow direction from each cell to it's steepest downslope neighbor.
 IGeoDataset flowLength(IGeoDataset directionRaster, boolean downStream, java.lang.Object weightRaster)
          Calculates distance, or weighted distance along a flow path.
 IGeoDataset sink(IGeoDataset directionRaster)
          Creates a raster identifying all sinks, or areas of internal drainage.
 IGeoDataset snapPourPoint(IGeoDataset sourceDataset, IGeoDataset accumulationRaster, double snapDistance)
          Snaps selected pour points to the cell of highest flow accumulation within a specified distance.
 IGeoDataset streamLink(IGeoDataset streamRaster, IGeoDataset directionRaster)
          Assigns unique values to sections of a raster linear network between intersections.
 IGeoDataset streamOrder(IGeoDataset streamRaster, IGeoDataset directionRaster, int orderType)
          Assigns a numeric order to segments of a raster representing branches of a linear network.
 IGeoDataset streamToFeature(IGeoDataset streamRaster, IGeoDataset directionRaster, boolean performWeeding)
          Converts a raster representing a linear network to features representing the linear network.
 IGeoDataset watershed(IGeoDataset directionRaster, IGeoDataset sourceDataset)
          Determines the contributing area above a set of cells in a raster.
 

Field Detail

IID768f40da_de80_11d3_9f8a_00c04f8ef00e

static final int IID768f40da_de80_11d3_9f8a_00c04f8ef00e
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

basin

IGeoDataset basin(IGeoDataset directionRaster)
                  throws java.io.IOException,
                         AutomationException
Creates a raster delineating all drainage basins.

Parameters:
directionRaster - 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.

fill

IGeoDataset fill(IGeoDataset surfaceRaster,
                 java.lang.Object zLimit)
                 throws java.io.IOException,
                        AutomationException
Fills sinks in a surface to remove small imperfections in the data.

Parameters:
surfaceRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
zLimit - 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.

flowAccumulation

IGeoDataset flowAccumulation(IGeoDataset directionRaster,
                             java.lang.Object weightRaster)
                             throws java.io.IOException,
                                    AutomationException
Creates a raster of accumulated flow to each cell.

Parameters:
directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
weightRaster - 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.

flowDirection

IGeoDataset flowDirection(IGeoDataset surfaceRaster,
                          boolean createDrop,
                          boolean forceFlowAtEdge)
                          throws java.io.IOException,
                                 AutomationException
Creates a raster of flow direction from each cell to it's steepest downslope neighbor.

Parameters:
surfaceRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
createDrop - The createDrop (in)
forceFlowAtEdge - The forceFlowAtEdge (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.

flowLength

IGeoDataset flowLength(IGeoDataset directionRaster,
                       boolean downStream,
                       java.lang.Object weightRaster)
                       throws java.io.IOException,
                              AutomationException
Calculates distance, or weighted distance along a flow path.

Parameters:
directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
downStream - The downStream (in)
weightRaster - 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.

sink

IGeoDataset sink(IGeoDataset directionRaster)
                 throws java.io.IOException,
                        AutomationException
Creates a raster identifying all sinks, or areas of internal drainage.

Parameters:
directionRaster - 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.

snapPourPoint

IGeoDataset snapPourPoint(IGeoDataset sourceDataset,
                          IGeoDataset accumulationRaster,
                          double snapDistance)
                          throws java.io.IOException,
                                 AutomationException
Snaps selected pour points to the cell of highest flow accumulation within a specified distance.

Parameters:
sourceDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
accumulationRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
snapDistance - The snapDistance (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.

streamLink

IGeoDataset streamLink(IGeoDataset streamRaster,
                       IGeoDataset directionRaster)
                       throws java.io.IOException,
                              AutomationException
Assigns unique values to sections of a raster linear network between intersections.

Parameters:
streamRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
directionRaster - 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.

streamOrder

IGeoDataset streamOrder(IGeoDataset streamRaster,
                        IGeoDataset directionRaster,
                        int orderType)
                        throws java.io.IOException,
                               AutomationException
Assigns a numeric order to segments of a raster representing branches of a linear network.

Parameters:
streamRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
orderType - A com.esri.arcgis.spatialanalyst.esriGeoAnalysisStreamOrderEnum 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.

streamToFeature

IGeoDataset streamToFeature(IGeoDataset streamRaster,
                            IGeoDataset directionRaster,
                            boolean performWeeding)
                            throws java.io.IOException,
                                   AutomationException
Converts a raster representing a linear network to features representing the linear network.

Parameters:
streamRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
performWeeding - The performWeeding (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.

watershed

IGeoDataset watershed(IGeoDataset directionRaster,
                      IGeoDataset sourceDataset)
                      throws java.io.IOException,
                             AutomationException
Determines the contributing area above a set of cells in a raster.

Parameters:
directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
sourceDataset - 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.