sas.guiframe package

Subpackages

• sas.guiframe.local_perspectives package
  • Subpackages
    • sas.guiframe.local_perspectives.data_loader package
      • Submodules
      • sas.guiframe.local_perspectives.data_loader.data_loader module
      • sas.guiframe.local_perspectives.data_loader.help_panel module
      • sas.guiframe.local_perspectives.data_loader.load_thread module
      • Module contents
    • sas.guiframe.local_perspectives.plotting package
      • Submodules
      • sas.guiframe.local_perspectives.plotting.AnnulusSlicer module
      • sas.guiframe.local_perspectives.plotting.Arc module
      • sas.guiframe.local_perspectives.plotting.AzimutSlicer module
      • sas.guiframe.local_perspectives.plotting.BaseInteractor module
      • sas.guiframe.local_perspectives.plotting.Edge module
      • sas.guiframe.local_perspectives.plotting.Plotter1D module
      • sas.guiframe.local_perspectives.plotting.Plotter2D module
      • sas.guiframe.local_perspectives.plotting.SectorSlicer module
      • sas.guiframe.local_perspectives.plotting.SimplePlot module
      • sas.guiframe.local_perspectives.plotting.SlicerParameters module
      • sas.guiframe.local_perspectives.plotting.appearanceDialog module
      • sas.guiframe.local_perspectives.plotting.binder module
      • sas.guiframe.local_perspectives.plotting.boxMask module
      • sas.guiframe.local_perspectives.plotting.boxSlicer module
      • sas.guiframe.local_perspectives.plotting.boxSum module
      • sas.guiframe.local_perspectives.plotting.detector_dialog module
      • sas.guiframe.local_perspectives.plotting.graphAppearance module
      • sas.guiframe.local_perspectives.plotting.help_panel module
      • sas.guiframe.local_perspectives.plotting.masking module
      • sas.guiframe.local_perspectives.plotting.plotting module
      • sas.guiframe.local_perspectives.plotting.profile_dialog module
      • sas.guiframe.local_perspectives.plotting.sectorMask module
      • sas.guiframe.local_perspectives.plotting.slicerpanel module
      • Module contents
  • Module contents

Submodules

sas.guiframe.CategoryInstaller module

Class for making sure all category stuff is installed and works fine.

Copyright (c) Institut Laue-Langevin 2012

@author kieranrcampbell@gmail.com @modified by NIST/MD sasview team

class sas.guiframe.CategoryInstaller.CategoryInstaller

Class for making sure all category stuff is installed

Note - class is entirely static!

static check_install(homedir=None, model_list=None)

the main method of this class makes sure serialized_cat.json exists and if not compile it and install :param homefile: Override the default home directory :param model_list: List of model names except customized models

static get_default_file()

returns the path of the default file e.g. blahblah/default_categories.json

static get_user_file()

returns the user data file, eg .sasview/serialized_cat.json

sas.guiframe.CategoryManager module

This software was developed by Institut Laue-Langevin as part of Distributed Data Analysis of Neutron Scattering Experiments (DANSE).

Copyright 2012 Institut Laue-Langevin

class sas.guiframe.CategoryManager.CategoryManager(parent, win_id, title)

Bases: wx._windows.Frame

A class for managing categories

dial_ok(dialog=None, model=None)

modify_dialog onclose

class sas.guiframe.CategoryManager.ChangeCat(parent, title, cat_list, current_cats)

Bases: wx._windows.Dialog

dialog for changing the categories of a model

get_category()

Returns a list of categories applying to this model

on_add(event)

Callback for new category added

on_existing(event)

Callback for existing category selected

on_newcat(event)

Callback for new category added

on_ok_mac(event)

On OK pressed (MAC only)

on_remove(event)

Callback for a category removed

class sas.guiframe.CategoryManager.CheckListCtrl(parent, callback_func)

Bases: wx._controls.ListCtrl, wx.lib.mixins.listctrl.CheckListCtrlMixin, wx.lib.mixins.listctrl.ListCtrlAutoWidthMixin

Taken from http://zetcode.com/wxpython/advanced/

OnCheckItem(index, flag)

When the user checks the item we need to save that state

sas.guiframe.CategoryManager.IS_MAC = True

Notes The category manager mechanism works from 3 data structures used: - self.master_category_dict: keys are the names of categories, the values are lists of tuples, the first being the model names (the models belonging to that category), the second a boolean of whether or not the model is enabled - self.by_model_dict: keys are model names, values are a list of categories belonging to that model - self.model_enabled_dict: keys are model names, values are bools of whether the model is enabled use self._regenerate_model_dict() to create the latter two structures from the former use self._regenerate_master_dict() to create the first structure from the latter two

The need for so many data structures comes from the fact sometimes we need fast access to all the models in a category (eg user selection from the gui) and sometimes we need access to all the categories corresponding to a model (eg user modification of model categories)

sas.guiframe.aboutbox module

class sas.guiframe.aboutbox.DialogAbout(*args, **kwds)

Bases: wx._windows.Dialog

“About” Dialog

Shows product name, current version, authors, and link to the product page. Current version is taken from version.py

onDanseLogo(event)

onEssLogo(event)

onIllLogo(event)

onIsisLogo(event)

onNistLogo(event)

onNsfLogo(event)

onSnsLogo(event)

onUTLogo(event)

onUmdLogo(event)

