Template:Dataset Calculator: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
 
(7 intermediate revisions by the same user not shown)
Line 29: Line 29:
*All datasets where “all time steps” has been selected must have the same time steps. (See example #9)
*All datasets where “all time steps” has been selected must have the same time steps. (See example #9)
*If there is a combination of activity on cells and points between the datasets being used in a calculation, before performing calculations for activity, the calculator will find the point activity from the given cell activity and use that in the activity calculations. (See example #26)
*If there is a combination of activity on cells and points between the datasets being used in a calculation, before performing calculations for activity, the calculator will find the point activity from the given cell activity and use that in the activity calculations. (See example #26)
{|
An SMS sample file with the examples in the table can be downloaded [https://www.xmswiki.com/images/f/fb/DatasetCalculatorExamples.sms.zip here].
{| class="wikitable"
|-
|-
!Test #
!Test #
!Dataset 1 value location
!Dataset 1 value location
!Dataset 1 activity
!Dataset 1 activity
D1 time steps
!Dataset 1 time steps
D2 value location
!Dataset 2 value location
D2 activity
!Dataset 2 activity
D2 Time steps
!Dataset 2 time steps
Result location
!Result location
Result activity
!Result activity
!Result timesteps
!Result time steps
|-
N/A
Cells
N/A
N/A
Points
N/A
N/A
Cell and values values cannot be mixed
N/A
N/A
|-
|-
|1
|1
Line 129: Line 119:
|cells activity
|cells activity
|all time steps
|all time steps
8
|-
cells
|8
cells activity
|cells
1 timestep
|cells activity
cells
|1 time step
no activity
|cells
1 timestep
|no activity
cells
|1 time step
cells activity
|cells
1 timestep
|cells activity
9
|1 time step
cells
|-
cells activity
|9
all timesteps
|cells
cells
|cells activity
cells activity  
|all time steps
all timesteps
|cells
cells
|cells activity  
cells activity
|all time steps
all timesteps
|cells
10
|cells activity
cells
|all time steps
cells activity
|-
1 timestep
|10
cells
|cells
no activity
|cells activity
all timesteps
|1 time step
cells
|cells
cells activity
|no activity
all timesteps
|all time steps
11
|cells
points
|cells activity
points activity
|all time steps
1 timestep
|-
points
|11
points activity
|points
1 timestep
|points activity
points
|1 time step
points activity
|points
1 timestep
|points activity
12
|1 time step
points
|points
points activity
|points activity
1 timestep
|1 time step
points
|-
points activity
|12
all timesteps
|points
points
|points activity
points activity
|1 time step
all timesteps
|points
13
|points activity
points
|all time steps
cells activity
|points
all timesteps
|points activity
points
|all time steps
no activity
|-
all timesteps
|13
points
|points
cells activity
|cells activity
all timesteps
|all time steps
14
|points
points
|no activity
cells activity
|all time steps
all timesteps
|points
points
|cells activity
points activity
|all time steps
1 timestep
|-
points
|14
points activity
|points
all timesteps
|cells activity
15
|all time steps
points
|points
cells activity
|points activity
all timesteps
|1 time step
points
|points
points activity
|points activity
all timesteps
|all time steps
points
|-
points activity
|15
all timesteps
|points
16
|cells activity
points
|all time steps
points activity
|points
all timesteps
|points activity
points
|all time steps
points activity
|points
all timesteps
|points activity
points
|all time steps
points activity
|-
all timesteps
|16
17
|points
points
|points activity
no activity  
|all time steps
1 timestep
|points
points
|points activity
no activity
|all time steps
1 timestep
|points
points
|points activity
no activity
|all time steps
1 timestep
|-
18
|17
points
|points
cells activity
|no activity  
1 timestep
|1 time step
points
|points
no activity
|no activity
1 timestep
|1 time step
points
|points
cells activity
|no activity
1 timestep
|1 time step
19
|-
points
|18
cells activity
|points
1 timestep
|cells activity
points
|1 time step
cells activity
|points
1 timestep
|no activity
points
|1 time step
cells activity
|points
1 timestep
|cells activity
20
|1 time step
points
|-
cells activity
|19
1 timestep
|points
points
|cells activity
cells activity
|1 time step
all timesteps
|points
points
|cells activity
cells activity
|1 time step
all timesteps
|points
21
|cells activity
points
|1 time step
no activity  
|-
1 timestep
|20
points
|points
no activity
|cells activity
1 timestep
|1 time step
points
|points
no activity
|cells activity
1 timestep
|all time steps
22
|points
points
|cells activity
no activity  
|all time steps
1 timestep
|-
points
|21
points activity
|points
all timesteps
|no activity  
points
|1 time step
points activity
|points
all timesteps
|no activity
23
|1 time step
points
|points
cells activity
|no activity
1 timestep
|1 time step
points
|-
no activity
|22
all timesteps
|points
points
|no activity  
cells activity
|1 time step
all timesteps
|points
24
|points activity
points
|all time steps
no activity  
|points
1 timestep
|points activity
points
|all time steps
points activity
|-
1 timestep
|23
points
|points
points activity
|cells activity
1 timestep
|1 time step
25
|points
points
|no activity
no activity  
|all time steps
all timesteps
|points
points
|cells activity
no activity
|all time steps
all timesteps
|-
points
|24
no activity
|points
all timesteps
|no activity  
26
|1 time step
points
|points
cells activity
|points activity
1 timestep
|1 time step
points
|points
points activity
|points activity
1 timestep
|1 time step
points
|-
points activity
|25
1 timestep
|points
27
|no activity  
points
|all time steps
cells activity
|points
1 timestep
|no activity
points
|all time steps
points activity
|points
all timesteps
|no activity
points
|all time steps
pionts activity
|-
all timesteps
|26
28
|points
points
|cells activity
no activity  
|1 time step
all timesteps
|points
points
|points activity
points activity
|1 time step
1 timestep
|points
points
|points activity
points activity
|1 time step
all timesteps
|-
29
|27
points
|points
no activity  
|cells activity
all timesteps
|1 time step
points
|points
points activity
|points activity
all timesteps
|all time steps
points
|points
points activity
|points activity
all time steps
|all time steps
30
|-
points
|28
cells activity
|points
all time steps
|no activity  
points
|all time steps
no activity
|points
1 time step
|points activity
points
|1 time step
cells activity
|points
all time steps
|points activity
31
|all time steps
points
|-
cells activity
|29
all time steps
|points
points
|no activity  
cells activity
|all time steps
all time steps
|points
points
|points activity
cells activity
|all time steps
all time steps
|points
|points activity
|all time steps
|-
|30
|points
|cells activity
|all time steps
|points
|no activity
|1 time step
|points
|cells activity
|all time steps
|-
|31
|points
|cells activity
|all time steps
|points
|cells activity
|all time steps
|points
|cells activity
|all time steps
|}
|}




<noinclude>[[Category:Toolbox Datasets]]</noinclude>
<noinclude>[[Category:Toolbox Datasets]]</noinclude>

Latest revision as of 16:01, 7 May 2024


Dataset Calculator

The Dataset Calculator tool will perform calculations on one or more dataset data and activity. The tool will produce a new dataset with the resulting values and activity of those datasets according to the provided mathematical expression

Input Parameters

  • Grid Source Selection – The source grid of any datasets to work with.
  • Data Location Selection – The allowed location of data in datasets: either on points or cells of the source grid.
  • Table –
    • Dataset – The selected dataset
    • Variable Name – The name to be used to refer to the chosen dataset within the provided expression.
    • Time Step – The chosen timestep from which to use data from this dataset. Or select all timesteps to use all values within this dataset.
  • Mathematical Expression – The expression to be evaluated with the chosen datasets

Output Parameters

  • Output Dataset Name – the name of the new dataset to fill with the resulting values from the expression.

The output will be a new dataset on the chosen grid with values and activity according to the expression and chosen datasets.

Current Location in toolbox

Datasets/ Dataset Calculator

Restrictions/Rules

The values will be the result of the expression being performed on each set of values of the datasets at each time step. Datasets with point and cell values cannot be mixed in the dataset calculator.

  • If no dataset being used in a calculation has activity, the resulting dataset will also not have activity. (See example #1 in the table below)
  • In calculations with multiple datasets with one timestep selected, the resulting time step will be 0.0. (See example #4)
  • If there is a combination of different selections for time steps and there is at least one dataset with “all time steps” selected, the resulting dataset’s time steps will be that dataset’s time steps. (see example #5)
    • In any such calculations, the calculator will use the single corresponding values array from any datasets with a single time step selected for every corresponding set of values in any datasets with “all time steps” selected. time step in the multiple time step selections.
  • All datasets where “all time steps” has been selected must have the same time steps. (See example #9)
  • If there is a combination of activity on cells and points between the datasets being used in a calculation, before performing calculations for activity, the calculator will find the point activity from the given cell activity and use that in the activity calculations. (See example #26)

An SMS sample file with the examples in the table can be downloaded here.

Test # Dataset 1 value location Dataset 1 activity Dataset 1 time steps Dataset 2 value location Dataset 2 activity Dataset 2 time steps Result location Result activity Result time steps
1 cells no activity 1 time step cells no activity 1 time step cells no activity 1 time step
2 cells no activity 1 time step cells no activity all time steps cells no activity all time steps
3 cells no activity all time steps cells no activity all time steps cells no activity all time steps
4 cells cells activity 1 time step cells cells activity 1 time step cells cells activity 1 time step
5 cells cells activity 1 time step cells cells activity all time steps cells cells activity all time steps
6 cells cells activity all time steps cells no activity 1 time step cells cells activity all time steps
7 cells cells activity all time steps cells no activity all time steps cells cells activity all time steps
8 cells cells activity 1 time step cells no activity 1 time step cells cells activity 1 time step
9 cells cells activity all time steps cells cells activity all time steps cells cells activity all time steps
10 cells cells activity 1 time step cells no activity all time steps cells cells activity all time steps
11 points points activity 1 time step points points activity 1 time step points points activity 1 time step
12 points points activity 1 time step points points activity all time steps points points activity all time steps
13 points cells activity all time steps points no activity all time steps points cells activity all time steps
14 points cells activity all time steps points points activity 1 time step points points activity all time steps
15 points cells activity all time steps points points activity all time steps points points activity all time steps
16 points points activity all time steps points points activity all time steps points points activity all time steps
17 points no activity 1 time step points no activity 1 time step points no activity 1 time step
18 points cells activity 1 time step points no activity 1 time step points cells activity 1 time step
19 points cells activity 1 time step points cells activity 1 time step points cells activity 1 time step
20 points cells activity 1 time step points cells activity all time steps points cells activity all time steps
21 points no activity 1 time step points no activity 1 time step points no activity 1 time step
22 points no activity 1 time step points points activity all time steps points points activity all time steps
23 points cells activity 1 time step points no activity all time steps points cells activity all time steps
24 points no activity 1 time step points points activity 1 time step points points activity 1 time step
25 points no activity all time steps points no activity all time steps points no activity all time steps
26 points cells activity 1 time step points points activity 1 time step points points activity 1 time step
27 points cells activity 1 time step points points activity all time steps points points activity all time steps
28 points no activity all time steps points points activity 1 time step points points activity all time steps
29 points no activity all time steps points points activity all time steps points points activity all time steps
30 points cells activity all time steps points no activity 1 time step points cells activity all time steps
31 points cells activity all time steps points cells activity all time steps points cells activity all time steps
Retrieved from "https://www.xmswiki.com/index.php?title=Template:Dataset_Calculator&oldid=162193"