def SetProtocol(self, protocolName=None, reloadProtocol=True):
"""
Set the current protocol.
Parameters
----------
protocolName: str
path to protocol file including extension
reloadProtocol : bool
currently ignored; protocol module is reinitialized regardless.
See also: PYME.Acquire.Protocols.
"""
if (protocolName is None) or (protocolName == '<None>'):
self.protocol = prot.NullProtocol
self.protocolZ = prot.NullZProtocol
else:
#pmod = __import__('PYME.Acquire.Protocols.' + protocolName.split('.')[0],fromlist=['PYME', 'Acquire','Protocols'])
#if reloadProtocol:
# reload(pmod) #force module to be reloaded so that changes in the protocol will be recognised
pmod = prot.get_protocol(protocol_name=protocolName, reloadProtocol=reloadProtocol)
self.protocol = pmod.PROTOCOL
self.protocol.filename = protocolName
self.protocolZ = pmod.PROTOCOL_STACK
self.protocolZ.filename = protocolName
self.z_dwell = self.protocolZ.dwellTime
def SetProtocol(self, protocolName=None, reloadProtocol=True):
"""Set the current protocol .
See also: PYME.Acquire.Protocols."""
if (protocolName is None) or (protocolName == '<None>'):
self.protocol = prot.NullProtocol
self.protocolZ = prot.NullZProtocol
else:
#pmod = __import__('PYME.Acquire.Protocols.' + protocolName.split('.')[0],fromlist=['PYME', 'Acquire','Protocols'])
#if reloadProtocol:
# reload(pmod) #force module to be reloaded so that changes in the protocol will be recognised
pmod = prot.get_protocol(protocol_name=protocolName, reloadProtocol=reloadProtocol)
self.protocol = pmod.PROTOCOL
self.protocol.filename = protocolName
self.protocolZ = pmod.PROTOCOL_STACK
self.protocolZ.filename = protocolName
def start_spooling(self, fn=None, settings={}, preflight_mode='interactive'):
"""
Parameters
----------
fn : str, optional
fn can be hardcoded here, otherwise differs to the seriesName
property which will create one if need-be.
settings : dict
keys should be `SpoolController` attributes or properties with
setters. Not all keys must be present, and example keys include:
method : str
One of 'File', 'Cluster', or 'Queue'(py2 only)
hdf_compression_level: int
zlib compression level that pytables should use (spool to
file and queue)
z_stepped : bool
toggle z-stepping during acquisition
z_dwell : int
number of frames to acquire at each z level (predicated on
`SpoolController.z_stepped` being True)
cluster_h5 : bool
Toggle spooling to single h5 file on cluster rather than pzf
file per frame. Only applicable to 'Cluster' `method` and
preferred for PYMEClusterOfOne.
pzf_compression_settings : dict
Compression settings relevant for 'Cluster' `method` if
`cluster_h5` is False. See HTTPSpooler.defaultCompSettings.
protocol_name : str
Note that passing the protocol name will force a (re)load of
the protocol file (even if it is already selected).
max_frames : int, optional
point at which to end the series automatically, by default
sys.maxsize
subdirectory : str, optional
Directory within current set directory to spool this series. The
directory will be created if it doesn't already exist.
extra_metadata : dict, optional
metadata to supplement this series for entries known prior to
acquisition which do not have handlers to hook start metadata
preflight_mode : str (default='interactive')
What to do when the preflight check fails. Options are 'interactive', 'warn', 'abort' and 'skip' which will
display a dialog and prompt the user, log a warning and continue, and log an error and abort, or skip completely.
The former is suitable for interactive acquisition, whereas one of the latter modes is likely better for automated spooling
via the action manager.
"""
# these settings were managed by the GUI, but are now managed by the
# controller, still allow them to be passed in, but default to internals
fn = self.seriesName if fn in ['', None] else fn
stack = settings.get('z_stepped', self.z_stepped)
compLevel = settings.get('hdf_compression_level', self.hdf_compression_level)
pzf_compression_settings = settings.get('pzf_compression_settings', self.pzf_compression_settings)
cluster_h5 = settings.get('cluster_h5', self.cluster_h5)
maxFrames = settings.get('max_frames', sys.maxsize)
stack_settings = settings.get('stack_settings', None)
# try stack settings for z_dwell, then aq settings.
# precedence is settings > stack_settings > self.z_dwell
# The reasoning for allowing the dwell time to be set in either the spooling or stack settings is to allow
# API users to choose which is most coherent for their use case (it would seem logical to put dwell time with
# the other stack settings, but this becomes problematic when sharing stack settings across modalities - e.g.
# PALM/STORM and widefield stacks which are likely to share most of the stack settings but have greatly different
# z dwell times). PYMEAcquire specifies it in the spooling/series settings by default to allow shared usage
# between modalities.
if stack_settings:
if isinstance(stack_settings, dict):
z_dwell = stack_settings.get('DwellFrames', self.z_dwell)
else:
# have a StackSettings object
# TODO - fix this to be a bit more sane and not use private attributes etc ...
z_dwell = stack_settings._dwell_frames
# z_dwell defaults to -1 (with a meaning of ignore) in StackSettings objects if not value is not
# explicitly provided. In this case, use our internal value instead. The reason for the 'ignore'
# special value is to allow the same StackSettings object to be used for widefield stacks and
# localization series (where sharing everything except dwell time makes sense).
if z_dwell < 1:
z_dwell = self.z_dwell
else:
z_dwell = self.z_dwell
z_dwell = settings.get('z_dwell', z_dwell)
if (stack_settings is not None) and (not isinstance(stack_settings, stackSettings.StackSettings)):
# let us pass stack settings as a dict, constructing a StackSettings instance as needed
stack_settings = stackSettings.StackSettings(**dict(stack_settings))
protocol_name = settings.get('protocol_name')
if protocol_name is None:
protocol, protocol_z = self.protocol, self.protocolZ
else:
pmod = prot.get_protocol(protocol_name)
protocol, protocol_z = pmod.PROTOCOL, pmod.PROTOCOL_STACK
subdirectory = settings.get('subdirectory', None)
# make directories as needed, makedirs(dir, exist_ok=True) once py2 support is dropped
if (self.spoolType != 'Cluster') and (not os.path.exists(self.get_dirname(subdirectory))):
os.makedirs(self.get_dirname(subdirectory))
if self._checkOutputExists(fn): #check to see if data with the same name exists
self.seriesCounter +=1
self.seriesName = self._GenSeriesName()
raise IOError('A series with the same name already exists')
if stack:
protocol = protocol_z
protocol.dwellTime = z_dwell
#print(protocol)
else:
protocol = protocol
if (preflight_mode != 'skip') and not preflight.ShowPreflightResults(protocol.PreflightCheck(), preflight_mode):
return #bail if we failed the pre flight check, and the user didn't choose to continue
#fix timing when using fake camera
if self.scope.cam.__class__.__name__ == 'FakeCamera':
fakeCycleTime = self.scope.cam.GetIntegTime()
else:
fakeCycleTime = None
frameShape = (self.scope.cam.GetPicWidth(), self.scope.cam.GetPicHeight())
if self.spoolType == 'Queue':
from PYME.Acquire import QueueSpooler
self.queueName = getRelFilename(self._get_queue_name(fn, subdirectory=subdirectory))
self.spooler = QueueSpooler.Spooler(self.queueName, self.scope.frameWrangler.onFrame,
frameShape = frameShape, protocol=protocol,
guiUpdateCallback=self._ProgressUpate, complevel=compLevel,
fakeCamCycleTime=fakeCycleTime, maxFrames=maxFrames, stack_settings=stack_settings)
elif self.spoolType == 'Cluster':
from PYME.Acquire import HTTPSpooler
self.queueName = self._get_queue_name(fn, pcs=(not cluster_h5),
subdirectory=subdirectory)
self.spooler = HTTPSpooler.Spooler(self.queueName, self.scope.frameWrangler.onFrame,
frameShape = frameShape, protocol=protocol,
guiUpdateCallback=self._ProgressUpate,
fakeCamCycleTime=fakeCycleTime, maxFrames=maxFrames,
compressionSettings=pzf_compression_settings, aggregate_h5=cluster_h5, stack_settings=stack_settings)
else:
from PYME.Acquire import HDFSpooler
self.spooler = HDFSpooler.Spooler(self._get_queue_name(fn, subdirectory=subdirectory),
self.scope.frameWrangler.onFrame,
frameShape = frameShape, protocol=protocol,
guiUpdateCallback=self._ProgressUpate, complevel=compLevel,
fakeCamCycleTime=fakeCycleTime, maxFrames=maxFrames, stack_settings=stack_settings)
#TODO - sample info is probably better handled with a metadata hook
#if sampInf:
# try:
# sampleInformation.getSampleData(self, self.spooler.md)
# except:
# #the connection to the database will timeout if not present
# #FIXME: catch the right exception (or delegate handling to sampleInformation module)
# pass
extra_metadata = settings.get('extra_metadata')
if extra_metadata is not None:
self.spooler.md.mergeEntriesFrom(MetaDataHandler.DictMDHandler(extra_metadata))
# stop the frameWrangler before we start spooling
# this serves to ensure that a) we don't accidentally spool frames which were in the camera buffer when we hit start
# and b) we get a nice clean timestamp for when the actual frames start (after any protocol init tasks)
# it might also slightly improve performance.
self.scope.frameWrangler.stop()
try:
self.spooler.onSpoolStop.connect(self.SpoolStopped)
self.spooler.StartSpool()
except:
self.spooler.abort()
raise
# restart frame wrangler
self.scope.frameWrangler.Prepare()
self.scope.frameWrangler.start()
self.onSpoolStart.send(self)
#return a function which can be called to indicate if we are done
return lambda : self.spooler.spool_complete