PYME.Acquire.ui.HDFSpoolFrame module

The GUI controls for streaming acquisiton.

class PYME.Acquire.ui.HDFSpoolFrame.PanSpool(parent, scope, **kwargs)

Bases: foldingPane

A Panel containing the GUI controls for spooling

Initialise the spooling panel.

Parameters
parentwx.Window derived class

The parent window

scopemicroscope instance

The currently active microscope class (see microscope.py)

defDirstring pattern

The default directory to save data to. Any keys of the form %(<key>) will be substituted using the values defined in PYME.fileUtils.nameUtils.dateDict

defSeriesstring pattern

This specifies a pattern for file naming. Keys will be substituted as for defDir

OnBAnalyse(event)
OnBSetAqProtocolButton(event)

Set the current protocol (GUI callback).

See also: PYME.Acquire.Protocols.

OnBSetSpoolDirButton(event)

Set the directory we’re spooling into (GUI callback).

OnBStartSpoolButton(event=None, stack=False)

GUI callback to start spooling.

NB: this is also called programatically by the start stack button.

OnBStartStackButton(event=None)

GUI callback to start spooling with z-stepping.

OnBStopSpoolingButton(event)

GUI callback to stop spooling.

OnSpoolMethodChanged(event)
OnSpoolingStarted(**kwargs)
OnSpoolingStopped(**kwargs)
OnTcSpoolFileText(event)
OnToggleZStepping(event)
Tick(**kwargs)

Called with each new frame. Updates the number of frames spooled and disk space remaining

UpdateFreeSpace(event=None)

Updates the free space display.

Designed to be used as a callback with one of the system timers, but can be called separately

get_compression_settings(ui_message_on_error=True)
update_spooler_compression_settings(ui_on_error=True)
update_ui()