krakentools.sensitivity.distributions.TruncatedNormalDistribution

class krakentools.sensitivity.distributions.TruncatedNormalDistribution(lower_limit_95_conf, upper_limit_95_conf)

Bases: Distribution

Normal distribution truncated to 95 % confidence interval.

__init__(lower_limit_95_conf, upper_limit_95_conf)

Inits TruncatedNormalDistribution with lower and upper limit of 95 % confidence interval.

Parameters:

  • lower_limit_95_conf (float) – Lower limit of 95 % confidence interval.

  • upper_limit_95_conf (float) – Upper limit of 95 % confidence interval.

Raises:

RuntimeError – upper_limit_95_conf is not larger than lower_limit_95_conf.

Methods

__init__(lower_limit_95_conf, ...)

Inits TruncatedNormalDistribution with lower and upper limit of 95 % confidence interval.

from_parameter_list(params)

Creates a TruncatedNormalDistribution object based on a list of parameters.

generate_values(n_values)

Samples values from truncated normal distribution.
classmethod from_parameter_list(params)

Creates a TruncatedNormalDistribution object based on a list of parameters.

Parameters:

params (List[str]) – List of size 2 containing lower and upper limit of 95 % confidence interval.

Raises:

  • RuntimeError – Length of params list is not 2.

  • RuntimeError – Can not convert a list element from string to float.

Returns:

New TruncatedNormalDistribution object.

Return type:

TruncatedNormalDistribution

generate_values(n_values)

Samples values from truncated normal distribution.

Parameters:

n_values (int) – Number of values to sample.

Returns:

Array containing the sampled values.

Return type:

np.ndarray