Back to Adaptive Vision Library website

You are here: Start » Function Reference » Statistics » LinearRegression_TheilSen

LinearRegression_TheilSen


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Computes linear regression of given point set using TheilSen algorithm.

Syntax

void avl::LinearRegression_TheilSen
(
	const atl::Array<float>& inYValues,
	const atl::Optional<atl::Array<float> >& inXValues,
	avl::TheilSenVariant::Type inVariant,
	avl::LinearFunction& outLinearFunction,
	atl::Array<float>& outEstimatedValues,
	atl::Array<float>& outResiduals
)

Parameters

Name Type Default Description
inYValues const Array<float>& Sequence of ordinates
inXValues const Optional<Array<float> >& NIL Sequence of abscissae, or {0, 1, 2, ...} by default
inVariant TheilSenVariant::Type Switches between Theil-Sen and Siegel methods
outLinearFunction LinearFunction& Linear function approximating the given point set
outEstimatedValues Array<float>& The result of application of the computed function to the X values
outResiduals Array<float>& Difference between an input Y value and the corresponding estimated value

Errors

Error type Description
DomainError Inconsistent size of arrays in LinearRegression_TheilSen.
DomainError Empty array of points in LinearRegression_TheilSen.