Back to FabImage Studio website

You are here: Start » Filter Reference » Data Classification » Regression Analysis » LinearRegression_M

LinearRegression_M

Advanced

Module: FoundationPro

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

Name Type Range Description
Input value
 inYValues RealArray Sequence of ordinates
Input value
 inXValues RealArray* Sequence of abscissae, or {0, 1, 2, ...} by default
Input value
 inOutlierSuppression MEstimator
Input value
 inClippingFactor Real 0.675 - 6.0 Multitude of standard deviation within which points are considered inliers
Input value
 inIterationCount Integer 0 - Number of iterations of outlier suppressing algorithm
Input value
 inInitialLinearFunction LinearFunction* Initial approximation of the output linear function (if available)
Output value
 outLinearFunction LinearFunction Linear function approximating the given point set
Output value
 outEstimatedValues RealArray The result of application of the computed function to the X values
Output value
 outResiduals RealArray Difference between an input Y value and the corresponding estimated value
Output value
 outYInliers RealArray Coordinate of the inlying points of the best line
Output value
 outXInliers RealArray Coordinate of the inlying points of the best line

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Inconsistent size of arrays in LinearRegression_M.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of LinearRegression filter group.