LinearModel¶

class
LinearModel
(*args)¶ The linear model class is created through the method build of a LinearModelFactory.
See also
 Attributes
thisown
The membership flag
Methods
Accessor to the object’s name.
Accessor to the confidence intervals.
getId
()Accessor to the object’s id.
getName
()Accessor to the object’s name.
Accessor to the pvalues.
getPredicted
(predictor)Accessor to the evaluation function of linear model.
Accessor to the regression coefficients.
getResidual
(predictor, measured)Accessor to the residuals.
Accessor to the object’s shadowed id.
Accessor to the object’s visibility state.
hasName
()Test if the object is named.
Test if the object has a distinguishable name.
setName
(name)Accessor to the object’s name.
setShadowedId
(id)Accessor to the object’s shadowed id.
setVisibility
(visible)Accessor to the object’s visibility state.

__init__
(*args)¶ Initialize self. See help(type(self)) for accurate signature.

getClassName
()¶ Accessor to the object’s name.
 Returns
 class_namestr
The object class name (object.__class__.__name__).

getConfidenceIntervals
()¶ Accessor to the confidence intervals.
 Returns
 confInterval
Interval
The confidence intervals of the linear model coefficients, corresponding to the level precised when the LinearModel class has been created through the method build.
 confInterval

getId
()¶ Accessor to the object’s id.
 Returns
 idint
Internal unique identifier.

getName
()¶ Accessor to the object’s name.
 Returns
 namestr
The name of the object.

getPValues
()¶ Accessor to the pvalues.
 Returns
 pvaluescollection of
Scalar
The collection of the pvalues of the linear model coefficients.
 pvaluescollection of

getPredicted
(predictor)¶ Accessor to the evaluation function of linear model.
 Parameters
 sampleX2d sequence of float
The input sample to be evaluated by the linear model.
 Returns
 Y
Sample
The response evaluated through the linear model on the sample sampleX.
 Y

getRegression
()¶ Accessor to the regression coefficients.
 Returns
 coef
Point
The coefficients of the linear model: .
 coef

getResidual
(predictor, measured)¶ Accessor to the residuals.
 Parameters
 Xsample: 2d sequence of float
The input sample on which the linear model has been built.
 Ysample: 2d sequence of float
The 1d output sample on which the linear model has been built.
 Returns
 residual
Sample
The residuals computed on each point.
 residual

getShadowedId
()¶ Accessor to the object’s shadowed id.
 Returns
 idint
Internal unique identifier.

getVisibility
()¶ Accessor to the object’s visibility state.
 Returns
 visiblebool
Visibility flag.

hasName
()¶ Test if the object is named.
 Returns
 hasNamebool
True if the name is not empty.

hasVisibleName
()¶ Test if the object has a distinguishable name.
 Returns
 hasVisibleNamebool
True if the name is not empty and not the default one.

setName
(name)¶ Accessor to the object’s name.
 Parameters
 namestr
The name of the object.

setShadowedId
(id)¶ Accessor to the object’s shadowed id.
 Parameters
 idint
Internal unique identifier.

setVisibility
(visible)¶ Accessor to the object’s visibility state.
 Parameters
 visiblebool
Visibility flag.

thisown
¶ The membership flag