Scripting > Math Functions


Convert Values to English Units

convertToEnglishUnits()

 

Perform unit conversion of data values and unit labels in the current time series or paired data set from Metric (SI) units to English units.  Determination of the unit system will be based upon the current units labels and parameter types.  If the data units are already in English units or the unit system cannot be determined, no conversion occurs.

For paired data, both x and y values are converted.  For time series data, missing values remain missing.

 

See also:  convertToMetricUnits(), isEnglish(), isMetric()

Parameters:  Takes no parameters

Example:  englishDataSet = siDataSet.convertToEnglishUnits()

Returns:  A HecMath object of the same type as the current object