IRSHousingModification#
The IRSHousingModification intervention class includes Indoor Residual Spraying (IRS) in the simulation. IRS is another key vector control tool in which insecticide is sprayed on the interior walls of a house so that mosquitoes resting on the walls after consuming a blood meal will die. IRS can also have a repellent effect. Because this class is distributed to individuals, it can target subgroups of the population. To target all individuals in a node, use IndoorSpaceSpraying. Do not use IRSHousingModification and IndoorSpaceSpraying together.
At a glance:
Distributed to: Individuals
Serialized: Yes, if it has been distributed to a person.
Uses insecticides: Yes. It can target specific species or other subgroups.
Time-based expiration: No
Purge existing: Yes. If a new intervention is added to to the individual, the existing intervention of the same name is removed when the new one is added.
Vector killing contributes to: Indoor Die After Feeding
Vector effects: Repelling and killing
Vector sexes affected: Females only
Vector life stage affected: Adult
Warning
EMOD simulations models nodes and individuals within nodes; they do not model houses. Therefore, housing modifications are received by individuals, not houses.
Use of this class and other housing modification classes requires caution because they can have unintended effects. For example, individuals in the same household may receive different housing modification interventions. An individual receiving a housing modification intervention who then migrates to another node will continue to receive that intervention. We recommend that you configure your simulation to take these logical inconsistencies into account.
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 |
8 |
The unit cost per housing modification (unamortized). |
{
"Cost_To_Consumer": 10.0
}
|
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 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"
]
}
|
Dont_Allow_Duplicates |
boolean |
0 |
1 |
0 |
If an individual’s container has an intervention, set to true (1) to prevent them from receiving another copy of the intervention. Supported by all intervention classes. |
{
"Dont_Allow_Duplicates": 0
}
|
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 |
IRSHousingModification |
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": "IRSHousingModification",
"Intervention_Name": "Indoor DDT spraying"
}
}
|
Killing_Config |
json object |
NA |
NA |
NA |
The configuration of killing efficacy and waning for housing modification. Killing is conditional on the vector not being repelled before feeding. Specify how this effect decays over time using one of the Waning effect classes. |
{
"Killing_Config": {
"Box_Duration": 3650,
"Initial_Effect": 0.53429,
"class": "WaningEffectBox"
}
}
|
New_Property_Value |
string |
NA |
NA |
“” |
An optional IndividualProperty key:value pair that will be assigned when the intervention is applied. 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"
}
|
Repelling_Config |
json object |
NA |
NA |
NA |
Defines a waning effect that determines the probability that a vector is repelled due to the intervention. Specify how this effect decays over time using one of the Waning effect classes. |
{
"Repelling_Config": {
"Box_Duration": 3650,
"Initial_Effect": 0.0,
"class": "WaningEffectBox"
}
}
|
{
"Events": [
{
"class": "CampaignEvent",
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Start_Day": 540,
"Event_Coordinator_Config": {
"class": "StandardInterventionDistributionEventCoordinator",
"Target_Demographic": "Everyone",
"Demographic_Coverage": 0.8,
"Intervention_Config": {
"class": "IRSHousingModification",
"Repelling_Config": {
"Box_Duration": 3650,
"Initial_Effect": 0,
"class": "WaningEffectBox"
},
"Cost_To_Consumer": 8,
"Killing_Config": {
"Box_Duration": 3650,
"Initial_Effect": 0.5,
"class": "WaningEffectBox"
}
}
}
}
],
"Use_Defaults": 1
}