Back to Aurora Vision Library website

You are here: Start » Function Reference » Surface » Surface Features » SurfaceVolume_Double

SurfaceVolume_Double


Header: AVL.h
Namespace: avl
Module: Vision3DStandard

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

Syntax

C++
C#
 
void avl::SurfaceVolume_Double
(
	const avl::Surface& inTopSurface,
	const avl::Surface& inBottomSurface,
	atl::Optional<const avl::Region&> inRoi,
	avl::VolumeCalculationMethod::Type inVolumeCalculationMethod,
	double& outVolume
)

Parameters

Name Type Default Description
Input value inTopSurface const Surface& The top surface
Input value inBottomSurface const Surface& The bottom surface
Input value inRoi Optional<const Region&> NIL Range of pixels to be processed
Input value inVolumeCalculationMethod VolumeCalculationMethod::Type Determines how the parts of a volume are added up
Output value outVolume double& Volume of the input surface

Errors

List of possible exceptions:

Error type Description
DomainError Different surface dimensions between inTopSurface and inBottomSurface in SurfaceVolume_Double.
DomainError Different surface scales or offsets between inTopSurface and inBottomSurface in SurfaceVolume_Double.
DomainError Different surface types between inTopSurface and inBottomSurface in SurfaceVolume_Double.
DomainError Region of interest exceeds an input surface in SurfaceVolume_Double.
DomainError Unsupported inVolumeCalculationMethod in SurfaceVolume_Double.