ktk.TimeSeries.add_data_info#
- TimeSeries.add_data_info(data_key, info_key, value, *, overwrite=False, in_place=False)[source]#
Add metadata to TimeSeries’ data.
Warning
This function will be deprecated when Kinetics Toolkit will reach version 1.0. Please use add_info instead.
- Parameters:
data_key (str) – The data key the info corresponds to.
info_key (str) – The key of the info dict.
value (Any) – The info.
overwrite (bool) – Optional. True to overwrite the data info if it is already present in the TimeSeries. Default is False.
in_place (bool) – Optional. True to modify the original TimeSeries. False to return a modified copy of the TimeSeries while leaving the original TimeSeries intact. Default is False.
- Returns:
The TimeSeries with the added data info.
- Return type: