PYME.Acquire.ui.HDFSpoolFrame module

The GUI controls for streaming acquisiton.

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

Bases: mClass

A Panel containing the GUI controls for spooling

Methods

OnBAnalyse(event)
OnBSetAqProtocolButton(event) Set the current protocol (GUI callback).
OnBSetSpoolDirButton(event) Set the directory we’re spooling into (GUI callback).
OnBStartSpoolButton([event, stack]) GUI callback to start spooling.
OnBStartStackButton([event]) GUI callback to start spooling with z-stepping.
OnBStopSpoolingButton(event) GUI callback to stop spooling.
OnSpoolMethodChanged(event)
OnSpoolingStarted(**kwargs)
OnSpoolingStopped(**kwargs)
OnTcSpoolFileText(event)
Tick(**kwargs) Called with each new frame.
UpdateFreeSpace([event]) Updates the free space display.

Initialise the spooling panel.

Parameters:

parent : wx.Window derived class

The parent window

scope : microscope instance

The currently active microscope class (see microscope.py)

defDir : string 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

defSeries : string pattern

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

Methods

OnBAnalyse(event)
OnBSetAqProtocolButton(event) Set the current protocol (GUI callback).
OnBSetSpoolDirButton(event) Set the directory we’re spooling into (GUI callback).
OnBStartSpoolButton([event, stack]) GUI callback to start spooling.
OnBStartStackButton([event]) GUI callback to start spooling with z-stepping.
OnBStopSpoolingButton(event) GUI callback to stop spooling.
OnSpoolMethodChanged(event)
OnSpoolingStarted(**kwargs)
OnSpoolingStopped(**kwargs)
OnTcSpoolFileText(event)
Tick(**kwargs) Called with each new frame.
UpdateFreeSpace([event]) Updates the free space display.
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)
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