parameter module

Define a model parameter.

class Parameter(markdown, unit='1', value=0.0, *, lower_bound=-inf, upper_bound=inf, description='', is_locked=False)

Bases: object

An electron emission model parameter.

Instantiate the parameter.

Parameters:

• markdown (str) – The name of the parameter, in markdown format.

• unit (str, default: '1') – The unit of the parameter.

• value (float, default: 0.0) – A first value for the parameter.

• lower_bound (float, default: -inf) – A first lower bound for the parameter.

• upper_bound (float, default: inf) – A first upper bound for the parameter.

• description (str, default: '') – A description string for the parameter.

• is_locked (bool, default: False) – Forces the parameters to a certain value, which will not be modified by EEmiLib.

_tol: float = 1e-10

__str__()

Return name of parameter, its value and its unit.

Return type:

str

property name: str

Return markdown name of parameter with its unit.

property value: float

Give the current value of the parameter.

property lower_bound: float

Give the current lower bound of the parameter.

property upper_bound: float

Give the current upper bound of the parameter.

lock()

Set the parameter to its current value.

Return type:

None

unlock()

Allow parameter to be changed again during optimisation.

Return type:

None