class sas.guiframe.aboutbox.MyApp(redirect=False, filename=None, useBestVisual=False, clearSigInt=True)

Bases: wx._core.App

OnInit()

sas.guiframe.aboutbox.launchBrowser(url)

Launches browser and opens specified url

In some cases may require BROWSER environment variable to be set up.

Parameters:url – URL to open

sas.guiframe.config module

Application settings

sas.guiframe.config.printEVT(message)

sas.guiframe.custom_pstats module

class sas.guiframe.custom_pstats.CustomPstats(*args, **kwds)

Bases: pstats.Stats

write_stats(*amount)

sas.guiframe.custom_pstats.f8(x)

sas.guiframe.custom_pstats.func_std_string(func_name)

sas.guiframe.custom_pstats.profile(fn, name='profile.txt', *args, **kw)

sas.guiframe.customdir module

class sas.guiframe.customdir.SetupCustom

Bases: object

implement custom config dir

find_dir()

setup_dir(path)

sas.guiframe.dataFitting module

Adapters for fitting module

class sas.guiframe.dataFitting.Data1D(x=None, y=None, dx=None, dy=None)

Bases: sas.plottools.plottables.Data1D, sas.dataloader.data_info.Data1D

copy_from_datainfo(data1d)

copy values of Data1D of type DataLaoder.Data_info

class sas.guiframe.dataFitting.Data2D(image=None, err_image=None, qx_data=None, qy_data=None, q_data=None, mask=None, dqx_data=None, dqy_data=None, xmin=None, xmax=None, ymin=None, ymax=None, zmin=None, zmax=None)

Bases: sas.plottools.plottables.Data2D, sas.dataloader.data_info.Data2D

copy_from_datainfo(data2d)

copy value of Data2D of type DataLoader.data_info

class sas.guiframe.dataFitting.Theory1D(x=None, y=None, dy=None)

Bases: sas.plottools.plottables.Theory1D, sas.dataloader.data_info.Data1D

copy_from_datainfo(data1d)

copy values of Data1D of type DataLaoder.Data_info

sas.guiframe.dataFitting.check_data_validity(data)

Return True is data is valid enough to compute chisqr, else False

sas.guiframe.data_manager module

This module manages all data loaded into the application. Data_manager makes available all data loaded for the current perspective.

All modules “creating Data” posts their data to data_manager . Data_manager make these new data available for all other perspectives.

class sas.guiframe.data_manager.DataManager

Bases: object

Manage a list of data

add_data(data_list)

receive a list of

create_gui_data(data, path=None)

Receive data from loader and create a data to use for guiframe

delete_by_id(id_list=None)

save data and path

delete_by_name(name_list=None)

save data and path

delete_data(data_id, theory_id=None, delete_all=False)

delete_theory(data_id, theory_id)

freeze(theory_id)

freeze_theory(data_id, theory_id)

get_all_data()

return list of all available data

get_by_id(id_list=None)

get_by_name(name_list=None)

return a list of data given a list of data names

get_data_state(data_id)

Send list of selected data

get_message()

return message

rename(name)

rename data

update_data(prev_data, new_data)

update_theory(theory, data_id=None, state=None)

sas.guiframe.data_panel module

This module provides Graphic interface for the data_manager module.

class sas.guiframe.data_panel.DataDialog(data_list, parent=None, text='', *args, **kwds)

Bases: wx._windows.Dialog

Allow file selection at loading time

get_data()

return the selected data

class sas.guiframe.data_panel.DataFrame(parent=None, owner=None, manager=None, size=(300, 800), list_of_perspective=[], list=[], *args, **kwds)

Bases: wx._windows.Frame

Data Frame

ALWAYS_ON = True

load_data_list(list=[])

Fill the list inside its panel

window_caption = 'Data Panel'

window_name = 'Data Panel'

class sas.guiframe.data_panel.DataPanel(parent, list=None, size=(255, 750), id=-1, list_of_perspective=None, manager=None, *args, **kwds)

Bases: wx.lib.scrolledpanel.ScrolledPanel, sas.guiframe.panel_base.PanelBase

This panel displays data available in the application and widgets to interact with data.

append_theory(state_id, theory_list)

append theory object under data from a state of id = state_id replace that theory if already displayed

append_theory_helper(tree, root, state_id, theory_list)

Append theory helper

check_theory_to_freeze()

Check_theory_to_freeze

define_panel_structure()

Define the skeleton of the panel

disable_app_combo(enable)

Disable app combo box

do_layout()

Create the panel layout

enable_append()

enable or disable append button

enable_freeze()

enable or disable the freeze button

enable_import()

enable or disable send button

enable_plot()

enable or disable plot button

enable_remove()

enable or disable remove button

enable_remove_plot()

enable remove plot button if there is a plot panel on focus

enable_selection()

enable or disable combobo box selection

fill_cbox_analysis(plugin)

fill the combobox with analysis name

get_frame()

layout_batch()

Set up batch mode options

layout_button()

Layout widgets related to buttons

layout_data_list()

Add a listcrtl in the panel

layout_selection()

Create selection option combo box

load_data_list(list)

add need data with its theory under the tree

load_error(error=None)

Pop up an error message.

Parameters:error – details error message to be displayed

onContextMenu(event)

Retrieve the state selected state

on_append_plot(event=None)

append plot to plot panel on focus

