amici.ode_model.EventObservable
- class amici.ode_model.EventObservable(identifier, name, value, event, measurement_symbol=None, transformation='lin')[source]
An Event Observable links model simulations to event related experimental measurements, abbreviated by
z
.- Variables
_event – symbolic event identifier
- __init__(identifier, name, value, event, measurement_symbol=None, transformation='lin')[source]
Create a new EventObservable instance.
- Parameters
identifier (
sympy.core.symbol.Symbol
) – SeeObservable.__init__()
.name (
str
) – SeeObservable.__init__()
.value (
sympy.core.expr.Expr
) – SeeObservable.__init__()
.transformation (
typing.Optional
[amici.import_utils.ObservableTransformation
]) – SeeObservable.__init__()
.event (
sympy.core.symbol.Symbol
) – Symbolic identifier of the corresponding event.
Methods Summary
__init__
(identifier, name, value, event[, ...])Create a new EventObservable instance.
Get the symbolic identifier of the corresponding event.
get_id
()ModelQuantity identifier
- rtype
get_name
()ModelQuantity name
- rtype
get_val
()ModelQuantity value
set_val
(val)Set ModelQuantity value
Methods
- __init__(identifier, name, value, event, measurement_symbol=None, transformation='lin')[source]
Create a new EventObservable instance.
- Parameters
identifier (
sympy.core.symbol.Symbol
) – SeeObservable.__init__()
.name (
str
) – SeeObservable.__init__()
.value (
sympy.core.expr.Expr
) – SeeObservable.__init__()
.transformation (
typing.Optional
[amici.import_utils.ObservableTransformation
]) – SeeObservable.__init__()
.event (
sympy.core.symbol.Symbol
) – Symbolic identifier of the corresponding event.
- get_event()[source]
Get the symbolic identifier of the corresponding event.
- Return type
- Returns
symbolic identifier
- get_id()
ModelQuantity identifier
- Return type
- Returns
identifier of the ModelQuantity
- get_measurement_symbol()
- Return type
- get_regularization_symbol()
- Return type
- get_val()
ModelQuantity value
- Return type
- Returns
value of the ModelQuantity
- set_val(val)
Set ModelQuantity value
- Returns
value of the ModelQuantity