You are here: Start » AVL.NET » Function Reference » Surface » Surface Features » AVL.SurfaceVolume_Single
Computes the volume of a surface with respect to a plane.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void SurfaceVolume_Single ( AvlNet.Surface inSurface, double inZ, NullableRef<AvlNet.Region> inRoi, AvlNet.VolumeCalculationMethod inVolumeCalculationMethod, out double outVolume, NullableValue<AvlNet.Plane3D> outPlane )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inSurface | AvlNet.Surface | Input surface. | |||
inZ | double | The volume is calculated with respect to the plane Z = inZ. | |||
inRoi | AvlNet.NullableRef<AvlNet.Region> | Range of pixels to be processed. Default value: atl::NIL. | |||
inVolumeCalculationMethod | AvlNet.VolumeCalculationMethod | Determines how the parts of a volume are added up. | |||
outVolume | double | Volume of the input surface. | |||
outPlane | AvlNet.NullableValue<AvlNet.Plane3D> | The plane defined as Z = inZ. Can be null to skip this parameter calculation. |
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
- SurfaceVolume_Single(Surface, Double, VolumeCalculationMethod, Double)
- SurfaceVolume_Single(Surface, Double, NullableRef<Region>, VolumeCalculationMethod, Double)
- SurfaceVolume_Single(Surface, Double, NullableRef<Region>, VolumeCalculationMethod, Double, Plane3D)