on_batch_mode(event)

Change to batch mode :param event: UI event

on_check_item(event)

On check item

on_close(event)

On close event

on_close_page(event=None)

On close

on_close_plot(event)

clseo the panel on focus

on_data_info(event)

Data Info panel

on_edit_data(event)

Pop Up Data Editor

on_freeze(event)

On freeze to make a theory to a data set

on_import(event=None)

Get all select data and set them to the current active perspetive

on_plot(event=None)

Send a list of data names to plot

on_plot_3d(event)

Frozen image of 3D

on_quick_plot(event)

Frozen plot

on_remove(event)

Get a list of item checked and remove them from the treectrl Ask the parent to remove reference to this item

on_right_click_data(event)

Allow Editing Data

on_right_click_theory(event)

On click theory data

on_save_as(event)

Save data as a file

on_single_mode(event)

Change to single mode :param event: UI event

remove_by_id(id)

Remove_dat by id

set_active_perspective(name)

set the active perspective

set_data_helper()

Set data helper

set_frame(frame)

set_panel_on_focus(name=None)

set the plot panel on focus

set_plot_unfocus()

Unfocus plot

set_schedule_full_draw(panel=None, func='del')

Send full draw to guimanager

show_data_button()

show load data and remove data button if dataloader on else hide them

window_caption = 'Data Explorer'

window_name = 'Data Panel'

window_type = 'Data Panel'

class sas.guiframe.data_panel.DataTreeCtrl(parent, *args, **kwds)

Bases: wx.lib.agw.customtreectrl.CustomTreeCtrl

Check list control to be used for Data Panel

OnCompareItems(item1, item2)

Overrides OnCompareItems in wx.TreeCtrl. Used by the SortChildren method.

class sas.guiframe.data_panel.State

DataPanel State

sas.guiframe.data_panel.set_data_state(data=None, path=None, theory=None, state=None)

Set data state

sas.guiframe.data_processor module

Implement grid used to store data

class sas.guiframe.data_processor.BatchCell

Object describing a cell in the grid.

class sas.guiframe.data_processor.BatchOutputFrame(parent, data_inputs, data_outputs, file_name='', details='', *args, **kwds)

Bases: wx._windows.Frame

Allow to select where the result of batch will be displayed or stored

on_apply(event)

Get the user selection and display output to the selected application

on_close(event)

close the Window

onselect(event=None)

Receive event and display data into third party application or save data to file.

class sas.guiframe.data_processor.GridFrame(parent=None, data_inputs=None, data_outputs=None, id=-1, title='Grid Window', size=(800, 500))

Bases: wx._windows.Frame

GetLabelText(id)

Get Label Text

add_table(event)

Add a new table

on_append_column(event)

Append a new column to the grid

on_clear(event)

On Clear

on_close(event)

on_copy(event)

On Copy

on_menu_open(event)

On menu open

on_open(event)

Open file containg batch result

on_paste(event)

On Paste

on_remove_column(event)

On remove column

on_save_page(event)

open_with_excel(event)

open excel and display batch result in Excel

set_data(data_inputs, data_outputs, details='', file_name=None)

Set data

class sas.guiframe.data_processor.GridPage(parent, panel=None)

Bases: wx.lib.sheet.CSheet

get_grid_view()

Return value contained in the grid

get_nofrows()

Return number of total rows

insert_after_col_menu(menu, label, window)

insert_col_menu(menu, label, window)

insert_column(col, col_name)

onContextMenu(event)

Default context menu

on_clear(event)

Clear the cells selected

on_copy(event)

On copy event from the contextmenu

on_edit_cell(event)

on_insert_after_column(event)

Insert the given column after the highlighted column

on_insert_column(event)

on_left_click(event)

Catch the left click on label mouse event

on_paste(event)

On paste event from the contextmenu

on_remove_column(event=None)

on_right_click(event)

Catch the right click mouse

on_selected_cell(event)

Handler catching cell selection

on_set_x_axis(event)

on_set_y_axis(event)

remove_column(col, numCols=1)

Remove column to the current grid

set_data(data_inputs, data_outputs, details, file_name)

Add data to the grid :param data_inputs: data to use from the context menu of the grid :param data_ouputs: default columns deplayed

set_grid_values()

Set the values in grids

class sas.guiframe.data_processor.GridPanel(parent, data_inputs=None, data_outputs=None, *args, **kwds)

Bases: sas.guiframe.data_processor.SPanel

add_column()

create_axis_label(cell_list)

Receive a list of cells and create a string presenting the selected cells. :param cell_list: list of tuple

edit_axis_helper(tcrtl_label, tcrtl_title, label, title)

get controls to modify

get_plot_axis(col, list)

get_sentence(dict, sentence, column_names)

Get sentence from dict

layout_grid()

Draw the area related to the grid

layout_plotting_area()

Draw area containing options to plot

on_edit_axis(event)

Get the selected column on the visible grid and set values for axis

on_plot(event)

Evaluate the contains of textcrtl and plot result

on_remove_column()

on_view(event)

Get object represented buy the given cell and plot them.

set_dyaxis(label='', dy=None)

set_xaxis(label='', x=None)

set_yaxis(label='', y=None)

class sas.guiframe.data_processor.Notebook(parent, manager=None, data=None, *args, **kwargs)

Bases: wx.aui.AuiNotebook, sas.guiframe.panel_base.PanelBase

