You are here: Start » FIL.NET » Function Reference » Data Classification » Regression Analysis » FIL.LinearRegression_M

FIL.LinearRegression_M

Computes linear regression of given point set using selected M-estimator for outlier suppression.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void LinearRegression_M
(
	IList<float> inYValues,
	NullableRef<IList<float>> inXValues,
	FilNet.MEstimator inOutlierSuppression,
	float inClippingFactor,
	int inIterationCount,
	FilNet.LinearFunction? inInitialLinearFunction,
	out FilNet.LinearFunction outLinearFunction,
	IList<float> outEstimatedValues,
	IList<float> outResiduals,
	NullableRef<List<float>> outYInliers,
	NullableRef<List<float>> outXInliers
)

Parameters

Name Type Range Default Description
inYValuesSystem.Collections.Generic.IList<float>Sequence of ordinates.
inXValuesFilNet.NullableRef<System.Collections.Generic.IList<float>>Sequence of abscissae, or {0, 1, 2, ...} by default. Default value: ftl::NIL.
inOutlierSuppressionFilNet.MEstimator
inClippingFactorfloat<0.675f, 6.0f>2.5fMultitude of standard deviation within which points are considered inliers. Default value: 2.5f.
inIterationCountint<0, INF>5Number of iterations of outlier suppressing algorithm. Default value: 5.
inInitialLinearFunctionFilNet.LinearFunction?Initial approximation of the output linear function (if available). Default value: ftl::NIL.
outLinearFunctionFilNet.LinearFunctionLinear function approximating the given point set.
outEstimatedValuesSystem.Collections.Generic.IList<float>The result of application of the computed function to the X values.
outResidualsSystem.Collections.Generic.IList<float>Difference between an input Y value and the corresponding estimated value.
outYInliersFilNet.NullableRef<System.Collections.Generic.List<float>>Coordinate of the inlying points of the best line. Can be null to skip this parameter calculation.
outXInliersFilNet.NullableRef<System.Collections.Generic.List<float>>Coordinate of the inlying points of the best line. Can be null to skip this parameter calculation.

Errors

List of possible exceptions:

Error type Description
DomainError Inconsistent size of arrays in LinearRegression_M.

Function Overrides

See also