Combo Overlay and File:Raster baddepth.png: Difference between pages

From Tygron Support wiki
(Difference between pages)
Jump to navigation Jump to search
 
No edit summary
 
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.]]


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.
Combo Overlays can take any [[Grid Overlay]] as [[prequel|input]]. It is often combined with one or more [[Average Overlay]]s or [[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==
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.
{{Combo operators|suppresscategory=true|allowselflinks=true|
{{Combo operators|combo_operator=SIN    | |category=Single  |type=Function  |display=Sine function}}
{{Combo operators|combo_operator=COS    | |category=Single  |type=Function  |display=Cosine function}}
{{Combo operators|combo_operator=TAN    | |category=Single  |type=Function  |display=Tangent function}}
{{Combo operators|combo_operator=ASIN    | |category=Single  |type=Function  |display=Arc sine function}}
{{Combo operators|combo_operator=ACOS    | |category=Single  |type=Function  |display=Arc cosine function}}
{{Combo operators|combo_operator=ATAN    | |category=Single  |type=Function  |display=Arc tangent function}}
{{Combo operators|combo_operator=ROUND  | |category=Single  |type=Function  |display=Round function}}
{{Combo operators|combo_operator=FLOOR  | |category=Single  |type=Function  |display=Floor function}}
{{Combo operators|combo_operator=CEIL    | |category=Single  |type=Function  |display=Ceil function}}
{{Combo operators|combo_operator=ABS    | |category=Single  |type=Function  |display=Absolute function}}
{{Combo operators|combo_operator=EXP    | |category=Single  |type=Function  |display=Exponential function}}
{{Combo operators|combo_operator=LN      | |category=Single  |type=Function  |display=The natural logarithm (base e) function}}
{{Combo operators|combo_operator=LOG    | |category=Single  |type=Function  |display=The natural logarithm (base 10) function}}
{{Combo operators|combo_operator=SQRT    | |category=Single  |type=Function  |display=The square root function}}
{{Combo operators|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 the provided argument}}
{{Combo operators|combo_operator=ERF    | |category=Single  |type=Function  |display=The gauss error function, for probability calculations.}}
{{Combo operators|combo_operator=ADD    | |category=Multi    |type=Operator  |display=Add one or more argument}}
{{Combo operators|combo_operator=MULT    | |category=Multi    |type=Operator  |display=Multiply one or more arguments}}
{{Combo operators|combo_operator=SUB    | |category=Multi    |type=Operator  |display=Subtract one or more arguments from the first argument}}
{{Combo operators|combo_operator=DIV    | |category=Multi    |type=Operator  |display=Divide the first argument with one or more other arguments}}
{{Combo operators|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|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|combo_operator=AVG    | |category=Multi    |type=Function  |display=Returns the [https://en.wikipedia.org/wiki/Arithmetic_mean arithmetic mean] of the provided arguments.}}
{{Combo operators|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|combo_operator=IF      | |category=Multi    |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|combo_operator=AND    | |category=Multi    |type=Boolean  |display=Returns 1.0 if all arguments are not equal to 0.0.}}
{{Combo operators|combo_operator=OR      | |category=Multi    |type=Boolean  |display=Returns 1.0 if any argument is not equal to 0.0.}}
{{Combo operators|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|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|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|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|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|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|combo_operator=PERCENTILE    | |category=Multi    |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|combo_operator=AVG_GTE_PERCENTILE    | |category=Multi    |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|combo_operator=AVG_LTE_PERCENTILE    | |category=Multi    |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|combo_operator=NO_DATA | |category=Constant |type=Constant  |display=The NO_DATA value for grid data, indicating no data exists.}}
}}
==Inputs==
* Up to three overlays can be configured as input for the combo overlay. They are referenced as A, B and C.
* 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, 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==
* [[Combo Overlay with average overlays]]
* [[Combo Overlay with masking]]
* [[Combo Overlay with distance filtering]]
{{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 edit a Combo Overlay's formula]]
* [[How to edit an overlay legend]]
* [[How to add and remove an Attribute]]
|videos=
{{video|link=https://youtu.be/jDgOkL1AF8Q|language=dutch|description=Example of the Combo overlay in the {{software}}.}}
{{video|link=https://youtu.be/n2LRtKoIt_Q|language=dutch|description=Testing a parametric design on environmental criteria in the {{software}}.}}
}}
{{Overlay nav}}

Revision as of 12:17, 27 May 2022