Circular Average

Circular Average - A function that receives a dataframe of raw tag data and computes the circular mean for samples in a range, returning the results.

Prerequisites

Ensure you have installed the RTDIP SDK as specified in the Getting Started section.

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().

Parameters

Name	Type	Description
business_unit	str	Business unit of the data
region	str	Region
asset	str	Asset
data_security_level	str	Level of data security
data_type	str	Type of the data (float, integer, double, string)
tag_names	list	List of tagname or tagnames ["tag_1", "tag_2"]
start_date	str	Start date (Either a date in the format YY-MM-DD or a datetime in the format YYY-MM-DDTHH:MM:SS or specify the timezone offset in the format YYYY-MM-DDTHH:MM:SS+zz:zz)
end_date	str	End date (Either a date in the format YY-MM-DD or a datetime in the format YYY-MM-DDTHH:MM:SS or specify the timezone offset in the format YYYY-MM-DDTHH:MM:SS+zz:zz)
time_interval_rate	str	The time interval rate (numeric input)
time_interval_unit	str	The time interval unit (second, minute, day, hour)
lower_bound	int	Lower boundary for the sample range
upper_bound	int	Upper boundary for the sample range
include_bad_data	bool	Include "Bad" data points with True or remove "Bad" data points with False

Example

from rtdip_sdk.authentication.azure import DefaultAuth
from rtdip_sdk.connectors import DatabricksSQLConnection
from rtdip_sdk.queries import circular_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",
    "lower_bound": 0,
    "upper_bound": 360,
    "include_bad_data": True,
}
x = circular_average.get(connection, parameters)
print(x)