TSTool / Command / SetToMin
Overview
The SetToMin
command sets a time series to contain, for each time step,
the minimum of its own values and those of one or more additional (independent) time series.
See also the SetToMax
command.
Command Editor
The command is available in the following TSTool menu:
- Commands / Set Time Series Contents
The following dialog is used to edit the command and illustrates the syntax of the command.
SetToMin
Command Editor (see full-size image)
Command Syntax
The command syntax is as follows:
SetToMin(Parameter="Value",...)
Command Parameters
Parameter | Description | Default |
---|---|---|
TSID required |
The time series identifier or alias for the time series to be modified. | None – must be specified. |
IndependentTSList |
Indicates the list of time series to be processed, one of:
|
AllTS (the time series receiving the result will not be included) |
IndependentTSID |
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 IndependentTSList=*TSID |
IndependentEnsembleID |
The ensemble to be processed, if processing an ensemble. Can be specified using ${Property} . |
Required if IndependentTSList=*EnsembleID |
Examples
See the automated tests.
A sample command file to process data from the State of Colorado’s HydroBase database is as follows:
# 08236000 - ALAMOSA RIVER ABOVE TERRACE RESERVOIR
08236000.DWR.Streamflow.Month~HydroBase
# 08236500 - ALAMOSA RIVER BELOW TERRACE RESERVOIR
08236500.DWR.Streamflow.Month~HydroBase
SetToMin(TSID="08236000.DWR.Streamflow.Month",IndependentTSList=SpecifiedTSID,IndependentTSID="08236500.DWR.Streamflow.Month")
Troubleshooting
See the main TSTool Troubleshooting documentation.
See Also
SelectTimeSeries
commandSetToMax
command