Combo Overlay: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(62 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[File:Combo_overlay_example1.jpg|thumb|250px|left|A Combo Overlay, combining a [[Rainfall Overlay]] with two [[Average Overlay]]s (NORMAL and SOCIAL), using only the highest values in the last time frame.]]


[[File:Combo_overlay_example.jpg|thumb|250px|left|The combo overlay, displaying only the values that are greater than a given value.]]
The Combo Overlay is a [[Grid Overlay]] which can be used to create additional spatial calculation models. Up to three [[prequel|input Overlay]]s can be selected which serve as input for the calculations. A large set of functions and operators are available which can then perform the desired computations.
The combo overlay is an overlay which can combine up to three [[Grid Overlay| grid overlays]] with boolean operators and use these overlays as input arguments functions and operators. The list of available functions and operators is given below. Combo overlays can also take other combo overlays as input. Another powerful combination is the use of combo overlays with [[Average Overlay|average overlays]] (with or without an average distance).
 
<br clear=all>
Combo Overlays can take any [[Grid Overlay]] as [[prequel|input]]. It is often combined with one or more [[Average Overlay]]s or [[Travel Distance Overlay]]s. The Combo Overlay can also use the results of more complex calculation models, such as the [[Water Overlay]] or the [[Heat Overlay]] to further process the computed results of those models. Finally, Combo Overlays can also refer to other Combo Overlays, to create even more powerful, varied, and complex spatial calculation models.  
 
{{clear}}


==Operators==
==Operators==
Line 8: Line 11:


