SugarTrap#

The SugarTrap intervention class implements a vector sugar-baited trap to collect/kill sugar-feeding mosquitoes and is sometimes called an attractive toxic sugar bait (ATSB). This intervention affects all mosquitoes living and feeding at a given node. Male vectors sugar-feed daily and female vectors sugar-feed once per blood meal (or upon emergence), so these traps can impact male survival on a daily basis. Efficacy can be modified using per-sex insecticide resistance.

The impact of sugar-baited traps will depend on the sugar-feeding behavior specified in the configuration file via Vector_Sugar_Feeding_Frequency, whether there is no sugar feeding, sugar feeding occurs once at emergence, sugar feeding occurs once per blood meal, or sugar feeding occurs every day. Note that if it is set to VECTOR_SUGAR_FEEDING_NONE, this intervention will have no effect. See Vector control configuration parameters for more information.

At a glance:

  • Distributed to: Nodes

  • Serialized: No. It will need to be redistributed when starting from a serialized file.

  • Uses insecticides: Yes. It can target sub-groups using genomes or specific sexes.

  • Time-based expiration: Yes. Expiration time can be specified using specific distributions.

  • Purge existing: Yes. If a new intervention is added to to the node, the existing intervention of the same name is removed when the new one is added.

  • Vector killing contributes to: Sugar Trap Killing

  • Vector effects: Killing

  • Vector sexes affected: Males and females

  • Vector life stage affected: Adult and immature when they are emerging (if configured)

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

10

The unit cost per vector control (unamortized).

{
  "Cost_To_Consumer": 9.0
}

Disqualifying_Properties

array of strings

NA

NA

[]

A list of NodeProperty 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"
  ]
}

Expiration_Constant

float

0

3.4E+38

6

Each instance will receive this constant/fixed value, in days, for expiration of the trap when Expiration_Distribution is set to CONSTANT_DISTRIBUTION.

{
  "Expiration_Distribution": "CONSTANT_DISTRIBUTION",
  "Expiration_Constant": 8
}

Expiration_Distribution

enum

NA

NA

NOT_INTIIALIZED

The distribution type to use for setting the expiration of the trap. Each assigned value is a random draw from the distribution. Possible values are:

NOT_INITIALIZED

No distribution set.

CONSTANT_DISTRIBUTION

Use the same value for each individual. Set Expiration_Constant.

UNIFORM_DISTRIBUTION

Use a uniform distribution with a given minimum and maximum. Set Expiration_Max and Expiration_Min.

GAUSSIAN_DISTRIBUTION

The distribution is Gaussian (or normal). Values are resampled to ensure >= 0. Set Expiration_Gaussian_Mean and Expiration_Gaussian_Std_Dev.

EXPONENTIAL_DISTRIBUTION

The distribution is exponential with a given mean. Set Expiration_Exponential.

WEIBULL_DISTRIBUTION

Use a Weibull distribution with a given shape and scale. Set Expiration_Kappa and Expiration_Lambda.

LOG_NORMAL_DISTRIBUTION

Use a log-normal distribution with a given mean and standard deviation of the natural log. Set Expiration_Log_Normal_Mu and Expiration_Log_Normal_Sigma.

POISSON_DISTRIBUTION

Use a Poisson distribution with a given mean. Set Expiration_Poisson_Mean.

DUAL_CONSTANT_DISTRIBUTION

Use a distribution where some individuals are set to a value of zero and the rest to a given value. Set Expiration_Proportion_0 and Expiration_Peak_2_Value. This distribution does not use the parameters set for CONSTANT_DISTRIBUTION.

DUAL_EXPONENTIAL_DISTRIBUTION

Use two exponential distributions with given means. Set Expiration_Mean_1, Expiration_Mean_2, and Expiration_Proportion_1. This distribution does not use the parameters set for EXPONENTIAL_DISTRIBUTION.

{
  "Expiration_Distribution": "GAUSSIAN_DISTRIBUTION",
  "Expiration_Gaussian_Mean": 4,
  "Expiration_Gaussian_Std_Dev": 1
}

Expiration_Exponential

float

0

3.4E+38

6

The mean expiration time of the trap, in days, when Expiration_Distribution is set to EXPONENTIAL_DISTRIBUTION.

{
  "Expiration_Distribution": "EXPONENTIAL_DISTRIBUTION",
  "Expiration_Exponential": 4.25
}

Expiration_Gaussian_Std_Dev

float

1.18E-38

3.4E+38

1

The standard deviation of the expiration time of the trap, in days, when Expiration_Distribution is set to GAUSSIAN_DISTRIBUTION.

{
  "Expiration_Distribution": "GAUSSIAN_DISTRIBUTION",
  "Expiration_Gaussian_Mean": 4,
  "Expiration_Gaussian_Std_Dev": 1
}

Expiration_Guassian_Mean

float

0

3.4E+38

6

The mean expiration time of the trap, in days, when Expiration_Distribution is set to GAUSSIAN_DISTRIBUTION.

{
  "Expiration_Distribution": "GAUSSIAN_DISTRIBUTION",
  "Expiration_Gaussian_Mean": 4,
  "Expiration_Gaussian_Std_Dev": 1
}

Expiration_Kappa

float

1.18E-38

3.4E+38

1

The shape value for the expiration time of the trap, in days, when Expiration_Distribution is set to WEIBULL_DISTRIBUTION.

{
  "Expiration_Distribution": "WEIBULL_DISTRIBUTION",
  "Expiration_Kappa": 0.9,
  "Expiration_Lambda": 1.5
}

