Scripting

HecMath Class

The objects returned from the HecDss..read(…) methods and supplied to the HecDss.write(…) method are HecMath objects.  There are currently three types of HecMath classes: TimeSeriesMath class, PairedDataMath class, and StreamRatingMath class which represent time-series data, paired data, and stream rating data, respectively. 

 

An HecMath object can be created for writing to new DSS data by first creating a new DataContainer as discussed in the sections "TimeSeriesContainer Class" and "PairedDataContainer Class", and then calling the HecMath.createInstance() function with the DataContainer object as the only parameter (e.g. myTimeSeriesMath = HecMath.createInstance(myTimeSeriesContainer)).  The methods for HecMath Objects, are listed in below.

 

HecMath Methods

Method

Returns

abs()

HecMath

accumulation()

TimeSeriesMath

acos()

HecMath

add(floating-point constant)

HecMath

add(TimeSeriesMath dataset)

TimeSeriesMath

applyMultipleLinearRegression(
       string startTimeString, 
       string endTimeString,
       sequence datasets, 
       floating-point minLimit, 
       floating-point maxLimit)

TimeSeriesMath

asin()

HecMath

atan()

HecMath

ceil()

HecMath

centeredMovingAverage(integer number,
       0/1 onlyValid, 
       0/1 useReduced)

TimeSeriesMath

conicInterpolation(TimeSeriesMath dataset,
       string inputType,                      
       string outputType,
       floating-point storageFactor)

TimeSeriesMath

convertValuesToEnglishUnits()

HecMath

convertValuesToMetricUnits()

HecMath

correlationCoefficients(
       TimeSeriesMath dataset)

LinearRegression

Statistics

cos()

HecMath

cyclicAnalysis()

sequence of TimeSeriesMath

decayingBasinWetnessParameter(
       TimeSeriesMath tsPrecip,      
       floating-point decayRate)

TimeSeriesMath

divide(floating-point constant)

HecMath

divide(TimeSeriesMath dataset)

TimeSeriesMath

estimateForMissingPrecipValues( 
       integer maxMissing)

TimeSeriesMath

estimateForMissingValues(        
       integer maxMissing)

TimeSeriesMath

exp()

HecMath

exponentiation(floating-point constant)

HecMath

exponentiation(HecMath tsMath)

HecMath

extractTimeSeriesDataForTimeSpecification(   
       string timeLevel,                         
       string range,                           
       0/1 isInclusive,                           
       integer intervalWindow,                    
       0/1 setAsIrregular)

TimeSeriesMath

firstValidDate()

integer

firstValidValue()

floating-point

floor()

HecMath

flowAccumulatorGageProcessor(
       TimeSeriesMath dataset)

TimeSeriesMath

fmod(HecMath tsMath)

HecMath

forwardMovingAverage(integer number)

TimeSeriesMath

forwardMovingAverage(                    
       integer numberToAverageOver,                      
       0/1 OnlyValidValues,                      
       0/1 useReduced)

Hecmath

generateDataPairs(TimeSeriesMath dataset,
       0/1 sort)

PairedDataMath

generateRegularIntervalTimeSeries(
       string startTime,                         
       string endTime,                     
       string timeInterval,                        
       string timeOffset,                        
       floating-point initialValue)

TimeSeriesMath

getData()

DataContainer

getType()

string

getUnits()

string

gmean(list of HecMath tsMathArray)

HecMath

hmean(list of HecMath tsMathArray)

HecMath

integer_divide(floating-point constant)

HecMath

integer_divide(HecMath tsMath)

HecMath

interpolateDataAtRegularInterval(    
       string timeInterval,                       
       string timeOffset)

TimeSeriesMath

inverse()

HecMath

isEnglish()

0/1

isMetric()

0/1

isMuskingumRoutingStable(       
       integer subReachCount,         
       floating-point muskingumK,         
       floating-point muskingumX)

string

lastValidDate()

integer

lastValidValue()

floating-point

log()

HecMath

log10()

HecMath

max()

floating-point

max(list of HecMath tsMathArray)

HecMath

maxDate()

integer

mean()

floating-point

mean(list of HecMath tsMathArray)

HecMath

med(list of HecMath tsMathArray)

HecMath

mergePairedData(PairedDataMath dataset)

PairedDataMath

mergeTimeSeries(TimeSeriesMath dataset)

TimeSeriesMath

min()

floating-point

min(list of HecMath tsMathArray)

HecMath

minDate()

integer

modifiedPulsRouting(      
       TimeSeriesMath dataset,            
       integer subReachCount,           
       floating-point muskingumX)

TimeSeriesMath

modulo(floating-point constant)

HecMath

modulo(HecMath tsMath)

HecMath

multipleLinearRegression(sequence datasets,
       floating-point minLimit,                   
       floating-point maxLimit)

PairedDataMath

multiply(floating-point constant)

HecMath

multiply(TimeSeriesMath dataset)

TimeSeriesMath

muskingumRouting(integer subReachCount,
       floating-point muskingumK,        
       floating-point muskingumX)

TimeSeriesMath

neg()

HecMath