{{Combo operators|suppresscategory=true|allowselflinks=true|
{{Combo operators|suppresscategory=true|allowselflinks=true|
{{Combo operators|type=row|combo_operator=SIN   | |category=Single |type=Function  |display=Sine function}}
 
{{Combo operators|type=row|combo_operator=COS   | |category=Single |type=Function  |display=Cosine function}}
{{Combo operators|type=row| combo_operator=SIN     | |category=Single   |combo_type=Function  |display=Sine function}}
{{Combo operators|type=row|combo_operator=TAN   | |category=Single |type=Function  |display=Tangent function}}
{{Combo operators|type=row| combo_operator=COS     | |category=Single   |combo_type=Function  |display=Cosine function}}
{{Combo operators|type=row|combo_operator=ASIN   | |category=Single |type=Function  |display=Arc sine function}}
{{Combo operators|type=row| combo_operator=TAN     | |category=Single   |combo_type=Function  |display=Tangent function}}
{{Combo operators|type=row|combo_operator=ACOS   | |category=Single |type=Function  |display=Arc cosine function}}
{{Combo operators|type=row| combo_operator=ASIN   | |category=Single   |combo_type=Function  |display=Arc sine function}}
{{Combo operators|type=row|combo_operator=ATAN   | |category=Single |type=Function  |display=Arc tangent function}}
{{Combo operators|type=row| combo_operator=ACOS   | |category=Single   |combo_type=Function  |display=Arc cosine function}}
{{Combo operators|type=row|combo_operator=ROUND | |category=Single |type=Function  |display=Round function}}
{{Combo operators|type=row| combo_operator=ATAN   | |category=Single   |combo_type=Function  |display=Arc tangent function}}
{{Combo operators|type=row|combo_operator=FLOOR | |category=Single |type=Function  |display=Floor function}}
{{Combo operators|type=row| combo_operator=ROUND   | |category=Single   |combo_type=Function  |display=Round function}}
{{Combo operators|type=row|combo_operator=CEIL   | |category=Single |type=Function  |display=Ceil function}}
{{Combo operators|type=row| combo_operator=FLOOR   | |category=Single   |combo_type=Function  |display=Floor function}}
{{Combo operators|type=row|combo_operator=ABS   | |category=Single |type=Function  |display=Absolute function}}
{{Combo operators|type=row| combo_operator=CEIL   | |category=Single   |combo_type=Function  |display=Ceil function}}
{{Combo operators|type=row|combo_operator=EXP   | |category=Single |type=Function  |display=Exponential function}}
{{Combo operators|type=row| combo_operator=ABS     | |category=Single   |combo_type=Function  |display=Absolute function}}
{{Combo operators|type=row|combo_operator=LN     | |category=Single |type=Function  |display=The natural logarithm (base e) function}}
{{Combo operators|type=row| combo_operator=EXP     | |category=Single   |combo_type=Function  |display=Exponential function}}
{{Combo operators|type=row|combo_operator=LOG   | |category=Single |type=Function  |display=The natural logarithm (base 10) function}}
{{Combo operators|type=row| combo_operator=LN     | |category=Single   |combo_type=Function  |display=The natural logarithm (base e) function}}
{{Combo operators|type=row|combo_operator=SQRT   | |category=Single |type=Function  |display=The square root function}}
{{Combo operators|type=row| combo_operator=LOG     | |category=Single   |combo_type=Function  |display=The natural logarithm (base 10) function}}
{{Combo operators|type=row|combo_operator=RANDOM | |category=Single |type=Function  |display=The random function, which returns a number greater than or equal to 0.0 and less than 1.0 }}
{{Combo operators|type=row| combo_operator=SQRT   | |category=Single   |combo_type=Function  |display=The square root function}}
{{Combo operators|type=row|combo_operator=ADD   | |category=Multi |type=Operator  |display=Add one or more argument}}
{{Combo operators|type=row| combo_operator=RANDOM | |category=Single   |combo_type=Function  |display=The random function, which returns a number greater than or equal to 0.0 and less than the provided argument}}
{{Combo operators|type=row|combo_operator=MULT   | |category=Multi |type=Operator  |display=Multiply one or more arguments}}
 
{{Combo operators|type=row|combo_operator=SUB   | |category=Multi |type=Operator  |display=Subtract one or argument from the first argument}}
{{Combo operators|type=row| combo_operator=ERF    | |category=Single  |combo_type=Function  |display=The gauss error function, for probability calculations.}}
{{Combo operators|type=row|combo_operator=DIV   | |category=Multi |type=Operator  |display=Divide the first argument with one or more other arguments}}
 
{{Combo operators|type=row|combo_operator=MIN   | |category=Multi |type=Function  |display=Returns the smallest of the provided arguments. That is, the result is the argument closest to negative infinity.}}
{{Combo operators|type=row| combo_operator=ADD     | |category=Multi   |combo_type=Operator  |display=Add one or more argument}}
{{Combo operators|type=row|combo_operator=MAX   | |category=Multi |type=Function  |display=Returns the largest of the provided arguments. That is, the result is the argument closest to positive infinity.}}
{{Combo operators|type=row| combo_operator=MULT   | |category=Multi   |combo_type=Operator  |display=Multiply one or more arguments}}
{{Combo operators|type=row|combo_operator=POW    | |category=Multi  |type=Function  |display=Raises the first argument to the power of the consecutive arguments. For example 2 to the power 3 to the power 4.}}
{{Combo operators|type=row| combo_operator=SUB     | |category=Multi   |combo_type=Operator  |display=Subtract one or more arguments from the first argument}}
{{Combo operators|type=row|combo_operator=OR    | |category=Multi  |type=Boolean  |display=Returns 1.0 if any argument is not equal to 0.0.}}
{{Combo operators|type=row| combo_operator=DIV     | |category=Multi   |combo_type=Operator  |display=Divide the first argument with one or more other arguments}}
{{Combo operators|type=row|combo_operator=AND    | |category=Multi |type=Boolean  |display=Returns 1.0 if all arguments are not equal to 0.0.}}
 
{{Combo operators|type=row|combo_operator=GTE   | |category=Pair   |type=Boolean  |display=Returns 1.0 if the first argument is larger than or equal to the second argument, else returns 0.0.}}
{{Combo operators|type=row| combo_operator=MIN     | |category=Multi   |combo_type=Function  |display=Returns the smallest of the provided arguments. That is, the result is the argument closest to negative infinity.}}
{{Combo operators|type=row|combo_operator=GT     | |category=Pair   |type=Boolean  |display=Returns 1.0 if the first argument is larger than the second argument, else returns 0.0.}}
{{Combo operators|type=row| combo_operator=MAX     | |category=Multi   |combo_type=Function  |display=Returns the largest of the provided arguments. That is, the result is the argument closest to positive infinity.}}
{{Combo operators|type=row|combo_operator=LTE   | |category=Pair   |type=Boolean  |display=Returns 1.0 if the first argument is smaller than or equal to the second argument, else returns 0.0.}}
{{Combo operators|type=row| combo_operator=AVG    | |category=Multi   |combo_type=Function |display=Returns the [https://en.wikipedia.org/wiki/Arithmetic_mean arithmetic mean] of the provided arguments.}}
{{Combo operators|type=row|combo_operator=LT     | |category=Pair   |type=Boolean  |display=Returns 1.0 if the first argument is smaller than the second argument, else returns 0.0.}}
{{Combo operators|type=row| combo_operator=POW    | |category=Multi    |combo_type=Function  |display=Raises the first argument to the power of the consecutive arguments. For example 2 to the power 3 to the power 4.}}
{{Combo operators|type=row|combo_operator=NEQ   | |category=Pair   |type=Boolean  |display=Returns 1.0 if the first argument is not equal to the second argument, else returns 0.0.}}
 
{{Combo operators|type=row|combo_operator=EQ     | |category=Pair   |type=Boolean  |display=Returns 1.0 if the first argument is equal to second argument, else returns 0.0.}}
{{Combo operators|type=row| combo_operator=IF      | |category=Multi   |combo_type=Function |display=Takes 3 arguments. If first argument is true (numerical value exactly 1), it returns the second argument, else it returns the third argument.}}
{{Combo operators|type=row| combo_operator=AND    | |category=Multi    |combo_type=Boolean  |display=Returns 1.0 if all arguments are not equal to 0.0.}}
{{Combo operators|type=row| combo_operator=OR      | |category=Multi   |combo_type=Boolean  |display=Returns 1.0 if any argument is not equal to 0.0.}}
 
 
 
{{Combo operators|type=row| combo_operator=GTE               | |category=Pair     |combo_type=Boolean  |display=Returns 1.0 if the first argument is larger than or equal to the second argument, else returns 0.0.}}
{{Combo operators|type=row| combo_operator=GT                 | |category=Pair     |combo_type=Boolean  |display=Returns 1.0 if the first argument is larger than the second argument, else returns 0.0.}}
{{Combo operators|type=row| combo_operator=LTE               | |category=Pair     |combo_type=Boolean  |display=Returns 1.0 if the first argument is smaller than or equal to the second argument, else returns 0.0.}}
{{Combo operators|type=row| combo_operator=LT                 | |category=Pair     |combo_type=Boolean  |display=Returns 1.0 if the first argument is smaller than the second argument, else returns 0.0.}}
{{Combo operators|type=row| combo_operator=NEQ               | |category=Pair     |combo_type=Boolean  |display=Returns 1.0 if the first argument is not equal to the second argument, else returns 0.0.}}
{{Combo operators|type=row| combo_operator=EQ                 | |category=Pair     |combo_type=Boolean  |display=Returns 1.0 if the first argument is equal to second argument, else returns 0.0.}}
 
 
 
{{Combo operators|type=row| combo_operator=PERCENTILE            | |category=Multi    |combo_type=Function  |display=Calculates the linear interpolated k-th percentile (value between 0 and 1) of the sorted array of provided arguments. The last provided argument should be the percentile.}}
{{Combo operators|type=row| combo_operator=AVG_GTE_PERCENTILE    | |category=Multi    |combo_type=Function  |display=Calculates the average of the provided arguments which are above the calculated linear interpolated k-th percentile (value between 0 and 1). The last provided argument should be the percentile.}}
{{Combo operators|type=row| combo_operator=AVG_LTE_PERCENTILE    | |category=Multi    |combo_type=Function  |display=Calculates the average of the provided arguments which are below the calculated linear interpolated k-th percentile (value between 0 and 1). The last provided argument should be the percentile.}}
{{Combo operators|type=row| combo_operator=NO_DATA              | |category=Constant |combo_type=Constant  |display=The NO_DATA value for grid data, indicating no data exists.}}
 
}}
}}


==How-to's==
==Inputs==
* Up to ten Overlays can be configured as input for the Combo Overlay. These [[Prequels (Combo Overlay)|prequels]] are referenced as [[A prequel (Combo Overlay)|A]], [[B prequel (Combo Overlay)|B]], [[C prequel (Combo Overlay)|C]], etc.
* You can use [[Global]]s in a formula.
 
===Timeframes===
When an [[prequel|input Overlay]] has multiple [[Timeframe]]s, additional syntax is available to specify the intended timeframes.
 
Timeframes are 0-indexed, meaning they start counting at 0. The first timeframe is 0, the second timeframe is 1, the tenth timeframe is 9, etc.
 
{|class=wikitable
! Syntax
! Meaning
! Example
! Effect
|-
| A
| The (last) value from Overlay A
| MUL(A,&nbsp;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,&nbsp;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,&nbsp;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 the following:
* The amount of [[timeframe]]s of Input [[Overlay]]s which are referenced in the formula using the T syntax.
* The amount of values in [[Global]]s which are referenced in the formula. ([[Global]]s are automatically interpreted as a [[Global array]].)
The highest found value among all those dictates the amount of [[Timeframe]]s the Combo Overlay has.
 
==Examples==
* [[Combo Overlay with average overlays]]
* [[Combo Overlay with masking]]
* [[Combo Overlay with distance filtering]]
* [[How to adjust the height map with a Combo Overlay]] - an example for kerbs
* [[How to compute the presence of features of a particular size]] - an example for public green
* [[How to combine results of multiple Overlays as timeframes in a Combo Overlay]]
* [[How to compute cool locations of sufficient size]]
* [[How to make a Grid Overlay of residences]]
 
 
* Conditionally include grid information in Combo Overlay calculation: https://community.tygron.com/forum/discussion/551/conditionally-include-grid-information-in-a-combo-overlay-calculation
* Biodiversity analysis: bats (Dutch only):
{{video|link=https://www.youtube.com/watch?v=vrfkI9oFYec&t=0s|language=Dutch|description=Example of the Combo overlay for bat routes in the {{software}}.}}
{{video|link=https://www.youtube.com/watch?v=W6gdoFDw4EU&t=0s|language=Dutch|description=Combining geo-information into a bat network in the {{software}}.}}
 
{{article end
|notes=
* When multiple input Overlays are referenced with a "T" syntax and those have varying amounts of [[timeframe]]s, the maximum amount of timeframes among those input Overlays is used.
* When the "T" syntax is used to refer to an input Overlay with fewer [[timeframe]]s than the Combo Overlay itself, any [[timeframe]] referenced via the "T" syntax beyond what the input Overlay offers uses whichever value the last [[timeframe]] of that input Overlay had. I.e. if a [[Water Overlay]] has 10 [[timeframe]]s but the Combo Overlay attempts to compute an 11th [[timeframe]] and beyond, the value from the last (10th) [[timeframe]] of the [[Water Overlay]] is used.
|howtos=
* [[How to add and remove an Overlay]]
* [[How to add and remove an Overlay]]
* [[How to edit a Combo Overlay's formula]]
* [[How to edit a Combo Overlay's formula]]
* [[How to edit an overlay legend]]
* [[How to edit an overlay legend]]
* [[How to add and remove an Attribute]]
* [[How to add and remove an Attribute]]
|seealso=
* [[Combo Overlay tutorial]]
|videos=
{{video|gallery=
  {{video|youtube=zLu16agFA7k|language=dutch|description=Example of the Combo overlay in the {{software}}.}}
  {{video|youtube=0nFZN6ORjcc|language=dutch|description=Testing a parametric design on environmental criteria in the {{software}}.}}
}}
}}


==Examples==
{{Overlay nav}}
* [[Combo Overlay with features]]
* [[Combo Overlay with masking]]
* [[Combo Overlay with distance filtering]]
 
{{Template:Overlay nav}}

Latest revision as of 12:45, 1 February 2024

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 be used to create additional spatial calculation models. Up to three input Overlays can be selected which serve as input for the calculations. A large set of functions and operators are available which can then perform the desired computations.

Combo Overlays can take any Grid Overlay as input. It is often combined with one or more Average Overlays or Travel Distance Overlays. The Combo Overlay can also use the results of more complex calculation models, such as the Water Overlay or the Heat Overlay to further process the computed results of those models. Finally, Combo Overlays can also refer to other Combo Overlays, to create even more powerful, varied, and complex spatial calculation models.

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.

Inputs

  • Up to ten Overlays can be configured as input for the Combo Overlay. These prequels are referenced as A, B, C, etc.
  • You can use Globals in a formula.

Timeframes

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

Timeframes are 0-indexed, meaning they start counting at 0. The first timeframe is 0, the second timeframe is 1, the tenth timeframe is 9, etc.

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 the following:

  • The amount of timeframes of Input Overlays which are referenced in the formula using the T syntax.
  • The amount of values in Globals which are referenced in the formula. (Globals are automatically interpreted as a Global array.)

The highest found value among all those dictates the amount of Timeframes the Combo Overlay has.

Examples


Example of the Combo overlay for bat routes in the Tygron Platform. (In Dutch)
Combining geo-information into a bat network in the Tygron Platform. (In Dutch)

Notes

  • When multiple input Overlays are referenced with a "T" syntax and those have varying amounts of timeframes, the maximum amount of timeframes among those input Overlays is used.
  • When the "T" syntax is used to refer to an input Overlay with fewer timeframes than the Combo Overlay itself, any timeframe referenced via the "T" syntax beyond what the input Overlay offers uses whichever value the last timeframe of that input Overlay had. I.e. if a Water Overlay has 10 timeframes but the Combo Overlay attempts to compute an 11th timeframe and beyond, the value from the last (10th) timeframe of the Water Overlay is used.

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)

See also