## Internal name for the AUI manager window_name = “Fit panel” ## Title to appear on top of the window

add_column()

Append a new column to the grid

add_empty_page()

create_axis_label(cell_list)

Receive a list of cells and create a string presenting the selected cells. :param cell_list: list of tuple

enable_close_button()

display the close button on tab for more than 1 tabs else remove the close button

get_column_labels()

return dictionary of columns labels of the current page

get_highlighted_row(is_number=True)

Add highlight rows

get_odered_results(inputs, outputs=None)

Get ordered the results

on_close_page(event)

close the page

on_edit_axis()

Return the select cell of a given selected column. Check that all cells are from the same column

on_remove_column()

Remove the selected column from the grid

set_data(data_inputs, data_outputs, details='', file_name=None)

window_caption = 'Notebook '

class sas.guiframe.data_processor.SPanel(parent, *args, **kwds)

Bases: wx.lib.scrolledpanel.ScrolledPanel

sas.guiframe.data_processor.parse_string(sentence, list)

Return a dictionary of column label and index or row selected :param sentence: String to parse :param list: list of columns label

sas.guiframe.data_state module

class sas.guiframe.data_state.DataState(data=None, parent=None)

Bases: object

Store information about data

clone()

get_data()

get_message()

return message

get_name()

get_path()

return the path of the loaded data

get_theory()

set_data(data)

set_name(name)

set_path(path)

Set the path of the loaded data

set_theory(theory_data, theory_state=None)

sas.guiframe.documentation_window module

class sas.guiframe.documentation_window.DocumentationWindow(parent, id, path, title='Help', size=(850, 540))

Bases: wx._windows.Frame

sas.guiframe.dummyapp module

Dummy application. Allows the user to set an external data manager

class sas.guiframe.dummyapp.DummyView(redirect=False, filename=None, useBestVisual=False, clearSigInt=True)

Bases: sas.guiframe.gui_manager.ViewApp

class sas.guiframe.dummyapp.SasView

class sas.guiframe.dummyapp.TestPlugin(name='Test_plugin', standalone=True)

Bases: sas.guiframe.plugin_base.PluginBase

get_context_menu(graph=None)

This method is optional.

When the context menu of a plot is rendered, the get_context_menu method will be called to give you a chance to add a menu item to the context menu.

A ref to a Graph object is passed so that you can investigate the plot content and decide whether you need to add items to the context menu.

This method returns a list of menu items. Each item is itself a list defining the text to appear in the menu, a tool-tip help text, and a call-back method.

Parameters:graph – the Graph object to which we attach the context menu Returns:a list of menu items with call-back function

get_panels(parent)

Create and return the list of wx.Panels for your plug-in. Define the plug-in perspective.

Panels should inherit from DefaultPanel defined below, or should present the same interface. They must define “window_caption” and “window_name”.

Parameters:parent – parent window Returns:list of panels

get_tools()

Returns a set of menu entries for tools

populate_menu(parent)

Create and return the list of application menu items for the plug-in. :param parent: parent window

Returns:plug-in menu

sas.guiframe.events module

sas.guiframe.gui_manager module

Gui manager: manages the widgets making up an application

class sas.guiframe.gui_manager.DefaultPanel(parent, *args, **kwds)

Bases: wx._windows.Panel, sas.guiframe.panel_base.PanelBase

Defines the API for a panels to work with the GUI manager

CENTER_PANE = True

window_caption = 'Welcome panel'

window_name = 'default'

class sas.guiframe.gui_manager.MDIFrame(parent, panel, title='Untitled', size=(300, 200))

Bases: wx._windows.MDIChildFrame

Frame for panels

OnClose(event)

On Close event

set_panel(panel)

set_panel_focus(event)

show_data_panel(action)

class sas.guiframe.gui_manager.ViewApp(redirect=False, filename=None, useBestVisual=False, clearSigInt=True)

Bases: wx._core.App

Toy application to test this Frame

OnInit()

When initialised

add_perspective(perspective)

Manually add a perspective to the application GUI

build_gui()

Build the GUI

clean_plugin_models(path)

Delete plugin models in app folder

Parameters:path – path of the plugin_models folder in app

display_splash_screen(parent, path='/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/sasview/images/SVwelcome_mini.png')

Displays the splash screen. It will exactly cover the main frame.

maximize_win()

Maximize the window after the frame shown

on_close_splash_screen(event)

When the splash screen is closed.

open_file()

open a state file at the start of the application

set_manager(manager)

Sets a reference to the application manager of the GUI manager (Frame)

set_welcome_panel(panel_class)

Set the welcome panel

Parameters:panel_class – class of the welcome panel to be instantiated

window_placement(size)

Determines the position and size of the application frame such that it fits on the user’s screen without obstructing (or being obstructed by) the Windows task bar. The maximum initial size in pixels is bounded by WIDTH x HEIGHT. For most monitors, the application will be centered on the screen; for very large monitors it will be placed on the left side of the screen.

class sas.guiframe.gui_manager.ViewerFrame(parent, title, size=(-1, -1), gui_style=381, style=541072960, pos=wx.Point(-1, -1))

Bases: wx._windows.MDIParentFrame

Main application frame

Close(event=None)

Quit the application

PopStatusText(*args, **kwds)

PushStatusText(*args, **kwds)

