Scripting > Math Functions


Conic Interpolation from Elevation/Area Table

conicInterpolation(  TimeSeriesMath tsData,

string inputType,

string outputType,

floating-point storageScaleFactor )

 

Use the conic interpolation table in the current paired data set to develop a new time series data set from the interpolation of tsData.
 

The current paired data should be an Elevation-Area table.  However, the first data pair are the initial conic depth, and the storage value at the first elevation in the table.  If the initial conic depth is undefined, the function will calculate a value.  Elevation-Area values in the table must be in ascending order.

tsData is either a time series of reservoir elevation or storage.  The type is specified by setting inputType as "S(TORAGE)" or "E(LEVATION).”  The desired output time series type is similarly set using outputType.  The valid settings for outputType are "S(TORAGE)”, "E(LEVATION)" or "A(REA).”  inputType and outputType must not be the same.

 

storageScaleFactor is an optional parameter used to scale input (by multiplying) and output (by dividing) storage values.  For example, if the area in the conic interpolation table is expressed in sq.ft., storageScaleFactor could be set to 43560. to convert the storage output to acre-ft.

 

Parameter type in the new time series is set according to outputType.  If the output time series values are elevation, the time series units are set to the paired data x-units label.  If the output time series values are area, the time series units are set to the paired data y-units label.  If the output is storage, the units are not set and should be set by the user with the setUnits function.

 

See also:  setUnits()

Parameters:

tsData – A TimeSeriesMath object representing elevation or storage.

inputType – A string specifying the parameter type for the input time series, either "S(TORAGE)" or "E(LEVATION).”  Only the first character of the string is interpreted by the function.

outputType – A string specifying the parameter type for the output time series, either "S(TORAGE)”, "E(LEVATION)" or “A(REA).”  Only the first character of the string is interpreted by the function.

storageScaleFactor – A floating-point number used to scale input (by multiplying) and output (by dividing) storage values.

Examples:

      tsStorage =

conicElevAreaCurve.conicInterpolation(

tsElev,

“Elevation”,

“Storage”,

1.0)

 

      tsArea =

conicElevAreaCurve.conicInterpolation(

tsElev,

“Elevation”,

“Area”,

1.0)

Returns: A new TimeSeriesMath object

Generated Exceptions:  Throws a hec.hecmath.HecMathException if inputType or outputType cannot be interpreted as one of the allowed values; if inputType and outputType are the same parameters; if values in the conic interpolation table are not in ascending order.