Back to FabImage Library website

You are here: Start » Function Reference » Basic » Statistics » StandardDeviation

StandardDeviation


Header: STD.h
Namespace: fil
Module: FoundationLite

Computes the standard deviation of an array of real numbers. The array must be not empty.

Syntax

void fil::StandardDeviation
(
	const ftl::Array<float>& inValues,
	const bool inUseSampleFormula,
	float& outStandardDeviation
)

Parameters

Name Type Default Description
Input value inValues const Array<float>&
Input value inUseSampleFormula const bool
Output value outStandardDeviation float&

Hints

  • If the input array is not guaranteed to be non-empty, precede this filter with SkipEmptyArray.

Errors

List of possible exceptions:

Error type Description
DomainError Empty array on input in StandardDeviation.