FIXME: No message is passed. What is this supposed to do?

SetStatusText(*args, **kwds)

WindowClose(event=None)

Quit the application from x icon

add_data(data_list)

receive a dictionary of data from loader store them its data manager if possible send to data the current active perspective if the data panel is not active. :param data_list: dictionary of data’s ID and value Data

add_data_helper(data_list)

add_icon()

get list of child and attempt to add the default icon

add_perspective(plugin)

Add a perspective if it doesn’t already exist.

append_bookmark(event=None)

Bookmark available information of the panel on focus

build_gui()

Build the GUI by setting up the toolbar, menu and layout.

check_multimode(perspective=None)

Check the perspective have batch mode capablitity

create_gui_data(data, path=None)

delete_data(data)

Delete the data.

delete_panel(uid)

delete panel given uid

disable_app_menu(p_panel=None)

Disables all menus in the menubar

enable_add_data(new_plot)

Enable append data on a plot panel

enable_bookmark()

Bookmark

enable_copy()

enable copy related control

enable_drag(event=None)

drag

enable_edit_menu()

enable menu item under edit menu depending on the panel on focus

enable_paste()

enable paste

enable_preview()

preview

enable_print()

print

enable_redo()

enable redo

enable_reset()

reset the current panel

enable_save()

save

enable_undo()

enable undo related control

enable_zoom()

zoom

enable_zoom_in()

zoom in

enable_zoom_out()

zoom out

freeze(data_id, theory_id)

full_draw()

Draw the panels with axes in the schedule to full dwar list

get_client_size()

return client size tuple

get_context_menu(plotpanel=None)

Get the context menu items made available by the different plug-ins. This function is used by the plotting module

get_current_context_menu(plotpanel=None)

Get the context menu items made available by the current plug-in. This function is used by the plotting module

get_current_perspective()

return the current perspective

get_data(path)

get_data_manager()

return the data manager.

get_paneinfo(name)

Get pane Caption from window_name

Parameters:name – window_name in AuiPaneInfo

: return: AuiPaneInfo of the name

get_save_location()

return the _default_save_location

get_schedule()

Get schedule

get_style()

Return the gui style

get_toolbar()

return the toolbar.

get_toolbar_height()

get_window_size()

Get window size

Return size:tuple

load_data(path)

load data from command line

load_folder(path)

Load entire folder

load_from_cmd(path)

load data from cmd or application

load_state(path, is_project=False)

load data from command line or application

on_batch_selection(event=None)

Parameters:event – contains parameter enable . when enable is set to True

the application is in Batch mode else the application is default mode(single mode)

on_bookmark_panel(event=None)

bookmark panel

on_category_panel(event)

On cat panel

on_change_caption(name, old_caption, new_caption)

Change the panel caption

Parameters:

• name – window_name of the pane
• old_caption – current caption [string]
• new_caption – new caption [string]

on_change_categories(evt)

on_close_welcome_panel()

Close the welcome panel

on_color_selection(event)

Parameters:event – contains parameters for id and color

on_copy_panel(event=None)

copy the last panel on focus if possible

on_drag_panel(event=None)

drag apply to the panel on focus

on_load_data(event)

received an event to trigger load from data plugin

on_panel_close(event)

Gets called when the close event for a panel runs. This will check which panel has been closed and delete it.

on_paste_panel(event=None)

paste clipboard to the last panel on focus

on_preview_panel(event=None)

preview information on the panel on focus

on_print_panel(event=None)

print available information on the last panel on focus

on_read_batch_tofile(base)

Open a file dialog , extract the file to read and display values into a grid

on_redo_panel(event=None)

redo the last cancel action done on the last panel on focus

on_reset_panel(event=None)

reset the current panel

on_save_helper(doc, reader, panel, path)

Save state into a file

on_save_panel(event=None)

save possible information on the current panel

on_set_batch_result(data_outputs, data_inputs=None, plugin_name='')

Display data into a grid in batch mode and show the grid

on_set_plot_focus(panel)

Set focus on a plot panel

on_undo_panel(event=None)

undo previous action of the last panel on focus if possible

on_view(evt)

A panel was selected to be shown. If it’s not already shown, display it.

Parameters:evt – menu event

on_zoom_in_panel(event=None)

zoom in of the panel on focus

on_zoom_out_panel(event=None)

zoom out on the panel on focus

on_zoom_panel(event=None)

zoom on the current panel if possible

onfreeze(theory_id)

open_with_externalapp(data, file_name, details='')

Display data in the another application , by default Excel

open_with_localapp(data_inputs=None, details='', file_name=None, data_outputs=None)

Display value of data into the application grid :param data: dictionary of string and list of items

plot_data(state_id, data_id=None, theory_id=None, append=False)

send a list of data to plot

popup_panel(p)

Add a panel object to the AUI manager

Parameters:p – panel object to add to the AUI manager Returns:ID of the event associated with the new panel [int]

post_init()

This initialization method is called after the GUI has been created and all plug-ins loaded. It calls the post_init() method of each plug-in (if it exists) so that final initialization can be done.

put_icon(frame)

Put icon on the tap of a panel

quit_guiframe()

Pop up message to make sure the user wants to quit the application

read_batch_tofile(file_name)

Extract value from file name and Display them into a grid

remove_data(data_id, theory_id=None)

