Package gui :: Package analyses :: Module auto_model_free :: Class Auto_model_free
[hide private]
[frames] | no frames]

Class Auto_model_free

source code


The model-free auto-analysis GUI element.

Instance Methods [hide private]
EvtHandler
__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.
source code
 
_about(self, event=None)
The about window.
source code
 
activate(self)
Activate or deactivate certain elements of the analysis in response to the execution lock.
source code
 
add_values(self, box)
Create and add the value.set buttons for the model-free analysis.
source code
class instance, list of str
assemble_data(self)
Assemble the data required for the auto-analysis.
source code
wx.BoxSizer instance
build_left_box(self)
Construct the left hand box to pack into the main model-free box.
source code
wx.BoxSizer instance
build_right_box(self)
Construct the right hand box to pack into the main model-free box.
source code
 
delete(self)
Unregister the spin count from the user functions.
source code
 
execute(self, event=None)
Set up, execute, and process the automatic model-free protocol.
source code
 
mode_dialog(self, event=None)
The calculation mode selection.
source code
 
observer_register(self, remove=False)
Register and unregister methods with the observer objects.
source code
 
results_directory(self, event=None)
The results directory selection.
source code
 
setup_dipole_pair(self, event=None)
Create the wizard for the dipole-dipole interaction.
source code
 
spin_isotope_heteronuc(self, event=None)
Set the nuclear isotope types of the heteronuclear spins via the spin.isotope user function.
source code
 
spin_isotope_proton(self, event=None)
Set the nuclear isotope types of the proton spins via the spin.isotope user function.
source code
 
sync_ds(self, upload=False)
Synchronise the analysis frame and the relax data store, both ways.
source code
 
value_set_csa(self, event=None)
Set the CSA via the value.set uf.
source code

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

Inherited from wx._windows.PyScrolledWindow: DoEraseBackground, DoGetBestSize, DoGetClientSize, DoGetPosition, DoGetSize, DoGetVirtualSize, DoMoveWindow, DoSetClientSize, DoSetSize, DoSetVirtualSize, GetDefaultAttributes, OnInternalIdle, SetBestSize, base_AcceptsFocus, base_AcceptsFocusFromKeyboard, base_AddChild, base_DoGetBestSize, base_DoGetClientSize, base_DoGetPosition, base_DoGetSize, base_DoGetVirtualSize, base_DoMoveWindow, base_DoSetClientSize, base_DoSetSize, base_DoSetVirtualSize, base_Enable, base_GetDefaultAttributes, base_GetMaxSize, base_InitDialog, base_OnInternalIdle, base_RemoveChild, base_ShouldInheritColours, base_TransferDataFromWindow, base_TransferDataToWindow, base_Validate

Inherited from wx._windows.PyScrolledWindow (private): _setCallbackInfo

Inherited from wx._windows.ScrolledWindow: AdjustScrollbars, CalcScrollInc, CalcScrolledPosition, CalcUnscrolledPosition, Create, DoPrepareDC, EnableScrolling, GetScaleX, GetScaleY, GetScrollPageSize, GetScrollPixelsPerUnit, GetTargetWindow, GetViewStart, Scroll, SetScale, SetScrollPageSize, SetScrollRate, SetScrollbars, SetTargetWindow, __repr__

Inherited from wx._windows.Panel: SetFocusIgnoringChildren

