Observables

Contents:

Observables: numerical information about the systems state,
Specification: how to access EpiHiper provided observables.
Examples

Introduction

Synopsis

Observables: numerical information about the systems state,

EpiHiper provides information information of the system state to the user to the user through observables. Observables comprise time, total population, and absolute and relative values about the number of nodes in each individual of the Contagion Model. Furthermore the changes in and out of such a state are provided. Observables may be used in a Trigger condition, and as as the right hand side of an operation (see Action Ensemble). Observables are read read-only.

Specification

Synopsis

Specification: how to access EpiHiper provided observables.

observable:   time | totalPopulation | (healthState type [subset])
healthState:  id
type:         absolute | relative
subset:       in | out | current

Table 18 Variable definition.
Name	Type	Description
healthState	string	An id of a state of the Contagion Model.
type	absolute\|relative	Specifies whether the total or relative (to total population) value is requested
subset	in\|out\|current	select whether the number of nodes entering (in), existing (out), or are currently in the state.

The normative JSON schema can be found at: observable

Examples

Trigger for seeding (introducing infected nodes) prior to tick 10.

"triggers": [
  {
    "ann:id": "t_seed",
    "trigger": {
      "left": {
        "observable": "time"
      },
      "operator": "<",
      "right": {
        "value": {
          "number": 10
        }
      }
    },
    "interventionIds": [
      "seed"
    ]
  }
]