PE functions by type
- Last UpdatedSep 04, 2025
- 4 minute read
- PI System
- PI Server 2023
- PI Server
This topic provides comprehensive tables that categorize and describe the available Performance Equation (PE) functions by type, including mathematical, aggregate, logical, string, time-based, archive-related, and point attribute functions. These tables are intended to serve as a quick reference for understanding the purpose and syntax of each function.
Detailed information on how to use these functions for Asset Analytics, including syntax, parameters, and practical examples, is available in the Expression functions reference.
A complete list of Performance Equation functions organized alphabetically can be found in the Alphabetical reference for PE functions and Steam functions are also available for thermodynamic property calculations. For details, see Steam functions overview.
Math functions
|
Name |
Description |
|---|---|
|
Abs |
Absolute value |
|
Asin |
Arc sine |
|
Acos |
Arc cosine |
|
Atn |
Arc tangent |
|
Atn2 |
Arc tangent (two arguments) |
|
Cos |
Cosine |
|
Cosh |
Hyperbolic cosine |
|
Exp |
Exponential |
|
Float |
Conversion of string to number |
|
Frac |
Fractional part of number |
|
Int |
Integer part of number |
|
Log |
Natural logarithm |
|
Log10 |
Common logarithm |
|
Poly |
Evaluate polynomial |
|
Round |
Round to nearest unit |
|
Sgn |
Numerical sign |
|
Sin |
Sine |
|
Sinh |
Hyperbolic sine |
|
Sqr |
Square root |
|
Tanh |
Hyperbolic tangent |
|
Tan |
Tangent |
|
Trunc |
Truncate to next smaller unit |
Aggregate functions
|
Name |
Description |
|---|---|
|
Avg |
Average |
|
Max |
Maximum |
|
Median |
Median selector |
|
Min |
Minimum |
|
PStDev |
Population standard deviation |
|
SStDev |
Sample standard deviation |
|
Total |
Sum |
Miscellaneous functions
|
Name |
Description |
|---|---|
|
BadVal |
See if a value is bad (not a number or time) |
|
Curve |
Get value of a curve |
|
DigState |
Get digital state from a string |
|
IsDST |
Test whether a time is in local daylight saving time period |
|
IsSet |
Test if a PI value is annotated, substituted, or questionable |
|
StateNo |
The code number of a digital state |
|
TagBad |
See if a point has an abnormal state |
PI Archive retrieval functions
|
Name |
Description |
|---|---|
|
NextEvent |
Time of a point's next archive event |
|
NextVal |
Point's next value after a time |
|
PrevEvent |
Time of a point's previous archive event |
|
PrevVal |
Point's previous value before a time |
|
TagVal |
Point's value at a time |
PI Archive search functions
|
Name |
Description |
|---|---|
|
FindEq |
Timestamp when point = value |
|
FindGE |
Timestamp when point >= value |
|
FindGT |
Timestamp when point > value |
|
FindLE |
Timestamp when point <= value |
|
FindLT |
Timestamp when point < value |
|
FindNE |
Timestamp when point != value |
|
TimeEq |
Total period when point = value |
|
TimeGE |
Total period when point >= value |
|
TimeGT |
Total period when point > value |
|
TimeLE |
Total period when point <= value |
|
TimeLT |
Total period when point < value |
|
TimeNE |
Total period when point != value |
PI Archive statistics functions
|
Name |
Description |
|---|---|
|
EventCount |
Number of archive events |
|
PctGood |
Percent of good time in a period |
|
Range |
Range of minimum to maximum value |
|
StDev |
Time-weighted standard deviation |
|
TagAvg |
Time-weighted average |
|
TagMean |
Event-weighted average |
|
TagMax |
Maximum value in a period |
|
TagMin |
Minimum value in a period |
|
TagTot |
Time integral over a period |
Point attribute functions
|
Name |
Description |
|
TagDesc |
Get a point's descriptor |
|
TagEU |
Get a point's engineering unit string |
|
TagExDesc |
Get a point's extended descriptor |
|
TagName |
Get a point's name |
|
TagNum |
Get a point's ID |
|
TagSource |
Get a point's point source string |
|
TagSpan |
Get a point's span |
|
TagType |
Get a point's type character |
|
TagTypVal |
Get a point's typical value |
|
TagZero |
Get a point's zero value |
Time functions
|
Name |
Description |
|---|---|
|
Bod |
Timestamp for beginning of the day for given time |
|
Bom |
Timestamp for beginning of the month for given time |
|
Bonm |
Timestamp for first of the next month for given time |
|
Day |
Day of the month from a time |
|
DaySec |
Seconds since midnight from a time |
|
Hour |
Hour from a time |
|
Minute |
Minute from a time |
|
Month |
Month from a time |
|
Noon |
Timestamp for local noon of day of a time |
|
ParseTime |
Convert character string to time |
|
Second |
Second from a time |
|
Weekday |
Day of the week from a time |
|
Year |
Year from a time |
|
Yearday |
Day of the year from a time |
Dynamic response functions
|
Name |
Description |
|---|---|
|
Arma |
Dynamic response from Auto Regressive Moving Average model |
|
Delay |
Introduce time delay |
|
MedianFilt |
Select the median value of time series |
|
Impulse |
Dynamic response characterized by impulse response shape |
Alarm status functions
|
Name |
Description |
|---|---|
|
AlmAckStat |
Alarm acknowledgment status code |
|
AlmCondition |
Condition code number for Alarm State |
|
AlmCondText |
Alarm condition as text |
|
AlmPriority |
Alarm priority number |
String functions
|
Name |
Description |
|---|---|
|
Ascii |
ASCII character code for a character |
|
Char |
String for ASCII character code(s) |
|
Compare |
Wild comparison of two strings |
|
DigText |
Text for a digital state |
|
Format |
Formatting of a numerical number |
|
InStr |
Instance of a sub-string |
|
LCase |
Conversion of all characters to lower case |
|
Len |
Length of a string |
|
Left |
First characters in a string |
|
LTrim |
Removal of blanks on the left side of a string |
|
Mid |
Extraction of a sub-string from a string |
|
Right |
Last characters in a string |
|
RTrim |
Removal of blanks on the right side of a string |
|
Trim |
Removal of blanks on both sides of a string |
|
UCase |
Conversion of all characters to upper case |
String conversion functions
|
Name |
Description |
|---|---|
|
Concat |
Concatenate two or more strings |
|
String |
String representing any PI value |
|
Text |
Concatenation of strings for a series of PI value arguments |