esppy.plotting.StreamingImages

class esppy.plotting.StreamingImages(data_callback, image_key=None, steps=100000.0, interval=1000, size=None, plot_width=900, plot_height=400, annotations=None, transformers=None, **kwargs)

Bases: object

Streaming Images

Parameters
data_callbackcallable

The function to call for data updates

image_keystring, optional

The key for the image data in the callback result. If a key value is not set, but there is only one key in the data, the data at that key will be used.

stepsint, optional

The maximum number of steps to iterate

intervalint, optional

The length of each step in milliseconds

sizestring or int or tuple, optional
The size of the displayed image. It can take the following values:
  • ‘contain’ - to indicate that the image should be scaled to fit inside the plot area

  • ‘cover’ - to indicate that the image should scale to cover the entire plot area

  • int - to indicate a square with a pixel width of height of the given integer

  • (int, int) - to indicate width and height values in pixels

plot_widthint, optional

The width of the plot in pixels

plot_heightint, optional

The height of the plot in pixels

annotationsWindow, optional

Window containing image highlighting information

transformersfunction or list-of-functions, optional

Functions to apply to each image prior to displaying

Returns
StreamingImages
Attributes
data_callbackcallable

The function to call for data updates

intervalint, optional

The length of each step in milliseconds

stepsint, optional

The maximum number of steps to iterate

__init__(self, data_callback, image_key=None, steps=100000.0, interval=1000, size=None, plot_width=900, plot_height=400, annotations=None, transformers=None, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, data_callback[, image_key, …])

Initialize self.