Skip to content

spacespraying

add_scheduled_space_spraying(campaign, start_day=1, node_ids=None, repetitions=1, timesteps_between_repetitions=365, spray_coverage=1.0, insecticide='', killing_initial_effect=1, killing_box_duration=-1, killing_decay_time_constant=0, intervention_name=iv_name, cost_to_consumer=0)

Configures and adds a node-targeted SpaceSpraying intervention to the campaign.

For killing 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 the intervention is given out.

 1
node_ids list

List of nodes to which to distribute the intervention. [] or None, indicates all nodes will get the intervention.

 None
repetitions int

The number of times an intervention is given, used with timesteps_between_repetitions. -1 means the intervention repeats forever. Sets Number_Repetitions.

 1
timesteps_between_repetitions int

The interval, in timesteps, between repetitions. Ignored if repetitions = 1. Sets Timesteps_Between_Repetitions.

 365
spray_coverage float

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

 1.0
insecticide str

The name of the insecticide defined in for this intervention. If insecticides are being used, then this must be defined as one of those values. If they are not being used, then this does not needed to be specified or can be empty string. It cannot have a value if does not define anything.

 ''
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 is possible to have multiple SpaceSpraying interventions if they have different Intervention_Name values.

 iv_name
killing_initial_effect float

Initial strength of the Killing effect. The effect may decay over time.

 1
killing_box_duration float

Box duration of effect in days before the decay of killing_initial_effect. -1 indicates effect is indefinite (WaningEffectConstant).

 -1
killing_decay_time_constant float

The exponential decay length, in days of the killing_initial_effect.

 0
cost_to_consumer float

Per unit cost when distributed.

 0
Source code in emodpy_malaria/interventions/spacespraying.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def add_scheduled_space_spraying(
        campaign,
        start_day: int = 1,
        node_ids: list = None,
        repetitions: int = 1,
        timesteps_between_repetitions: int = 365,
        spray_coverage: float = 1.0,
        insecticide: str = "",
        killing_initial_effect: float = 1,
        killing_box_duration: float = -1,
        killing_decay_time_constant: float = 0,
        intervention_name: str = iv_name,
        cost_to_consumer: float = 0
):
    """
    Configures and adds a node-targeted **SpaceSpraying** intervention to the campaign.

    For killing effects - depending on the parameters you set,
    different **WaningEffect** classes will be used:<br>
        • box_duration = -1 => WaningEffectConstant, decay_time_constant is ignored<br>
        • box_duration = 0 + decay_time_constant > 0 => WaningEffectExponential<br>
        • box_duration > 0 + decay_time_constant = 0 => WaningEffectBox<br>
        • box_duration > 0 + decay_time_constant > 0 => WaningEffectBoxExponential<br>

    Args:
        campaign (emodpy.campaign.emod_campaign.EMODCampaign): campaign object to which the intervention will be added, and schema_path container
        start_day (int): The day the intervention is given out.
        node_ids (list): List of nodes to which to distribute the intervention. [] or None, indicates all nodes
            will get the intervention.
        repetitions (int): The number of times an intervention is given, used with timesteps_between_repetitions. -1 means
            the intervention repeats forever. Sets **Number_Repetitions**.
        timesteps_between_repetitions (int): The interval, in timesteps, between repetitions. Ignored if repetitions = 1.
            Sets **Timesteps_Between_Repetitions**.
        spray_coverage (float): The portion of the node that has been sprayed. This value is multiplied by the current
            efficacy of the **WaningEffect**.
        insecticide (str): The name of the insecticide defined in <config.Insecticides> for this intervention.
            If insecticides are being used, then this must be defined as one of those values. If they are not
            being used, then this does not needed to be specified or can be empty string. It cannot have a
            value if <config.Insecticides> does not define anything.
        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 is possible to have multiple **SpaceSpraying** interventions
            if they have different **Intervention_Name** values.
        killing_initial_effect (float): Initial strength of the Killing effect. The effect may decay over time.
        killing_box_duration (float): Box duration of effect in days before the decay of **killing_initial_effect**.
            -1 indicates effect is indefinite (WaningEffectConstant).
        killing_decay_time_constant (float): The exponential decay length, in days of the **killing_initial_effect**.
        cost_to_consumer (float): Per unit cost when distributed.

    """
    node_intervention = _space_spraying(campaign=campaign,
                                        spray_coverage=spray_coverage,
                                        insecticide=insecticide,
                                        intervention_name=intervention_name,
                                        killing_initial_effect=killing_initial_effect,
                                        killing_box_duration=killing_box_duration,
                                        killing_decay_time_constant=killing_decay_time_constant,
                                        cost_to_consumer=cost_to_consumer)
    add_campaign_event(campaign=campaign,
                       start_day=start_day,
                       node_ids=node_ids,
                       repetitions=repetitions,
                       timesteps_between_repetitions=timesteps_between_repetitions,
                       node_intervention=node_intervention)

new_intervention_as_file(campaign, start_day=0, filename='SpaceSpraying.json')

Creates a file with SpaceSpraying intervention.

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 to distribute the SpaceSpraying intervention

 0
filename str

name of the filename created.

 'SpaceSpraying.json'

Returns:

Type Description
str

filename of the file created.
Source code in emodpy_malaria/interventions/spacespraying.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def new_intervention_as_file(campaign, start_day: int = 0, filename: str = "SpaceSpraying.json"):
    """
    Creates a file with **SpaceSpraying** intervention.

    Args:
        campaign (emodpy.campaign.emod_campaign.EMODCampaign): campaign object to which the intervention will be added, and schema_path container
        start_day (int): the day to distribute the **SpaceSpraying** intervention
        filename (str): name of the filename created.

    Returns:
        (str): filename of the file created.
    """
    add_scheduled_space_spraying(campaign=campaign, start_day=start_day)
    campaign.save(filename)
    return filename