Developer notes

The Fox class

The Fox class is where we manipulate dictionary-series data.

class foxplot.fox.Fox(filename)

Frequent Observation diXionaries, our main class.

Our main class to read, access and manipulate series of dictionary data.

detect_time()

Search for a time key in root keys.

Return type:

None

static empty()

Initialize from empty time series.

Return type:

Fox

get_series(label)

Get time-series data from a given label.

Parameters:

label (str) – Label to the data in input dictionaries, for example /observation/cpu_temperature.

Return type:

Series

Returns:

Corresponding time series.

plot(left, right=None, title=None)

Plot a set of indexed series.

Parameters:

• left (Union[Series, Node, List[Union[Series, Node]]]) – Series to plot on the left axis.

• right (Union[Series, Node, List[Union[Series, Node]], None]) – Series to plot on the right axis.

• title (Optional[str]) – Plot title.

Return type:

None

set_time(time)

Set label of time index in input dictionaries.

Parameters:

time (Series) – Time index as a series.

unpack(unpacked)

Append data from an unpacked dictionary.

Parameters:

unpacked (dict) – Unpacked dictionary.

Return type:

None