Package gui :: Package analyses :: Module auto_rx_base :: Class Auto_rx
[hide private]
[frames] | no frames]

Class Auto_rx

source code


The base class for the R1 and R2 frames.

Instance Methods [hide private]
 
__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, data_index=None)
Build the automatic R1 and R2 analysis GUI frame elements.
source code
 
activate(self)
Activate or deactivate certain elements of the analysis in response to the execution lock.
source code
class instance, list of str
assemble_data(self)
Assemble the data required for the auto-analysis.
source code
wx.BoxSizer instance
build_right_box(self)
Construct the right hand box to pack into the main Rx box.
source code
 
delete(self)
Unregister the spin count from the user functions.
source code
 
execute(self, event)
Set up, execute, and process the automatic Rx analysis.
source code
 
observer_register(self, remove=False)
Register and unregister methods with the observer objects.
source code
 
peak_wizard(self, event)
Launch the Rx peak loading wizard.
source code
 
results_directory(self, event)
The results directory selection.
source code
 
sync_ds(self, upload=False)
Synchronise the analysis frame and the relax data store, both ways.
source code
int
wizard_page_after_error_type(self)
Set the page after the error type choice.
source code
int
wizard_page_after_repl(self)
Set the page that comes after the spectrum.replicated page.
source code
int
wizard_page_after_rmsd(self)
Set the page that comes after the spectrum.baseplane_rmsd page.
source code
 
wizard_update_pts(self)
Update the spectrum.replicated page based on previous data.
source code
 
wizard_update_repl(self)
Update the spectrum.replicated page based on previous data.
source code
 
wizard_update_rmsd(self)
Update the spectrum.baseplane_rmsd page based on previous data.
source code
 
wizard_update_relax_time(self)
Update the relax_fit.relax_time page based on previous data.
source code

Inherited from base.Base_analysis: add_button_open, add_execute_relax, add_spin_control, add_spin_systems, add_static_text, add_subsubtitle, add_subtitle, add_text_control, add_title, build_left_box, 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 [hide private]
  analysis_type = None
hash(x)
  bitmap = None
hash(x)
  label = None
hash(x)

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

Method Details [hide private]

__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, data_index=None)
(Constructor)

source code 

Build the automatic R1 and R2 analysis GUI frame elements.

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 data pipe associated with this analysis.
  • pipe_bundle (str) - The name of the data pipe bundle associated with this analysis.
  • 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__

assemble_data(self)

source code 

Assemble the data required for the auto-analysis.

See the docstring for auto_analyses.relax_fit 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_right_box(self)

source code 

Construct the right hand box to pack into the main Rx box.

Returns: wx.BoxSizer instance
The right hand box element containing all Rx GUI elements (excluding the bitmap) to pack into the main Rx box.

execute(self, event)

source code 

Set up, execute, and process the automatic Rx analysis.

Parameters:
  • event (wx event) - The wx event.

observer_register(self, remove=False)

source code 

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

peak_wizard(self, event)

source code 

Launch the Rx peak loading wizard.

Parameters:
  • event (wx event) - The wx event.

results_directory(self, event)

source code 

The results directory selection.

Parameters:
  • event (wx event) - The wx event.

sync_ds(self, upload=False)

source code 

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.

wizard_page_after_error_type(self)

source code 

Set the page after the error type choice.

Returns: int
The index of the next page, which is the current page index plus one.

wizard_page_after_repl(self)

source code 

Set the page that comes after the spectrum.replicated page.

Returns: int
The index of the next page.

wizard_page_after_rmsd(self)

source code 

Set the page that comes after the spectrum.baseplane_rmsd page.

Returns: int
The index of the next page.