sas.qtgui.Utilities package

Submodules

sas.qtgui.Utilities.AddMultEditor module

Widget for simple add / multiply editor.

class sas.qtgui.Utilities.AddMultEditor.AddMultEditor(parent=None)

Bases: QDialog, Ui_AddMultEditorUI

Dialog for easy custom composite models. Provides a Dialog panel to choose two existing models (including pre-existing Plugin Models which may themselves be composite models) as well as an operation on those models (add or multiply) the resulting model will add a scale parameter and a background parameter. The user can also give a brief help for the model in the description box and must provide a unique name which is verified before the new model is saved.

__doc__ = '\n       Dialog for easy custom composite models.  Provides a Dialog panel\n       to choose two existing models (including pre-existing Plugin Models which\n       may themselves be composite models) as well as an operation on those models\n       (add or multiply) the resulting model will add a scale parameter and a\n       background parameter.\n       The user can also give a brief help for the model in the description box and\n       must provide a unique name which is verified before the new model is saved.\n    '

__init__(parent=None)

__module__ = 'sas.qtgui.Utilities.AddMultEditor'

onApply()

Validity check, save model to file

onHelp()

Display related help section

onNameCheck()

Check if proposed new model name does not already exists (if the overwriting is not allowed). If not an error message not show error message is displayed

onOperatorChange(index)

Respond to operator combo box changes

onOverwrite()

Modify state on checkbox change

readModels(std_only=False)

Generate list of all models

setupModels()

Add list of models to ‘Model1’ and ‘Model2’ comboboxes

setupSignals()

Signals from various elements

updateModels()

Update contents of comboboxes with new plugin models

write_new_model_to_file(fname, model1_name, model2_name, operator)

Write and Save file

sas.qtgui.Utilities.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.qtgui.Utilities.CategoryInstaller.CategoryInstaller

Bases: object

Class for making sure all category stuff is installed

Note - class is entirely static!

__dict__ = mappingproxy({'__module__': 'sas.qtgui.Utilities.CategoryInstaller', '__doc__': '\n    Class for making sure all category stuff is installed\n\n    Note - class is entirely static!\n    ', '__init__': <function CategoryInstaller.__init__>, '_get_home_dir': <staticmethod object>, '_regenerate_model_dict': <staticmethod object>, '_regenerate_master_dict': <staticmethod object>, 'get_user_file': <staticmethod object>, 'get_default_file': <staticmethod object>, 'check_install': <staticmethod object>, '__dict__': <attribute '__dict__' of 'CategoryInstaller' objects>, '__weakref__': <attribute '__weakref__' of 'CategoryInstaller' objects>, '__annotations__': {}})

__doc__ = '\n    Class for making sure all category stuff is installed\n\n    Note - class is entirely static!\n    '

__init__()

initialization

__module__ = 'sas.qtgui.Utilities.CategoryInstaller'

__weakref__

list of weak references to the object (if defined)

static _get_home_dir()

returns the users sasview config dir

static _regenerate_master_dict(by_model_dict, model_enabled_dict)

regenerates master_category_dict from by_model_dict and model_enabled_dict returns the master category dictionary

static _regenerate_model_dict(master_category_dict)

regenerates self.by_model_dict which has each model name as the key and the list of categories belonging to that model along with the enabled mapping returns tuplet (by_model_dict, model_enabled_dict)

static check_install(homedir=None, model_list=None)

the main method of this class makes sure categories.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()

static get_user_file()

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

sas.qtgui.Utilities.CodeEditor module

class sas.qtgui.Utilities.CodeEditor.QCodeEditor(parent=None)

Bases: QPlainTextEdit

__doc__ = None

__init__(parent=None)

__module__ = 'sas.qtgui.Utilities.CodeEditor'

highlightCurrentLine()

lineNumberAreaPaintEvent(event)

lineNumberAreaWidth()

resizeEvent(self, QResizeEvent)

updateLineNumberArea(rect, dy)

updateLineNumberAreaWidth()

class sas.qtgui.Utilities.CodeEditor.QLineNumberArea(editor)

Bases: QWidget

__doc__ = None

__init__(editor)

__module__ = 'sas.qtgui.Utilities.CodeEditor'

paintEvent(self, QPaintEvent)

sizeHint(self) → QSize

sas.qtgui.Utilities.ConnectionProxy module

class sas.qtgui.Utilities.ConnectionProxy.ConnectionProxy(url, timeout)

Bases: object

__dict__ = mappingproxy({'__module__': 'sas.qtgui.Utilities.ConnectionProxy', '__init__': <function ConnectionProxy.__init__>, '_get_addresses_of_proxy_pac': <function ConnectionProxy._get_addresses_of_proxy_pac>, '_parse_proxy_pac': <function ConnectionProxy._parse_proxy_pac>, '_set_proxy': <function ConnectionProxy._set_proxy>, 'connect': <function ConnectionProxy.connect>, '__dict__': <attribute '__dict__' of 'ConnectionProxy' objects>, '__weakref__': <attribute '__weakref__' of 'ConnectionProxy' objects>, '__doc__': None, '__annotations__': {}})

__doc__ = None

__init__(url, timeout)

__module__ = 'sas.qtgui.Utilities.ConnectionProxy'

__weakref__

list of weak references to the object (if defined)

_get_addresses_of_proxy_pac()

Return a list of possible auto proxy .pac files being used, based on the system registry (win32) or system preferences (OSX). @return: list of urls

_parse_proxy_pac(pac_urls_list)

