CoverageByNodeEventCoordinator

The CoverageByNodeEventCoordinator coordinator class distributes individual-level interventions and is similar to the StandardInterventionDistributionEventCoordinator, but adds the ability to specify different demographic coverages by node. If no coverage has been specified for a particular node ID, the coverage will be zero. See the following JSON example and table, which shows all available parameters for this event coordinator.

Note

This can only be used with individual-level interventions, but EMOD will not produce an error if you attempt to use it with an node-level intervention.

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
Coverage_By_Node array of arrays NA NA NA An array of (nodeID, coverage) pairs configuring the demographic coverage of interventions by node for the targeted populations. The coverage value must be a float between 0 and 1. 
{
    "Event_Coordinator_Config": {
        "Coverage_By_Node": [
            [
                1,
                0.6
            ],
            [
                2,
                0.9
            ],
            [
                3,
                0.1
            ]
        ]
    }
}
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"
    }
}
Number_Repetitions integer -1 1000 1 The number of times an intervention is given, used with Timesteps_Between_Repetitions. 
{
    "Event_Coordinator_Config": {
        "Intervention_Config": {
            "class": "Outbreak",
            "Num_Cases": 1
        },
        "Number_Repetitions": 10,
        "Timesteps_Between_Repetitions": 50,
        "class": "StandardInterventionDistributionEventCoordinator"
    }
}
Timesteps_Between_Repetitions integer -1 10000 -1 The repetition interval. 
{
    "Timesteps_Between_Repetitions": 50
}
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:

  • Everyone
  • ExplicitAgeRanges
  • ExplicitAgeRangesAndGender
  • ExplicitGender
  • PossibleMothers
  • ArrivingAirTravellers
  • DepartingAirTravellers
  • ArrivingRoadTravellers
  • DepartingRoadTravellers
  • AllArrivingTravellers
  • AllDepartingTravellers
  • ExplicitDiseaseState
 
{
    "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:

  • Male
  • Female
  • All
 
{
    "Target_Gender": "Male"
}
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
}

{
    "Events": [{
        "class": "CampaignEvent",
        "Start_Day": 0,
        "Nodeset_Config": {
            "Node_List": [
                1,
                2,
                3
            ],
            "class": "NodeSetNodeList"
        },
        "Event_Coordinator_Config": {
            "class": "CoverageByNodeEventCoordinator",
            "Target_Demographic": "Everyone",
            "Coverage_By_Node": [
                [1, 0.6],
                [2, 0.9],
                [3, 0.1]
            ],
            "Intervention_Config": {
                "Cost_To_Consumer": 10.0,
                "Reduced_Transmit": 0,
                "Vaccine_Take": 1,
                "Vaccine_Type": "AcquisitionBlocking",
                "Waning_Config": {
                    "Box_Duration": 3650,
                    "Initial_Effect": 1,
                    "class": "WaningEffectBox"
                },
                "class": "SimpleVaccine"
            }
        }
    }]
}