Inherited from wx._core.Window: AcceptsFocus, AcceptsFocusFromKeyboard, AddChild, AdjustForLayoutDirection, AssociateHandle, CacheBestSize, CanSetTransparent, CaptureMouse, Center, CenterOnParent, Centre, CentreOnParent, ClearBackground, ClientToScreen, ClientToScreenXY, ClientToWindowSize, Close, ConvertDialogPointToPixels, ConvertDialogSizeToPixels, ConvertPixelPointToDialog, ConvertPixelSizeToDialog, DLG_PNT, DLG_SZE, Destroy, DestroyChildren, Disable, DissociateHandle, DragAcceptFiles, Enable, FindWindowById, FindWindowByLabel, FindWindowByName, Fit, FitInside, Freeze, GetAcceleratorTable, GetAdjustedBestSize, GetAutoLayout, GetBackgroundColour, GetBackgroundStyle, GetBestFittingSize, GetBestSize, GetBestSizeTuple, GetBestVirtualSize, GetBorder, GetCaret, GetCharHeight, GetCharWidth, GetChildren, GetClientAreaOrigin, GetClientRect, GetClientSize, GetClientSizeTuple, GetConstraints, GetContainingSizer, GetCursor, GetDropTarget, GetEffectiveMinSize, GetEventHandler, GetExtraStyle, GetFont, GetForegroundColour, GetFullTextExtent, GetGrandParent, GetGtkWidget, GetHandle, GetHelpText, GetHelpTextAtPoint, GetId, GetLabel, GetLayoutDirection, GetMaxHeight, GetMaxSize, GetMaxWidth, GetMinHeight, GetMinSize, GetMinWidth, GetName, GetParent, GetPosition, GetPositionTuple, GetRect, GetScreenPosition, GetScreenPositionTuple, GetScreenRect, GetScrollPos, GetScrollRange, GetScrollThumb, GetSize, GetSizeTuple, GetSizer, GetTextExtent, GetThemeEnabled, GetToolTip, GetToolTipString, GetTopLevelParent, GetUpdateClientRect, GetUpdateRegion, GetValidator, GetVirtualSize, GetVirtualSizeTuple, GetWindowBorderSize, GetWindowStyle, GetWindowStyleFlag, GetWindowVariant, HasCapture, HasFlag, HasMultiplePages, HasScrollbar, HasTransparentBackground, Hide, HitTest, HitTestXY, InheritAttributes, InheritsBackgroundColour, InitDialog, InvalidateBestSize, IsBeingDeleted, IsDoubleBuffered, IsEnabled, IsExposed, IsExposedPoint, IsExposedRect, IsFrozen, IsRetained, IsShown, IsShownOnScreen, IsTopLevel, Layout, LineDown, LineUp, Lower, MakeModal, Move, MoveAfterInTabOrder, MoveBeforeInTabOrder, MoveXY, Navigate, PageDown, PageUp, PopEventHandler, PopupMenu, PopupMenuXY, PostCreate, PrepareDC, PushEventHandler, Raise, Refresh, RefreshRect, RegisterHotKey, ReleaseMouse, RemoveChild, RemoveEventHandler, Reparent, ScreenToClient, ScreenToClientXY, ScrollLines, ScrollPages, ScrollWindow, SendSizeEvent, SetAcceleratorTable, SetAutoLayout, SetBackgroundColour, SetBackgroundStyle, SetBestFittingSize, SetCaret, SetClientRect, SetClientSize, SetClientSizeWH, SetConstraints, SetContainingSizer, SetCursor, SetDimensions, SetDoubleBuffered, SetDropTarget, SetEventHandler, SetExtraStyle, SetFocus, SetFocusFromKbd, SetFont, SetForegroundColour, SetHelpText, SetHelpTextForId, SetId, SetInitialSize, SetLabel, SetLayoutDirection, SetMaxSize, SetMinSize, SetName, SetOwnBackgroundColour, SetOwnFont, SetOwnForegroundColour, SetPosition, SetRect, SetScrollPos, SetScrollbar, SetSize, SetSizeHints, SetSizeHintsSz, SetSizeWH, SetSizer, SetSizerAndFit, SetThemeEnabled, SetToolTip, SetToolTipString, SetTransparent, SetValidator, SetVirtualSize, SetVirtualSizeHints, SetVirtualSizeHintsSz, SetVirtualSizeWH, SetWindowStyle, SetWindowStyleFlag, SetWindowVariant, ShouldInheritColours, Show, Thaw, ToggleWindowStyle, TransferDataFromWindow, TransferDataToWindow, UnregisterHotKey, Update, UpdateWindowUI, UseBgCol, Validate, WarpPointer, WindowToClientSize

Inherited from wx._core.EvtHandler: AddPendingEvent, Bind, Connect, Disconnect, GetEvtHandlerEnabled, GetNextHandler, GetPreviousHandler, ProcessEvent, ProcessPendingEvents, SetEvtHandlerEnabled, SetNextHandler, SetPreviousHandler, Unbind

Inherited from wx._core.EvtHandler (private): _setOORInfo

Inherited from wx._core.Object: GetClassName, IsSameAs

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]

Inherited from wx._windows.ScrolledWindow: GetClassDefaultAttributes

Inherited from wx._core.Window: FindFocus, GetCapture, NewControlId, NextControlId, PrevControlId

Class Variables [hide private]

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

Properties [hide private]

Inherited from wx._windows.PyScrolledWindow: thisown

Inherited from wx._windows.ScrolledWindow: ScaleX, ScaleY, TargetWindow, ViewStart

Inherited from wx._core.Window: AcceleratorTable, AutoLayout, BackgroundColour, BackgroundStyle, BestSize, BestVirtualSize, Border, Caret, CharHeight, CharWidth, Children, ClientAreaOrigin, ClientRect, ClientSize, Constraints, ContainingSizer, Cursor, DefaultAttributes, DropTarget, EffectiveMinSize, Enabled, EventHandler, ExtraStyle, Font, ForegroundColour, GrandParent, GtkWidget, Handle, HelpText, Id, Label, LayoutDirection, MaxHeight, MaxSize, MaxWidth, MinHeight, MinSize, MinWidth, Name, Parent, Position, Rect, ScreenPosition, ScreenRect, Shown, Size, Sizer, ThemeEnabled, ToolTip, ToolTipString, TopLevel, TopLevelParent, UpdateClientRect, UpdateRegion, Validator, VirtualSize, WindowStyle, WindowStyleFlag, WindowVariant

Inherited from wx._core.EvtHandler: EvtHandlerEnabled, NextHandler, PreviousHandler

Inherited from wx._core.Object: ClassName

Inherited from object: __class__

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, uf_exec=[], data_index=None)
(Constructor)

source code 

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).
Returns: EvtHandler
Overrides: object.__init__

_about(self, event=None)

source code 

The about window.

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

add_values(self, box)

source code 

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)

source code 

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)

source code 

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)

source code 

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)

source code 

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

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

mode_dialog(self, event=None)

source code 

The calculation mode selection.

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

results_directory(self, event=None)

source code 

The results directory selection.

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

setup_dipole_pair(self, event=None)

source code 

Create the wizard for the dipole-dipole interaction.

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

spin_isotope_heteronuc(self, event=None)

source code 

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)

source code 

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)

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.

value_set_csa(self, event=None)

source code 

Set the CSA via the value.set uf.

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