PYME.Acquire.htsms.rule_ui module

class PYME.Acquire.htsms.rule_ui.ChainedAnalysisPage(parent, protocol_rules, recipe_manager, spool_controller, default_pairings=None)

Bases: mClass

Parameters

parentwx something

protocol_rulesdict

[description]

recipe_managerPYME.recipes.recipeGui.RecipeManager

[description]

default_pairingsdict

protocol keys with lists of RuleFactorys as values to prepopulate panel on start up

OnAddRecipe(wx_event=None)

OnClear(wx_event=None)

OnPick(event)

OnPostChoice(wx_event=None)

OnProtocolChoice(wx_event=None)

add_tile(rule_tile)

property rule_chain

select_rule_chain(protocol='default')

update(*args, **kwargs)

class PYME.Acquire.htsms.rule_ui.ChainedAnalysisPanel(parent, protocol_rules, chained_analysis_page, default_pairings=None)

Bases: mClass

Parameters

parentPYME.ui.AUIFrame.AUIFrame

should be the ‘main frame’

protocol_rulesdict

[description]

recipe_managerPYME.recipes.recipeGui.RecipeManager

[description]

default_pairingsdict

protocol keys with RuleChains as values to prepopulate panel on start up

OnEditRuleChain(wx_event=None)

OnRemoveProtocolRule(wx_event=None)

OnToggleActive(wx_event)

static plug(main_frame, scope, default_pairings=None)

Adds a ChainedAnalysisPanel to a microscope gui during start-up

Parameters

main_framePYME.Acquire.acquiremainframe.PYMEMainFrame

microscope gui application

scopePYME.Acquire.microscope.microscope

the microscope itself

default_pairingsdict

[optional] protocol keys with lists of RuleFactorys as values to prepopulate panel on start up. By default, None

class PYME.Acquire.htsms.rule_ui.LocalizationSettingsPanel(wx_parent, localization_settings, mdh_changed_signal=None, chained_analysis_page=None)

Bases: mClass

OnAddLocalizationRule(wx_event=None)

class PYME.Acquire.htsms.rule_ui.ProtocolRuleFactoryListCtrl(protocol_rules, wx_parent)

Bases: mClass

Parameters

protocol_rules: dict

acquisition protocols (keys) and their associated rule factory chains

wx_parent

OnGetItemText(item, col)

Note that this is overriding the wxListCtrl method as required for wxLC_VIRTUAL style

Parameters

itemlong

wx list item

collong

column specifier for wxListCtrl

Returns

——-

strReturns string of column ‘col’ for item ‘item’

delete_rule_chains(indices=None)

get_next_selected(current)

get_selected_items()

update_list(sender=None, **kwargs)

class PYME.Acquire.htsms.rule_ui.ProtocolRules(spool_controller, posting_thread_queue_size=5)

Bases: OrderedDict

Container for associating sets of analysis rules with specific acquisition protocols

Notes

use ordered dict for reproducibility with listctrl displays

Parameters

posting_thread_queue_sizeint, optional

sets the size of a queue to hold rule posting threads to ensure they have time to execute, by default 5. .. seealso:: modules PYME.cluster.rules

on_spool_event(event)

pipe input series name into rule chain and post them all

Parameters

kwargs: dict

present here to allow us to call this method through a dispatch.Signal.send

on_spool_start(**kwargs)

on_spool_stop(**kwargs)

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

class PYME.Acquire.htsms.rule_ui.RuleChain(rule_factories=None, *args, **kwargs)

Bases: HasTraits

post_on = <PYME.misc.mock_traits.CStr object>

protocol = <PYME.misc.mock_traits.CStr object>

class PYME.Acquire.htsms.rule_ui.RulePlotPanel(parent, protocol_rules, **kwargs)

Bases: PlotPanel

draw()

class PYME.Acquire.htsms.rule_ui.RuleRecipeManager(chained_analysis_page=None)

Bases: RecipeManager

OnAddRecipeRule(wx_event=None)

class PYME.Acquire.htsms.rule_ui.RuleRecipeView(parent, recipes)

Bases: RecipeView

class PYME.Acquire.htsms.rule_ui.RuleTile(*args, **kwargs)

Bases: HasTraits

default_traits_view()

This is the traits stock method to specify the default view

property default_view

get_params()

rule_timeout = <PYME.misc.mock_traits.Float object>

task_timeout = <PYME.misc.mock_traits.Float object>

class PYME.Acquire.htsms.rule_ui.SMLMChainedAnalysisPage(parent, protocol_rules, recipe_manager, localization_panel=None, default_pairings=None, localization_settings=None)

Bases: ChainedAnalysisPage

Parameters

parentwx something

protocol_rulesdict

[description]

recipe_managerPYME.recipes.recipeGui.RecipeManager

[description]

default_pairingsdict

protocol keys with lists of RuleFactorys as values to prepopulate panel on start up

OnAddLocalization(wx_event=None)

class PYME.Acquire.htsms.rule_ui.SMLMChainedAnalysisPanel(wx_parent, protocol_rules, chained_analysis_page, default_pairings=None)

Bases: ChainedAnalysisPanel

Parameters

wx_parent

localization_settings: PYME.ui.AnalysisSettingsUI.AnalysisSettings

rule_list_ctrl: RuleChainListCtrl

default_pairingsdict

[optional] protocol keys with lists of RuleFactorys as values to prepopulate panel on start up. By default, None

static plug(main_frame, scope, default_pairings=None)

Adds a SMLMChainedAnalysisPanel to a microscope gui during start-up

Parameters

main_framePYME.Acquire.acquiremainframe.PYMEMainFrame

microscope gui application

scopePYME.Acquire.microscope.microscope

the microscope itself

default_pairingsdict

[optional] protocol keys with RuleChains as values to prepopulate panel on start up. By default, None

PYME.Acquire.htsms.rule_ui.get_protocol_list()

version of PYME.Acquire.protocol.get_protocol_list which uses ‘default’ instead of ‘<None>’ and drops all ‘.py’ extensions

PYME.Acquire.htsms.rule_ui.get_rule_tile(rule_factory_class)