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( |
TimeSeriesMath |
|
asin() |
HecMath |
|
atan() |
HecMath |
|
ceil() |
HecMath |
|
centeredMovingAverage(integer number, |
TimeSeriesMath |
|
conicInterpolation(TimeSeriesMath dataset, |
TimeSeriesMath |
|
convertValuesToEnglishUnits() |
HecMath |
|
convertValuesToMetricUnits() |
HecMath |
|
correlationCoefficients( |
LinearRegression Statistics |
|
cos() |
HecMath |
|
cyclicAnalysis() |
sequence of TimeSeriesMath |
|
decayingBasinWetnessParameter( |
TimeSeriesMath |
|
divide(floating-point constant) |
HecMath |
|
divide(TimeSeriesMath dataset) |
TimeSeriesMath |
|
estimateForMissingPrecipValues( |
TimeSeriesMath |
|
estimateForMissingValues( |
TimeSeriesMath |
|
exp() |
HecMath |
|
exponentiation(floating-point constant) |
HecMath |
|
exponentiation(HecMath tsMath) |
HecMath |
|
extractTimeSeriesDataForTimeSpecification( |
TimeSeriesMath |
|
firstValidDate() |
integer |
|
firstValidValue() |
floating-point |
|
floor() |
HecMath |
|
flowAccumulatorGageProcessor( |
TimeSeriesMath |
|
fmod(HecMath tsMath) |
HecMath |
|
forwardMovingAverage(integer number) |
TimeSeriesMath |
|
forwardMovingAverage( |
Hecmath |
|
generateDataPairs(TimeSeriesMath dataset, |
PairedDataMath |
|
generateRegularIntervalTimeSeries( |
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( |
TimeSeriesMath |
|
inverse() |
HecMath |
|
isEnglish() |
0/1 |
|
isMetric() |
0/1 |
|
isMuskingumRoutingStable( |
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 |
|
modulo(floating-point constant) |
HecMath |
|
modulo(HecMath tsMath) |
HecMath |
|
multipleLinearRegression(sequence datasets, |
PairedDataMath |
|
multiply(floating-point constant) |
HecMath |
|
multiply(TimeSeriesMath dataset) |
TimeSeriesMath |
|
muskingumRouting(integer subReachCount, |
TimeSeriesMath |
|
neg() |
HecMath |
|
numberInvalidValues() |
integer |
|
numberMissingValues() |
integer |
|
numberQuestionedValues() |
integer |
|
numberRejectedValues() |
integer |
|
numberValidValues() |
integer |
|
olympicSmoothing(integer number, |
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 |
|
polynomialTransformationWithIntegral( |
TimeSeriesMath |
|
product(list of HecMath tsMathArray) |
HecMath |
|
ratingTableInterpolation( |
TimeSeriesMath |
|
replaceSpecificValues(HecDouble from, |
HecMath |
|
reverseRatingTableInterpolation( |
TimeSeriesMath |
|
rms(list of HecMath tsMathArray) |
HecMath |
|
round() |
HecMath |
|
roundOff(integer digits, integer place) |
HecMath |
|
screenWithConstantValue( |
HecMath |
|
screenWithDurationMagnitude( |
HecMath |
|
screenWithForwardMovingAverage( |
HecMath |
|
screenWithForwardMovingAverage( |
TimeSeriesMath |
|
screenWithMaxMin(floating-point min, |
TimeSeriesMath |
|
screenWithMaxMin( |
HecMath |
|
screenWithMaxMin( |
HecMath |
|
screenWithMaxMin( |
HecMath |
|
screenWithRateOfChange( |
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, |
TimeSeriesMath |
|
sqrt() |
HecMath |
|
standardDeviation() |
floating-point |
|
standardDeviation ( |
HecMath |
|
straddleStaggerRouting(integer avgCount, |
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, |
TimeSeriesMath |
|
transformTimeSeries( |
TimeSeriesMath |
|
truncate() |
HecMath |
|
twoVariableRatingTableInterpolation( |
TimeSeriesMath |
|
var (list of HecMath tsMathArray) |
HecMath |