Delete data state if data_id is provide delete theory created with data of id data_id if theory_id is provide if delete all true: delete the all state else delete theory

reset_bookmark_menu(panel)

Reset Bookmark menu list

: param panel: a control panel or tap where the bookmark is

save_data1d(data, fname)

Save data dialog

save_data2d(data, fname)

Save data2d dialog

send_focus_to_datapanel(name)

Send focusing on ID to data explorer

set_current_perspective(perspective)

set the current active perspective

set_custom_default_perspective()

Set default starting perspective

set_data(data_id, theory_id=None)

set data to current perspective

set_default_perspective()

Choose among the plugin the first plug-in that has “set_default_perspective” method and its return value is True will be as a default perspective when the welcome page is closed

set_input_file(input_file)

Parameters:input_file – file to read

set_manager(manager)

Sets the application manager for this frame

Parameters:manager – frame manager

set_panel_on_focus(event)

Store reference to the last panel on focus update the toolbar if available update edit menu if available

set_panel_on_focus_helper()

Helper for panel on focus with data_panel

set_perspective(panels)

Sets the perspective of the GUI. Opens all the panels in the list, and closes all the others.

Parameters:panels – list of panels

set_plot_unfocus()

Un focus all plot panels

set_schedule(schedule=False)

Set schedule

set_schedule_full_draw(panel=None, func='del')

Add/subtract the schedule full draw list with the panel given

Parameters:

• panel – plot panel
• func – append or del [string]

set_theory(state_id, theory_id=None)

setup_custom_conf()

Set up custom configuration if exists

show_batch_frame(event=None)

show the grid of result

show_data1d(data, name)

Show data dialog

show_data2d(data, name)

Show data dialog

show_data_panel(event=None, action=True)

show the data panel

show_welcome_panel(event)

Display the welcome panel

update_data(prev_data, new_data)

Update the data.

update_theory(data_id, theory, state=None)

Update the theory

write_batch_tofile(data, file_name, details='')

Helper to write result from batch into cvs file

sas.guiframe.gui_manager.get_app_dir()

The application directory is the one where the default custom_config.py file resides.

sas.guiframe.gui_manager.get_user_directory()

Returns the user’s home directory

sas.guiframe.gui_statusbar module

class sas.guiframe.gui_statusbar.Console(parent=None, status='', *args, **kwds)

Bases: wx._windows.Frame

Close(event)

set_message(status, event=None)

set_multiple_messages(messages=[])

class sas.guiframe.gui_statusbar.ConsolePanel(parent, *args, **kwargs)

Bases: wx._windows.Panel

set_message(status='', event=None)

class sas.guiframe.gui_statusbar.SPageStatusbar(parent, timeout=None, *args, **kwds)

Bases: wx._windows.StatusBar

class sas.guiframe.gui_statusbar.StatusBar(parent, id)

Bases: wx._windows.StatusBar

Application status bar

OnIdle(event)

OnSize(evt)

PopStatusText(*args, **kwds)

Override status bar

PushStatusText(*args, **kwds)

SetStatusText(text='', number=1, event=None)

clear_gauge(msg='')

Hide the gauge

enable_clear_gauge()

clear the progress bar

get_msg_position()

reposition()

Place the various fields in their proper position

set_dialog(event)

Display dialogbox

set_gauge(event)

change the state of the gauge according the state of the current job

set_icon(event)

Display icons related to the type of message sent to the statusbar when available. No icon is displayed if the message is empty

set_message(event)

display received message on the statusbar

set_status(event)

Update the status bar .

Parameters:

• type – type of message send. type must be in [“start”,”progress”,”update”,”stop”]
• msg – the message itself as string
• thread – if updatting using a thread status

sas.guiframe.gui_style module

Provide the style for guiframe

class sas.guiframe.gui_style.GUIFRAME

CALCULATOR_ON = 256

DATALOADER_ON = 16

DEFAULT_STYLE = 92

FIXED_PANEL = 4

FLOATING_PANEL = 2

MANAGER_ON = 1

MULTIPLE_APPLICATIONS = 92

PLOTTING_ON = 8

SINGLE_APPLICATION = 64

TOOLBAR_ON = 32

WELCOME_PANEL_ON = 128

class sas.guiframe.gui_style.GUIFRAME_ICON

BOOKMARK_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x1006e1210> >

BOOKMARK_ICON_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/bookmark.png'

COPY_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x10a214c00> >

COPY_ICON_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/copy.png'

DRAG_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x100721050> >

DRAG_ID_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/drag_hand.png'

FRAME_ICON_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/ball.ico'

HIDE_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x10a4f6cf0> >

HIDE_ID_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/hide.png'

PASTE_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x1006becb0> >

PASTE_ICON_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/paste.png'

PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images'

PREVIEW_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x10a4d0430> >

PREVIEW_ID_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/report.png'

PRINT_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x104b324a0> >

PRINT_ID_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/printer.png'

REDO_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x104b91fa0> >

REDO_ICON_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/redo.png'

REPORT_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x10a424a10> >

RESET_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x10a46fef0> >

RESET_ID_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/reset.png'

SAVE_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x10a221a80> >

SAVE_ICON_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/save.png'

UNDO_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x108d88e10> >

UNDO_ICON_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/undo.png'

ZOOM_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x10a2c0e30> >

ZOOM_ID_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/search_pan.png'

