SpatialRepellent

The SpatialRepellent intervention class implements node-level spatial repellents exclusively against outdoor-biting mosquitoes.

At a glance:

  • Distributed to: Nodes

  • Serialized: No, it needs to be redistributed when starting from a serialized file.

  • Uses insecticides: Yes. It can target subgroups using genomes.

  • Time-based expiration: No

  • Purge existing: Yes. If a new intervention is added to to the node, the existing intervention of the same name is removed when the new one is added.

  • Vector killing contributes to: No killing but Survive Without Successful Feed

  • Vector effects: Repelling

  • Vector sexes affected: Females only

  • Vector life stage affected: Adult

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 format does not permit comments, but you can add “dummy” parameters to add contextual information to your files. Any keys that are not EMOD parameter names will be ignored by the model.

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

Cost_To_Consumer

float

0

999999

10

The unit cost per vector control (unamortized).

{
  "Cost_To_Consumer": 8
}

Disqualifying_Properties

array of strings

NA

NA

[]

A list of IndividualProperty key:value pairs that cause an intervention to be aborted (persistent interventions will stop being distributed to individuals 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"
  ]
}

Insecticide_Name

string

NA

NA

UNINITIALIZED STRING

The name of the insecticide defined in <config.Insecticides> for this intervention. If insecticides are being used, this must be defined as one of those values; if they are not being used this can be empty. It cannot have a value if you did not configure <config.Insecticides>.

{
  "Insecticide_Name": "carbamate"
}

Intervention_Name

string

NA

NA

SpatialRepellent

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": "SpatialRepellent",
    "Intervention_Name": "Mosquito coil repellent"
  }
}

New_Property_Value

string

NA

NA

“”

An optional NodeProperty key:value pair that will be assigned when the intervention is applied. See NodeProperties and IndividualProperties parameters for more information.

{
  "New_Property_Value": "HasHealthCare:YES"
}

Repelling_Config

json object

NA

NA

NA

Defines the configuration of efficacy and waning for spatial repellent. Specify how this effect decays over time using one of the Waning effect classes.

{
  "Repelling_Config": {
    "Box_Duration": 100,
    "Decay_Time_Constant": 150,
    "Initial_Effect": 0.4,
    "class": "WaningEffectBoxExponential"
  }
}

Spray_Coverage

float

0

1

1

The portion of the node that has been sprayed. This value is multiplied by the current efficacy of the WaningEffect.

{
  "Spray_Coverage": 0.6
}
{
    "Events": [{
        "class": "CampaignEvent",
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Start_Day": 120,
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Intervention_Config": {
                "class": "SpatialRepellent",
                "Repelling_Config": {
                    "Box_Duration": 100,
                    "Decay_Time_Constant": 150,
                    "Initial_Effect": 0.4,
                    "class": "WaningEffectBoxExponential"
                },
                "Cost_To_Consumer": 1.0,
                "Spray_Coverage": 0.6
            }
        }
    }],
    "Use_Defaults": 1
}