LinearModelResult

class LinearModelResult(*args)

Result of a LinearModelAlgorithm.

Parameters
inputSample2-d sequence of float

The input sample of a model.

basisBasis

Functional basis to estimate the trend.

designMatrix

The design matrix X.

outputSample2-d sequence of float

The output sample of a model.

metaModelFunction

The meta model.

trendCoefficientssequence of float

The trend coeffients associated to the linearmodel.

formulastr

The formula description.

coefficientsNamessequence of str

The coefficients names of the basis.

sampleResiduals2-d sequence of float

The residual errors.

standardizedSampleResiduals2-d sequence of float

The normalized residual errors.

diagonalGramInversesequence of float

The diagonal of the Gram inverse matrix.

leveragessequence of float

The leverage score.

cookDistancessequence of float

The cook’s distances.

sigma2float

The unbiased noise variance.

See also

LinearModelAlgorithm

Methods

getAdjustedRSquared()

Accessor to the Adjusted R-squared test.

getBasis()

Accessor to the basis.

getClassName()

Accessor to the object's name.

getCoefficients()

Accessor to the coefficients of the linear model of the trend.

getCoefficientsNames()

Accessor to the coefficients names.

getCoefficientsStandardErrors()

Accessor to the coefficients of standard error.

getCookDistances()

Accessor to the cook's distances.

getDegreesOfFreedom()

Accessor to the degrees of freedom.

getDiagonalGramInverse()

Accessor to the diagonal gram inverse matrix.

getFittedSample()

Accessor to the fitted sample.

getFormula()

Accessor to the formula.

getId()

Accessor to the object's id.

getInputSample()

Accessor to the input sample.

getLeverages()

Accessor to the leverages.

getMetaModel()

Accessor to the metamodel.

getModel()

Accessor to the model.

getName()

Accessor to the object's name.

getNoiseDistribution()

Accessor to the noise distribution, ie the underlying distribution of the residual.

getOutputSample()

Accessor to the output sample.

getRSquared()

Accessor to the R-squared test.

getRelativeErrors()

Accessor to the relative errors.

getResiduals()

Accessor to the residuals.

getSampleResiduals()

Accessor to the residuals.

getShadowedId()

Accessor to the object's shadowed id.

getStandardizedResiduals()

Accessor to the standardized residuals.

getVisibility()

Accessor to the object's visibility state.

hasIntercept()

Returns if intercept is provided in the basis or not.

hasName()

Test if the object is named.

hasVisibleName()

Test if the object has a distinguishable name.

setMetaModel(metaModel)

Accessor to the metamodel.

setModel(model)

Accessor to the model.

setName(name)

Accessor to the object's name.

setRelativeErrors(relativeErrors)

Accessor to the relative errors.

setResiduals(residuals)

Accessor to the residuals.

setShadowedId(id)

Accessor to the object's shadowed id.

setVisibility(visible)

Accessor to the object's visibility state.
__init__(*args)
getAdjustedRSquared()

Accessor to the Adjusted R-squared test.

Returns
adjustedRSquaredfloat

Not defined when degrees of freedom is null.

getBasis()

Accessor to the basis.

Returns
basisBasis

The basis which had been passed to the constructor.

getClassName()

Accessor to the object’s name.

Returns
class_namestr

The object class name (object.__class__.__name__).

getCoefficients()

Accessor to the coefficients of the linear model of the trend.

Returns
betaPoint
getCoefficientsNames()

Accessor to the coefficients names.

Returns
coefficientsNamesDescription
getCoefficientsStandardErrors()

Accessor to the coefficients of standard error.

Returns
standardErrorsPoint
getCookDistances()

Accessor to the cook’s distances.

Returns
cookDistancesPoint
getDegreesOfFreedom()

Accessor to the degrees of freedom.

Returns
dofint

Sample size minus basis size, a null value is allowed.

getDiagonalGramInverse()

Accessor to the diagonal gram inverse matrix.

Returns
diagonalGramInversePoint
getFittedSample()

Accessor to the fitted sample.

Returns
outputSampleSample
getFormula()

Accessor to the formula.

Returns
condensedFormulastr
getId()

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getInputSample()

Accessor to the input sample.

Returns
inputSampleSample

The Xsample which had been passed to the constructor.

getLeverages()

Accessor to the leverages.

Returns
leveragesPoint
getMetaModel()

Accessor to the metamodel.

Returns
metaModelFunction

Metamodel.

getModel()

Accessor to the model.

Returns
modelFunction

Physical model approximated by a metamodel.

getName()

Accessor to the object’s name.

Returns
namestr

The name of the object.

getNoiseDistribution()

Accessor to the noise distribution, ie the underlying distribution of the residual.

Returns
noiseDistributionDistribution

Not defined when degrees of freedom is null.

getOutputSample()

Accessor to the output sample.

Returns
outputSampleSample

The Ysample which had been passed to the constructor.

getRSquared()

Accessor to the R-squared test.

Returns
rSquaredfloat
getRelativeErrors()

Accessor to the relative errors.

Returns
relativeErrorsPoint

The relative errors defined as follows for each output of the model: \displaystyle \frac{\sum_{i=1}^N (y_i - \hat{y_i})^2}{N \Var{\vect{Y}}} with \vect{Y} the vector of the N model’s values y_i and \hat{y_i} the metamodel’s values.

getResiduals()

Accessor to the residuals.

Returns
residualsPoint

The residual values defined as follows for each output of the model: \displaystyle \frac{\sqrt{\sum_{i=1}^N (y_i - \hat{y_i})^2}}{N} with y_i the N model’s values and \hat{y_i} the metamodel’s values.

getSampleResiduals()

Accessor to the residuals.

Returns
sampleResidualsSample
getShadowedId()

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getStandardizedResiduals()

Accessor to the standardized residuals.

Returns
standardizedResidualsSample
getVisibility()

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

hasIntercept()

Returns if intercept is provided in the basis or not.

Returns
interceptBool
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.

setMetaModel(metaModel)

Accessor to the metamodel.

Parameters
metaModelFunction

Metamodel.

setModel(model)

Accessor to the model.

Parameters
modelFunction

Physical model approximated by a metamodel.

setName(name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setRelativeErrors(relativeErrors)

Accessor to the relative errors.

Parameters
relativeErrorssequence of float

The relative errors defined as follows for each output of the model: \displaystyle \frac{\sum_{i=1}^N (y_i - \hat{y_i})^2}{N \Var{\vect{Y}}} with \vect{Y} the vector of the N model’s values y_i and \hat{y_i} the metamodel’s values.

setResiduals(residuals)

Accessor to the residuals.

Parameters
residualssequence of float

The residual values defined as follows for each output of the model: \displaystyle \frac{\sqrt{\sum_{i=1}^N (y_i - \hat{y_i})^2}}{N} with y_i the N model’s values and \hat{y_i} the metamodel’s values.

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.