Appendix B - Channel Functions and Aggregations

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

Appendix B - Channel Functions and Aggregations

Aggregations listed here are performed on a channel at its 'processing interval'. A channels default aggregation is 'Average' by default, with 'VectorAvg' being applied to vector channels.

Functions can be applied as part of a Calculated Channel calculation. See Calculated Channel Examples.

 

Aggregation

Description

Avg

Average value for period

CapturePercent

Capture % during period

Count

Number of measurements in period

Delta

Difference between the first and last reading during period.

DbAvg

dB Average for period

Earliest

Earliest measurement in the period

Exceedences

Count of values exceeding threshold, parameter defines threshold value

GeometricMean

Geometric mean value in period

GeometricStdDev

Geometric standard deviation in period

Latest

Latest value measured

Log10Avg

Base 10 logarithmic average for period

LogAvg

Base e Logarithmic average for period

Max

Maximum value measured in period

MaxAbs

Maximum of absolute values

Median

Median value for period

Min

Minimum value measured in period

MinAbs

Minimum of absolute values

Mode

Mode value for the period

NthEarliest

Nth earliest value in the period, parameter indicates position

NthLatest

Nth latest value in the period, parameter indicates position

NthMax

Nth maximum value in the period, parameter indicates position

NthMin

Nth minimum value in the period, parameter indicates position

NthPercentile

Nth percentile value in the period, parameter indicates percentile

Range

Difference between minimum and maximum readings during period.

Rms

Root Mean Square for period

SigmaTheta

Sigma Theta value calculated from vector values

StdDev

Standard deviation calculation for the period

Sum

Sum of values during period

VectorAvg

Vector average by taking direction / magnitude into account

VectorSum

Vector sum by taking direction / magnitude into account

 

 

Function

Description

Abs(value)

Return the absolute value of a number

ACos(value)

Returns the angle whose cosine is the specified number

ASin(value)

Returns the angle whose sine is the specified number

ATan(value)

Returns the angle whose tangent is the specified number

ATan2(x, y)

Returns the angle whose tangent is the quotient of two specified numbers

Cos(value)

Returns the cosine of the specified angle

Cosh(value)

Returns the hyperbolic cosine of the specified angle

Convert(value, sourceUnit, destUnit)

Convert a value from one unit to another

ConvertMolecular(value, sourceUnit, destUnit, molecularFormula)

Convert a value between gravimetric and volumetric units using a molecular weight or formula at the temperature specified in the configuration settings.

ConvertMolecularTemp(value, sourceUnit, destUnit, molecularFormula, temperatureCelsius)

Convert a value between gravimetric and volumetric units using a molecular weight or formula at a specified temperature

Exp(value)

Returns e raised to the specified power

If(condition, ifTrue, ifFalse)

Evaluate a condition and return one of two values based on the result

Log(value)

Returns the natural (base e) logarithm of a specified number

Log10(value)

Returns the base 10 logarithm of a specified number

Max(...values)

Return the larger of multiple values

Min(...values)

Return the smaller of multiple values

Avg(...values)

Return the average of multiple values

Round(value, precision)

Round a number to a specific number of decimal places

Sin(value)

Returns the sine of the specified angle

Sinh(value)

Returns the hyperbolic sine of the specified angle

SolarAzimuth(timestamp, latitude, longitude)

Returns the solar azimuth at given time (Unix time) and position (decimal degrees)

SolarElevation(timestamp, latitude, longitude)

Returns the solar elevation at given time (Unix time) and position (decimal degrees)

SolarRad(timestamp, latitude, longitude)

Returns the direct solar radiation at given time (Unix time) and position (decimal degrees)

Sqr(value)

Returns the square root of a specified number

Tan(value)

Returns the tangent of the specified angle

Tanh(value)

Returns the hyperbolic tangent of the specified angle

 

 

Global

Description

e

Natural Log Constant (e)

h

Planck Constant (h)

now

Unix Time (seconds since 1970-01-01 UTC)

null

Null Constant

pi

Pi Constant (π)