{"id":9937,"date":"2016-02-23T12:56:56","date_gmt":"2016-02-23T04:56:56","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=9937"},"modified":"2024-08-15T10:31:33","modified_gmt":"2024-08-15T02:31:33","slug":"timeweightedaverage_sampled","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/calculations\/timeweightedaverage_sampled\/","title":{"rendered":"TimeWeightedAverage_Sampled()"},"content":{"rendered":"\n

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

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

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

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

Returns the time-weighted average of the values of\u00a0an expression over a range of time.<\/p>\n

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

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

StartTime<\/strong>: The start time over which to produce the average.\u00a0
\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 average.\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

A time-weighted average takes all the values that the expression held during a period of time, multiplies them by the time that the value was in effect, sums them, and then divides by the total time. This is most appropriate when producing averages of sampled continuous functions, such as the temperature of a furnace.<\/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: TimeWeightedAverage_Sampled(Expr, Time() - 60, Time())<\/span>
\n Result: Average over the last minute (60 seconds).<\/p>\n

Expression: TimeWeightedAverage_Sampled<\/span>(Expr, Time() - 60)<\/span>
\n Result: Average over the last minute (60 seconds).<\/p>\n

Expression: TimeWeightedAverage_Sampled<\/span>(Expr, Midnight(Time()))<\/span>
\n Result: Average since midnight (the start of the day).<\/p>\n

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

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

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

Use TimeWeightedAverage_Sampled() to get the time-weighted average of the values of an expression over a range of time.<\/p>\n

Read more<\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":9939,"parent":3650,"menu_order":232,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[9],"tags":[285,100,413,422],"class_list":["post-9937","page","type-page","status-publish","has-post-thumbnail","hentry","category-tech-ref","tag-average","tag-calculations","tag-sampled","tag-time-weighted","Product-srv"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/9937","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=9937"}],"version-history":[{"count":1,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/9937\/revisions"}],"predecessor-version":[{"id":46262,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/9937\/revisions\/46262"}],"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\/9939"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=9937"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=9937"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=9937"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}