amici.ode_model.Observable
- class amici.ode_model.Observable(identifier, name, value, measurement_symbol=None, transformation='lin')[source]
An Observable links model simulations to experimental measurements, abbreviated by
y
.- Variables
_measurement_symbol – sympy symbol used in the objective function to represent measurements to this observable
trafo – observable transformation, only applies when evaluating objective function or residuals
- __init__(identifier, name, value, measurement_symbol=None, transformation='lin')[source]
Create a new Observable instance.
- Parameters
identifier (
sympy.core.symbol.Symbol
) – unique identifier of the Observablename (
str
) – individual name of the Observable (does not need to be unique)value (
sympy.core.expr.Expr
) – formulatransformation (
typing.Optional
[amici.import_utils.ObservableTransformation
]) – observable transformation, only applies when evaluating objective function or residuals
Methods Summary
__init__
(identifier, name, value[, ...])Create a new Observable instance.
get_id
()ModelQuantity identifier
- rtype
get_name
()ModelQuantity name
get_val
()ModelQuantity value
set_val
(val)Set ModelQuantity value
Methods
- __init__(identifier, name, value, measurement_symbol=None, transformation='lin')[source]
Create a new Observable instance.
- Parameters
identifier (
sympy.core.symbol.Symbol
) – unique identifier of the Observablename (
str
) – individual name of the Observable (does not need to be unique)value (
sympy.core.expr.Expr
) – formulatransformation (
typing.Optional
[amici.import_utils.ObservableTransformation
]) – observable transformation, only applies when evaluating objective function or residuals
- get_id()
ModelQuantity identifier
- Return type
- Returns
identifier of the ModelQuantity
- get_val()
ModelQuantity value
- Return type
- Returns
value of the ModelQuantity
- set_val(val)
Set ModelQuantity value
- Returns
value of the ModelQuantity