Time Weighted Average
get(connection, parameters_dict)
A function that receives a dataframe of raw tag data and performs a time weighted averages, returning the results.
This function requires the input of a pandas dataframe acquired via the rtdip.functions.raw() method and the user to input a dictionary of parameters. (See Attributes table below)
Pi data points will either have step enabled (True) or step disabled (False). You can specify whether you want step to be fetched by "Pi" or you can set the step parameter to True/False in the dictionary below.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
connection |
object
|
Connection chosen by the user (Databricks SQL Connect, PYODBC SQL Connect, TURBODBC SQL Connect) |
required |
parameters_dict |
dict
|
A dictionary of parameters (see Attributes table below) |
required |
Source code in src/sdk/python/rtdip_sdk/queries/time_series/time_weighted_average.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
|
Example
from rtdip_sdk.authentication.azure import DefaultAuth
from rtdip_sdk.connectors import DatabricksSQLConnection
from rtdip_sdk.queries import time_weighted_average
auth = DefaultAuth().authenticate()
token = auth.get_token("2ff814a6-3304-4ab8-85cb-cd0e6f879c1d/.default").token
connection = DatabricksSQLConnection("{server_hostname}", "{http_path}", token)
parameters = {
"business_unit": "{business_unit}",
"region": "{region}",
"asset": "{asset_name}",
"data_security_level": "{security_level}",
"data_type": "float",
"tag_names": ["{tag_name_1}", "{tag_name_2}"],
"start_date": "2023-01-01",
"end_date": "2023-01-31",
"time_interval_rate": "15",
"time_interval_unit": "minute",
"window_length": 1,
"include_bad_data": True,
"step": "true"
}
x = time_weighted_average.get(connection, parameters)
print(x)
This example is using DefaultAuth()
and DatabricksSQLConnection()
to authenticate and connect. You can find other ways to authenticate here. The alternative built in connection methods are either by PYODBCSQLConnection()
, TURBODBCSQLConnection()
or SparkConnection()
.
Note
See Samples Repository for full list of examples.
Note
server_hostname
and http_path
can be found on the SQL Warehouses Page.