rc.gsa.calibrators

Contains the calculation of a single closed Sobol index without storing it.

Classes

ClosedSobol	Calculates closed Sobol Indices.
ClosedSobolWithError	Calculates closed Sobol Indices with Errors.
ClosedSobolWithRotation	Encapsulates the calculation of closed Sobol indices with a rotation U = Theta X.

Module Contents

class ClosedSobol(gp, **kwargs)

Bases: gf.Module, rc.gsa.base.Calibrator

Calculates closed Sobol Indices.

Parameters:

• gp (GPR)

• kwargs (rc.base.definitions.Any)

property META: rc.base.definitions.Dict[str, rc.base.definitions.Any]

Classmethod:

Return type:

rc.base.definitions.Dict[str, rc.base.definitions.Any]

Default calculation meta.

Returns: An empty dictionary.

marginalize(m)

Calculate everything. :param m: A Tf.Tensor pair of ints indicating the slice [m[0]:m[1]].

Returns: The Sobol ClosedSobol of m.

Parameters:

m (TF.Slice)

Return type:

rc.base.definitions.Dict[str, TF.Tensor]

class ClosedSobolWithError(gp, **kwargs)

Bases: ClosedSobol

Calculates closed Sobol Indices with Errors.

Parameters:

• gp (GPR)

• kwargs (rc.base.definitions.Any)

property META: rc.base.definitions.Dict[str, rc.base.definitions.Any]

Classmethod:

Return type:

rc.base.definitions.Dict[str, rc.base.definitions.Any]

Default calculation meta. is_T_partial forces W[Mm] = W[MM] = 0.

Returns:

If True this effectively asserts the full [‘M’] model is variance free, so WmM is not calculated or returned.

Return type:

is_T_partial

marginalize(m)

Calculate everything. :param m: A Tf.Tensor pair of ints indicating the slice [m[0]:m[1]].

Returns: The Sobol ClosedSobol of m, with errors (T and W).

Parameters:

m (TF.Slice)

Return type:

rc.base.definitions.Dict[str:TF.Tensor]

class ClosedSobolWithRotation(gp, **kwargs)

Bases: ClosedSobol

Encapsulates the calculation of closed Sobol indices with a rotation U = Theta X.

Parameters:

• gp (GPR)

• kwargs (rc.base.definitions.Any)