LinearBasisFactory

class LinearBasisFactory(*args)

Linear basis factory.

The linear basis is composed of the linear terms of the canonical basis:

\{ \psi_k(x) \} = \{ 1, x_1, \hdots, x_n \}

Parameters:
dimensioninteger

Input dimension of the basis.

See also

BasisFactory, ConstantBasisFactory, QuadraticBasisFactory

Examples

>>> import openturns as ot
>>> basis = LinearBasisFactory(2).build()
>>> f = ot.AggregatedFunction(basis)
>>> x = [2, 3]
>>> print(f(x))
[1,2,3]

Methods

build()

Build the basis.

getClassName()

Accessor to the object's name.

getId()

Accessor to the object's id.

getName()

Accessor to the object's name.

getShadowedId()

Accessor to the object's shadowed id.

getVisibility()

Accessor to the object's visibility state.

hasName()

Test if the object is named.

hasVisibleName()

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)
build()

Build the basis.

Returns:
basisBasis.
getClassName()

Accessor to the object’s name.

Returns:
class_namestr

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

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.

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.

Examples using the class

Create a general linear model metamodel

Create a general linear model metamodel

Choose the trend basis of a kriging metamodel

Choose the trend basis of a kriging metamodel

Kriging : choose a trend vector space

Kriging : choose a trend vector space