usage_dependent_bednet
add_scheduled_usage_dependent_bednet(campaign, start_day=1, demographic_coverage=1, target_num_individuals=None, node_ids=None, ind_property_restrictions=None, target_age_min=0, target_age_max=malaria_common.MAX_AGE_YEARS, target_gender='All', intervention_name='UsageDependentBednet', discard_config=None, insecticide='', repelling_initial_effect=0, repelling_box_duration=0, repelling_decay_time_constant=1460, blocking_initial_effect=0.9, blocking_box_duration=0, blocking_decay_time_constant=730, blocking_linear_times=None, blocking_linear_values=None, blocking_expire_at_end=0, killing_initial_effect=0, killing_box_duration=0, killing_decay_time_constant=1460, age_dependence=None, seasonal_dependence=None, dont_allow_duplicates=False)
Add an insecticide-treated net (ITN) intervention with a seasonal usage pattern to the campaign using the UsageDependentBednet class.
Note: for killing, blocking, repelling effects - depending on the parameters you set, different WaningEffect classes will be used: box_duration = -1 => WaningEffectConstant, decay_time_constant is ignored box_duration = 0 + decay_time_constant > 0 => WaningEffectExponential box_duration > 0 + decay_time_constant = 0 => WaningEffectBox box_duration > 0 + decay_time_constant > 0 => WaningEffectBoxExponential
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
campaign
|
EMODCampaign
|
campaign object to which the intervention will be added, and schema_path container |
required |
start_day
|
int
|
The day on which to start distributing the bednets (Start_Day parameter). |
1
|
demographic_coverage
|
float
|
This value is the probability that each individual in the target population will receive the intervention. It does not guarantee that the exact fraction of the target population set by Demographic_Coverage receives the intervention. |
1
|
target_num_individuals
|
int
|
The exact number of people to select out of the targeted group. If this value is set, demographic_coverage parameter is ignored |
None
|
node_ids
|
list
|
The list of nodes to apply this intervention to (Node_List parameter). If not provided, intervention is distributed to all nodes. |
None
|
ind_property_restrictions
|
list
|
A list of dictionaries of IndividualProperties, which are needed for the individual to receive the intervention. Sets the Property_Restrictions_Within_Node |
None
|
ind_property_restrictions
|
list
|
The IndividualProperty key:value pairs
that individuals must have to receive the intervention (
Property_Restrictions_Within_Node parameter). In the format |
None
|
target_age_min
|
float
|
The lower end of ages targeted for an intervention, in years. Sets Target_Age_Min |
0
|
target_age_max
|
float
|
The upper end of ages targeted for an intervention, in years. Sets Target_Age_Max |
MAX_AGE_YEARS
|
target_gender
|
str
|
The gender targeted for an intervention: All, Male, or Female. |
'All'
|
intervention_name
|
str
|
The optional name used to refer to this intervention as a means to differentiate it from others that use the same class. It’s possible to have multiple UsageDependentBednets interventions attached to a person if they have different Intervention_Name values. |
'UsageDependentBednet'
|
discard_config
|
dict
|
A dictionary of parameters needed to define expiration distribution. No need to definite the distribution with all its parameters Default is bednet being discarded with EXPONENTIAL_DISTRIBUTION with Expiration_Period_Exponential of 10 years Examples:: |
None
|
insecticide
|
str
|
The name of the insecticide defined in |
''
|
repelling_initial_effect
|
float
|
Initial strength of the Repelling effect. The effect may decay over time. |
0
|
repelling_box_duration
|
int
|
Box duration of effect in days before the decay of Repelling Initial_Effect. |
0
|
repelling_decay_time_constant
|
float
|
The exponential decay length, in days of the Repelling Initial_Effect. |
1460
|
blocking_initial_effect
|
float
|
Initial strength of the Blocking effect. The effect may decay over time. |
0.9
|
blocking_box_duration
|
int
|
Box duration of effect in days before the decay of Blocking Initial_Effect. |
0
|
blocking_decay_time_constant
|
float
|
The exponential decay length, in days of the Blocking Initial_Effect. |
730
|
blocking_linear_times
|
list
|
An array of days that matches the defined linear values for Blocking Initial_Effect |
None
|
blocking_linear_values
|
list
|
An array of multiplier values that matches the defined linear days for Blocking Initial_Effect. |
None
|
blocking_expire_at_end
|
int
|
Set to 1 to have efficacy go to zero and let the intervention expire when the end of the map is reached. Only vaccines and bednet usage currently support this expiration feature. defaults to 0. |
0
|
killing_initial_effect
|
float
|
Initial strength of the Killing effect. The effect may decay over time. |
0
|
killing_box_duration
|
int
|
Box duration of effect in days before the decay of Killing Initial_Effect. |
0
|
killing_decay_time_constant
|
float
|
The exponential decay length, in days of the Killing Initial_Effect. |
1460
|
age_dependence
|
dict
|
A dictionary defining the age dependence of net use. Must contain a list of ages in years and list of usage rate. Default is uniform across all ages. Times are in years of age |
None
|
seasonal_dependence
|
dict
|
A dictionary defining the seasonal dependence of net use. Time since start will reset to zero once it reaches 365. This allows you to simulate seasonal effects. Times are given in days of the year; values greater than 365 are ignored. Dictionaries can be (times, values) for linear spline or (minimum coverage, day of maximum coverage) for sinusoidal dynamics. Default is constant use during the year. |
None
|
dont_allow_duplicates
|
bool
|
Set to True to prevent individual from receiving another copy of the intervention. Default is False. |
False
|
Source code in emodpy_malaria/interventions/usage_dependent_bednet.py
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | |
add_triggered_usage_dependent_bednet(campaign, start_day=1, demographic_coverage=1, node_ids=None, ind_property_restrictions=None, trigger_condition_list=None, triggered_campaign_delay=None, listening_duration=-1, target_age_min=0, target_age_max=malaria_common.MAX_AGE_YEARS, target_gender='All', intervention_name='UsageDependentBednet', discard_config=None, insecticide='', repelling_initial_effect=0, repelling_box_duration=0, repelling_decay_time_constant=1460, blocking_initial_effect=0.9, blocking_box_duration=0, blocking_decay_time_constant=730, blocking_linear_times=None, blocking_linear_values=None, blocking_expire_at_end=0, killing_initial_effect=0, killing_box_duration=0, killing_decay_time_constant=1460, age_dependence=None, seasonal_dependence=None, dont_allow_duplicates=False)
Add an insecticide-treated net (ITN) intervention with a seasonal usage pattern to the campaign using the UsageDependentBednet class.
Note: for killing, blocking, repelling effects - depending on the parameters you set, different WaningEffect classes will be used: box_duration = -1 => WaningEffectConstant, decay_time_constant is ignored box_duration = 0 + decay_time_constant > 0 => WaningEffectExponential box_duration > 0 + decay_time_constant = 0 => WaningEffectBox box_duration > 0 + decay_time_constant > 0 => WaningEffectBoxExponential
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
campaign
|
EMODCampaign
|
campaign object to which the intervention will be added, and schema_path container |
required |
start_day
|
int
|
The day on which to start distributing the bednets (Start_Day parameter). |
1
|
demographic_coverage
|
float
|
This value is the probability that each individual in the target population will receive the intervention. It does not guarantee that the exact fraction of the target population set by Demographic_Coverage receives the intervention. |
1
|
node_ids
|
list
|
The list of nodes to apply this intervention to (Node_List parameter). If not provided, intervention is distributed to all nodes. |
None
|
ind_property_restrictions
|
list
|
A list of dictionaries of IndividualProperties, which are needed for the individual to receive the intervention. Sets the Property_Restrictions_Within_Node |
None
|
trigger_condition_list
|
list
|
(Optional) A list of the events that will trigger the ITN intervention. If included, start is the day when monitoring for triggers begins. |
None
|
triggered_campaign_delay
|
float
|
(Optional) Delay in days before the intervention is given out after being triggered. |
None
|
listening_duration
|
int
|
If run as a birth-triggered event or a trigger_condition_list, specifies the duration for the distribution to continue. Default is to continue until the end of the simulation. |
-1
|
target_age_min
|
float
|
The lower end of ages targeted for an intervention, in years. Sets Target_Age_Min |
0
|
target_age_max
|
float
|
The upper end of ages targeted for an intervention, in years. Sets Target_Age_Max |
MAX_AGE_YEARS
|
target_gender
|
str
|
The gender targeted for an intervention: All, Male, or Female. |
'All'
|
ind_property_restrictions
|
list
|
The IndividualProperty key:value pairs
that individuals must have to receive the intervention (
Property_Restrictions_Within_Node parameter). In the format |
None
|
intervention_name
|
str
|
The optional name used to refer to this intervention as a means to differentiate it from others that use the same class. It’s possible to have multiple UsageDependentBednets interventions attached to a person if they have different Intervention_Name values. |
'UsageDependentBednet'
|
discard_config
|
dict
|
A dictionary of parameters needed to define expiration distribution. No need to definite the distribution with all its parameters Default is bednet being discarded with EXPONENTIAL_DISTRIBUTION with Expiration_Period_Exponential of 10 years Examples:: |
None
|
insecticide
|
str
|
The name of the insecticide defined in |
''
|
repelling_initial_effect
|
float
|
Initial strength of the Repelling effect. The effect may decay over time. |
0
|
repelling_box_duration
|
int
|
Box duration of effect in days before the decay of Repelling Initial_Effect. |
0
|
repelling_decay_time_constant
|
float
|
The exponential decay length, in days of the Repelling Initial_Effect. |
1460
|
blocking_initial_effect
|
float
|
Initial strength of the Blocking effect. The effect may decay over time. |
0.9
|
blocking_box_duration
|
int
|
Box duration of effect in days before the decay of Blocking Initial_Effect. |
0
|
blocking_decay_time_constant
|
float
|
The exponential decay length, in days of the Blocking Initial_Effect. |
730
|
blocking_linear_times
|
list
|
An array of days that matches the defined linear values for Blocking Initial_Effect. |
None
|
blocking_linear_values
|
list
|
An array of multiplier values that matches the defined linear days for Blocking Initial_Effect. |
None
|
blocking_expire_at_end
|
int
|
Set to 1 to have efficacy go to zero and let the intervention expire when the end of the map is reached. Only vaccines and bednet usage currently support this expiration feature. defaults to 0. |
0
|
killing_initial_effect
|
float
|
Initial strength of the Killing effect. The effect may decay over time. |
0
|
killing_box_duration
|
int
|
Box duration of effect in days before the decay of Killing Initial_Effect. |
0
|
killing_decay_time_constant
|
float
|
The exponential decay length, in days of the Killing Initial_Effect. |
1460
|
age_dependence
|
dict
|
A dictionary defining the age dependence of net use. Must contain a list of ages in years and list of usage rate. Default is uniform across all ages. Times are in years of age |
None
|
seasonal_dependence
|
dict
|
A dictionary defining the seasonal dependence of net use. Time since start will reset to zero once it reaches 365. This allows you to simulate seasonal effects. Times are given in days of the year; values greater than 365 are ignored. Dictionaries can be (times, values) for linear spline or (minimum coverage, day of maximum coverage) for sinusoidal dynamics. Default is constant use during the year. |
None
|
dont_allow_duplicates
|
bool
|
Set to True to prevent individual from receiving another copy of the intervention. Default is False. |
False
|
Source code in emodpy_malaria/interventions/usage_dependent_bednet.py
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | |