Combo Overlay: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
Line 54: Line 54:


===Timeframes===
===Timeframes===
* To query a specific timeframe add its number. E.g. A2 queries timeframe 2 from Input Overlay A.
When an input Overlay has multiple [[Timeframe]]s, additional syntax is available to specify the intended timeframes.
* To query multiple timeframes add start:end numbers. E.g. A1:5 is identical to "A1 A2 A3 A4 A5". Note that this functionality creates individual arguments, and as such the function this is used in must permit sufficient arguments.
 
* When selecting an overlay as just "A" the last timeframe is selected by default.
{|class=wikitable
! Syntax
! Meaning
! Example
! Effect
|-
| A
| The (last) value from Overlay A
| MUL(A, 10)
| Assuming:
*A is a [[Water Overlay]] with [[Surface last value result type (Water Overlay)|Surface Last Value]] as result type
Will show the height of the water at the end of the calculation in cm (rather than m).
|-
| A2
| The third timeframe's value from Overlay A
| GT(A2, 38)
| Assuming:
*A is a [[Heat Overlay]] with [[Pet result type (Heat Overlay)|Physiological Equivalent Temperature]] as result type
Will indicate whether any given location is (1) or is not (0) hotter than 38 {{celsius}}, on the third computed timeframe of the [[Heat Overlay]].
|-
| A0:2
| The values from the first through third timeframes from Overlay A, as a list of inputs
| AVG(A0:2)
| Assuming:
*A is a [[Heat Overlay]] with [[Pet result type (Heat Overlay)|Physiological Equivalent Temperature]] as result type
Will show the average of the computed temperatures of the first three timeframes of the [[Heat Overlay]].
|-
| AT
| For each timeframe of the Combo Overlay, the value from that same timeframe from Overlay A, as individual inputs.
This will cause the Combo Overlay to have at least as many timeframes as Overlay A.
| MUL(AT, 10)
| Assuming:
*A is a [[Water Overlay]] with [[Surface last value result type (Water Overlay)|Surface Last Value]] as result type
Will show the height of the water at each timeframe of the [[Water Overlay]]'s calculations in cm (rather than m).
|}
 
A [[Combo Overlay]] automatically computes the amount of [[timeframe]]s it requires, based on whether (and which of) its input Overlays are references with a "T" syntax.


==Examples==
==Examples==

Revision as of 14:48, 19 January 2022

A combo overlay, combining a Rainfall Overlay with two Average Overlays (NORMAL and SOCIAL), using only the highest values in the last time frame.

The combo overlay is a Grid Overlay which can combine up to three Grid Overlays with boolean operators and use these overlays as input arguments functions and operators. The list of available functions and operators is given in the chapter below. Combo overlays can also take other combo overlays as input. Another powerful combination is the use of combo overlays with Average Overlays (with or without an average distance).

Operators

In the table below are the operators displayed that are supported by the combo overlay. The term argument refers to a grid overlay configured as input, a numerical value or a global name.

Input overlays and timeframes

  • Up to three overlays can be configured as input for the combo overlay. They are referenced as A, B and C.
  • You can use Globals in a formula.

Timeframes

When an input Overlay has multiple Timeframes, additional syntax is available to specify the intended timeframes.

Syntax Meaning Example Effect
A The (last) value from Overlay A MUL(A, 10) Assuming:

Will show the height of the water at the end of the calculation in cm (rather than m).

A2 The third timeframe's value from Overlay A GT(A2, 38) Assuming:

Will indicate whether any given location is (1) or is not (0) hotter than 38 °C, on the third computed timeframe of the Heat Overlay.

A0:2 The values from the first through third timeframes from Overlay A, as a list of inputs AVG(A0:2) Assuming:

Will show the average of the computed temperatures of the first three timeframes of the Heat Overlay.

AT For each timeframe of the Combo Overlay, the value from that same timeframe from Overlay A, as individual inputs.

This will cause the Combo Overlay to have at least as many timeframes as Overlay A.

MUL(AT, 10) Assuming:

Will show the height of the water at each timeframe of the Water Overlay's calculations in cm (rather than m).

A Combo Overlay automatically computes the amount of timeframes it requires, based on whether (and which of) its input Overlays are references with a "T" syntax.

Examples

How-to's

Videos

Example of the Combo overlay in the Tygron Platform. (In dutch)
Testing a parametric design on environmental criteria in the Tygron Platform. (In dutch)