Transforms (draft)

Transforms, as its name suggests, allow you to modify (or transform) the view of the data. Once generated, they can be used as a template for another action, such as applying to custom charts. They are centrally managed using the Transforms Manager and are saved with the project.

Note: Applying a transform results in changes to all three data views - Charts, Tables and Statistics tabs. Refer to Data manipulation in Results manager.

Working with transforms

Working with transforms is a two-step process:

First, create a transform using the Transforms Manager (Figure 1);
Then, apply the transform to any chart (either to a single result or a custom chart) using the Transform application tab (Figure 2).

Creating transforms

Transforms are created and configured using the Transforms Manager (Figure 1).

First open it using one of the following methods:
- The Options menu;
- The Results manager toolbar; or
- The equivalent hotkeys (Ctrl+Shift+T).
Then, specify the type of transform using the Add transform drop-down menu;
Configure it using the pane on the right.

Once defined, all transforms are listed in the Transforms Manager.

To delete a transform, select it from the list, then click Remove transform in the toolbar.

Figure 1. Transforms Manager

Applying transforms

Note: Transforms should have units compatible with the data they are being applied to.

Once defined, transform can be applied to charts in one of two ways:

In the tree menu of the Results Manager, right click on the result and choose Add Transform » <name of transform>; or
In the Transform application tab (Figure 2), enable the transform you wish to apply (below the Search functionality).
- The panel on the left shows all the transforms that have been defined. Only compatible transforms will appear.
- The panel on the right provides a summary of all the applied transforms.
- Transforms are applied in the order they appear (ie. from top to bottom). The can be re-ordered by dragging them up or down the list. You can get different results by applying transforms in a different order.

Once a transform has been applied, the result will be displayed in the Charts tab.

Figure 2. Transform application tab

Types of transforms

There are six types of transforms available in Source.

Aggregator

This transform aggregates a shorter timestep to a longer timestep, eg. aggregates daily data to monthly or yearly using one of the aggregation methods described in Table 1.

The percentile is a statistical measure, used to indicate the value below which a given percentage of data falls. For example, the 20th percentile is the value below which 20% of data may be found. So, if you configure < 20 percentile, this refers to the smallest 20% of all values.

This window works in a similar way to the Number range transform. The values entered must be real numbers between the range 0 and 100.

Note: When choosing a yearly time-step, you must also specify the start date of the water year.

Table 1. Transform aggregation methods

Aggregation method	Description	Example for aggregating rainfall from a daily to a monthly timestep
Max	Returns the maximum value for the original timestep for each aggregated timestep.	The minimum daily rainfall value for that month.
Min	Returns the minimum value for the original timestep for each aggregated timestep.	The maximum daily rainfall value for that month.
Mean	Returns the mean of all values for the original timestep for each aggregated timestep.	The mean daily rainfall for all days that month.
Percentile	For each aggregated timestep, returns the value below which x% of all values for the original timestep fall.	When percentile equals 75, 75% of the days of the month have rainfall below this value.
Standard deviation	Returns the standard deviation of all values for the original timestep for each aggregated timestep.	The standard deviation in daily rainfall for all days that month.
Sum	Returns the sum of all values for the original timestep for each aggregated timestep.	The sum of the daily rainfall values for that month (ie. total monthly rainfall).

Figure 3. Aggregator transform

Date range filter

This transform returns values within the entered date range. Note that the start date must be before the end date. Select 'Add' to enter another date range, this can be done multiple times. The filter will return all values that match any of the date ranges entered (ie. this transform returns values within either the first date range or second date range, etc.). In comparison, if you create two date range filter transforms each with a single date range, and apply both transforms to a result, only values that are within the overlap between both date range filters will be returned (ie. applying multiple date range filter transforms returns the overlap between the first date range filter and the second date range filter, etc).

You can work with checkboxes as follows:

Enable the Start date checkbox only. This will display all values from the date specified to the last date in the time series;
Enable the End date checkbox only to display all values from the first date in the time series to the specified end date;
Enable both the Start Date and End Date checkboxes to specify either a single date range, or when specifying multiple different date ranges, you can enable/disable a combination of start and end dates.

Figure 4. Date range transform

Inverter

As its name suggests, this transform returns the inverted values of a result, ie. it multiples all values by -1.

Number range filter

This transform returns values within the range of entered numbers. You can choose:

A single range (for eg. > 25). In this case, values that are above 25 will be displayed in the chart and table views, and will also be used in statistical analyses;
A combination of ranges. By enabling the second range, and using and/or, you can filter all values that match the ranges of numbers specified.

Note that you must also specify units for both ranges.

Figure 5. Number range transform

Percentile range filter