You are here: Start » FIL.NET » Function Reference » Surface » Surface Features » FIL.SurfaceVolume_Single

FIL.SurfaceVolume_Single

Computes the volume of a surface with respect to a plane.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void SurfaceVolume_Single
(
	FilNet.Surface inSurface,
	double inZ,
	NullableRef<FilNet.Region> inRoi,
	FilNet.VolumeCalculationMethod inVolumeCalculationMethod,
	out double outVolume
)

Parameters

Name Type Range Default Description
inSurfaceFilNet.SurfaceInput surface.
inZdoubleThe volume is calculated with respect to the plane Z = inZ.
inRoiFilNet.NullableRef<FilNet.Region>Range of pixels to be processed. Default value: ftl::NIL.
inVolumeCalculationMethodFilNet.VolumeCalculationMethodDetermines how the parts of a volume are added up.
outVolumedoubleVolume of the input surface.

Errors

List of possible exceptions:

Error type Description
DomainError Region of interest exceeds an input surface in SurfaceVolume_Single.
DomainError Unsupported inVolumeCalculationMethod in SurfaceVolume_Single.

Function Overrides

See also