Skip to content

waning_config

InsecticideWaningEffect

Defines insecticide waning effects for use in multi-insecticide interventions. Each instance pairs an insecticide name with one or more waning effect configurations for killing, repelling, and/or blocking.

The class automatically determines the correct EMOD schema type based on which configs are provided:

Parameters:

Name Type Description Default
campaign (api_campaign, required)

An instance of the emod_api.campaign module.

 required
killing_config (AbstractWaningConfig, required)

The waning effect configuration for insecticidal killing efficacy. Specify how this effect decays over time using one of the waning effect classes in Waning Effects.

 required
repelling_config AbstractWaningConfig

The waning effect configuration for repelling efficacy. A vector is repelled before any blocking or killing can occur. Repelled vectors survive and do not attempt to feed again until the following day. Required for IRS and bednet multi-insecticide interventions. Default value: None

 None
blocking_config AbstractWaningConfig

The waning effect configuration for blocking efficacy. Blocking probabilities are applied to the subset of meal-seeking mosquitoes that have not been repelled. A vector must be blocked before it can be killed. Required for bednet multi-insecticide interventions. Cannot be provided without repelling_config. Default value: None

 None
insecticide_name str

The name of the insecticide defined via malaria_config.add_insecticide_resistance() in the config builder. If insecticides are being used, this must match one of those values. It cannot have a value if you did not configure insecticide resistance. See Insecticide Resistance and Vector Genetics for details. Default value: None

 None
Source code in emodpy_malaria/campaign/waning_config.py 
  7
  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
 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
