Back to Aurora Vision Library website
You are here: Start » Function Reference » Surface » Surface Features » SurfaceVolume_Single
SurfaceVolume_Single
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | Vision3DStandard |
Computes the volume of a surface with respect to a plane.
Syntax
C++
C#
void avl::SurfaceVolume_Single ( const avl::Surface& inSurface, const double inZ, atl::Optional<const avl::Region&> inRoi, avl::VolumeCalculationMethod::Type inVolumeCalculationMethod, double& outVolume, atl::Optional<avl::Plane3D&> outPlane = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inSurface | const Surface& | Input surface | ||
inZ | const double | The volume is calculated with respect to the plane Z = inZ | ||
inRoi | Optional<const Region&> | NIL | Range of pixels to be processed | |
inVolumeCalculationMethod | VolumeCalculationMethod::Type | Determines how the parts of a volume are added up | ||
outVolume | double& | Volume of the input surface | ||
outPlane | Optional<Plane3D&> | NIL | The plane defined as Z = inZ |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outPlane.
Read more about Optional Outputs.
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. |