TSTool / Command / Disaggregate
Overview
The Disaggregate
command creates a new time series by disaggregating a
time series with a longer data interval into a time series with a shorter data interval.
The resulting time series will have the same metadata and
identifier as the original time series, with a different data interval.
See also the general ChangeInterval
command.
Converting longer-interval data may cause a perceived shift in the time.
For example, 1Day data shifted to 24Hour data will result in the
daily values being set at hour zero of the following day.
This shift is necessary to generically represent different time precision.
Plots will also reflect the shift because hours are not considered
when computing plot positions for daily data.
It is important to understand how disaggregated data is treated with respect
to time when using with other applications. If necessary, use the
ShiftTimeByInterval
command to manipulate the resulting output time series.
Command Editor
The following dialog is used to edit the command and illustrates the syntax of the command.
Disaggregate
Command Editor (see also the full-size image)
Command Syntax
The command syntax is as follows:
Disaggregate(Parameter="Value",...)
Command Parameters
Parameter | Description | Default |
---|---|---|
TSID required |
The time series identifier or alias for the time series to be disaggregated. | None – must be specified. |
Alias required |
The alias to assign to the time series, as a literal string or using the special formatting characters listed by the command editor. The alias is a short identifier used by other commands to locate time series for processing, as an alternative to the time series identifier (TSID ). |
None – must be specified. |
Method required |
The method used to perform the disaggregation, one of the following:
|
None – must be specified. |
NewInterval required |
The data interval for the disaggregated time series (NHour, NDay, etc.). | None – must be specified. |
NewDataType |
The data type for the disaggregated time series, if different from the original. | Same data type as the original time series. |
NewUnits |
The units for the disaggregated time series, if different from the original. | Same units as the original time series. |
Examples
See the automated tests.
A sample command file to process a time series from the State of Colorado’s HydroBase database is as follows:
# 08223000 - RIO GRANDE RIVER AT ALAMOSA
ReadTimeSeries(TSID="08223000.DWR.Streamflow.Day~HydroBase",Alias=”DayTS”)
Disaggregate(TSID="DayTS",Alias=”HourTS”,Method=Ormsbee,NewInterval=6Hour)
Examples of graphs for the original and disaggregated data are shown below, for the two disaggregation methods:
Daily Input Time Series and 6-Hour Disaggregated Time Series using SameValue Method
Daily Input Time Series and 6-Hour Disaggregated Time Series using Ormsbee Method
Troubleshooting
See Also
ChangeInterval
commandSelectTimeSeries
commandShiftTimeByInterval
command