class InsecticideWaningEffect:
    """
    Defines insecticide waning effects for use in multi-insecticide interventions. Each
    instance pairs an insecticide name with one or more waning effect configurations for
    killing, repelling, and/or blocking.

    The class automatically determines the correct EMOD schema type based on which
    configs are provided:

    * **killing only** → used by
      [MultiInsecticideSpaceSpraying](https://emod.idmod.org/emodpy-malaria/autoapi/emodpy_malaria/campaign/node_intervention/)
      and
      [MultiInsecticideIndoorSpaceSpraying](https://emod.idmod.org/emodpy-malaria/autoapi/emodpy_malaria/campaign/node_intervention/)
    * **killing + repelling** → used by
      [MultiInsecticideIRSHousingModification](https://emod.idmod.org/emodpy-malaria/autoapi/emodpy_malaria/campaign/individual_intervention/)
    * **killing + repelling + blocking** → used by
      [MultiInsecticideUsageDependentBednet](https://emod.idmod.org/emodpy-malaria/autoapi/emodpy_malaria/campaign/individual_intervention/)

    Args:
        campaign (api_campaign, required):
            An instance of the emod_api.campaign module.

        killing_config (AbstractWaningConfig, required):
            The waning effect configuration for insecticidal killing efficacy. Specify how
            this effect decays over time using one of the waning effect classes in
            [Waning Effects](https://emod.idmod.org/emodpy-malaria/autoapi/emodpy_malaria/campaign/waning_config/).

        repelling_config (AbstractWaningConfig, optional):
            The waning effect configuration for repelling efficacy. A vector is repelled
            before any blocking or killing can occur. Repelled vectors survive and do not
            attempt to feed again until the following day. Required for IRS and bednet
            multi-insecticide interventions.
            Default value: None

        blocking_config (AbstractWaningConfig, optional):
            The waning effect configuration for blocking efficacy. Blocking probabilities
            are applied to the subset of meal-seeking mosquitoes that have not been
            repelled. A vector must be blocked before it can be killed. Required for bednet
            multi-insecticide interventions. Cannot be provided without ``repelling_config``.
            Default value: None

        insecticide_name (str, optional):
            The name of the insecticide defined via
            ``malaria_config.add_insecticide_resistance()`` in the config builder. If
            insecticides are being used, this must match one of those values. It cannot have
            a value if you did not configure insecticide resistance. See
            [Insecticide Resistance](https://emod.idmod.org/emodpy-malaria/emod/vector-model-insecticide-resistance/)
            and [Vector Genetics](https://emod.idmod.org/emodpy-malaria/emod/vector-model-genetics/) for details.
            Default value: None
    """

    _VARIANT_SCHEMA = {
        "K": "idmType:InsecticideWaningEffect_K",
        "RK": "idmType:InsecticideWaningEffect_RK",
        "RBK": "idmType:InsecticideWaningEffect_RBK",
    }

    def __init__(self, campaign,
                 killing_config: AbstractWaningConfig,
                 repelling_config: AbstractWaningConfig = None,
                 blocking_config: AbstractWaningConfig = None,
                 insecticide_name: str = None):
        if not isinstance(killing_config, AbstractWaningConfig):
            raise ValueError(
                f"'killing_config' must be an AbstractWaningConfig instance, "
                f"got {type(killing_config).__name__}.")
        if blocking_config is not None and repelling_config is None:
            raise ValueError(
                "'blocking_config' requires 'repelling_config'. Blocking is applied to "
                "vectors that were not repelled, so both must be specified together.")
        if repelling_config is not None and not isinstance(repelling_config, AbstractWaningConfig):
            raise ValueError(
                f"'repelling_config' must be an AbstractWaningConfig instance, "
                f"got {type(repelling_config).__name__}.")
        if blocking_config is not None and not isinstance(blocking_config, AbstractWaningConfig):
            raise ValueError(
                f"'blocking_config' must be an AbstractWaningConfig instance, "
                f"got {type(blocking_config).__name__}.")

        self._campaign = campaign
        self._killing_config = killing_config
        self._repelling_config = repelling_config
        self._blocking_config = blocking_config
        self._insecticide_name = insecticide_name

        if blocking_config is not None:
            self._variant = "RBK"
        elif repelling_config is not None:
            self._variant = "RK"
        else:
            self._variant = "K"

    @property
    def variant(self) -> str:
        """The EMOD schema variant: ``"K"``, ``"RK"``, or ``"RBK"``."""
        return self._variant

    def require_variant(self, expected: str, intervention_name: str):
        """Validates that this effect has the correct variant for the consuming intervention.

        Args:
            expected: The required variant (``"K"``, ``"RK"``, or ``"RBK"``).
            intervention_name: Name of the intervention, used in the error message.

        Raises:
            ValueError: If the variant does not match.
        """
        if self._variant != expected:
            parts = {"K": "killing", "RK": "repelling + killing",
                     "RBK": "repelling + blocking + killing"}
            raise ValueError(
                f"{intervention_name} requires InsecticideWaningEffect with "
                f"{parts[expected]} configs (variant '{expected}'), but got variant "
                f"'{self._variant}' ({parts[self._variant]}).")

    def to_schema_dict(self) -> s2c.ReadOnlyDict:
        obj = s2c.get_class_with_defaults(
            self._VARIANT_SCHEMA[self._variant], schema_json=self._campaign.get_schema())
        obj.Killing_Config = self._killing_config.to_schema_dict(self._campaign)
        if self._repelling_config is not None:
            obj.Repelling_Config = self._repelling_config.to_schema_dict(self._campaign)
        if self._blocking_config is not None:
            obj.Blocking_Config = self._blocking_config.to_schema_dict(self._campaign)
        if self._insecticide_name is not None:
            obj.Insecticide_Name = self._insecticide_name
        obj.pop("schema", None)
        obj.pop("explicits", None)
        return obj

variant property

The EMOD schema variant: "K", "RK", or "RBK".

require_variant(expected, intervention_name)

Validates that this effect has the correct variant for the consuming intervention.

Parameters:

Name Type Description Default
expected str

The required variant ("K", "RK", or "RBK").

 required
intervention_name str

Name of the intervention, used in the error message.

 required

Raises:

Type Description
ValueError

If the variant does not match.
Source code in emodpy_malaria/campaign/waning_config.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def require_variant(self, expected: str, intervention_name: str):
    """Validates that this effect has the correct variant for the consuming intervention.

    Args:
        expected: The required variant (``"K"``, ``"RK"``, or ``"RBK"``).
        intervention_name: Name of the intervention, used in the error message.

    Raises:
        ValueError: If the variant does not match.
    """
    if self._variant != expected:
        parts = {"K": "killing", "RK": "repelling + killing",
                 "RBK": "repelling + blocking + killing"}
        raise ValueError(
            f"{intervention_name} requires InsecticideWaningEffect with "
            f"{parts[expected]} configs (variant '{expected}'), but got variant "
            f"'{self._variant}' ({parts[self._variant]}).")