Class Auto_model_free

The model-free auto-analysis GUI element.

Instance Methods

__init__(self, parent, id=-1, pos=wx.Point(-1,-1), size=wx.Size(-1,-1), style=524288, name='scrolledpanel', gui=None, analysis_name=None, pipe_name=None, pipe_bundle=None, uf_exec=[], data_index=None)
Build the automatic model-free protocol GUI element.

_about(self, event=None)
The about window.

activate(self)
Activate or deactivate certain elements of the analysis in response to the execution lock.

add_values(self, box)
Create and add the value.set buttons for the model-free analysis.

class instance, list of str assemble_data(self)
Assemble the data required for the auto-analysis.

wx.BoxSizer instance build_left_box(self)
Construct the left hand box to pack into the main model-free box.

wx.BoxSizer instance build_right_box(self)
Construct the right hand box to pack into the main model-free box.

delete(self)
Unregister the spin count from the user functions.

execute(self, event=None)
Set up, execute, and process the automatic model-free protocol.

mode_dialog(self, event=None)
The calculation mode selection.

observer_register(self, remove=False)
Register and unregister methods with the observer objects.

results_directory(self, event=None)
The results directory selection.

setup_dipole_pair(self, event=None)
Create the wizard for the dipole-dipole interaction.

spin_isotope_heteronuc(self, event=None)
Set the nuclear isotope types of the heteronuclear spins via the spin.isotope user function.

spin_isotope_proton(self, event=None)
Set the nuclear isotope types of the proton spins via the spin.isotope user function.

sync_ds(self, upload=False)
Synchronise the analysis frame and the relax data store, both ways.

value_set_csa(self, event=None)
Set the CSA via the value.set uf.

Inherited from base.Base_analysis: add_button_open, add_execute_analysis, add_spin_control, add_spin_systems, add_static_text, add_subsubtitle, add_subtitle, add_text_control, add_title, build_main_box, launch_spin_editor, resize, spin_count, update_spin_count

Inherited from wx.lib.scrolledpanel.ScrolledPanel: OnChildFocus, ScrollChildIntoView, SetupScrolling

Inherited from wx.lib.scrolledpanel.ScrolledPanel (private): _SetupAfter

Class Variables

Inherited from base.Base_analysis: border, size_graphic_panel, spacer_horizontal, width_button, width_main_separator, width_text

Method Details

__init__(self, parent, id=-1, pos=wx.Point(-1,-1), size=wx.Size(-1,-1), style=524288, name='scrolledpanel', gui=None, analysis_name=None, pipe_name=None, pipe_bundle=None, uf_exec=[], data_index=None)
(Constructor)

Build the automatic model-free protocol GUI element.

Parameters:

• parent (wx object) - The parent wx element.
• id (int) - The unique ID number.
• pos (wx.Size object) - The position.
• size (wx.Size object) - The size.
• style (int) - The style.
• name (unicode) - The name for the panel.
• gui (gui.relax_gui.Main instance) - The main GUI class.
• analysis_name (str) - The name of the analysis (the name in the tab part of the notebook).
• pipe_name (str) - The name of the original data pipe for this analysis.
• pipe_bundle (str) - The name of the data pipe bundle associated with this analysis.
• uf_exec (list of methods) - The list of user function on_execute methods returned from the new analysis wizard.
• data_index (None or int) - The index of the analysis in the relax data store (set to None if no data currently exists).

Overrides: wx.lib.scrolledpanel.ScrolledPanel.__init__

_about(self, event=None)

The about window.

Parameters:

• event (wx event) - The wx event.

add_values(self, box)

Create and add the value.set buttons for the model-free analysis.

Parameters:

• box (wx.BoxSizer instance) - The box element to pack the GUI element into.

assemble_data(self)

Assemble the data required for the auto-analysis.

See the docstring for auto_analyses.dauvernge_protocol for details. All data is taken from the relax data store, so data upload from the GUI to there must have been previously performed.

Returns: class instance, list of str

A container with all the data required for the auto-analysis.

build_left_box(self)

Construct the left hand box to pack into the main model-free box.

Returns: wx.BoxSizer instance

The left hand box element containing the bitmap and about button to pack into the main model-free box.

Overrides: base.Base_analysis.build_left_box

build_right_box(self)

Construct the right hand box to pack into the main model-free box.

Returns: wx.BoxSizer instance

The right hand box element containing all model-free GUI elements (excluding the bitmap) to pack into the main model-free box.

execute(self, event=None)

Set up, execute, and process the automatic model-free protocol.

Parameters:

• event (wx event) - The wx event.

mode_dialog(self, event=None)

The calculation mode selection.

Parameters:

• event (wx event) - The wx event.

observer_register(self, remove=False)

Register and unregister methods with the observer objects.

Parameters:

• remove (False) - If set to True, then the methods will be unregistered.

Overrides: base.Base_analysis.observer_register

results_directory(self, event=None)

The results directory selection.

Parameters:

• event (wx event) - The wx event.

setup_dipole_pair(self, event=None)

Create the wizard for the dipole-dipole interaction.

Parameters:

• event (wx event) - The wx event.

spin_isotope_heteronuc(self, event=None)

Set the nuclear isotope types of the heteronuclear spins via the spin.isotope user function.

Parameters:

• event (wx event) - The wx event.

spin_isotope_proton(self, event=None)

Set the nuclear isotope types of the proton spins via the spin.isotope user function.

Parameters:

• event (wx event) - The wx event.

sync_ds(self, upload=False)

Synchronise the analysis frame and the relax data store, both ways.

This method allows the frame information to be uploaded into the relax data store, or for the information in the relax data store to be downloaded by the frame.

Parameters:

• upload (bool) - A flag which if True will cause the frame to send data to the relax data store. If False, data will be downloaded from the relax data store to update the frame.

value_set_csa(self, event=None)

Set the CSA via the value.set uf.

Parameters:

• event (wx event) - The wx event.