{"id":9981,"date":"2016-02-23T14:32:35","date_gmt":"2016-02-23T06:32:35","guid":{"rendered":"http:\/\/localhost\/help\/p2-server\/calculations\/integral_sampled\/"},"modified":"2024-01-17T10:48:02","modified_gmt":"2024-01-17T02:48:02","slug":"integral_sampled","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/calculations\/integral_sampled\/","title":{"rendered":"Integral_Sampled()"},"content":{"rendered":"\n

Format<\/span><\/h2>\n

Integral_Sampled(Expr ,StartTime [,EndTime])<\/strong><\/p>\n

Note: This function was named\u00a0Integral<\/em>\u00a0in v2.6.<\/p>\n

Returns<\/span><\/h2>\n

Returns the integral of an expression over a range of time.<\/p>\n

Inputs<\/span><\/h2>\n

Expr<\/strong>: The expression to be integrated.
\n Behaviour: Required
\n Dimension:\u00a0Collection
\n Valid\u00a0data types:\u00a0Boolean, Decimal, Integer<\/p>\n

Note:\u00a0The integrated function is constructed by using a zero-order hold (that is, step function) on EXPR's sampled points.<\/p>\n

StartTime<\/strong>: The start time over which to produce the integral.
\n Behaviour: Required
\n Dimension: Collection, SingleValue
\n Valid data types: DateTime, Decimal, Integer, String<\/p>\n

Note: You can use the Time<\/a>() function to use a valid DateTime argument.<\/p>\n

EndTime<\/strong>: The end time over which to produce the integral.\u00a0If not specified, it assumes the current time.\u00a0
\n Behaviour: Optional\u00a0
\n Dimension: Collection, SingleValue
\n Valid data types: DateTime, Decimal, Integer, String<\/p>\n

Note: You can use the Time<\/a>() function to use a valid DateTime argument.<\/p>\n

How to format data types<\/a><\/p>\n

When to Use<\/h2>\n

Integral_Sampled()\u00a0operates in SI units of time, that is, seconds. If you are integrating a rate to produce a total, ensure that the rate is a per-second quantity so that you produce a meaningful result.<\/p>\n

It is possible to retrieve very large volumes of data through indiscriminate use of this function. Retrieving large amounts of Historian data across a slow network can affect system performance for all users of the system.<\/p>\n

Examples<\/span><\/h2>\n

Expression: Integral_Sampled(Expr, Time() - 60, Time())<\/span>
\n Result: Integral\u00a0over the last minute (60 seconds).<\/p>\n

Expression: Integral_Sampled<\/span>(Expr, Time() - 60)<\/span>
\n Result: Integral\u00a0over the last minute (60 seconds).<\/p>\n

Expression: Integral_Sampled<\/span>(Expr, Midnight(Time()))<\/span>
\n Result: Integral\u00a0since midnight (the start of the day).<\/p>\n

Expression: Integral_Sampled<\/span>({tag, sampleMethod = \"Raw\"}, Time() \u2013 60)<\/span>
\n Result: Integral\u00a0of the raw values over the last minute.<\/p>\n

Expression: Integral_Sampled<\/span>(Sampling(Expr, \"raw\"), Time() - 60)<\/span>
\n Result: Integral\u00a0of the raw values over the last minute.<\/p>\n

Expression: Integral_Sampled<\/span>({HourlyFlowRate}\/3600, Midnight(Time()))<\/span>
\n Result: Integral of the hourly flow rate since midnight, ie total production for the day (3600 is the number of seconds in an hour).<\/p>\n

Expression: Integral_Sampled<\/span>({ABC} > 10, Midnight(Time()))<\/span>
\n Result: The total number of seconds during which the tag ABC has been greater than 10, since midnight. Equality operators (ie =, ==, !=, <, <=, >, >=) evaluate to 1 or 0, so integrating them produces the total time that the expression is true.<\/p>\n

\u00a0<\/p>\n","protected":false},"excerpt":{"rendered":"

Use Integral_Sampled() to get the integral of an expression over a range of time.<\/p>\n

Read more<\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":10000,"parent":3650,"menu_order":123,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[9],"tags":[100,414,413],"class_list":["post-9981","page","type-page","status-publish","has-post-thumbnail","hentry","category-tech-ref","tag-calculations","tag-integral","tag-sampled","Product-srv"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/9981","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=9981"}],"version-history":[{"count":1,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/9981\/revisions"}],"predecessor-version":[{"id":46222,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/9981\/revisions\/46222"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/3650"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/10000"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=9981"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=9981"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=9981"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}