com.esri.arcgis.geoanalyst
Class RasterSurfaceOp

java.lang.Object
  extended by com.esri.arcgis.geoanalyst.RasterSurfaceOp
All Implemented Interfaces:
IGeoAnalysisEnvironment, IRasterAnalysisEnvironment, ISurfaceOp, ISurfaceOp2, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class RasterSurfaceOp
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, ISurfaceOp, ISurfaceOp2, ISupportErrorInfo

Raster surface operation class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RasterSurfaceOp()
          Constructs a RasterSurfaceOp using ArcGIS Engine.
RasterSurfaceOp(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterSurfaceOp theRasterSurfaceOp = (RasterSurfaceOp) obj;
 
Method Summary
 IGeoDataset aspect(IGeoDataset geoDataset)
          Calculates Aspect.
 IGeoDataset contour(IGeoDataset geoDataset, double interval, Object base)
          Creates contours or isolines based off of a constant interval from a base contour.
 IGeoDataset contour(IGeoDataset geoDataset, double interval, Object base, Object zFactor)
          Creates contours or isolines based off of a constant interval from a base contour.
 void contourAsPolyline(IGeoDataset geoDataset, IPoint inputPoint, IPolyline[] contourLine, double[] elevation)
          Creates a single contour or isoline that passes through a specified point on a surface.
 IGeoDataset contourList(IGeoDataset geoDataset, Object contoursArray)
          Creates contours or isolines based off a list of contour values.
 void contoursAsPolylines(IGeoDataset geoDataset, IPointCollection inputPoints, IGeometryCollection[] contourLines, IPointCollection[] outputPointsWithElevations)
          Creates multiple contours or isolines that pass through specified points on a surface.
 IGeoDataset curvature(IGeoDataset geoDataset, boolean profile, boolean plan)
          Calculates curvature, optionally including profile and plan curvature.
 IGeoDataset curvature(IGeoDataset geoDataset, boolean profile, boolean plan, Object zFactor)
          Calculates curvature, optionally including profile and plan curvature.
 IGeoDataset cutFill(IGeoDataset beforeGeoDataset, IGeoDataset afterGeoDataset, Object zFactor)
          Calculates cut and fill areas.
 boolean equals(Object o)
          Compare this object with another
 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
 IGeoDataset hillShade(IGeoDataset geoDataset, double azimuth, double altitude, boolean inModelShadows, Object zFactor)
          Calculates Hillshade.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 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.
 IGeoDataset slope(IGeoDataset geoDataset, int slopeType, Object zFactor)
          Calculates Slope.
 IGeoDataset visibility(IGeoDataset geoDataset, IGeoDataset observers, int visType)
          Performs visibility analysis on a surface based on a set of input observation points.
 IGeoDataset visibility(IGeoDataset geoDataset, IGeoDataset observers, int visType, Object pZFactor, Object pRefractivityCoefficient)
          Performs visibility analysis on a surface based on a set of input observation points.
 
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

RasterSurfaceOp

public RasterSurfaceOp()
                throws IOException,
                       UnknownHostException
Constructs a RasterSurfaceOp using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RasterSurfaceOp

public RasterSurfaceOp(Object obj)
                throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterSurfaceOp theRasterSurfaceOp = (RasterSurfaceOp) obj;

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

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.

hillShade

public IGeoDataset hillShade(IGeoDataset geoDataset,
                             double azimuth,
                             double altitude,
                             boolean inModelShadows,
                             Object zFactor)
                      throws IOException,
                             AutomationException
Calculates Hillshade.

Remarks

geoDataset

the input Raster, RasterDataset, RasterBand, or RasterDescriptor from which the shaded relief is derived

azimuth

the azimuth angle of the light source. The azimuth is expressed in positive degrees from 0 to 360, measured clockwise from the north. A commonly used azimuth is 315 degrees

altitude

the slope or angle of the illumination source above the horizon. The slope is expressed in positive degrees, with 0 degrees at the horizon and 90 degrees directly overhead. A commonly used altitude is 45 degrees

inModelShadows

a Boolean specifying the type of shaded relief to be generated

If True, the output shaded relief Raster will consider both local illumination angles and shadows. The output Raster contains values ranging from 0 and 255, with 0 representing the areas in shadow, and 255 the brightest.

If False, the output shaded relief Raster only considers local illumination angles; the effects of shadows are not considered. The output grid contains values ranging from 0 and 255, with 0 representing the darkest areas and 255 the brightest.

[zFactor]

the geoDataset ZUnits are multiplied by the specified [zFactor] to adjust the output Raster ZUnits to another unit of measure. If no [zFactor] is specified, a [zFactor] of 1 is applied. Higher z values will result in a more exaggerated relief (surface) and thus in a more extreme shading

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
hillShade in interface ISurfaceOp
Specified by:
hillShade in interface ISurfaceOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
azimuth - The azimuth (in)
altitude - The altitude (in)
inModelShadows - The inModelShadows (in)
zFactor - 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.

slope

public IGeoDataset slope(IGeoDataset geoDataset,
                         int slopeType,
                         Object zFactor)
                  throws IOException,
                         AutomationException
Calculates Slope.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

slopeType

esriGeoAnalysisSlopeEnum specifying the units in which the value of slope will be expressed

esriGeoAnalysisSlopeDegree with this option the inclination of slope will be calculated in degrees

esriGeoAnalysisSlopePercentrise indicates to output the percent rise, also referred to as the percent slope

[zFactor]

the number of ground x, y Units in one surface ZUnit

The geoDataset ZUnits are multiplied by the specified zFactor to adjust the output Raster ZUnits to another unit of measure. If no zFactor is specified the value of the zFactor is 1. Higher z values will result in a more exaggerated relief (surface) and thus in a more extreme shading.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
slope in interface ISurfaceOp
Specified by:
slope in interface ISurfaceOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
slopeType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisSlopeEnum constant (in)
zFactor - 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.

aspect

public IGeoDataset aspect(IGeoDataset geoDataset)
                   throws IOException,
                          AutomationException
Calculates Aspect.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
aspect in interface ISurfaceOp
Specified by:
aspect in interface ISurfaceOp2
Parameters:
geoDataset - 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.

cutFill

public IGeoDataset cutFill(IGeoDataset beforeGeoDataset,
                           IGeoDataset afterGeoDataset,
                           Object zFactor)
                    throws IOException,
                           AutomationException
Calculates cut and fill areas.

Remarks

beforeGeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor. Represents the before (past) state of the study area.

afterGeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor. Represents the current or after state of the study area.

[zFactor]

the number of ground x, y Units in one surface ZUnit

The geoDataset ZUnits are multiplied by the specified zFactor to adjust the output Raster ZUnits to another unit of measure. If no zFactor is specified the value of the zFactor is 1. Higher z values will result in a more exaggerated relief (surface) and thus in a more extreme shading.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
cutFill in interface ISurfaceOp
Specified by:
cutFill in interface ISurfaceOp2
Parameters:
beforeGeoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
afterGeoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
zFactor - 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.

curvature

public IGeoDataset curvature(IGeoDataset geoDataset,
                             boolean profile,
                             boolean plan)
                      throws IOException,
                             AutomationException
Calculates curvature, optionally including profile and plan curvature.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor representing a continuous surface

profile

a Boolean that if True will create an output profile Raster

The profile Raster shows the rate of change of slope for each cell. This is the curvature of the surface in the direction of slope.

plan

The plan Raster shows the curvature of the surface perpendicular to the slope direction, referred to as the planform curvature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
curvature in interface ISurfaceOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
profile - The profile (in)
plan - The plan (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.

contour

public IGeoDataset contour(IGeoDataset geoDataset,
                           double interval,
                           Object base)
                    throws IOException,
                           AutomationException
Creates contours or isolines based off of a constant interval from a base contour.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor to be contoured

interval

the contour interval to be used. This can be any positive number

[base]

the value from which to begin generation of contours. Contours are generated above and below this value as needed to cover the entire value range of the geoData. If none is specified, then the contouring will begin at 0

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
contour in interface ISurfaceOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
interval - The interval (in)
base - 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.

contourList

public IGeoDataset contourList(IGeoDataset geoDataset,
                               Object contoursArray)
                        throws IOException,
                               AutomationException
Creates contours or isolines based off a list of contour values.

Remarks

GeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor to be contoured

contoursarray

the list of z values at which to generate contours

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
contourList in interface ISurfaceOp
Specified by:
contourList in interface ISurfaceOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
contoursArray - A Variant (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.

contoursAsPolylines

public void contoursAsPolylines(IGeoDataset geoDataset,
                                IPointCollection inputPoints,
                                IGeometryCollection[] contourLines,
                                IPointCollection[] outputPointsWithElevations)
                         throws IOException,
                                AutomationException
Creates multiple contours or isolines that pass through specified points on a surface.

Remarks

GeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor to be contoured

inputPoints

a input collection of points using IPointCollection which specifies where multiple contours or isolines will pass through.

contourLines

the output collection of polylines from IGeometryCollection representing multiple contour or isolines that identify the constant cell values of the input points.

outputPointsWithElevations

an output point collection which can be used to obtain the cell value (z attribute) of the (i)th point object that intersects with input GeoDataset thus describing the value of the (i)th output contour line

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
contoursAsPolylines in interface ISurfaceOp
Specified by:
contoursAsPolylines in interface ISurfaceOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
inputPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)
contourLines - A reference to a com.esri.arcgis.geometry.IGeometryCollection (out: use single element array)
outputPointsWithElevations - A reference to a com.esri.arcgis.geometry.IPointCollection (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

contourAsPolyline

public void contourAsPolyline(IGeoDataset geoDataset,
                              IPoint inputPoint,
                              IPolyline[] contourLine,
                              double[] elevation)
                       throws IOException,
                              AutomationException
Creates a single contour or isoline that passes through a specified point on a surface.

Remarks

GeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor to be contoured

inputPoint

an input point feature defined by a point object using IPoint interface which the resulting contour or isoline will pass through

contourLine

the output contour or isoline polyline object which represents the constant cell values of the input point.

elevation

an output double value which represents the cell value that the input point intersects with in the input GeoDataset. This value therefore can be used to describe the value of the output contour line

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
contourAsPolyline in interface ISurfaceOp
Specified by:
contourAsPolyline in interface ISurfaceOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
inputPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
contourLine - A reference to a com.esri.arcgis.geometry.IPolyline (out: use single element array)
elevation - The elevation (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

visibility

public IGeoDataset visibility(IGeoDataset geoDataset,
                              IGeoDataset observers,
                              int visType)
                       throws IOException,
                              AutomationException
Performs visibility analysis on a surface based on a set of input observation points.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor used to define the z values for visibility calculations and analysis

observers

input FeatureClass or FeatureClassDescriptor containing containing point or line features used as observation points

visType

an esriGeoAnalysisVisibilityEnum specifing the type of visibility analysis to be performed

esriGeoAnalysisVisibilityFrequency the output will only record the number of times each raster-cell location can be seen by the observation points

The observation frequency will be recorded in the Value item in the output Raster's value attribute table.

esriGeoAnalysisVisibilityObservers the output for each cell location will contain a binary-encoded value which can be decoded to identify the observation# of each observation point that can see each Raster cell

The encoded value will be recorded in the Value item in the output Raster's value attribute table. In addition to the standard items, Value and Count, in the value attribute table, a new item named OBSn will be created in the value attribute table for each observer n in the input point dataset. The OBSn item will be assigned a value of 1 if the cell can be seen by observer n, or a value of 0 if it cannot be seen.

esriGeoAnalysisVisibilityFrequencyUseCurvature the output will only record the number of times each raster-cell location can be seen by the observation points

The observation frequency will be recorded in the Value item in the output Raster's value attribute table. It also corrects for earth curvature and refraction.

esriGeoAnalysisVisibilityObserversUseCurvature the output for each cell location will contain a binary-encoded value which can be decoded to identify the observation# of each observation point that can see each Raster cell

The encoded value will be recorded in the Value item in the output Raster's value attribute table. In addition to the standard items, Value and Count, in the value attribute table, a new item named OBSn will be created in the value attribute table for each observer n in the input point dataset. The OBSn item will be assigned a value of 1 if the cell can be seen by observer n, or a value of 0 if it cannot be seen. It also corrects for earth curvature and refraction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
visibility in interface ISurfaceOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
observers - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
visType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisVisibilityEnum 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.

contour

public IGeoDataset contour(IGeoDataset geoDataset,
                           double interval,
                           Object base,
                           Object zFactor)
                    throws IOException,
                           AutomationException
Creates contours or isolines based off of a constant interval from a base contour.

Remarks

geoData

an input Raster, RasterDataset, RasterBand, or RasterDescriptor to be contoured

interval

the contour interval to be used. This can be any positive number

[base]

the value from which to begin generation of contours. Contours are generated above and below this value as needed to cover the entire value range of the geoData. If none is specified, then the contouring will begin at 0

[zFactor]

The number of ground x, y Units in one surface ZUnit

The geoDataset ZUnits are multiplied by the specified zFactor to adjust the output Raster ZUnits to another unit of measure. If no zFactor is specified the value of the zFactor is 1. Higher z values will result in a more exaggerated relief (surface) and thus in a more extreme shading.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
contour in interface ISurfaceOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
interval - The interval (in)
base - A Variant (in, optional, pass null if not required)
zFactor - 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.

curvature

public IGeoDataset curvature(IGeoDataset geoDataset,
                             boolean profile,
                             boolean plan,
                             Object zFactor)
                      throws IOException,
                             AutomationException
Calculates curvature, optionally including profile and plan curvature.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor representing a continuous surface

profile

a Boolean that if True will create an output profile Raster

The profile Raster shows the rate of change of slope for each cell. This is the curvature of the surface in the direction of slope.

plan

The plan Raster shows the curvature of the surface perpendicular to the slope direction, referred to as the planform curvature.

[zFactor]

The number of ground x, y Units in one surface ZUnit

The geoDataset ZUnits are multiplied by the specified zFactor to adjust the output Raster ZUnits to another unit of measure. If no zFactor is specified the value of the zFactor is 1. Higher z values will result in a more exaggerated relief (surface) and thus in a more extreme shading.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
curvature in interface ISurfaceOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
profile - The profile (in)
plan - The plan (in)
zFactor - 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.

visibility

public IGeoDataset visibility(IGeoDataset geoDataset,
                              IGeoDataset observers,
                              int visType,
                              Object pZFactor,
                              Object pRefractivityCoefficient)
                       throws IOException,
                              AutomationException
Performs visibility analysis on a surface based on a set of input observation points.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor used to define the z values for visibility calculations and analysis

observers

input FeatureClass or FeatureClassDescriptor containing containing point or line features used as observation points

visType

an esriGeoAnalysisVisibilityEnum specifing the type of visibility analysis to be performed

esriGeoAnalysisVisibilityFrequency the output will only record the number of times each raster-cell location can be seen by the observation points

The observation frequency will be recorded in the Value item in the output Raster's value attribute table.

esriGeoAnalysisVisibilityObservers the output for each cell location will contain a binary-encoded value which can be decoded to identify the observation# of each observation point that can see each Raster cell

The encoded value will be recorded in the Value item in the output Raster's value attribute table. In addition to the standard items, Value and Count, in the value attribute table, a new item named OBSn will be created in the value attribute table for each observer n in the input point dataset. The OBSn item will be assigned a value of 1 if the cell can be seen by observer n, or a value of 0 if it cannot be seen.

esriGeoAnalysisVisibilityFrequencyUseCurvature the output will only record the number of times each raster-cell location can be seen by the observation points

The observation frequency will be recorded in the Value item in the output Raster's value attribute table. It also corrects for earth curvature and refraction.

esriGeoAnalysisVisibilityObserversUseCurvature the output for each cell location will contain a binary-encoded value which can be decoded to identify the observation# of each observation point that can see each Raster cell

The encoded value will be recorded in the Value item in the output Raster's value attribute table. In addition to the standard items, Value and Count, in the value attribute table, a new item named OBSn will be created in the value attribute table for each observer n in the input point dataset. The OBSn item will be assigned a value of 1 if the cell can be seen by observer n, or a value of 0 if it cannot be seen. It also corrects for earth curvature and refraction.

[pZFactor]

The number of ground x, y units in one surface Zunit.

The geoDataset ZUnits are multiplied by the specified zFactor to adjust the output Raster ZUnits to another unit of measure. If no zFactor is specified the value of the zFactor is 1. Higher z values will result in a more exaggerated relief (surface) and thus in a more extreme shading.

[pRefractivityCoefficient]

Coefficient of the refraction of visible light in air. The default value is 0.13

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
visibility in interface ISurfaceOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
observers - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
visType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisVisibilityEnum constant (in)
pZFactor - A Variant (in, optional, pass null if not required)
pRefractivityCoefficient - 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.

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.