InputEIR

The InputEIR intervention class enables the Entomological Inoculation Rate (EIR) to be configured for each month of the year in a particular node. The EIR is the number of mosquito bites per night multiplied by the proportion of those bites that are positive for sporozoites.

Note

Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. Minimum, maximum, or default values of “NA” indicate that those values are not applicable for that parameter.

EMOD does not use true defaults; that is, if the dependency relationships indicate that a parameter is required, you must supply a value for it. However, many of the tools used to work with EMOD will use the default values provided below.

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

Age_Dependence

enum

NA

NA

OFF

Determines how InputEIR depends on the age of the target. Possible values are:

OFF

Age has no effect.

LINEAR

The biting risk is 20% of the adult exposure rising linearly until age 20.

SURFACE_AREA_DEPENDENT

The biting risk rises linearly from 7% to 23% over the first two years of life and then rises with a shallower linear slope to the adult value at age 20.

{
    "Age_Dependence": "SURFACE_AREA_DEPENDENT"
}

Disqualifying_Properties

array of strings

NA

NA

[]

A list of NodeProperty key:value pairs that cause an intervention to be aborted (persistent interventions will stop being distributed to nodes with these values). See NodeProperties and IndividualProperties parameters for more information. Generally used to control the flow of health care access. For example, to prevent the same individual from accessing health care via two different routes at the same time.

{
    "Disqualifying_Properties": [
        "InterventionStatus:LostForever"
    ]
}

Intervention_Name

string

NA

NA

NA

The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.

{
    "Intervention_Config": {
        "class": "InputEIR",
        "Intervention_Name": "Entomological Inoculation Rate config"
    }
}

Monthly_EIR

array of floats

0

1000

NA

An array of 12 elements that contain an entomological inoculation rate (EIR) for each month. Each value should be between 0 and 1000.

{
    "Monthly_EIR": [
        0.39,
        0.19,
        0.77,
        0,
        0,
        0,
        6.4,
        2.2,
        4.7,
        3.9,
        0.87,
        0.58
    ]
}

New_Property_Value

string

NA

NA

NA

An optional NodeProperty key:value pair that will be assigned when the intervention is distributed. See NodeProperties and IndividualProperties parameters for more information. Generally used to indicate the broad category of health care cascade to which an intervention belongs to prevent individuals from accessing care through multiple pathways. For example, if an individual must already be taking a particular medication to be prescribed a new one.

{
    "New_Property_Value": "InterventionStatus:None"
}
{
     "Use_Defaults": 1,
     "Campaign_Name": "Constant EIR challenge",
     "Events": [{
          "class": "CampaignEvent",
          "Event_Name": "Input EIR intervention",
          "Start_Day": 0,
          "Nodeset_Config": {
               "class": "NodeSetAll"
          },
          "Event_Coordinator_Config": {
               "class": "StandardInterventionDistributionEventCoordinator",
               "Number_Repetitions": 1,
               "Intervention_Config": {
                    "class": "InputEIR",
                    "Age_Dependence": "SURFACE_AREA_DEPENDENT",
                    "Monthly_EIR": [0.39, 0.19, 0.77, 0, 0, 0, 6.4, 2.2, 4.7, 3.9, 0.87, 0.58]
               }
          }
     }]
}