class LivePlotClient(object): def __init__(self, timeout=2000, size=2**28): self.app = QCoreApplication.instance() if self.app is None: self.app = QCoreApplication([]) self.sock = QLocalSocket() self.sock.connectToServer("LivePlot") if not self.sock.waitForConnected(): raise EnvironmentError("Couldn't find LivePlotter instance") self.sock.disconnected.connect(self.disconnect_received) key = str(uuid.uuid4()) self.shared_mem = QSharedMemory(key) if not self.shared_mem.create(size): raise Exception("Couldn't create shared memory %s" % self.shared_mem.errorString()) logging.debug('Memory created with key %s and size %s' % (key, self.shared_mem.size())) self.sock.write(key.encode()) self.sock.waitForBytesWritten() self.is_connected = True self.timeout = timeout atexit.register(self.close) def close(self): self.shared_mem.detach() def send_to_plotter(self, meta, arr=None): if not self.is_connected: return if meta["name"] is None: meta["name"] = "*" if arr is not None: arrbytes = bytearray(arr) arrsize = len(arrbytes) if arrsize > self.shared_mem.size(): raise ValueError("Array too big %s > %s" % (arrsize, self.shared_mem.size())) meta['arrsize'] = arrsize meta['dtype'] = str(arr.dtype) meta['shape'] = arr.shape else: meta['arrsize'] = 0 meta_bytes = json.dumps(meta).ljust(300) if len(meta_bytes) > 300: raise ValueError("meta object is too large (> 300 char)") if arr is None: self.sock.write(meta_bytes.encode()) else: if not self.sock.bytesAvailable(): self.sock.waitForReadyRead() self.sock.read(2) self.shared_mem.lock() self.sock.write(meta_bytes.encode()) region = self.shared_mem.data() region[:arrsize] = arrbytes self.shared_mem.unlock() def plot_y(self, name, arr, extent=None, start_step=(0, 1), label=''): arr = np.array(arr) if extent is not None and start_step is not None: raise ValueError( 'extent and start_step provide the same info and are thus mutually exclusive' ) if extent is not None: x0, x1 = extent nx = len(arr) start_step = x0, float(x1 - x0) / nx meta = { 'name': name, 'operation': 'plot_y', 'start_step': start_step, 'rank': 1, 'label': label, } self.send_to_plotter(meta, arr.astype('float64')) self.send_to_plotter({ 'name': 'none', 'operation': 'none' }, np.array([0.])) def plot_z(self, name, arr, extent=None, start_step=None, xname='X axis',\ xscale='arb. u.', yname='Y axis', yscale='arb. u.', zname='Y axis', zscale='arb. u.'): ''' extent is ((initial x, final x), (initial y, final y)) start_step is ((initial x, delta x), (initial_y, final_y)) ''' arr = np.array(arr) if extent is not None and start_step is not None: raise ValueError( 'extent and start_step provide the same info and are thus mutually exclusive' ) if extent is not None: (x0, x1), (y0, y1) = extent nx, ny = arr.shape start_step = (x0, float(x1 - x0) / nx), (y0, float(y1 - y0) / ny) meta = { 'name': name, 'operation': 'plot_z', 'rank': 2, 'start_step': start_step, 'X': xscale, 'Y': yscale, 'Z': zscale, 'Xname': xname, 'Yname': yname, 'Zname': zname, } self.send_to_plotter(meta, arr.astype('float64')) self.send_to_plotter({ 'name': 'none', 'operation': 'none' }, np.array([0.])) def plot_xy(self, name, xs, ys, label='', xname='X axis', xscale='arb. u.',\ yname='Y axis', yscale='arb. u.', scatter='False', timeaxis='False'): arr = np.array([xs, ys]) meta = { 'name': name, 'operation': 'plot_xy', 'rank': 1, 'label': label, 'X': xscale, 'Y': yscale, 'Xname': xname, 'Yname': yname, 'Scatter': scatter, 'TimeAxis': timeaxis } self.send_to_plotter(meta, np.array([xs, ys]).astype('float64')) self.send_to_plotter({ 'name': 'none', 'operation': 'none' }, np.array([0.])) def append_y(self, name, point, start_step=(0, 1), label='', xname='X axis',\ xscale='arb. u.', yname='Y axis', yscale='arb. u.',scatter='False', timeaxis='False'): self.send_to_plotter({ 'name': name, 'operation': 'append_y', 'value': point, 'start_step': start_step, 'rank': 1, 'label': label, 'X': xscale, 'Y': yscale, 'Xname': xname, 'Yname': yname, 'Scatter': scatter, 'TimeAxis': timeaxis }) self.send_to_plotter({ 'name': 'none', 'operation': 'none' }, np.array([0.])) def append_xy(self, name, x, y, label=''): self.send_to_plotter({ 'name': name, 'operation': 'append_xy', 'value': (x, y), 'rank': 1, 'label': label, }) self.send_to_plotter({ 'name': 'none', 'operation': 'none' }, np.array([0.])) def append_z(self, name, arr, start_step=None, xname='X axis',\ xscale='arb. u.', yname='Y axis', yscale='arb. u.', zname='Y axis', zscale='arb. u.'): arr = np.array(arr) meta = { 'name': name, 'operation': 'append_z', 'rank': 2, 'start_step': start_step, 'X': xscale, 'Y': yscale, 'Z': zscale, 'Xname': xname, 'Yname': yname, 'Zname': zname, } self.send_to_plotter(meta, arr.astype('float64')) self.send_to_plotter({ 'name': 'none', 'operation': 'none' }, np.array([0.])) def label(self, name, text): self.send_to_plotter({ 'name': name, 'operation': 'label', 'value': text }) self.send_to_plotter({ 'name': 'none', 'operation': 'none' }, np.array([0.])) def clear(self, name=None): self.send_to_plotter({'name': name, 'operation': 'clear'}) def hide(self, name=None): self.send_to_plotter({'name': name, 'operation': 'close'}) def remove(self, name=None): self.send_to_plotter({'name': name, 'operation': 'remove'}) self.send_to_plotter({ 'name': 'none', 'operation': 'none' }, np.array([0.])) def disconnect_received(self): self.is_connected = False warnings.warn( 'Disconnected from LivePlotter server, plotting has been disabled')