CalendarEventCoordinator¶
The CalendarEventCoordinator coordinator class distributes individual-level interventions at a specified time and coverage. See the following JSON example and table, which shows all available parameters for this event coordinator.
Note
Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. JSON does not permit comments, but you can add “dummy” parameters to add contextual information to your files.
The table below describes all possible parameters with which this class can be configured. The JSON example that follows shows one potential configuration.
Parameter | Data type | Minimum | Maximum | Default | Description | Example |
---|---|---|---|---|---|---|
Distribution_Coverages | array of floats | 0 | 1 | 0 | A vector of floats for the fraction of individuals that will receive this intervention in a CalendarEventCoordinator. | {
"Distribution_Times": [100, 200, 400, 800, 1200],
"Distribution_Coverages": [0.01, 0.05, 0.1, 0.2, 1.0]
}
|
Distribution_Times | array of integers | 1 | 2.15E+0 | 0 | A vector of integers for simulation times at which distribution of events occurs in a CalendarEventCoordinator. | {
"Distribution_Times": [100, 200, 400, 800, 1200],
"Distribution_Coverages": [0.01, 0.05, 0.1, 0.2, 1.0]
}
|
Intervention_Config | JSON object | NA | NA | NA | The nested JSON of the actual intervention to be distributed by this event coordinator. | {
"Intervention_Config": {
"class": "OutbreakIndividual",
"Incubation_Period_Override": 1,
"Outbreak_Source": "PrevalenceIncrease"
}
}
|
Property_Restrictions | array of JSON objects | NA | NA | NA | A list of the IndividualProperty key:value pairs, as defined in the demographics file, that individuals must have to be targeted by this individual-level intervention. See NodeProperties and IndividualProperties parameters for more information. | {
"Property_Restrictions": [
"Risk:HIGH"
]
}
|
Node_Property_Restrictions | array of JSON objects | NA | NA | NA | A list of the NodeProperty key:value pairs, as defined in the demographics file, that nodes must have to be targeted by the intervention. | {
"Node_Property_Restrictions": [{
"Place": "URBAN",
"Risk": "MED"
},
{
"Place": "RURAL",
"Risk": "LOW"
}
]
}
|
Target_Age_Min | float | 0 | 3.40E+3 | 0 | The lower end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender. | {
"Target_Age_Max": 20,
"Target_Age_Min": 10,
"Target_Demographic": "ExplicitAgeRanges"
}
|
Target_Demographic | enum | NA | NA | Everyone | The target demographic group. Possible values are:
|
{
"Target_Age_Max": 20,
"Target_Age_Min": 10,
"Target_Demographic": "ExplicitAgeRanges"
}
|
Target_Gender | enum | NA | NA | All | Specifies the gender restriction for the intervention. Possible values are:
|
{
"Target_Gender": "Male"
}
|
Timesteps_Between_Repetitions | integer | -1 | 10000 | -1 | The repetition interval. | {
"Timesteps_Between_Repetitions": 50
}
|
Demographic_Coverage | float | 0 | 1 | 1 | The fraction of individuals in the target demographic that will receive this intervention. | {
"Demographic_Coverage": 1
}
|
Property_Restrictions_Within_Node | array of JSON objects | NA | NA | NA | A list of the IndividualProperty key:value pairs, as defined in the demographics file, that individuals must have to be targeted by this node-level intervention. See NodeProperties and IndividualProperties parameters for more information. | {
"Property_Restrictions_Within_Node": [{
"Risk": "HIGH"
}]
}
|
Target_Residents_Only | boolean | NA | NA | 0 | When set to true (1), the intervention is only distributed to individuals that began the simulation in the node (i.e. those that claim the node as their residence). | {
"Target_Residents_Only": 1
}
|
Target_Age_Max | float | 0 | 3.40E+3 | 3.40E+38 | The upper end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender. | {
"Target_Age_Max": 20,
"Target_Age_Min": 10,
"Target_Demographic": "ExplicitAgeRanges"
}
|
{
"Events": [{
"class": "CampaignEvent",
"Event_Name": "High-risk vaccination",
"Start_Day": 1,
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Event_Coordinator_Config": {
"class": "CalendarEventCoordinator",
"Demographic_Coverage": 1,
"Property_Restrictions": [
"Risk:High"
],
"Number_Repetitions": 1,
"Timesteps_Between_Repetitions": 0,
"Target_Demographic": "Everyone",
"Target_Residents_Only": 1,
"Distribution_Times": [100, 200, 400, 800, 1200],
"Distribution_Coverages": [0.01, 0.05, 0.1, 0.2, 1.0],
"Intervention_Config": {
"Cost_To_Consumer": 0,
"Vaccine_Take": 1,
"Vaccine_Type": "AcquisitionBlocking",
"class": "SimpleVaccine",
"Waning_Config": {
"Initial_Effect": 1,
"Box_Duration": 1825,
"class": "WaningEffectBox"
}
}
}
}]
}