ZOOM_IN_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x10a4e8a70> >

ZOOM_IN_ID_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/zoom_in.png'

ZOOM_OUT_ICON = <wx._core.Image; proxy of <Swig Object of type 'wxImage *' at 0x10931d840> >

ZOOM_OUT_ID_PATH = '/Users/andrewjackson/Devel/sasview/build/lib.macosx-10.5-x86_64-2.7/sas/guiframe/images/zoom_out.png'

class sas.guiframe.gui_style.GUIFRAME_ID

BOOKMARK_ID = 104

COPYAS_ID = 116

COPYEX_ID = 114

COPYLAT_ID = 115

COPY_ID = 102

CURRENT_APPLICATION = 113

CURVE_SYMBOL_NUM = 13

DRAG_ID = 109

PASTE_ID = 103

PREVIEW_ID = 111

PRINT_ID = 112

REDO_ID = 101

RESET_ID = 110

SAVE_ID = 105

UNDO_ID = 100

ZOOM_ID = 108

ZOOM_IN_ID = 106

ZOOM_OUT_ID = 107

sas.guiframe.gui_toolbar module

class sas.guiframe.gui_toolbar.GUIToolBar(parent, *args, **kwds)

Bases: wx._controls.ToolBar

Implement toolbar for guiframe

add_bookmark_default()

Add default items in bookmark menu

append_bookmark(event)

receive item to append on the toolbar button bookmark

append_bookmark_item(id, label)

Append a item in bookmark

do_layout()

enable_bookmark(panel)

enable_copy(panel)

enable_paste(panel)

enable_preview(panel)

enable_print(panel)

enable_redo(panel)

enable_reset(panel)

enable_save(panel)

enable_undo(panel)

enable_zoom(panel)

enable_zoom_in(panel)

enable_zoom_out(panel)

get_bookmark_items()

Get bookmark menu items

on_bind_button()

Bind the buttons

on_bookmark(event)

add book mark

remove_bookmark_item(item)

Remove a bookmark item

update_button(application_name='', panel_name='')

update_toolbar(panel=None)

sas.guiframe.gui_toolbar.clear_image(image)

sas.guiframe.panel_base module

class sas.guiframe.panel_base.PanelBase(parent=None)

Defines the API for a panels to work with the ViewerFrame toolbar and menu bar

get_bookmark_flag()

Get the bookmark flag to update appropriately the tool bar

get_copy_flag()

Get the copy flag to update appropriately the tool bar

get_data()

return list of current data

get_drag_flag()

Get the drag flag to update appropriately the tool bar

get_frame()

get_manager()

get_paste_flag()

Get the copy flag to update appropriately the tool bar

get_preview_flag()

Get the preview flag to update appropriately the tool bar

get_print_flag()

Get the print flag to update appropriately the tool bar

get_redo_flag()

Get the redo flag to update appropriately the tool bar

get_reset_flag()

Get the reset flag to update appropriately the tool bar

get_save_flag()

Get the save flag to update appropriately the tool bar

get_state()

return the current state

get_undo_flag()

Get the undo flag to update appropriately the tool bar

get_zoom_flag()

Get the zoom flag to update appropriately the tool bar

get_zoom_in_flag()

Get the zoom in flag to update appropriately the tool bar

get_zoom_out_flag()

Get the zoom out flag to update appropriately the tool bar

group_id = None

has_changed()

on_batch_selection(event)

Parameters:event – contains parameter enable . when enable is set to True

the application is in Batch mode else the application is default mode(single mode)

on_bookmark(event)

The derivative class is on bookmark mode if implemented

on_close(event)

Close event. Hide the whole window.

on_copy(event)

The copy action if possible

on_drag(event)

The derivative class allows dragging motion if implemented

on_kill_focus(event=None)

The derivative class is on unfocus if implemented

on_paste(event)

The paste action if possible

on_preview(event)

Display a printable version of the class derivative

on_redo(event)

The previous action is restored if possible

on_reset(event)

The derivative class state is restored

on_save(event)

The state of the derivative class is restored

on_set_focus(event=None)

The derivative class is on focus if implemented

on_tap_focus()

Update menu on clicking the panel tap

on_undo(event)

The current action is canceled

on_zoom(event)

The derivative class is on zoom mode (using pane) if zoom mode is implemented

on_zoom_in(event)

The derivative class is on zoom in mode if implemented

on_zoom_out(event)

The derivative class is on zoom out mode if implemented

save_project(doc=None)

return an xml node containing state of the panel

that guiframe can write to file

set_manager(manager)

uid = None

sas.guiframe.pdfview module

class sas.guiframe.pdfview.PDFFrame(parent, id, title, path)

Bases: wx._windows.Frame

Frame for PDF panel

class sas.guiframe.pdfview.PDFPanel(parent, path=None)

Bases: wx._windows.Panel

Panel that contains the pdf reader

OnClose(event)

Close panel

OnLoad(event=None, path=None)

Load a pdf file

: Param path: full path to the file

OnNextPageButton(event)

Goes to Next page

OnOpenButton(event)

Open file button

OnPrevPageButton(event)

Goes to Previous page

class sas.guiframe.pdfview.TextFrame(parent, id, title, text)

Bases: wx._windows.Frame

Frame for PDF panel

class sas.guiframe.pdfview.TextPanel(parent, text=None)

Bases: wx.lib.scrolledpanel.ScrolledPanel

