Back to FabImage Library website

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

SurfaceVolume_Single


Header: FIL.h
Namespace: fil
Module: Vision3DStandard

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

Syntax

C++
C#
 
void fil::SurfaceVolume_Single
(
	const fil::Surface& inSurface,
	const double inZ,
	ftl::Optional<const fil::Region&> inRoi,
	fil::VolumeCalculationMethod::Type inVolumeCalculationMethod,
	double& outVolume,
	ftl::Optional<fil::Plane3D&> outPlane = ftl::NIL
)

Parameters

Name Type Default Description
Input value
 inSurface const Surface& Input surface
Input value
 inZ const double The volume is calculated with respect to the plane Z = inZ
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
Output value
 outPlane Optional<Plane3D&> NIL The plane defined as Z = inZ

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::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.