Result type: Difference between revisions
mNo edit summary |
No edit summary |
||
| (22 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
A result type | A result type of a [[Grid Overlay]] indicates what output result from a complex calculation should be stored in that overlay. Since one calculation can often produce multiple types of (intermediate) results, result child overlays can be added to store these results. These result child overlays are always related to their result parent overlay. A result parent overlay always governs the calculation settings, such as the calculation model attributes and [[Overlay|keys]]. | ||
[[File:Overlay_overview_heat_stress_parent_child.png|thumb|left|600px|[[Overlay Overview]] with a [[Heat Stress Overlay]] as a [[Result Parent Overlay]] with several [[Result Child Overlay]]s, indicated with a white color.]]{{clear}} | |||
[[:Category:Overlays with result types|A number of overlays]] offer multiple result types. | |||
== | ==Result Parent Overlay== | ||
Some [[Grid Overlay]]s, such as the [[Water Overlay]], perform complex calculations with multiple forms of input and intermediate steps, and possibly also multiple kinds of output. For these [[Overlay]]s, a specific result type can be configured which indicates what information should be output when the calculation completes. For example, for the [[Water Overlay]] the [[ | Some [[Grid Overlay]]s, such as the [[Water Overlay]], perform complex calculations with multiple forms of input and intermediate steps, and possibly also multiple kinds of output. For these [[Overlay]]s, a specific result type can be configured which indicates what information should be output when the calculation completes. For example, for the [[Water Overlay]] the [[Result_type_(Water_Overlay)|result types]] include the [[surface last value result type (Water Overlay)|surface last value result type]] and the [[ground watertable result type (Water Overlay)|groundwater result type]] for water above and below ground respectively. | ||
Even though a calculation may calculate intermediate results as it progresses, or even a variety of end-results, only the results specified by the configured result type are stored. | Even though a calculation may calculate intermediate results as it progresses, or even a variety of end-results, only the results specified by the configured result type are stored. Other overlay results are not stored in that overlay. | ||
However, additional [[Result Child Overlay]]s can be added to this overlay to store these additional results. Therefore, this main overlay is refered to as the [[Result Parent Overlay]]. | |||
The benefits of using Result | ==Result Child Overlay== | ||
Generally, [[:Category:Overlays with result types|Overlays which offer multiple result types]] also offer the ability to add additional output Overlays, which are automatically linked to the calculation model, so that more different kinds of results can be obtained after the calculation completes. These are Result Child Overlays. They are automatically added as [[Child Overlay]]s to the related calculation model. Otherwise, these [[Overlay]]s function the same as other [[Overlay]]s. They can be named, have their own legend and [[Attribute]]s, and can be selected in the [[viewer ]]interface. They can also be [[TQL|queried]] for their results, and [[Export Geo data|export]]ed. | |||
The benefits of using Result Child Overlays rather than multiple individual [[Grid Overlay]]s configured identically other than their result type, are: | |||
* Only a single [[Overlay]] contains the configuration for the desired calculation. If multiple configurations have to be kept identical, the chance of a user making a mistake when making a change to the configuration is much greater. | * Only a single [[Overlay]] contains the configuration for the desired calculation. If multiple configurations have to be kept identical, the chance of a user making a mistake when making a change to the configuration is much greater. | ||
* Only a single calculation needs to be performed. If multiple calculations need to run, even if they are configured the same, the waiting time for them all to complete would be greater for each added [[Overlay]]. | * Only a single calculation needs to be performed. If multiple calculations need to run, even if they are configured the same, the waiting time for them all to complete would be greater for each added [[Overlay]]. | ||
Unlike other [[Child Overlay]]s, when the [[Parent Overlay]] is removed, the Result | Unlike other [[Child Overlay]]s, when the [[Parent Overlay]] is removed, the Result Child Overlays are automatically removed as well. | ||
==Notes== | ==Notes== | ||
* When a Result | * When a Result Child Overlay has its result type changed, its legend is automatically updated (unless a [[How to configure a Grid Overlay's legend|custom legend]] is configured). However, the actual data is not immediately updated; The [[Result Parent Overlay]] the Result Child Overlay is related to needs to be recalculated. | ||
{{Article end | |||
|howtos= | |||
* [[How to add and remove a Result type]] | * [[How to add and remove a Result type]] | ||
* [[How to use the Overlay Overview]] | |||
|seealso= | |||
* [[Grid Overlay]] | |||
* [[Overlay Overview]] | |||
}} | |||
{{overlay nav}} | |||
Latest revision as of 16:21, 29 February 2024
A result type of a Grid Overlay indicates what output result from a complex calculation should be stored in that overlay. Since one calculation can often produce multiple types of (intermediate) results, result child overlays can be added to store these results. These result child overlays are always related to their result parent overlay. A result parent overlay always governs the calculation settings, such as the calculation model attributes and keys.
A number of overlays offer multiple result types.
Result Parent Overlay
Some Grid Overlays, such as the Water Overlay, perform complex calculations with multiple forms of input and intermediate steps, and possibly also multiple kinds of output. For these Overlays, a specific result type can be configured which indicates what information should be output when the calculation completes. For example, for the Water Overlay the result types include the surface last value result type and the groundwater result type for water above and below ground respectively.
Even though a calculation may calculate intermediate results as it progresses, or even a variety of end-results, only the results specified by the configured result type are stored. Other overlay results are not stored in that overlay.
However, additional Result Child Overlays can be added to this overlay to store these additional results. Therefore, this main overlay is refered to as the Result Parent Overlay.
Result Child Overlay
Generally, Overlays which offer multiple result types also offer the ability to add additional output Overlays, which are automatically linked to the calculation model, so that more different kinds of results can be obtained after the calculation completes. These are Result Child Overlays. They are automatically added as Child Overlays to the related calculation model. Otherwise, these Overlays function the same as other Overlays. They can be named, have their own legend and Attributes, and can be selected in the viewer interface. They can also be queried for their results, and exported.
The benefits of using Result Child Overlays rather than multiple individual Grid Overlays configured identically other than their result type, are:
- Only a single Overlay contains the configuration for the desired calculation. If multiple configurations have to be kept identical, the chance of a user making a mistake when making a change to the configuration is much greater.
- Only a single calculation needs to be performed. If multiple calculations need to run, even if they are configured the same, the waiting time for them all to complete would be greater for each added Overlay.
Unlike other Child Overlays, when the Parent Overlay is removed, the Result Child Overlays are automatically removed as well.
Notes
- When a Result Child Overlay has its result type changed, its legend is automatically updated (unless a custom legend is configured). However, the actual data is not immediately updated; The Result Parent Overlay the Result Child Overlay is related to needs to be recalculated.
How-to's
See also