BiteColonization Class
BiteColonization
Description
The colonization process is a series of “filters” - in order to successfully colonize a cell, the agent must pass all the filters:
| Filter | Description |
|---|---|
| active | no colonization if the agent is already present on the cell (implicit) |
| dispersalFilter | no colonization if there is no (or not enough) dispersal input |
| speciesFilter | no colonization if potential host tree species are not present (not implemented) |
| cellFilter | filter based on cell variables |
| treeFilter | filter based on tree properties |
| saplingFilter | filter based on sapling properties |
| onCalculate | Javascript event, that can prevent colonization |
Setup
dispersalFilter(dynamic expression)dispersalFilterhas access to cell variables; no colonization if the result of the expression is either 0, or “false”.cellFilter(dynamic expression) (optional)“Constraint” object, i.e. either 1 or more dynamic expressions. Access to cell variables. Multiple filters are combined multiplicatively and if the result is <1, then the value is interpreted as probability of passing the filter.
treeFilter(dynamic expression) (optional)“Constraint” object, i.e. either 1 or more dynamic expressions. Access to tree variables. The filter is passed if at least one tree on the cell evaluates to ‘true’.
See also saplingFilter. If a saplingFilter is present than colonization is possible when the tree- or the sapling filter is passed.
For example: treeFilter: 'species=piab and dbh>20' is passed if one tree with the specified properties exist on the cell (i.e., a spruce with a dbh >20cm)
A filter constraint with access to sapling variables. The filter is passed if at least one tree on the cell evaluates to ‘true’.saplingFilter(dynamic expression) (optional)
See also the treeFilter. If a treeFilter is present than colonization is possible when the tree- or the sapling filter is passed.
If a cell is colonied, the initial value for the variableinitialAgentBiomass(dynamic expression) (optional)agentBiomassis calculated with this dynamic expression. If provided, the variable is required (e.g. by a BiteBiomass item). The initial biomass is the sum over all trees (when an expression is used), or the result of the Javascript function (with the context of a cell). ## Properties
no properties.
Variables
no variables.
Events
TheonSetup(item)onSetupevent is triggered after the setup of the item.
item is the BiteColonization object.
called after all filters have been passed already. The cell is not colonized, if the function returnsonCalculate(cell)false.
cell is the Cell object.