SimpleHousingModification¶
The SimpleHousingModification intervention class implements a housing modification for vector control. It is the base class from which other housing modifications are derived.
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 |
---|---|---|---|---|---|---|
Killing_Config | JSON object | NA | NA | NA | The configuration of killing efficacy and waning for housing modification. Killing is conditional on NOT blocking the mosquito 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"
}
}
|
Blocking_Config | JSON object | NA | NA | NA | The configuration of pre-feed mosquito repellency and waning for housing modification. Specify how this effect decays over time using one of the Waning effect classes. | {
"Blocking_Config": {
"Box_Duration": 3650,
"Initial_Effect": 0.0,
"class": "WaningEffectBox"
}
}
|
Cost_To_Consumer | float | 0 | 999999 | 8 | The unit cost per housing modification (unamortized). | {
"Cost_To_Consumer": 10.0
}
|
Dont_Allow_Duplicates | boolean | NA | NA | 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
}
|
Disqualifying_Properties | string | NA | 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"
]
}
|
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_Name":"Diagnostic_Sample"
}
|
New_Property_Value | string | NA | NA | NA | An optional IndividualProperty 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"
}
|
{
"Events": [{
"class": "CampaignEvent",
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Start_Day": 120,
"Event_Coordinator_Config": {
"class": "StandardInterventionDistributionEventCoordinator",
"Target_Demographic": "Everyone",
"Demographic_Coverage": 0.8,
"Intervention_Config": {
"class": "SimpleHousingModification",
"Blocking_Config": {
"Box_Duration": 100,
"Decay_Time_Constant": 150,
"Initial_Effect": 0.6,
"class": "WaningEffectBoxExponential"
},
"Cost_To_Consumer": 1.0,
"Killing_Config": {
"Box_Duration": 100,
"Decay_Time_Constant": 150,
"Initial_Effect": 0.4,
"class": "WaningEffectBoxExponential"
}
}
}
}],
"Use_Defaults": 1
}