This document is archived and information here might be outdated.  Recommended version.


ISurfaceOp2.Curvature Method (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > GeoAnalyst > ESRI.ArcGIS.GeoAnalyst > Interfaces > IS > ISurfaceOp2 Interface > ISurfaceOp2.Curvature Method (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (GeoAnalyst)  

ISurfaceOp2.Curvature Method

Calculates curvature, optionally including profile and plan curvature.

[Visual Basic .NET]
Public Function Curvature ( _
    ByVal GeoDataset As IGeoDataset, _
    ByVal profile As Boolean, _
    ByVal plan As Boolean, _
    [ByRef zFactor As Object] _
) As IGeoDataset

[C#]
public IGeoDataset Curvature (
    IGeoDataset GeoDataset,
    bool profile,
    bool plan,
    ref object zFactor
);
[C#]

Optional Values

zFactor   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing. 
[C++]
HRESULT Curvature(
  IGeoDataset* GeoDataset,
  VARIANT_BOOL profile,
  VARIANT_BOOL plan,
  VARIANT* zFactor,
  IGeoDataset** outGeoDataset
);

[C++]

Parameters
GeoDataset [in]

  GeoDataset is a parameter of type IGeoDataset
profile [in]
  profile is a parameter of type VARIANT_BOOL
plan [in]
  plan is a parameter of type VARIANT_BOOL
zFactor [optional]
  zFactor is a parameter of type VARIANT

  To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.
outGeoDataset [out, retval]

  outGeoDataset is a parameter of type IGeoDataset

Product Availability

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

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.

 

See Also

ISurfaceOp2 Interface