numberInvalidValues()

integer

numberMissingValues()

integer

numberQuestionedValues()

integer

numberRejectedValues()

integer

numberValidValues()

integer

olympicSmoothing(integer number,      
       0/1 onlyValid,                               
       0/1 useReduced)

TimeSeriesMath

p1(list of HecMath tsMathArray)

HecMath

p2(list of HecMath tsMathArray)

HecMath

p5(list of HecMath tsMathArray)

HecMath

p10(list of HecMath tsMathArray)

HecMath

p20(list of HecMath tsMathArray)

HecMath

p25(list of HecMath tsMathArray)

HecMath

p75(list of HecMath tsMathArray)

HecMath

p80(list of HecMath tsMathArray)

HecMath

p89(list of HecMath tsMathArray)

HecMath

p90(list of HecMath tsMathArray)

HecMath

p95(list of HecMath tsMathArray)

HecMath

p99(list of HecMath tsMathArray)

HecMath

periodConstants(TimeSeriesMath dataset)

TimeSeriesMath

polynomialTransformation(    
       TimeSeriesMath dataset)

TimeSeriesMath

polynomialTransformationWithIntegral(
        TimeSeriesMath dataset)

TimeSeriesMath

product(list of HecMath tsMathArray)

HecMath

ratingTableInterpolation(
       TimeSeriesMath dataset)

TimeSeriesMath

replaceSpecificValues(HecDouble from,
       HecDouble to)

HecMath

reverseRatingTableInterpolation(
       TimeSeriesMath dataset)

TimeSeriesMath

rms(list of HecMath tsMathArray)

HecMath

round()

HecMath

roundOff(integer digits, integer place)

HecMath

screenWithConstantValue(                     
       String durationStr,                 
       floating-point rejectTolerance, 
       floating-point questionTolerance,
       floating-point minThreshold,  
       integer maxMissing)

HecMath

screenWithDurationMagnitude(                     
       String durationStr,          
       floating-point minRejectLimit,        
       floating-point minQuestionLimit,  
       floating-point maxRejectLimit,                        
       floating-point maxQuestionLimit)

HecMath

screenWithForwardMovingAverage(    
       integer numberToAverageOver, 
       floating-point changeLimit)

HecMath

screenWithForwardMovingAverage(    
       integer number, 
       floating-point changeLimit, 
       0/1 setMissing, string invalidQuality)

TimeSeriesMath

screenWithMaxMin(floating-point min,  
       floating-point max, 
       floating-point rate,   
       0/1 setMissing, 
       string invalidQuality)

TimeSeriesMath

screenWithMaxMin(
       floating-point minValueLimit,
       floating-point maxValueLimit, 
       floating-point changeLimit)

HecMath

screenWithMaxMin( 
       floating-point minValueLimit, 
       floating-point maxValueLimit,   
       floating-point changeLimit, 
       0/1 setInvalidToSpecified, 
       floating-point invalidValueReplacement,  
       string qualityFlagForInvalidValue)

HecMath

screenWithMaxMin( 
       floating-point minRejectLimit, 
       floating-point minQuestionLimit,    
       floating-point maxQuestionLimit, 
       floating-point maxRejectLimit)

HecMath

screenWithRateOfChange( 
       floating-point minRejectLimit, 
       floating-point minQuestionLimit,  
       floating-point maxQuestionLimit,  
       floating-point maxRejectLimit)

HecMath

setCurve(string name)

None

setCurve(integer number)

None

setData(DataContainer data)

None

setLocation(string location)

None

setParameter(string parameter)

None

setPathname(string pathname)

None

setTimeInterval(string interval)

None

setType(string type)

None

setUnits(string units)

None

setVersion(string version)

None

setWatershed(string watershed)

None

shiftAdjustment(TimeSeriesMath dataset)

TimeSeriesMath

shiftInTime(string timeShift)

TimeSeriesMath

sign()

HecMath

sin()

HecMath

skewCoefficient()

floating-point

snapToRegularInterval(string timeInterval,
       string timeOffset, 
       string timeBackward,
       string timeForward)

TimeSeriesMath

sqrt()

HecMath

standardDeviation()

floating-point

standardDeviation (
       list of HecMath tsMathArray)

HecMath

straddleStaggerRouting(integer avgCount,
       integer lagCount, 
       integer subReachCount)

TimeSeriesMath

subtract(floating-point constant)

HecMath

subtract(TimeSeriesMath dataset)

TimeSeriesMath

successiveDifferences()

TimeSeriesMath

sum()

floating-point

sum (list of HecMath tsMathArray)

HecMath

tan()

HecMath

timeDerivative()

TimeSeriesMath

transformTimeSeries(string timeInterval, 
       string timeOffset,
       string functionType)

TimeSeriesMath

transformTimeSeries( 
       TimeSeriesMath dataset, 
       string functionType)

TimeSeriesMath

truncate()

HecMath

twoVariableRatingTableInterpolation(
       TimeSeriesMath dataset1,
       TimeSeriesMath dataset2)

TimeSeriesMath

var (list of HecMath tsMathArray)

HecMath