Skip to content

TSTool / Command / Multiply

Overview

The Multiply command multiplies one time series by another. Missing data in either time series causes the result to be missing. See also the Scale command, which multiplies time series by a numerical value.

Command Editor

The command is available in the following TSTool menu:

  • Commands / Manipulate Time Series

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

Multiply command editor

Multiply Command Editor (see full-size image)

Command Syntax

The command syntax is as follows:

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

Command Parameters

Parameter              Description Default                           
TSID The time series identifier or alias for the time series to be modified. Can specify using ${Property}. None – must be specified.
MultiplierTSID The time series identifier or alias for the time series that is the multiplier. Can specify using ${Property}. None – must be specified.
NewUnits Specify the new units to assign. Can specify using ${Property}. Original units remain.

Examples

See the automated tests.

A sample command file to process time series from the State of Colorado’s HydroBase database is as follows (not an actual case but for illustration):

# 2184 - DEL NORTE 2 E
2184.NOAA.TempMean.Month~HydroBase
# 5706 - MONTE VISTA 2 W
5706.NOAA.TempMean.Month~HydroBase
Multiply(TSID="2184.NOAA.TempMean.Month",MultiplierTSID="5706.NOAA.TempMean.Month")

Troubleshooting

See the main TSTool Troubleshooting documentation.

See Also