Skip to content

TSTool / Command / FillFromTS

Overview

The FillFromTS command fills missing data in a time series (or ensemble) by transferring non-missing values from another time series (or ensemble). This is useful when two time series typically have very similar values. The filled time series is not automatically extended. A period can be specified to limit the period that is checked for missing data. See also the SetFromTS command, which will transfer all values. If multiple time series or an ensemble is being processed, the number of independent time series must be one or the same number as the time series being filled. Data transfer occurs by date/time, not sequentially. This may be a problem if trying to fill from a time series that has been shifted and leap years have caused an offset – an enhancement may be made in the future to address this issue.

Command Editor

The following dialog is used to edit the command and illustrates the syntax of the command.

FillFromTS

FillFromTS Command Editor (see also the full-size image)

Command Syntax

The command syntax is as follows:

FillFromTS(Parameter="Value",...)

Command Parameters

Parameter                            Description Default                                   
TSList Indicates the list of time series to be processed, one of:
  • AllMatchingTSID – all time series that match the TSID (single TSID or TSID with wildcards) will be processed.
  • AllTS – all time series before the command.
  • EnsembleID – all time series in the ensemble will be processed (see the EnsembleID parameter).
  • FirstMatchingTSID – the first time series that matches the TSID (single TSID or TSID with wildcards) will be processed.
  • LastMatchingTSID – the last time series that matches the TSID (single TSID or TSID with wildcards) will be processed.
  • SelectedTS – the time series are those selected with the SelectTimeSeries command.
 AllTS
TSID The time series identifier or alias for the time series to be processed, using the * wildcard character to match multiple time series. Can be specified using ${Property}. Required if TSList=*TSID
EnsembleID The ensemble to be processed, if processing an ensemble. Can be specified using ${Property}. Required if TSList=*EnsembleID
IndependentTSList Indicates how to determine the list of independent time series (see the explanation of TSList). AllTS
IndependentTSID The time series identifier or alias for the independent time series (see the explanation of TSID). Can be specified with processor ${Property}. Required when a IndependentTSList=*TSID
IndependentEnsembleID The ensemble identifier for the independent time series (see the explanation of EnsembleID). Can be specified with processor ${Property}. Required when IndependentTSList=EnsembleID
FillStart The date/time to start filling. Can be specified with processor ${Property}. Fill the entire period.
FillEnd The date/time to end filling. Can be specified with processor ${Property}. Fill the entire period.
FillFlag If specified, data flags will be enabled for the time series and each filled value will be tagged with the specified string. The flag can then be used later to label graphs, etc. Prefix with + to append the flag. Can be specified with processor ${Property}. No flag is assigned.
FillFlagDesc Description for the fill flag, used in reports. Can be specified with processor ${Property}. Automatically generated.
RecalcLimits Available only for monthly time series. Indicate whether the original data limits for the time series should be recalculated after the filling the time series. Setting to True is appropriate if the independent time series provides additional data values. False (only the values in the initial time series will be used for historical data).

Examples

See the automated tests.

Troubleshooting

See Also