Panel that contains the text

OnClose(event)

Close panel

class sas.guiframe.pdfview.ViewApp(redirect=False, filename=None, useBestVisual=False, clearSigInt=True)

Bases: wx._core.App

OnInit()

sas.guiframe.plugin_base module

class sas.guiframe.plugin_base.PluginBase(name='Test_plugin', standalone=True)

This class defines the interface for a Plugin class that can be used by the gui_manager.

Plug-ins should be placed in a sub-directory called “perspectives”. For example, a plug-in called Foo should be place in “perspectives/Foo”. That directory contains at least two files:

1. perspectives/Foo/__init__.py contains two lines:

   PLUGIN_ID = "Foo plug-in 1.0"
   from Foo import *
   

2. perspectives/Foo/Foo.py contains the definition of the Plugin class for the Foo plug-in. The interface of that Plugin class should follow the interface of the class you are looking at.

See dummyapp.py for a plugin example.

add_color(color, id)

Adds color to a plugin

can_load_data()

if return True, then call handler to laod data

clear_panel()

clear all related panels

delete_data(data_id)

Delete all references of data which id are in data_list.

get_batch_capable()

Check if the plugin has a batch capability

get_context_menu(plotpanel=None)

This method is optional.

When the context menu of a plot is rendered, the get_context_menu method will be called to give you a chance to add a menu item to the context menu.

A ref to a plotpanel object is passed so that you can investigate the plot content and decide whether you need to add items to the context menu.

This method returns a list of menu items. Each item is itself a list defining the text to appear in the menu, a tool-tip help text, and a call-back method.

Parameters:graph – the Graph object to which we attach the context menu Returns:a list of menu items with call-back function

get_extensions()

return state reader and its extensions

get_frame()

Returns MDIChildFrame

get_panels(parent)

Create and return the list of wx.Panels for your plug-in. Define the plug-in perspective.

Panels should inherit from DefaultPanel defined below, or should present the same interface. They must define “window_caption” and “window_name”.

Parameters:parent – parent window Returns:list of panels

get_perspective()

Get the list of panel names for this perspective

get_tools()

Returns a set of menu entries for tools

is_always_active()

return True is this plugin is always active and it is local to guiframe even if the user is switching between perspectives

is_in_use(data_id)

get a data id a list of data name if data data is

currently used by the plugin and the name of the plugin

data_name = ‘None’ in_use = False example [(data_name, self.sub_menu)]

load_data(event)

Load data

load_folder(event)

Load entire folder

on_batch_selection(flag)

need to be overwritten by the derivated class

on_perspective(event=None)

Call back function for the perspective menu item. We notify the parent window that the perspective has changed.

Parameters:event – menu event

on_set_state_helper(event)

update state

populate_file_menu()

Append menu item under file menu item of the frame

populate_menu(parent)

Create and return the list of application menu items for the plug-in.

Parameters:parent – parent window Returns:plug-in menu

post_init()

Post initialization call back to close the loose ends

set_batch_selection(flag)

the plugin to its batch state if flag is True

set_data(data_list=None)

receive a list of data and use it in the current perspective

set_default_perspective()

Call back method that True to notify the parent that the current plug-in can be set as default perspective. when returning False, the plug-in is not candidate for an automatic default perspective setting

set_is_active(active=False)

set_state(state=None, datainfo=None)

update state

set_theory(theory_list=None)

Parameters:theory_list – list of information related to available theory state

use_data()

return True if these plugin use data

sas.guiframe.startup_configuration module

sas.guiframe.startup_configuration.PANEL_HEIGHT = 215

Dialog to set Appication startup configuration

class sas.guiframe.startup_configuration.StartupConfiguration(parent, gui, id=-1, title='Startup Setting')

Bases: wx._windows.Dialog

Dialog for Startup Configuration

OnCurrent(event=None)

Set to curent setup

OnDefault(event=None)

Set to default

write_custom_config()

Write custom configuration

write_string(fname, strings)

Write and Save file

sas.guiframe.utils module

Contains common classes and functions

class sas.guiframe.utils.PanelMenu(self, String title=EmptyString, long style=0)

Bases: wx._core.Menu

graph = None

plots = None

set_graph(graph)

set_plots(plots)

sas.guiframe.utils.check_float(item)

Parameters:item – txtcrtl containing a value

sas.guiframe.utils.format_number(value, high=False)

Return a float in a standardized, human-readable formatted string

sas.guiframe.utils.look_for_tag(string1, begin, end=None)

this method remove the begin and end tags given by the user from the string .

Parameters:

• begin – the initial tag
• end – the final tag
• string – the string to check

Returns:

begin_flag==True if begin was found, end_flag==if end was found else return false, false

sas.guiframe.utils.parse_name(name, expression)

remove “_” in front of a name

sas.guiframe.utils.split_list(separator, mylist, n=0)

returns a list of string without white space of separator

Parameters:separator – the string to remove

sas.guiframe.utils.split_text(separator, string1, n=0)

return a list of string without white space of separator

Parameters:separator – the string to remove

Module contents

sas.guiframe.data_files()

Return the data files associated with guiframe images .

The format is a list of (directory, [files...]) pairs which can be used directly in setup(...,data_files=...) for setup.py.

sas.guiframe.get_data_path(media)

sas.guiframe.get_media_path(media)