ScaleLarvalHabitat#

The ScaleLarvalHabitat intervention class is a node-level intervention that enables species-specific habitat modification within shared habitat types. This intervention has a similar function to the demographic parameter ScaleLarvalMultiplier, but enables habitat availability to be modified at any time or at any location during the simulation, as specified in the campaign event.

To reset the multiplier, you must either replace the existing one with a new intervention where the multiplier/factor is 1.0 or use the Disqualifying_Properties to cause the intervention to abort.

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

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"
  ]
}

Factor

float

0

3.40E+38

1

The multiplier by which to scale the larval habitat availability.

 
{
  "LarvalHabitatMultiplier": [
    {
      "Factor": 0.01,
      "Habitat": "TEMPORARY_RAINFALL",
      "Species": "gambiae"
    }
  ]
}

Habitat

enum

NA

NA

NONE

The name of the habitat for which to specify a larval habitat multiplier. See Larval habitat parameters for more information. Possible values are:

  • NONE (default but not allowed; it must be configured to a habitat type)

  • TEMPORARY_RAINFALL

  • WATER_VEGETATION

  • MARSHY_STREAM

  • HUMAN_POPULATION

  • CONSTANT

  • BRACKISH_SWAMP

  • LINEAR_SPLINE

  • ALL_HABITATS

 
{
  "Habitat": "BRACKISH_SWAMP"
}

Intervention_Name

string

NA

NA

ScaleLarvalHabitat

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": "ScaleLarvalHabitat",
    "Intervention_Name": "Reduce habitat for Aedes aegypti"
  }
}

Larval_Habitat_Multiplier

array of json objects

NA

NA

NA

The value by which to scale the larval habitat availability (specified in Habitats in the configuration file) per intervention, across all habitat types, for specific habitat types, or for specific mosquito species within each habitat type. See Larval habitat parameters for more information.

The following example scales the larval habitat equally across all habitat types and mosquito species.

{
  "LarvalHabitatMultiplier": [
    {
      "Factor": 0.02,
      "Habitat": "ALL_HABITATS",
      "Species": "ALL_SPECIES"
    }
  ]
}

The following example scales the larval habitat only in the temporary rainfall habitat for all mosquito species.

{
  "LarvalHabitatMultiplier": [
    {
      "Factor": 0.02,
      "Habitat": "TEMPORARY_RAINFALL",
      "Species": "ALL_SPECIES"
    }
  ]
}

The following example scales the larval habitat independently for A. gambiae in the temporary rainfall habitat and for A. arabiensis in the brackish swamp habitat.

{
  "LarvalHabitatMultiplier": [
    {
      "Factor": 0.01,
      "Habitat": "TEMPORARY_RAINFALL",
      "Species": "gambiae"
    },
    {
      "Factor": 0.02,
      "Habitat": "BRACKISH_SWAMP",
      "Species": "arabiensis"
    }
  ]
}

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"
}

Species

string

NA

NA

ALL_SPECIES

The name of the species for which to specify a larval habitat multiplier. This must be one of the names specified in the configuration parameter Vector_Species_Params or set to ALL_SPECIES.

 
{
  "Species": "arabiensis"
}

{
  "Use_Defaults": 1,
  "Events": [
    {
      "class": "CampaignEvent",
      "Nodeset_Config": {
        "class": "NodeSetAll"
      },
      "Start_Day": 730,
      "Event_Coordinator_Config": {
        "Intervention_Config": {
          "Larval_Habitat_Multiplier": {
            "LarvalHabitatMultiplier": [
              {
                "Factor": 0.05,
                "Habitat": "CONSTANT",
                "Species": "Gambiae"
              },
              {
                "Factor": 0.05,
                "Habitat": "TEMPORARY_RAINFALL",
                "Species": "ALL_SPECIES"
              }
            ]
          },
          "class": "ScaleLarvalHabitat"
        },
        "class": "StandardInterventionDistributionEventCoordinator"
      }
    }
  ]
}