1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
#!/usr/bin/env python
from typing import TypeVar, Tuple
import collections
import json
import ast
import bisect
import pandas
import numpy
import matplotlib.pyplot as mpyplot
import matplotlib.patches as mpatches
TimeStampType = TypeVar('TimeStamp', int, float)
"""Type definition for timestamp as integer or float values."""
DataType = TypeVar('Data')
"""Type definition for data to store anything in time."""
TimeStampedBufferType = TypeVar('TimeStampedBuffer', bound="TimeStampedBuffer")
# Type definition for type annotation convenience
class JsonEncoder(json.JSONEncoder):
def default(self, obj):
# numpy cases
if isinstance(obj, numpy.integer):
return int(obj)
if isinstance(obj, numpy.floating):
return float(obj)
if isinstance(obj, numpy.ndarray):
return obj.tolist()
# default case
try:
return json.JSONEncoder.default(self, obj)
# class case
except:
# ignore attribute starting with _
public_dict = {}
for k, v in vars(obj).items():
if not k.startswith('_'):
public_dict[k] = v
return public_dict
class TimeStampedBuffer(collections.OrderedDict):
"""Ordered dictionary to handle timestamped data.
```
{
timestamp1: data1,
timestamp2: data2,
...
}
```
.. warning:: Timestamps must be numbers.
.. warning:: Timestamps are not sorted internally.
Data are considered to be stored according at their coming time.
"""
def __new__(cls, args = None):
"""Inheritance"""
return super(TimeStampedBuffer, cls).__new__(cls)
def __setitem__(self, ts: TimeStampType, data: DataType):
"""Store data at given timestamp."""
assert(type(ts) == int or type(ts) == float)
super().__setitem__(ts, data)
def __repr__(self):
"""String representation"""
return json.dumps(self, ensure_ascii=False, cls=JsonEncoder)
def __str__(self):
"""String representation"""
return json.dumps(self, ensure_ascii=False, cls=JsonEncoder)
def append(self, timestamped_buffer: TimeStampedBufferType) -> TimeStampedBufferType:
"""Append a timestamped buffer."""
for ts, value in timestamped_buffer.items():
self[ts] = value
return self
@property
def first(self) -> Tuple[TimeStampType, DataType]:
"""Easing access to first item."""
return list(self.items())[0]
def pop_first(self) -> Tuple[TimeStampType, DataType]:
"""Easing FIFO access mode."""
return self.popitem(last=False)
def pop_last_until(self, ts: TimeStampType) -> Tuple[TimeStampType, DataType]:
"""Pop all item until a given timestamped value and return the first after."""
# get last item before given timestamp
earliest_ts, earliest_value = self.get_last_until(ts)
first_ts, first_value = self.first
while first_ts < earliest_ts:
self.pop_first()
first_ts, first_value = self.first
return first_ts, first_value
def pop_last_before(self, ts: TimeStampType) -> Tuple[TimeStampType, DataType]:
"""Pop all item before a given timestamped value and return the last one."""
# get last item before given timestamp
earliest_ts, earliest_value = self.get_last_before(ts)
popep_ts, poped_value = self.pop_first()
while popep_ts != earliest_ts:
popep_ts, poped_value = self.pop_first()
return popep_ts, poped_value
@property
def last(self) -> Tuple[TimeStampType, DataType]:
"""Easing access to last item."""
return list(self.items())[-1]
def pop_last(self) -> Tuple[TimeStampType, DataType]:
"""Easing FIFO access mode."""
return self.popitem(last=True)
def get_first_from(self, ts) -> Tuple[TimeStampType, DataType]:
"""Retreive first item timestamp from a given timestamp value."""
ts_list = list(self.keys())
first_from_index = bisect.bisect_left(ts_list, ts)
if first_from_index < len(self):
first_from_ts = ts_list[first_from_index]
return first_from_ts, self[first_from_ts]
else:
raise KeyError(f'No data stored after {ts} timestamp.')
def get_last_before(self, ts) -> Tuple[TimeStampType, DataType]:
"""Retreive last item timestamp before a given timestamp value."""
ts_list = list(self.keys())
last_before_index = bisect.bisect_left(ts_list, ts) - 1
if last_before_index >= 0:
last_before_ts = ts_list[last_before_index]
return last_before_ts, self[last_before_ts]
else:
raise KeyError(f'No data stored before {ts} timestamp.')
def get_last_until(self, ts) -> Tuple[TimeStampType, DataType]:
"""Retreive last item timestamp until a given timestamp value."""
ts_list = list(self.keys())
last_until_index = bisect.bisect_right(ts_list, ts) - 1
if last_until_index >= 0:
last_until_ts = ts_list[last_until_index]
return last_until_ts, self[last_until_ts]
else:
raise KeyError(f'No data stored until {ts} timestamp.')
@classmethod
def from_json(self, json_filepath: str) -> TimeStampedBufferType:
"""Create a TimeStampedBuffer from .json file."""
with open(json_filepath, encoding='utf-8') as ts_buffer_file:
json_buffer = json.load(ts_buffer_file)
return TimeStampedBuffer({ast.literal_eval(ts_str): json_buffer[ts_str] for ts_str in json_buffer})
def to_json(self, json_filepath: str):
"""Save a TimeStampedBuffer to .json file."""
with open(json_filepath, 'w', encoding='utf-8') as ts_buffer_file:
json.dump(self, ts_buffer_file, ensure_ascii=False, cls=JsonEncoder)
@classmethod
def from_dataframe(self, dataframe: pandas.DataFrame, exclude=[]) -> TimeStampedBufferType:
"""Create a TimeStampedBuffer from [pandas dataframe](https://pandas.pydata.org/docs/reference/frame.html)."""
dataframe.drop(exclude, inplace=True, axis=True)
assert(dataframe.index.name == 'timestamp')
return TimeStampedBuffer(dataframe.to_dict('index'))
def as_dataframe(self, exclude=[], split={}) -> pandas.DataFrame:
"""Convert as [pandas dataframe](https://pandas.pydata.org/docs/reference/frame.html).
The optional *split* argument allows tuple values to be stored in dedicated columns.
For example: to convert {"point": (0, 0)} data as two separated "x" and "y" columns, use split={"point": ["x", "y"]}
.. warning:: Values must be dictionaries.
Each key is stored as a column name.
.. note:: Timestamps are stored as index column called 'timestamp'.
"""
df = pandas.DataFrame.from_dict(self.values())
# Exclude columns
df.drop(exclude, inplace=True, axis=True)
# Split columns
if len(split) > 0:
splited_columns = []
for column in df.columns:
if column in split.keys():
df[split[column]] = pandas.DataFrame(df[column].tolist(), index=df.index)
df.drop(column, inplace=True, axis=True)
for new_column in split[column]:
splited_columns.append(new_column)
else:
splited_columns.append(column)
# Reorder splited columns
df = df[splited_columns]
# Append timestamps as index column
df['timestamp'] = self.keys()
df.set_index('timestamp', inplace=True)
return df
def plot(self, names=[], colors=[], split={}, samples=None) -> list:
"""Plot as [matplotlib](https://matplotlib.org/) time chart."""
df = self.as_dataframe(split=split)
legend_patches = []
# decimate data
if samples != None:
if samples < len(df):
step = int(len(df) / samples) + 1
df = df.iloc[::step, :]
for name, color in zip(names, colors):
markerline, stemlines, baseline = mpyplot.stem(df.index, df[name])
mpyplot.setp(markerline, color=color, linewidth=1, markersize = 1)
mpyplot.setp(stemlines, color=color, linewidth=1)
mpyplot.setp(baseline, color=color, linewidth=1)
legend_patches.append(mpatches.Patch(color=color, label=name.upper()))
return legend_patches
|
