Template:Dataset Calculator
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.
It should be noted that datasets at different locations (point vs. cell) cannot be used in the same expression.
Input Parameters
- Grid source selection – Select the geometry on which the dataset calculation will be performed. The geometry can be a 2D mesh, scatter set, grid or UGrid. The cells or points in the geometry define the locations where data from the dataset exists and the locations for the calculations specified in the tool.
- Data location selection – Determines the location of the calculations in the geometry. 2D meshes and scatter sets only support point datasets. UGrids supports both point and cell datasets. Cartesian grids can be of one type or the other.
- "Cells" – Calculations will be performed on the cell values of the geometry.
- "Points" – Calculations with be performed on the point values of the geometry.
- Dataset table – Can be populated with the datasets from the select Grid source selection. This table allows selecting which datasets are to be used and specify a variable name for each that will appear in the expression. The default variable names follow the pattern of d1, d2, etc., but user specified names can be specified as well. Not all datasets selected in the table need to be used in the expression.
- 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 time step from which to use data from this dataset. Or select all time steps to use all values within this dataset.
- Mathematical expression – The equation or expression that will be evaluated at each location in the dataset. Parentheses can be used in the expression as in mathematical notation.
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 |
Examples
The examples below provide descriptions and context for dataset calculator results.
Test 1 of Dataset Calculator
This example is regarding two datasets. The inputs for dataset value locations include cells, there is one time step per each dataset, and no activity in either dataset. The result location for the datasets include cells, there is one result time step per each dataset, and no result activity in either dataset.
Test 4 of Dataset Calculator
This example is regarding two datasets. The inputs for dataset value locations include cells, there is one time step per each dataset, and cells activity in both datasets. The result location for the datasets include cells, there is one result time step per each dataset, and cells activity in both datasets.
Test 11 of Dataset Calculator
This example is regarding two datasets. The inputs for dataset value locations include points, there is one time step per each dataset, and points activity in both datasets. The result location for the datasets include points, there is one result time step per each dataset, and points activity in both datasets.
Test 17 of Dataset Calculator
This example is regarding two datasets. The inputs for dataset value locations include points, there is one time step per each dataset, and no activity in either dataset. The result location for the datasets include points, there is one result time step per each dataset, and no activity in either dataset.
Test 29 of Dataset Calculator
This example is regarding two datasets. The inputs for dataset 1 value location includes points, all time steps are used in dataset 1, and no activity in dataset 1. The inputs for dataset 2 value location includes points, all time steps are used in dataset 2, and points activity in dataset 2. The result location for both datasets include points, all time steps are used per each dataset, and points activity in both datasets.
