|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ISurfaceOp
Provides access to members that control the Surface Operation.
| 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. |
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 |
cutFill(IGeoDataset beforeGeoDataset,
IGeoDataset afterGeoDataset,
Object zFactor)
Calculates cut and fill areas. |
IGeoDataset |
hillShade(IGeoDataset geoDataset,
double azimuth,
double altitude,
boolean inModelShadows,
Object zFactor)
Calculates Hillshade. |
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. |
| Method Detail |
|---|
IGeoDataset hillShade(IGeoDataset geoDataset,
double azimuth,
double altitude,
boolean inModelShadows,
Object zFactor)
throws IOException,
AutomationException
|
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 |
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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGeoDataset slope(IGeoDataset geoDataset,
int slopeType,
Object zFactor)
throws IOException,
AutomationException
|
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. |
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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGeoDataset aspect(IGeoDataset geoDataset)
throws IOException,
AutomationException
|
geoDataset |
an input Raster, RasterDataset, RasterBand, or RasterDescriptor |
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGeoDataset cutFill(IGeoDataset beforeGeoDataset,
IGeoDataset afterGeoDataset,
Object zFactor)
throws IOException,
AutomationException
|
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. |
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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGeoDataset curvature(IGeoDataset geoDataset,
boolean profile,
boolean plan)
throws IOException,
AutomationException
|
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. |
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)profile - The profile (in)plan - The plan (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGeoDataset contour(IGeoDataset geoDataset,
double interval,
Object base)
throws IOException,
AutomationException
|
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 |
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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGeoDataset contourList(IGeoDataset geoDataset,
Object contoursArray)
throws IOException,
AutomationException
|
GeoDataset |
an input Raster, RasterDataset, RasterBand, or RasterDescriptor to be contoured |
|
contoursarray |
the list of z values at which to generate contours |
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)contoursArray - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void contoursAsPolylines(IGeoDataset geoDataset,
IPointCollection inputPoints,
IGeometryCollection[] contourLines,
IPointCollection[] outputPointsWithElevations)
throws IOException,
AutomationException
|
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 |
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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void contourAsPolyline(IGeoDataset geoDataset,
IPoint inputPoint,
IPolyline[] contourLine,
double[] elevation)
throws IOException,
AutomationException
|
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 |
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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGeoDataset visibility(IGeoDataset geoDataset,
IGeoDataset observers,
int visType)
throws IOException,
AutomationException
|
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. |
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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||