Two Variable Rating Table
Interpolation
twoVariableRatingTableInterpolation(
TimeSeriesMath
tsDataX,
TimeSeriesMath tsDataZ)
Derive a new time series data set by using the x-y curves in the current paired data set to perform two-variable rating table interpolation of the time series tsDataX and tsDataZ. For two-variable rating table interpolation, the current paired data set should have more than one curve (multiple sets of y-values).
As an example, reservoir release is a function of both the gate opening height and reservoir elevation (see below). For each gate opening height, there is a reservoir elevation-reservoir release curve, where reservoir elevation is the independent variable (x-values) and reservoir release the dependent variable (y-values) of a paired data set. Each paired data curve has a curve label. In this case, the curve label is assigned the gate opening height. Using the paired data set shown in the figure below, the function may be employed to interpolate time series values of reservoir elevation (tsDataX) and gate opening height (tsDataZ) to develop a time series of reservoir release.
No extrapolation is performed. If time series values from tsDataX or tsDataZ are outside the range bounded by the paired data, the new time series value is set to missing. Units and parameter type in the new time series are set to the y-units label and parameter of the current paired data set. All other names and labels are copied over from tsDataX.
Times for tsDataX and tsDataZ must match. Curve labels must be set for curves in the rating table paired data set and must be interpretable as numeric values.
Example of two variable rating table paired data, reservoir release as a function of reservoir elevation and gate opening height (curve labels)
Parameters:
tsDataX – A regular or irregular interval TimeSeriesMath object,
interpreted as x-ordinate values in the two variable interpolation.
tsDataZ – A regular or irregular interval TimeSeriesMath object,
interpreted as z-ordinate values, (value defined by the paired data curve labels).
Example: tsOutflow =
gateCurve.twoVariableRatingTableInterpolation(
tsElevation,
tsGateOpening)
Returns: A new TimeSeriesMath object.
Generated Exceptions: Throws a HecMathException if times do not match for tsDataX and tsDataZ; if the paired data curve labels are blank or cannot be interpreted as number values.