For every pac file url in pac_urls_list, it tryes to connect. If the connection is successful parses the file in search for http proxies. @param pac_urls_list: List with urls for the pac files @return: list with all found http proxies

_set_proxy(proxy_dic=None)

Sets connection proxy. if proxy_dic is None get’s teh proxy from the system. To disable autodetected proxy pass an empty dictionary: {} @param proxy_dic: format: {‘http’: ‘http://www.example.com:3128/’}

connect()

Performs the request and gets a response from self.url @return: response object from urllib2.urlopen

sas.qtgui.Utilities.CustomDir module

sas.qtgui.Utilities.CustomDir._find_customconf_dir()

Find path of the config directory. The plugin directory is located in the user’s home directory.

sas.qtgui.Utilities.CustomDir._find_usersasview_dir()

Find and return user/.sasview dir

sas.qtgui.Utilities.CustomDir.setup_conf_dir(path)

Setup the custom config dir and cat file

sas.qtgui.Utilities.FileConverter module

File Converter Widget

class sas.qtgui.Utilities.FileConverter.FileConverterWidget(parent=None)

Bases: QDialog, Ui_FileConverterUI

Class to describe the behaviour of the File Converter widget

__doc__ = '\n    Class to describe the behaviour of the File Converter widget\n    '

__init__(parent=None)

Parent here is the GUI Manager. Required for access to the help location and to the file loader.

__module__ = 'sas.qtgui.Utilities.FileConverter'

addSlots()

Create callbacks for UI elements and outside signals

askFrameRange(n_frames=1)

Display a dialog asking the user to input the range of frames they would like to export

Parameters:

n_frames – How many frames the loaded data file has

Returns:

A dictionary containing the parameters input by the user

convert1Ddata(qdata, iqdata, ofile, metadata)

Formats a 1D array of q_axis data and a 2D array of I axis data (where each row of iqdata is a separate row), into an array of Data1D objects

extractBSLdata(filename)

Extracts data from a 2D BSL file

Parameters:

filename – The header file to extract the data from

Return x_data:

A 1D array containing all the x coordinates of the data

Return y_data:

A 1D array containing all the y coordinates of the data

Return frame_data:

A dictionary of the form {frame_number: data}, where data is a 2D numpy array containing the intensity data

getDetectorMetadata()

Read the detector metadata fields and put them in the dictionary

getMetadata()

metadata getter

getSampleMetadata()

Read the sample metadata fields and put them in the dictionary

getSourceMetadata()

Read the source metadata fields and put them in the dictionary

onConvert()

Call the conversion method (and update DataExplorer with converted data)?

onHelp()

Display online help related to the file converter

onIFileOpen()

Show the path chooser for file with I

onInputFormat()

Enable/disable UI items based on input format spec

onNewFile()

show the save new file widget

onNewFileEdited()

Update the output file state on direct field edit

onQFileOpen()

Show the path chooser for file with Q

openFile()

Show the path chooser for existent file

readMetadata()

Read the metadata fields and put them in the dictionary

This reads the UI elements directly, but we don’t have a clear MVP distinction in this widgets, so there.

setValidators()

Apply validators for double precision numbers to numerical fields

updateConvertState()

Asserts presece of files for coversion. If all present -> enable the Convert button.

sas.qtgui.Utilities.FrameSelect module

FrameSelect class describes behaviour of the FrameSelect dialog

class sas.qtgui.Utilities.FrameSelect.FrameSelect(parent=None, frames=1, isBSL=True)

Bases: QDialog, Ui_FrameSelect

Class to describe the behaviour of the Frame Selector widget

__doc__ = '\n    Class to describe the behaviour of the Frame Selector widget\n    '

__init__(parent=None, frames=1, isBSL=True)

__module__ = 'sas.qtgui.Utilities.FrameSelect'

addSlots()

Describe behaviour of OK and Cancel buttons

addState()

Minor bookkeeping

addText()

Initialize view

getFrames()

Accessor for state values

onFirstChanged()

Manage view-model sync

onIncrementChanged()

Manage view-model sync

onLastChanged()

Manage view-model sync

updateDisplay()

manage model-view sync

sas.qtgui.Utilities.GenericReader module

Thread handler used to load data

class sas.qtgui.Utilities.GenericReader.GenReader(path, loader, completefn=None, updatefn=None, yieldtime=0.01, worktime=0.01)

Bases: CalcThread

Load a sld data given a filename

__doc__ = '\n    Load a sld data given a filename\n    '

__init__(path, loader, completefn=None, updatefn=None, yieldtime=0.01, worktime=0.01)

Prepare the calculator

__module__ = 'sas.qtgui.Utilities.GenericReader'

compute()

Read some data

isquit()

@raise KeyboardInterrupt: when the thread is interrupted

sas.qtgui.Utilities.GridPanel module

class sas.qtgui.Utilities.GridPanel.BatchInversionOutputPanel(parent=None, output_data=None)

Bases: BatchOutputPanel

Class for stateless grid-like printout of P(r) parameters for any number of data sets

__doc__ = '\n        Class for stateless grid-like printout of P(r) parameters for any number\n        of data sets\n    '

__init__(parent=None, output_data=None)

__module__ = 'sas.qtgui.Utilities.GridPanel'

closeEvent(event)

Tell the parent window the window closed

classmethod onHelp()

Open a local url in the default browser

setupTable(widget=None, data=None)

Create tablewidget items and show them, based on params

class sas.qtgui.Utilities.GridPanel.BatchOutputPanel(parent=None, output_data=None)

Bases: QMainWindow, Ui_GridPanelUI

Class for stateless grid-like printout of model parameters for mutiple models

ERROR_COLUMN_CAPTION = ' (Err)'

IS_WIN = True

__doc__ = '\n    Class for stateless grid-like printout of model parameters for mutiple models\n    '

__init__(parent=None, output_data=None)

__module__ = 'sas.qtgui.Utilities.GridPanel'

actionLoadData()

Open file load dialog and load a .csv file

actionSaveFile()

Generate a .csv file and dump it do disk

actionSendToExcel()

Generates a .csv file and opens the default CSV reader

addFitResults(results)

Create a new tab with batch fitting results

addTabPage(name=None)

Add new tab page with QTableWidget

addToolbarActions()

Assing actions and callbacks to the File menu items

closeEvent(event)

Overwrite QDialog close method to allow for custom widget close

currentTable()

Returns the currently shown QTabWidget

classmethod dataFromTable(table)

Creates a dictionary {<parameter>:[list of values]} from the parameter table

classmethod onHelp()

Open a local url in the default browser

onPlot()

Plot selected fits by sending signal to the parent

setupTable(widget=None, data=None)

Create tablewidget items and show them, based on params

setupTableFromCSV(csv_data)

Create tablewidget items and show them, based on params

showContextMenu(position)

Show context specific menu in the tab table widget.

windowClosedSignal

classmethod writeBatchToFile(data, tmpfile, details='')

Helper to write result from batch into cvs file

sas.qtgui.Utilities.GuiUtils module

Global defaults and various utility functions usable by the general GUI

class sas.qtgui.Utilities.GuiUtils.Communicate

Bases: QObject

Utility class for tracking of the Qt signals

SaveFitParamsSignal

__doc__ = '\n    Utility class for tracking of the Qt signals\n    '

__module__ = 'sas.qtgui.Utilities.GuiUtils'

activeGraphName

activeGraphsSignal

changeDataExplorerTabSignal

copyExcelFitParamsSignal

copyFitParamsSignal

copyLatexFitParamsSignal

customModelDirectoryChanged

dataDeletedSignal

deleteIntermediateTheoryPlotsSignal

extMaskEditorSignal

fileDataReceivedSignal

fileReadSignal

forcePlotDisplaySignal

maskEditorSignal

pasteFitParamsSignal

perspectiveChangedSignal

plotFromNameSignal

plotRequestedSignal

plotUpdateSignal

progressBarUpdateSignal

resultPlotUpdateSignal

sendDataToGridSignal

sendDataToPanelSignal

statusBarUpdateSignal

updateMaskedDataSignal

updateModelCategoriesSignal

updateModelFromDataOperationPanelSignal

updateModelFromPerspectiveSignal

updatePerspectiveWithDataSignal

updateTheoryFromPerspectiveSignal

class sas.qtgui.Utilities.GuiUtils.DoubleValidator

Bases: QDoubleValidator

Allow only dots as decimal separator

__doc__ = '\n    Allow only dots as decimal separator\n    '

__module__ = 'sas.qtgui.Utilities.GuiUtils'

fixup(input)

Correct (remove) potential preexisting content

validate(input, pos)

Return invalid for commas

class sas.qtgui.Utilities.GuiUtils.FormulaValidator(parent=None)

Bases: QValidator

__doc__ = None

__init__(parent=None)

__module__ = 'sas.qtgui.Utilities.GuiUtils'

_setStyleSheet(value)

validate(self, str, int) → Tuple[QValidator.State, str, int]

class sas.qtgui.Utilities.GuiUtils.HashableStandardItem(parent=None)

Bases: QStandardItem

Subclassed standard item with reimplemented __hash__ to allow for use as an index.

__doc__ = '\n    Subclassed standard item with reimplemented __hash__\n    to allow for use as an index.\n    '

__hash__()

just a random hash value

__init__(parent=None)

__module__ = 'sas.qtgui.Utilities.GuiUtils'

clone()

Assure __hash__ is cloned as well

sas.qtgui.Utilities.GuiUtils._find_local_config(confg_file, path)

Find configuration file for the current application

sas.qtgui.Utilities.GuiUtils.checkModel(path)

Check that the model save in file ‘path’ can run.

sas.qtgui.Utilities.GuiUtils.convertFromSVS(datasets)

Read in properties from SVS and convert into a simple dict

sas.qtgui.Utilities.GuiUtils.convertUnitToHTML(unit)

Convert ASCII unit display into well rendering HTML

sas.qtgui.Utilities.GuiUtils.convertUnitToUTF8(unit)

Convert ASCII unit display into UTF-8 symbol

sas.qtgui.Utilities.GuiUtils.createModelItemWithPlot(update_data, name='')

Creates a checkboxed QStandardItem named “name” Adds ‘update_data’ to that row.

sas.qtgui.Utilities.GuiUtils.dataFromItem(item)

Retrieve Data1D/2D component from QStandardItem. The assumption - data stored in SasView standard, in child 0

sas.qtgui.Utilities.GuiUtils.deleteRedundantPlots(item, new_plots)

Checks all plots that are children of the given item; if any have an ID or name not included in new_plots, it is deleted. Useful for e.g. switching from P(Q)S(Q) to P(Q); this would remove the old S(Q) plot.

Ensure that new_plots contains ALL the relevant plots(!!!)

sas.qtgui.Utilities.GuiUtils.enum(*sequential, **named)

Create an enumeration object from a list of strings

sas.qtgui.Utilities.GuiUtils.findNextFilename(filename, directory)

Finds the next available (non-existing) name for ‘filename’ in ‘directory’. plugin.py -> plugin (n).py - for first ‘n’ for which the file doesn’t exist

sas.qtgui.Utilities.GuiUtils.formatNumber(value, high=False)

Return a float in a standardized, human-readable formatted string. This is used to output readable (e.g. x.xxxe-y) values to the panel.

sas.qtgui.Utilities.GuiUtils.formatValue(value)

Formats specific data types for the GUI.

This function accepts three types of data: numeric data castable to float, a numpy.ndarray of type castable to float, or None. Numeric data is returned in human-readable format by formatNumber(), numpy arrays are averaged over all axes, and the mean returned in human-readable format. If value=None then the string “NaN” is returned.

Parameters:

value (float, numeric type castable to float, numpy.ndarray, None) – The value to be formatted

Returns:

The formatted value

Return type:

str

sas.qtgui.Utilities.GuiUtils.getChildrenFromItem(root)

Recursively go down the model item looking for all children

sas.qtgui.Utilities.GuiUtils.getConstraints(fit_project)

Extracts constraints from fir_project dict and returns a dict where keys are the tab name and values are a list of constraints on that tab. The dict can then be passed to the updateFromConstraints method from the fitting perspective to apply the constraints with error checking mechanism

sas.qtgui.Utilities.GuiUtils.getMonospaceFont()

Convenience function; returns a monospace font to be used in any shells, code editors, etc.

sas.qtgui.Utilities.GuiUtils.get_app_dir()

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

Returns:

app_path - the path to the applicatin directory

sas.qtgui.Utilities.GuiUtils.get_user_directory()

Returns the user’s home directory

sas.qtgui.Utilities.GuiUtils.infoFromData(data)

Given Data1D/Data2D object, extract relevant Info elements and add them to a model item

sas.qtgui.Utilities.GuiUtils.itemFromDisplayName(name, model_item)

Returns the model item text=name in the model

sas.qtgui.Utilities.GuiUtils.onTXTSave(data, path)

Save file as formatted txt

sas.qtgui.Utilities.GuiUtils.openLink(url)

Open a URL in an external browser. Check the URL first, though.

sas.qtgui.Utilities.GuiUtils.parseName(name, expression)

remove “_” in front of a name

sas.qtgui.Utilities.GuiUtils.plotsFromCheckedItems(model_item)

Returns the list of plots for items in the model which are checked

sas.qtgui.Utilities.GuiUtils.plotsFromDisplayName(name, model_item)

Returns the list of plots for the item with text=name in the model

sas.qtgui.Utilities.GuiUtils.plotsFromModel(model_name, model_item)

Returns the list of plots for the item with model name in the model

sas.qtgui.Utilities.GuiUtils.plotsOfType(model, datatype=<class 'sas.qtgui.Plotting.PlotterData.Data1D'>)

Returns the list of plots for the whole model of type datatype

sas.qtgui.Utilities.GuiUtils.readDataFromFile(fp)

Reads in Data1D/Data2 datasets from the file. Datasets are stored in the JSON format.

sas.qtgui.Utilities.GuiUtils.readProjectFromSVS(filepath)

Read old SVS file and convert to the project dictionary

sas.qtgui.Utilities.GuiUtils.replaceHTMLwithASCII(html)

Replace some important HTML-encoded characters with their ASCII equivalents

sas.qtgui.Utilities.GuiUtils.replaceHTMLwithUTF8(html)

Replace some important HTML-encoded characters with their UTF-8 equivalents

sas.qtgui.Utilities.GuiUtils.retrieveData1d(data)

Retrieve 1D data from file and construct its text representation

sas.qtgui.Utilities.GuiUtils.retrieveData2d(data)

Retrieve 2D data from file and construct its text representation

sas.qtgui.Utilities.GuiUtils.saveAnyData(data, wildcard_dict=None)

Generic file save routine called by SaveData1D and SaveData2D

Parameters:

• data – Data 1D or Data2D object the data will be taken from

• wildcard_dict – Dictionary in format {“Display Text”: “.ext”}

sas.qtgui.Utilities.GuiUtils.saveData(fp, data)

save content of data to fp (a .write()-supporting file-like object)

sas.qtgui.Utilities.GuiUtils.saveData1D(data)

Save 1D data points

Parameters:

data – Data1D object the data will be taken from

sas.qtgui.Utilities.GuiUtils.saveData2D(data)

Save data2d data points

Parameters:

data – Data2D object the data will be taken from

sas.qtgui.Utilities.GuiUtils.showHelp(url)

Open a local url in the default browser

sas.qtgui.Utilities.GuiUtils.toDouble(value_string)

toFloat conversion which cares deeply about user’s locale

sas.qtgui.Utilities.GuiUtils.updateModelItem(item, update_data, name='')

Adds a simple named child to QStandardItem

sas.qtgui.Utilities.GuiUtils.updateModelItemStatus(model_item, filename='', name='', status=2)

Update status of checkbox related to high- and low-Q extrapolation choice in Invariant Panel

sas.qtgui.Utilities.GuiUtils.updateModelItemWithPlot(item, update_data, name='', checkbox_state=None)

Adds a checkboxed row named “name” to QStandardItem Adds ‘update_data’ to that row.

sas.qtgui.Utilities.GuiUtils.xyTransform(data, xLabel='', yLabel='')

Transforms x and y in View and set the scale

sas.qtgui.Utilities.IPythonWidget module

class sas.qtgui.Utilities.IPythonWidget.IPythonWidget(**kwargs: Any)

Bases: RichJupyterWidget

__doc__ = None

__init__(parent=None, **kwargs)

Create a RichJupyterWidget.

__module__ = 'sas.qtgui.Utilities.IPythonWidget'

_cross_validation_lock: bool

_trait_default_generators = {}

_trait_notifiers: Dict[str, Any]

_trait_validators: Dict[str, Any]

_trait_values: Dict[str, Any]

sas.qtgui.Utilities.ImageViewer module

Image viewer widget.

class sas.qtgui.Utilities.ImageViewer.ImageViewer(parent=None)

Bases: QMainWindow, Ui_ImageViewerUI

Implemented as QMainWindow to enable easy menus

__doc__ = '\n    Implemented as QMainWindow to enable easy menus\n    '

__init__(parent=None)

__module__ = 'sas.qtgui.Utilities.ImageViewer'

actionConvertToData()

Show the options dialog and if accepted, send data to conversion

actionCopyImage()

Copy MPL widget area to buffer

actionHowTo()

Send the image viewer help URL to the help viewer

actionLoadImage()

Image loader given files extensions

actionPrintImage()

Display printer dialog and print the MPL widget area

actionSaveImage()

Use the internal MPL method for saving to file

addPlotter()

Add a new plotter to the frame

addTriggers()

Trigger definitions for all menu/toolbar actions.

convertImage(rgb, xmin, xmax, ymin, ymax, zscale)

Convert image to data2D

disableMenus()

All menu items but “Load File” and “Help” should be disabled when no data is present

enableMenus()

Enable all menu items when data is present

rgb2gray(rgb)

RGB to Grey

showImage(filename)

Show the requested image in the main frame

class sas.qtgui.Utilities.ImageViewer.ImageViewerOptions(parent=None)

Bases: QDialog, Ui_ImageViewerOptionsUI

Logics for the image viewer options UI

__doc__ = '\n    Logics for the image viewer options UI\n    '

__init__(parent=None)

__module__ = 'sas.qtgui.Utilities.ImageViewer'

addDefaults()

Fill out textedits with default values

addValidators()

Define simple validators on line edits

getState()

return current state of the widget

sas.qtgui.Utilities.LocalConfig module

Application settings

sas.qtgui.Utilities.LocalConfig.printEVT(message)

Post a debug message to console/file

sas.qtgui.Utilities.ModelEditor module

class sas.qtgui.Utilities.ModelEditor.ModelEditor(parent=None, is_python=True)

Bases: QDialog, Ui_ModelEditor

Class describing the “advanced” model editor. This is a simple text browser allowing for editing python and supporting simple highlighting.

__doc__ = '\n    Class describing the "advanced" model editor.\n    This is a simple text browser allowing for editing python and\n    supporting simple highlighting.\n    '

__init__(parent=None, is_python=True)

__module__ = 'sas.qtgui.Utilities.ModelEditor'

addSignals()

Respond to signals in the widget

getModel()

Return the current model, as displayed in the window

modelModified

onEdit()

Respond to changes in the text browser.

setupWidgets()

Set up dialog widgets. Here - just the highlighter connected to the text edit.

sas.qtgui.Utilities.ObjectLibrary module

sas.qtgui.Utilities.ObjectLibrary.addObject(obj_name, obj)

sas.qtgui.Utilities.ObjectLibrary.deleteObjectByName(obj_name)

sas.qtgui.Utilities.ObjectLibrary.deleteObjectByRef(obj)

sas.qtgui.Utilities.ObjectLibrary.getObject(obj_name)

sas.qtgui.Utilities.ObjectLibrary.listObjects()

sas.qtgui.Utilities.PlotView module

class sas.qtgui.Utilities.PlotView.EmbeddedPylab(canvas)

Bases: object

Define a ‘with’ context manager that lets you use pylab commands to plot on an embedded canvas. This is useful for wrapping existing scripts in a GUI, and benefits from being more familiar than the underlying object oriented interface.

As a convenience, the pylab module is returned on entry.

Example

The following example shows how to use the WxAgg backend in a wx panel:

from matplotlib.backends.backend_wxagg import FigureCanvasWxAgg as FigureCanvas
from matplotlib.backends.backend_wxagg import NavigationToolbar2WxAgg as Toolbar
from matplotlib.figure import Figure

class PlotPanel(wx.Panel):
    def __init__(self, *args, **kw):
        wx.Panel.__init__(self, *args, **kw)

        figure = Figure(figsize=(1,1), dpi=72)
        canvas = FigureCanvas(self, wx.ID_ANY, figure)
        self.pylab_interface = EmbeddedPylab(canvas)

        # Instantiate the matplotlib navigation toolbar and explicitly show it.
        mpl_toolbar = Toolbar(canvas)
        mpl_toolbar.Realize()

        # Create a vertical box sizer to manage the widgets in the main panel.
        sizer = wx.BoxSizer(wx.VERTICAL)
        sizer.Add(canvas, 1, wx.EXPAND|wx.LEFT|wx.RIGHT, border=0)
        sizer.Add(mpl_toolbar, 0, wx.EXPAND|wx.ALL, border=0)

        # Associate the sizer with its container.
        self.SetSizer(sizer)
        sizer.Fit(self)

    def plot(self, *args, **kw):
        with self.pylab_interface as pylab:
            pylab.clf()
            pylab.plot(*args, **kw)

Similar patterns should work for the other backends. Check the source code in matplotlib.backend_bases.* for examples showing how to use matplotlib with other GUI toolkits.

__dict__ = mappingproxy({'__module__': 'sas.qtgui.Utilities.PlotView', '__doc__': "\n    Define a 'with' context manager that lets you use pylab commands to\n    plot on an embedded canvas.  This is useful for wrapping existing\n    scripts in a GUI, and benefits from being more familiar than the\n    underlying object oriented interface.\n\n    As a convenience, the pylab module is returned on entry.\n\n    *Example*\n\n    The following example shows how to use the WxAgg backend in a wx panel::\n\n        from matplotlib.backends.backend_wxagg import FigureCanvasWxAgg as FigureCanvas\n        from matplotlib.backends.backend_wxagg import NavigationToolbar2WxAgg as Toolbar\n        from matplotlib.figure import Figure\n\n        class PlotPanel(wx.Panel):\n            def __init__(self, *args, **kw):\n                wx.Panel.__init__(self, *args, **kw)\n\n                figure = Figure(figsize=(1,1), dpi=72)\n                canvas = FigureCanvas(self, wx.ID_ANY, figure)\n                self.pylab_interface = EmbeddedPylab(canvas)\n\n                # Instantiate the matplotlib navigation toolbar and explicitly show it.\n                mpl_toolbar = Toolbar(canvas)\n                mpl_toolbar.Realize()\n\n                # Create a vertical box sizer to manage the widgets in the main panel.\n                sizer = wx.BoxSizer(wx.VERTICAL)\n                sizer.Add(canvas, 1, wx.EXPAND|wx.LEFT|wx.RIGHT, border=0)\n                sizer.Add(mpl_toolbar, 0, wx.EXPAND|wx.ALL, border=0)\n\n                # Associate the sizer with its container.\n                self.SetSizer(sizer)\n                sizer.Fit(self)\n\n            def plot(self, *args, **kw):\n                with self.pylab_interface as pylab:\n                    pylab.clf()\n                    pylab.plot(*args, **kw)\n\n    Similar patterns should work for the other backends.  Check the source code\n    in matplotlib.backend_bases.* for examples showing how to use matplotlib\n    with other GUI toolkits.\n    ", '__init__': <function EmbeddedPylab.__init__>, '__enter__': <function EmbeddedPylab.__enter__>, '__exit__': <function EmbeddedPylab.__exit__>, '__dict__': <attribute '__dict__' of 'EmbeddedPylab' objects>, '__weakref__': <attribute '__weakref__' of 'EmbeddedPylab' objects>, '__annotations__': {}})

__doc__ = "\n    Define a 'with' context manager that lets you use pylab commands to\n    plot on an embedded canvas.  This is useful for wrapping existing\n    scripts in a GUI, and benefits from being more familiar than the\n    underlying object oriented interface.\n\n    As a convenience, the pylab module is returned on entry.\n\n    *Example*\n\n    The following example shows how to use the WxAgg backend in a wx panel::\n\n        from matplotlib.backends.backend_wxagg import FigureCanvasWxAgg as FigureCanvas\n        from matplotlib.backends.backend_wxagg import NavigationToolbar2WxAgg as Toolbar\n        from matplotlib.figure import Figure\n\n        class PlotPanel(wx.Panel):\n            def __init__(self, *args, **kw):\n                wx.Panel.__init__(self, *args, **kw)\n\n                figure = Figure(figsize=(1,1), dpi=72)\n                canvas = FigureCanvas(self, wx.ID_ANY, figure)\n                self.pylab_interface = EmbeddedPylab(canvas)\n\n                # Instantiate the matplotlib navigation toolbar and explicitly show it.\n                mpl_toolbar = Toolbar(canvas)\n                mpl_toolbar.Realize()\n\n                # Create a vertical box sizer to manage the widgets in the main panel.\n                sizer = wx.BoxSizer(wx.VERTICAL)\n                sizer.Add(canvas, 1, wx.EXPAND|wx.LEFT|wx.RIGHT, border=0)\n                sizer.Add(mpl_toolbar, 0, wx.EXPAND|wx.ALL, border=0)\n\n                # Associate the sizer with its container.\n                self.SetSizer(sizer)\n                sizer.Fit(self)\n\n            def plot(self, *args, **kw):\n                with self.pylab_interface as pylab:\n                    pylab.clf()\n                    pylab.plot(*args, **kw)\n\n    Similar patterns should work for the other backends.  Check the source code\n    in matplotlib.backend_bases.* for examples showing how to use matplotlib\n    with other GUI toolkits.\n    "

__enter__()

__exit__(*args, **kw)

__init__(canvas)

__module__ = 'sas.qtgui.Utilities.PlotView'

__weakref__

list of weak references to the object (if defined)

class sas.qtgui.Utilities.PlotView.PlotView(*args, **kw)

Bases: QWidget, _PlotViewShared

__doc__ = None

__init__(*args, **kw)

__module__ = 'sas.qtgui.Utilities.PlotView'

_is_shown()

class sas.qtgui.Utilities.PlotView._PlotViewShared

Bases: object

__dict__ = mappingproxy({'__module__': 'sas.qtgui.Utilities.PlotView', 'title': 'Plot', 'default_size': (600, 400), 'pylab_interface': None, 'plot_state': None, 'model': None, '_calculating': False, '_need_plot': False, '_need_newmodel': False, 'set_model': <function _PlotViewShared.set_model>, 'update_model': <function _PlotViewShared.update_model>, 'update_parameters': <function _PlotViewShared.update_parameters>, '_show': <function _PlotViewShared._show>, '_redraw': <function _PlotViewShared._redraw>, 'get_state': <function _PlotViewShared.get_state>, 'set_state': <function _PlotViewShared.set_state>, 'menu': <function _PlotViewShared.menu>, 'newmodel': <function _PlotViewShared.newmodel>, 'plot': <function _PlotViewShared.plot>, '__dict__': <attribute '__dict__' of '_PlotViewShared' objects>, '__weakref__': <attribute '__weakref__' of '_PlotViewShared' objects>, '__doc__': None, '__annotations__': {'pylab_interface': 'EmbeddedPylab'}})

__doc__ = None

__module__ = 'sas.qtgui.Utilities.PlotView'

__weakref__

list of weak references to the object (if defined)

_calculating = False

_need_newmodel = False

_need_plot = False

_redraw(newmodel=False)

_show()

default_size = (600, 400)

get_state()

menu()

Return a model specific menu

model = None

newmodel(model=None)

New or updated model structure. Do any sort or precalculation you need. plot will be called separately when you are done.

For long calculations, periodically perform wx.YieldIfNeeded() and then if self.cancel_calculation is True, return from the plot.

plot()

Plot to the current figure. If model has a plot method, just use that.

For long calculations, periodically perform wx.YieldIfNeeded() and then if self.cancel_calculation is True, return from the plot.

plot_state = None

pylab_interface: EmbeddedPylab = None

set_model(model)

set_state(state)

title = 'Plot'

update_model(model)

update_parameters(model)

sas.qtgui.Utilities.PluginDefinition module

class sas.qtgui.Utilities.PluginDefinition.PluginDefinition(parent=None)

Bases: QDialog, Ui_PluginDefinition

Class describing the “simple” plugin editor. This is a simple series of widgets allowing for specifying model form and parameters.

__doc__ = '\n    Class describing the "simple" plugin editor.\n    This is a simple series of widgets allowing for specifying\n    model form and parameters.\n    '

__init__(parent=None)

__module__ = 'sas.qtgui.Utilities.PluginDefinition'

addSignals()

Define slots for widget signals

addTooltip()

Add the default tooltip to the text field

addWidgets()

Initialize various widgets in the dialog

getModel()

Return the current plugin model

initializeModel()

Define the dictionary for internal data representation

modelModified

onDescriptionChanged()

Respond to changes in plugin description

onFunctionChanged()

Respond to changes in function body

onOverwrite()

Respond to change in file overwrite checkbox

onParamsChanged(row, column)

Respond to changes in non-polydisperse parameter table

onParamsPDChanged(row, column)

Respond to changes in non-polydisperse parameter table

onPluginNameChanged()

Respond to changes in plugin name

sas.qtgui.Utilities.PluginManager module

class sas.qtgui.Utilities.PluginManager.PluginManager(parent=None)

Bases: QDialog, Ui_PluginManagerUI

Class describing the model plugin manager. This is a simple list widget allowing for viewing/adding/deleting custom models.

__doc__ = '\n    Class describing the model plugin manager.\n    This is a simple list widget allowing for viewing/adding/deleting custom models.\n    '

__init__(parent=None)

__module__ = 'sas.qtgui.Utilities.PluginManager'

addSignals()

Define slots for widget signals

onAdd()

Show the add new model dialog

onAddFile()

Open system Load FIle dialog, load a plugin and put it in the plugin directory

onDelete()

Remove the file containing the selected plugin

onDuplicate()

Creates a copy of the selected model(s)

onEdit()

Show the edit existing model dialog

onHelp()

Show the help page in the default browser

onSelectionChanged()

Respond to row selection

readModels()

Read in custom models from the default location

sas.qtgui.Utilities.PythonSyntax module

class sas.qtgui.Utilities.PythonSyntax.PythonHighlighter(document, is_python=True)

Bases: QSyntaxHighlighter

Syntax highlighter for the Python language.

__doc__ = 'Syntax highlighter for the Python language.\n    '

__init__(document, is_python=True)

__module__ = 'sas.qtgui.Utilities.PythonSyntax'

braces = ['\\{', '\\}', '\\(', '\\)', '\\[', '\\]']

c_keywords = ['auto', 'break', 'case', 'char', 'const', 'continue', 'default', 'do', 'double', 'else', 'enum', 'extern', 'float', 'for', 'goto', 'if', 'int', 'long', 'register', 'return', 'short', 'signed', 'sizeof', 'static', 'struct', 'switch', 'typedef', 'union', 'unsigned', 'void', 'volatile', 'while']

highlightBlock(text)

Apply syntax highlighting to the given block of text.

match_multiline(text, delimiter, in_state, style)

Do highlighting of multi-line strings. delimiter should be a QRegExp for triple-single-quotes or triple-double-quotes, and in_state should be a unique integer to represent the corresponding state changes when inside those strings. Returns True if we’re still inside a multi-line string when this function is finished.

operators = ['=', '==', '!=', '<', '<=', '>', '>=', '\\+', '-', '\\*', '/', '//', '\\%', '\\*\\*', '\\+=', '-=', '\\*=', '/=', '\\%=', '\\^', '\\|', '\\&', '\\~', '>>', '<<']

python_keywords = ['and', 'assert', 'break', 'class', 'continue', 'def', 'del', 'elif', 'else', 'except', 'exec', 'finally', 'for', 'from', 'global', 'if', 'import', 'in', 'is', 'lambda', 'not', 'or', 'pass', 'print', 'raise', 'return', 'try', 'while', 'yield', 'None', 'True', 'False']

sas.qtgui.Utilities.PythonSyntax.format(color, style='')

Return a QTextCharFormat with the given attributes.

sas.qtgui.Utilities.ReportDialog module

class sas.qtgui.Utilities.ReportDialog.ReportDialog(parent=None, report_list=None)

Bases: QDialog, Ui_ReportDialogUI

Class for stateless grid-like printout of model parameters for mutiple models

static HTML2PDF(data, filename)

Create a PDF file from html source string. Returns True is the file creation was successful. : data: html string : filename: name of file to be saved

__doc__ = '\n    Class for stateless grid-like printout of model parameters for mutiple models\n    '

__init__(parent=None, report_list=None)

__module__ = 'sas.qtgui.Utilities.ReportDialog'

getPictures(basename)

Returns list of saved MPL figures

static onHTMLSave(html, filename)

HTML file write

onPrint()

Display the print dialog and send the report to printer

onSave()

Display the Save As… prompt and save the report if instructed so

static onTXTSave(data, filename)

Simple txt file serialization

setupDialog(output=None)

Display the HTML content in the browser.

sas.qtgui.Utilities.ResultPanel module

FitPanel class contains fields allowing to fit models and data

class sas.qtgui.Utilities.ResultPanel.ResultPanel(parent, manager=None, *args, **kwargs)

Bases: QTabWidget

FitPanel class contains fields allowing to fit models and data

Note:

For Fit to be performed the user should check at least one parameter on fit Panel window.

__doc__ = '\n    FitPanel class contains fields allowing to fit  models and  data\n\n    :note: For Fit to be performed the user should check at least one parameter\n        on fit Panel window.\n\n    '

__init__(parent, manager=None, *args, **kwargs)

__module__ = 'sas.qtgui.Utilities.ResultPanel'

closeEvent(event)

Overwrite QDialog close method to allow for custom widget close

onPlotResults(results, optimizer='Unknown')

updateBumps()

Monkeypatching bumps plot viewer to allow Qt

windowClosedSignal

window_name = 'Result panel'

sas.qtgui.Utilities.SasviewLogger module

class sas.qtgui.Utilities.SasviewLogger.QtHandler

Bases: QObject, Handler

Version of logging handler “emitting” the message to custom stdout()

__doc__ = '\n    Version of logging handler "emitting" the message to custom stdout()\n    '

__init__()

__module__ = 'sas.qtgui.Utilities.SasviewLogger'

emit(record)

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

messageWritten

sas.qtgui.Utilities.SasviewLogger.setup_qt_logging()

sas.qtgui.Utilities.TabbedModelEditor module

class sas.qtgui.Utilities.TabbedModelEditor.TabbedModelEditor(parent=None, edit_only=False)

Bases: QDialog, Ui_TabbedModelEditor

Model editor “container” class describing interaction between plugin definition widget and model editor widget. Once the model is defined, it can be saved as a plugin.

__doc__ = '\n    Model editor "container" class describing interaction between\n    plugin definition widget and model editor widget.\n    Once the model is defined, it can be saved as a plugin.\n    '

__init__(parent=None, edit_only=False)

__module__ = 'sas.qtgui.Utilities.TabbedModelEditor'

addSignals()

Define slots for common widget signals

addWidgets()

Populate tabs with widgets

canWriteModel(model=None, full_path='')

Determine if the current plugin can be written to file

checkModel(model_str)

Run the ast check and return True if the model is good. False otherwise.

closeEvent(event)

Overwrite the close even to assure intent

editorModelModified()

User modified the model in the Model Editor. Disable the plugin editor and show that the model is changed.

generateModel(model, fname)

generate model from the current plugin state

getModel()

Retrieves plugin model from the currently open tab

classmethod getParamHelper(param_str)

yield a sequence of name, value pairs for the parameters in param_str

Parameters can be defined by one per line by name=value, or multiple on the same line by separating the pairs by semicolon or comma. The value is optional and defaults to “1.0”.

isModelCorrect(full_path)

Run the sasmodels method for model check and return True if the model is good. False otherwise.

loadFile(filename)

Performs the load operation and updates the view

onApply()

Write the plugin and update the model editor if plugin editor open Write/overwrite the plugin if model editor open

onCancel()

Accept if document not modified, confirm intent otherwise.

onHelp()

Bring up the Model Editor Documentation whenever the HELP button is clicked. Calls Documentation Window with the path of the location within the documentation tree (after /doc/ ….”.

onLoad()

Loads a model plugin file

onModifiedExit()

pluginTitleSet()

User modified the model name. Display the model name in the window title and allow for model save.

saveClose()

Check if file needs saving before closing or model reloading

setPluginActive(is_active=True)

Enablement control for all the controls on the simple plugin editor

setTabEdited(is_edited)

Change the widget name to indicate unsaved state Unsaved state: add “*” to filename display saved state: remove “*” from filename display

classmethod strFromParamDict(param_dict)

Creates string from parameter dictionary

Example:

{
    0: ('variable','value'),
    1: ('variable','value'),
    ...
}

updateFromEditor()

Save the current state of the Model Editor

updateFromPlugin()

Write the plugin and update the model editor

classmethod writeFile(fname, model_str='')

Write model content to file “fname”

Module contents