Back to FabImage Library website

You are here: Start » Function Reference » Profile » Profile Features » ProfileAverage

ProfileAverage


Header: FIL.h
Namespace: fil
Module: FoundationPro

Computes the average value of a profile.

Syntax

C++
C#
 
void fil::ProfileAverage
(
	const fil::Profile& inProfile,
	ftl::Optional<const fil::Range&> inRange,
	float& outAverage
)

Parameters

Name Type Default Description
Input value
 inProfile const Profile& Input profile
Input value
 inRange Optional<const Range&> NIL
Output value
 outAverage float&

Errors

List of possible exceptions:

Error type Description
DomainError Empty profile in ProfileAverage.
DomainError Empty profile range in ProfileAverage.
DomainError Range exceeds the input profile in ProfileAverage.