Expiration_Lambda

float

1.18E-38

3.4E+38

1

The scale value for the expriation time of the trap, in days, when Expiration_Distribution is set to WEIBULL_DISTRIBUTION.

{
  "Expiration_Distribution": "WEIBULL_DISTRIBUTION",
  "Expiration_Kappa": 0.9,
  "Expiration_Lambda": 1.5
}

Expiration_Log_Normal_Mu

float

-3.40E+38

3.4E+38

6

The mean of the natural log of the expiration time of the trap, in days, when Expiration_Distribution is set to LOG_NORMAL_DISTRIBUTION.

{
  "Expiration_Distribution": "LOG_NORMAL_DISTRIBUTION",
  "Expiration_Log_Normal_Mu": 9,
  "Expiration_Log_Normal_Sigma": 2
}

Expiration_Log_Normal_Sigma

float

-3.40E+38

3.4E+38

1

The standard deviation of the natural log of the expiration time of the trap, in days, when Expiration_Distribution is set to LOG_NORMAL_DISTRIBUTION.

{
  "Expiration_Distribution": "LOG_NORMAL_DISTRIBUTION",
  "Expiration_Log_Normal_Mu": 9,
  "Expiration_Log_Normal_Sigma": 2
}

Expiration_Max

float

0

3.4E+38

1

The maximum time to expiration of the trap, in days, when Expiration_Distribution is set to UNIFORM_DISTRIBUTION.

{
  "Expiration_Distribution": "UNIFORM_DISTRIBUTION",
  "Expiration_Min": 2,
  "Expiration_Max": 7
}

Expiration_Mean_1

float

1.18E-38

3.4E+38

1

The mean of the first exponential distribution in days, when Exponential_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.

{
  "Expiration_Distribution": "DUAL_EXPONENTIAL_DISTRIBUTION",
  "Expiration_Mean_1": 4,
  "Expiration_Mean_2": 12,
  "Expiration_Proportion_1": 0.2
}

Expiration_Mean_2

float

1.18E-38

3.4E+38

1

The mean of the second exponential distribution in days, when Exponential_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.

{
  "Expiration_Distribution": "DUAL_EXPONENTIAL_DISTRIBUTION",
  "Expiration_Mean_1": 4,
  "Expiration_Mean_2": 12,
  "Expiration_Proportion_1": 0.2
}

Expiration_Min

float

0

3.4E+38

0

The minimum time to expiration of the trap, in days, when Expiration_Distribution is set to UNIFORM_DISTRIBUTION.

{
  "Expiration_Distribution": "UNIFORM_DISTRIBUTION",
  "Expiration_Min": 2,
  "Expiration_Max": 7
}

Expiration_Peak_2_Value

float

0

3.4E+38

1

The expiration value, in days, to assign to the remaining traps when Expiration_Distribution is set to DUAL_CONSTANT_DISTRIBUTION.

{
  "Expiration_Distribution": "DUAL_CONSTANT_DISTRIBUTION",
  "Expiration_Proportion_0": 0.25,
  "Expiration_Peak_2_Value": 5
}

Expiration_Poisson_Mean

float

0

3.4E+38

6

The mean of the expiration time of the trap, in days, when Expiration_Distribution is set to POISSON_DISTRIBUTION.

{
  "Expiration_Distribution": "POISSON_DISTRIBUTION",
  "Expiration_Poisson_Mean": 5
}

Expiration_Proportion_0

float

0

1

1

The proportion of traps to assign a value of zero days to expiration when Expiration_Distribution is set to DUAL_CONSTANT_DISTRIBUTION.

{
  "Expiration_Distribution": "DUAL_CONSTANT_DISTRIBUTION",
  "Expiration_Proportion_0": 0.25,
  "Expiration_Peak_2_Value": 5
}

Expiration_Proportion_1

float

0

1

1

The proportion of traps in the first exponential distribution when Expiration_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.

{
  "Expiration_Distribution": "DUAL_EXPONENTIAL_DISTRIBUTION",
  "Expiration_Mean_1": 4,
  "Expiration_Mean_2": 12,
  "Expiration_Proportion_1": 0.2
}

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

SugarTrap

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": "SugarTrap",
    "Intervention_Name": "Mosquito sugar feeding, nationwide campaign"
  }
}

Killing_Config

json object

NA

NA

NA

The configuration for the effects of killing of the targeted stage. Specify how this effect decays over time using one of the Waning effect classes.

{
  "Killing_Config": {
    "Box_Duration": 3650,
    "Initial_Effect": 0.5,
    "class": "WaningEffectBox"
  }
}

New_Property_Value

string

NA

NA

“”

An optional NodeProperty key:value pair that will be assigned when the intervention is applied. See NodeProperties and IndividualProperties parameters for more information.

{
  "New_Property_Value": "HasHealthCare:YES"
}
{
    "Events": [{
        "class": "CampaignEvent",
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Start_Day": 1460,
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Target_Demographic": "Everyone",
            "Intervention_Config": {
                "class": "SugarTrap",
                "Cost_To_Consumer": 3.75,
                "Killing_Config": {
                    "class": "WaningEffectExponential",
                    "Decay_Time_Constant": 2190,
                    "Initial_Effect": 0.1
                },
                "Expiration_Distribution": "CONSTANT_DISTRIBUTION",
                "Expiration_Constant": 360
            }
        }
    }],
    "Use_Defaults": 1
}