sas.sasgui.perspectives.fitting package

Subpackages

Submodules

sas.sasgui.perspectives.fitting.basepage module

Base Page for fitting

class sas.sasgui.perspectives.fitting.basepage.BasicPage(parent, color='blue', **kwargs)

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

This class provide general structure of the fitpanel page

ID_BOOKMARK = 181

ID_DISPERSER_HELP = 182

check_invalid_panel()

check if the user can already perform some action with this panel

createMemento()

return the current state of the page

create_default_data()

Given the user selection, creates a 1D or 2D data Only when the page is on theory mode.

define_page_structure()

Create empty sizer for a panel

formfactor_combo_init()

First time calls _show_combox_helper

get_all_checked_params()

Found all parameters current check and add them to list of parameters to fit if implemented

get_cat_combo_box_pos(state)

Iterate through the categories to find the structurefactor :return: combo_box_position

get_clipboard()

Get strings in the clipboard

get_copy()

Get copy params to clipboard

get_copy_excel()

Get copy params to clipboard

get_copy_latex()

Get copy params to clipboard

get_copy_params()

Get the string copies of the param names and values in the tap

get_copy_params_excel()

Get the string copies of the param names and values in the tap

get_copy_params_latex()

Get the string copies of the param names and values in the tap

get_data()

return the current data

get_data_list()

return the current data

get_images()

Get the images of the plots corresponding this panel for report

: return graphs: list of figures : Need Move to guiframe

get_paste()

Paste params from the clipboard

get_paste_params(text='')

Get the string copies of the param names and values in the tap

get_state()

return the current page state

get_weight_flag()

Get flag corresponding to a given weighting dI data if implemented

initialize_combox()

put default value in the combo box

onContextMenu(event)

Retrieve the state selected state

onPinholeSmear(event)

Create a custom pinhole smear object if implemented

onRedo(event)

Restore the previous action cancelled

onResetModel(event)

Reset model state

onSetFocus(evt)

highlight the current textcrtl and hide the error text control shown after fitting

onSlitSmear(event)

Create a custom slit smear object if implemented

onSmear(event)

Create a smear object if implemented

onUndo(event)

Cancel the previous action

on_bookmark(event)

save history of the data and model

on_copy(event)

Copy Parameter values to the clipboad

on_function_help_clicked(event)

Function called when ‘Help’ button is pressed next to model of interest. This calls DocumentationWindow from documentation_window.py. It will load the top level of the model help documenation sphinx generated html if no model is presented. If a model IS present then if documention for that model exists it will load to that point otherwise again it will go to the top. For Wx2.8 and below is used (i.e. non-released through installer) a browser is loaded and the top of the model documentation only is accessible because webbrowser module does not pass anything after the # to the browser.

Parameters:event – on Help Button pressed event

on_left_down(event)

Get key stroke event

on_model_help_clicked(event)

Function called when ‘Description’ button is pressed next to model of interest. This calls the Description embedded in the model. This should work with either Wx2.8 and lower or higher. If no model is selected it will give the message that a model must be chosen first in the box that would normally contain the description. If a badly behaved model is encountered which has no description then it will give the message that none is available.

Parameters:event – on Description Button pressed event

on_paste(event)

Paste Parameter values to the panel if possible

on_pd_help_clicked(event)

Bring up Polydispersity Documentation whenever the ? button is clicked. Calls DocumentationWindow with the path of the location within the documentation tree (after /doc/ ....”. Note that when using old versions of Wx (before 2.9) and thus not the release version of istallers, the help comes up at the top level of the file as webbrowser does not pass anything past the # to the browser when it is running “file:///....”

Parameters:event – Triggers on clicking ? in polydispersity box

on_preview(event)

Report the current fit results

on_reset_clicked(event)

On ‘Reset’ button for Q range clicked

on_save(event)

Save the current state into file

on_set_focus(event)

On Set Focus, update guimanger and menu

on_smear_helper(update=False)

Help for onSmear if implemented

Parameters:update – force or not to update

on_tap_focus()

Update menu1 on cliking the page tap

populate_box(model_dict)

Store list of model

Parameters:model_dict – dictionary containing list of models

read_file(path)

Read two columns file

Parameters:path – the path to the file to read

reset_page(state, first=False)

reset the state if implemented

reset_page_helper(state)

Use page_state and change the state of existing page

Precondition:the page is already drawn or created Postcondition:the state of the underlying data changes as well as the state of the graphic interface

save_current_state()

Store current state

save_current_state_fit()

Store current state for fit_page

select_log(event)

Log checked to generate log spaced points for theory model

select_param(event)

Select TextCtrl checked if implemented

set_clipboard(content=None)

Put the string to the clipboard

set_data(data=None)

Sets data if implemented

set_dispers_sizer()

fill sizer containing dispersity info

set_index_model(index)

Index related to this page

set_layout()

layout

set_manager(manager)

set panel manager

Parameters:manager – instance of plugin fitting

set_model_dictionary(model_dict)

Store a dictionary linking model name -> model object

Parameters:model_dict – dictionary containing list of models

set_model_state(state)

reset page given a model state

set_owner(owner)

set owner of fitpage

Parameters:owner – the class responsible of plotting

show_npts2fit()

setValue Npts for fitting if implemented

update_pinhole_smear()

Method to be called by sub-classes Moveit; This method doesn’t belong here

update_slit_smear()

called by kill_focus on pinhole TextCntrl to update the changes if implemented

window_caption = 'Fit Page '

window_name = 'Fit Page'

class sas.sasgui.perspectives.fitting.basepage.ModelTextCtrl(parent, id=-1, value=u'', pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=0, validator=<wx._core.Validator; proxy of <Swig Object of type 'wxValidator *' at 0xd857340> >, name=u'text', kill_focus_callback=None, set_focus_callback=None, mouse_up_callback=None, text_enter_callback=None)

Bases: wx._controls.TextCtrl

Text control for model and fit parameters. Binds the appropriate events for user interactions. Default callback methods can be overwritten on initialization

Parameters:

• kill_focus_callback – callback method for EVT_KILL_FOCUS event
• set_focus_callback – callback method for EVT_SET_FOCUS event
• mouse_up_callback – callback method for EVT_LEFT_UP event
• text_enter_callback – callback method for EVT_TEXT_ENTER event

full_selection = False

sas.sasgui.perspectives.fitting.batchfitpage module

Batch panel

class sas.sasgui.perspectives.fitting.batchfitpage.BGTextCtrl(*args, **kwds)

Bases: wx._controls.TextCtrl

Text control used to display outputs. No editing allowed. The background is grayed out. User can’t select text.

class sas.sasgui.perspectives.fitting.batchfitpage.BatchFitPage(parent, color=None)

Bases: sas.sasgui.perspectives.fitting.fitpage.FitPage

Batch Page

window_caption = 'BatchFit'

window_name = 'BatchFit'

sas.sasgui.perspectives.fitting.console module

class sas.sasgui.perspectives.fitting.console.ConsoleUpdate(parent, manager=None, quiet=False, progress_delta=60, improvement_delta=5)

Bases: sas.sascalc.fit.AbstractFitEngine.FitHandler

Print progress to the console.

abort()

error(msg)

Model had an error; print traceback

finalize()

get_result()

improvement()

Called when a result is observed which is better than previous results from the fit.

improvement_delta = 5

Number of seconds between improvement updates

isbetter = False

Record whether results improved since last update

print_result()

Print result object

progress(k, n)

Report on progress.

progress_delta = 60

Number of seconds between progress updates

set_result(result)

starting_fit()

stop(msg)

Post event msg and stop

update_fit(last=False)

sas.sasgui.perspectives.fitting.fit_thread module

class sas.sasgui.perspectives.fitting.fit_thread.FitThread(fn, page_id, handler, batch_outputs, batch_inputs=None, pars=None, completefn=None, updatefn=None, yieldtime=0.03, worktime=0.03, reset_flag=False)

Bases: sas.sascalc.data_util.calcthread.CalcThread

Thread performing the fit

compute()

Perform a fit

isquit()

Raises:KeyboardInterrupt – when the thread is interrupted

sas.sasgui.perspectives.fitting.fit_thread.map_apply(arguments)

sas.sasgui.perspectives.fitting.fit_thread.map_getattr(classInstance, classFunc, *args)

Take an instance of a class and a function name as a string. Execute class.function and return result

sas.sasgui.perspectives.fitting.fitpage module

FitPanel class contains fields allowing to display results when fitting a model and one data

class sas.sasgui.perspectives.fitting.fitpage.BGTextCtrl(*args, **kwds)

Bases: wx._controls.TextCtrl

Text control used to display outputs. No editing allowed. The background is grayed out. User can’t select text.

class sas.sasgui.perspectives.fitting.fitpage.FitPage(parent, color=None)

Bases: sas.sasgui.perspectives.fitting.basepage.BasicPage

FitPanel class contains fields allowing to display results when fitting a model and one data

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

compute_data_range(data)

compute the minimum and the maximum range of the data return the npts contains in data :param data:

compute_data_set_range(data_list)

find the range that include all data in the set return the minimum and the maximum values

enable_datasource()

Enable or disable data source control depending on existing data

enable_fit_button()

Enable fit button if data is valid and model is valid

fill_data_combobox(data_list)

Get a list of data and fill the corresponding combobox

get_all_checked_params()

Found all parameters current check and add them to list of parameters to fit

get_chi2()

return the current chi2

get_npts2fit()

return numbers of data points within qrange

Note:This is to normalize chisq by Npts of fit

get_range()

return the fitting range

get_view_mode()

return True if the panel allow 2D or False if 1D

get_weight_flag()

Get flag corresponding to a given weighting dI data.

onPinholeSmear(event)

Create a custom pinhole smear object that will change the way residuals are compute when fitting

Note:accuracy is given by strings’High’,’Med’, ‘Low’ FOR 2d, None for 1D

onSlitSmear(event)

Create a custom slit smear object that will change the way residuals are compute when fitting

onSmear(event)

Create a smear object that will change the way residuals are computed when fitting

onWeighting(event)

On Weighting radio button event, sets the weightbt_string

on_complete_chisqr(event)

Display result chisqr on the panel :event: activated by fitting/ complete after draw

on_key(event)

On Key down

on_qrange_text(event)

#On q range value updated. DO not combine with qrange_click().

on_right_down(event)

Get key stroke event

on_select_data(event=None)

On_select_data

on_set_focus(event)

Override the basepage focus method to ensure the save flag is set properly when focusing on the fit page.

on_smear_helper(update=False)

Help for onSmear

Parameters:update – force or not to update

onsetValues(chisqr, p_name, out, cov)

Build the panel from the fit result

Parameters:

• chisqr – Value of the goodness of fit metric
• p_name – the name of parameters
• out – list of parameter with the best value found during fitting
• cov – Covariance matrix

qrang_set_focus(event=None)

ON Qrange focus

qrange_click(event)

On Qrange textctrl click, make the qrange lines in the plot

rename_model()

find a short name for model

reset_page(state, first=False)

reset the state

select_param(event=None)

Select TextCtrl checked for fitting purpose and stores them in self.param_toFit=[] list

set_data(data)

reset the current data

set_fitbutton()

Set fit button label depending on the fit_started[bool]

set_model_param_sizer(model)

Build the panel from the model content

Parameters:model – the model selected in combo box for fitting purpose

show_npts2fit()

setValue Npts for fitting

update_pinhole_smear()

called by kill_focus on pinhole TextCntrl to update the changes

Returns:False when wrong value was entered

update_slit_smear()

called by kill_focus on pinhole TextCntrl to update the changes

Returns:False when wrong value was entered

sas.sasgui.perspectives.fitting.fitpanel module

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.

class sas.sasgui.perspectives.fitting.fitpanel.FitPanel(parent, manager=None, *args, **kwargs)

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

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.

CENTER_PANE = True

add_empty_page()

add an empty page

add_sim_page(caption='Const & Simul Fit')

Add the simultaneous fit page

clear_panel()

Clear and close all panels, used by guimanager

close_all()

remove all pages, used when a svs file is opened

close_page_with_data(deleted_data)

close a fit page when its data is completely remove from the graph

delete_data(data)

Delete the given data

enable_close_button()

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

get_current_page()

Returns:the current page selected

get_data()

get the data in the current page

get_page_by_id(uid)

get_state()

return the state of the current selected page

helper_on_page_change()

on_close_page(event=None)

close page and remove all references to the closed page

on_closed(event)

on_page_changing(event)

calls the function when the current event handler has exited. avoiding to call panel on focus on a panel that is currently deleted

on_set_focus(event)

reset_pmodel_list()

save_project(doc=None)

return an xml node containing state of the panel that guiframe can write to file

set_data(data_list)

Add a fitting page on the notebook contained by fitpanel

Parameters:data_list – data to fit

:return panel : page just added for further used. is used by fitting module

set_data_on_batch_mode(data_list)

Add all data to a single tab when the application is on Batch mode. However all data in the set of data must be either 1D or 2D type. This method presents option to select the data type before creating a tab.

set_manager(manager)

set panel manager

Parameters:manager – instance of plugin fitting

set_model_dict(m_dict)

copy a dictionary of model name -> model object

Parameters:m_dict – dictionary linking model name -> model object

set_model_list(dict)

copy a dictionary of model into its own dictionary

Parameters:dict – dictionnary made of model name as key and model class as value

set_model_state(state)

receive a state to reset the model in the current page

set_state(state)

Restore state of the panel

update_model_list()

window_caption = 'Fit Panel '

window_name = 'Fit panel'

sas.sasgui.perspectives.fitting.fitproblem module

Inferface containing information to store data, model, range of data, etc... and retreive this information. This is an inferface for a fitProblem i.e relationship between data and model.

class sas.sasgui.perspectives.fitting.fitproblem.FitProblem

Bases: sas.sasgui.perspectives.fitting.fitproblem.FitProblemComponent

FitProblem class allows to link a model with the new name created in _on_model, a name theory created with that model and the data fitted with the model. FitProblem is mostly used as value of the dictionary by fitting module.

clear_model_param()

clear constraint info

enable_smearing(flag=False)

Parameters:flag – bool.When flag is 1 get the computer smear value. When flag is 0 ingore smear value.

get_fit_data()

Returns:data associate with this class

get_fit_tab_caption()

get_graph_id()

Get graph_id

get_model()

Returns:saved model

get_model_param()

return list of couple of parameter name and value

get_name()

get_origin_data()

get_param2fit()

return the list param names to fit

get_range()

Returns:fitting range

get_residuals()

Returns:residuals

get_result()

get result

get_scheduled()

return true or false if a problem as being schedule for fitting

get_smearer()

return smear object

get_theory_data()

Returns:theory generated with the current model and data of this class

get_weight()

returns weight array

save_model_name(name)

schedule_tofit(schedule=0)

set schedule to true to decide if this fit must be performed

set_fit_data(data)

Store data associated with this class :param data: list of data selected

set_fit_tab_caption(caption)

set_graph_id(id)

Set graph id (from data_group_id at the time the graph produced)

set_model(model)

associates each model with its new created name :param model: model selected :param name: name created for model

set_model_param(name, value=None)

Store the name and value of a parameter of this fitproblem’s model :param name: name of the given parameter :param value: value of that parameter

set_param2fit(list)

Store param names to fit (checked) :param list: list of the param names

set_range(qmin=None, qmax=None)

set fitting range :param qmin: minimum value to consider for the fit range :param qmax: maximum value to consider for the fit range

set_residuals(residuals)

save a copy of residual :param data: data selected

set_result(result)

set_smearer(smearer)

save reference of smear object on fitdata

Parameters:smear – smear object from DataLoader

set_theory_data(data)

save a copy of the data select to fit

Parameters:data – data selected

set_weight(is2d, flag=None)

Received flag and compute error on data. :param flag: flag to transform error of data. :param is2d: flag to distinguish 1D to 2D Data

class sas.sasgui.perspectives.fitting.fitproblem.FitProblemComponent

Bases: object

Inferface containing information to store data, model, range of data, etc... and retreive this information. This is an inferface for a fitProblem i.e relationship between data and model.

clear_model_param()

clear constraint info

enable_smearing(flag=False)

Parameters:flag – bool.When flag is 1 get the computer smear value. When flag is 0 ingore smear value.

get_fit_data()

get_fit_tab_caption()

Return the caption of the page associated with object

get_graph_id()

Get graph_id

get_model()

Returns:saved model

get_model_param()

return list of couple of parameter name and value

get_name()

get_param2fit()

return the list param names to fit

get_range()

Returns:fitting range

get_residuals()

Returns:residuals

get_result()

get result

get_scheduled()

return true or false if a problem as being schedule for fitting

get_smearer()

return smear object

get_theory_data()

Returns:list of data dList

get_weight()

get fitting weight

save_model_name(name)

schedule_tofit(schedule=0)

set schedule to true to decide if this fit must be performed

set_fit_data(data)

Store of list of data and create by create new fitproblem of each data id, if there was existing information about model, this information get copy to the new fitproblem :param data: list of data selected

set_fit_tab_caption(caption)

store the caption of the page associated with object

set_graph_id(id)

Set graph id (from data_group_id at the time the graph produced)

set_model(model)

associates each model with its new created name :param model: model selected :param name: name created for model

set_model_param(name, value=None)

Store the name and value of a parameter of this fitproblem’s model :param name: name of the given parameter :param value: value of that parameter

set_param2fit(list)

Store param names to fit (checked) :param list: list of the param names

set_range(qmin=None, qmax=None)

set fitting range

set_residuals(residuals)

save a copy of residual :param data: data selected

set_result(result)

set_theory_data(data)

save a copy of the data select to fit :param data: data selected

set_weight(flag=None)

set fitting range

class sas.sasgui.perspectives.fitting.fitproblem.FitProblemDictionary

Bases: sas.sasgui.perspectives.fitting.fitproblem.FitProblemComponent, dict

This module implements a dictionary of fitproblem objects

add_data(data)

Add data to the current dictionary of fitproblem. if data id does not exist create a new fit problem. :note: only data changes in the fit problem

clear_model_param(fid=None)

clear constraint info

enable_smearing(flag=False, fid=None)

Parameters:flag – bool.When flag is 1 get the computer smear value. When flag is 0 ingore smear value.

get_batch_result()

get result

get_fit_data(fid)

return data for the given fitproblem id :param fid: key representing a fitproblem, usually extract from data id

get_fit_problem()

return fitproblem contained in this dictionary

get_fit_tab_caption()

Return the caption of the page associated with object

get_graph_id()

Get graph_id

get_model(fid)

Returns:saved model

get_model_param(fid)

return list of couple of parameter name and value

get_name(fid=None)

get_param2fit()

return the list param names to fit

get_range(fid)

Returns:fitting range

get_residuals(fid)

Returns:residuals

get_result(fid)

get result

get_scheduled()

return true or false if a problem as being schedule for fitting

get_smearer(fid=None)

return smear object

get_theory_data(fid)

Returns:list of data dList

get_weight(fid=None)

return fit weight

save_model_name(name, fid=None)

schedule_tofit(schedule=0)

set schedule to true to decide if this fit must be performed

set_batch_result(batch_inputs, batch_outputs)

set a list of result

set_fit_data(data)

save a copy of the data select to fit :param data: data selected

set_fit_tab_caption(caption)

store the caption of the page associated with object

set_graph_id(id)

Set graph id (from data_group_id at the time the graph produced)

set_model(model, fid=None)

associates each model with its new created name :param model: model selected :param name: name created for model

set_model_param(name, value=None, fid=None)

Store the name and value of a parameter of this fitproblem’s model :param name: name of the given parameter :param value: value of that parameter

set_param2fit(list)

Store param names to fit (checked) :param list: list of the param names

set_range(qmin=None, qmax=None, fid=None)

set fitting range

set_residuals(residuals, fid)

save a copy of residual :param data: data selected

set_result(result, fid)

set_smearer(smearer, fid=None)

save reference of smear object on fitdata :param smear: smear object from DataLoader

set_theory_data(fid, data=None)

save a copy of the data select to fit :param data: data selected

set_weight(is2d, flag=None, fid=None)

fit weight

sas.sasgui.perspectives.fitting.fitting module

Fitting perspective

class sas.sasgui.perspectives.fitting.fitting.Plugin

Bases: sas.sasgui.guiframe.plugin_base.PluginBase

Fitting plugin is used to perform fit

add_color(color, id)

adds a color as a key with a plot id as its value to a dictionary

add_fit_page(data)

given a data, ask to the fitting panel to create a new fitting page, get this page and store it into the page_finder of this plug-in :param data: is a list of data

clear_panel()

create_fit_problem(page_id)

Given an ID create a fitproblem container

create_theory_1D(x, y, page_id, model, data, state, data_description, data_id, dy=None)

Create a theory object associate with an existing Data1D and add it to the data manager. @param x: x-values of the data @param y: y_values of the data @param page_id: fit page ID @param model: model used for fitting @param data: Data1D object to create the theory for @param state: model state @param data_description: title to use in the data manager @param data_id: unique data ID

delete_custom_model(event)

Delete custom model file

delete_data(data)

delete the given data from panel

delete_fit_problem(page_id)

Given an ID create a fitproblem container

draw_model(model, page_id, data=None, smearer=None, enable1D=True, enable2D=False, state=None, fid=None, toggle_mode_on=False, qmin=None, qmax=None, update_chisqr=True, weight=None, source='model')

Draw model.

Parameters:

• model – the model to draw
• name – the name of the model to draw
• data – the data on which the model is based to be drawn
• description – model’s description
• enable1D – if true enable drawing model 1D
• enable2D – if true enable drawing model 2D
• qmin – Range’s minimum value to draw model
• qmax – Range’s maximum value to draw model
• qstep – number of step to divide the x and y-axis
• update_chisqr – update chisqr [bool]

edit_custom_model(event)

Get the python editor panel

get_batch_capable()

Check if the plugin has a batch capability

get_context_menu(plotpanel=None)

Get the context menu items available for P(r).them allow fitting option for Data2D and Data1D only.

Parameters:graph – the Graph object to which we attach the context menu Returns:a list of menu items with call-back function Note:if Data1D was generated from Theory1D the fitting option is not allowed

get_graph_id(uid)

Set graph_id for fitprobelm

get_page_finder()

return self.page_finder used also by simfitpage.py

get_panels(parent)

Create and return a list of panel objects

load_plugin_models(event)

Update of models in plugin_models folder

make_new_model(event)

Make new model

make_sum_model(event)

Edit summodel template and make one

onFit(uid)

Get series of data, model, associates parameters and range and send then to series of fitters. Fit data and model, display result to corresponding panels. :param uid: id related to the panel currently calling this fit function.

on_add_new_page(event=None)

ask fit panel to create a new empty page

on_add_sim_page(event)

Create a page to access simultaneous fit option

on_batch_selection(flag)

switch the the notebook of batch mode or not

on_bumps_options(event=None)

Open the bumps options panel.

on_fit_results(event=None)

Make the Fit Results panel visible.

on_fitter_changed(event)

on_gpu_options(event=None)

Make the Fit Results panel visible.

on_help(algorithm_id)

on_reset_batch_flag(event)

Set batch_reset_flag

on_set_batch_result(page_id, fid, batch_outputs, batch_inputs)

on_set_state_helper(event=None)

Set_state_helper. This actually sets state after plotting data from state file.

: event: FitStateUpdateEvent called

by dataloader.plot_data from guiframe

populate_menu(owner)

Create a menu for the Fitting plug-in

Parameters:

• id – id to create a menu
• owner – owner of menu

Returns:

list of information to populate the main menu

put_icon(frame)

Put icon in the frame title bar

remove_plot(uid, fid=None, theory=False)

remove model plot when a fit page is closed :param uid: the id related to the fitpage to close :param fid: the id of the fitproblem(data, model, range,etc)

save_fit_state(filepath, fitstate)

save fit page state into file

schedule_for_fit(value=0, uid=None)

Set the fit problem field to 0 or 1 to schedule that problem to fit. Schedule the specified fitproblem or get the fit problem related to the current page and set value. :param value: integer 0 or 1 :param uid: the id related to a page contaning fitting information

select_data(panel)

set_data(data_list=None)

receive a list of data to fit

set_edit_menu(owner)

Set list of the edit model menu labels

set_edit_menu_helper(owner=None, menu=None)

help for setting list of the edit model menu labels

set_fit_range(uid, qmin, qmax, fid=None)

Set the fitting range of a given page for all its data by default. If fid is provide then set the range only for the data with fid as id :param uid: id corresponding to a fit page :param fid: id corresponding to a fit problem (data, model) :param qmin: minimum value of the fit range :param qmax: maximum value of the fit range

set_fit_weight(uid, flag, is2d=False, fid=None)

Set the fit weights of a given page for all its data by default. If fid is provide then set the range only for the data with fid as id :param uid: id corresponding to a fit page :param fid: id corresponding to a fit problem (data, model) :param weight: current dy data

set_graph_id(uid, graph_id)

Set graph_id for fitprobelm

set_page_finder(modelname, names, values)

Used by simfitpage.py to reset a parameter given the string constrainst.

Parameters:

• modelname – the name ot the model for with the parameter has to reset
• value – can be a string in this case.
• names – the paramter name

set_param2fit(uid, param2fit)

Set the list of param names to fit for fitprobelm

set_smearer(uid, smearer, fid, qmin=None, qmax=None, draw=True, enable_smearer=False)

Get a smear object and store it to a fit problem of fid as id. If proper flag is enable , will plot the theory with smearing information.

Parameters:

• smearer – smear object to allow smearing data of id fid
• enable_smearer – Define whether or not all (data, model) contained in the structure of id uid will be smeared before fitting.
• qmin – the maximum value of the theory plotting range
• qmax – the maximum value of the theory plotting range
• draw – Determine if the theory needs to be plot

set_state(state=None, datainfo=None, format=None)

Call-back method for the fit page state reader. This method is called when a .fitv/.svs file is loaded.

: param state: PageState object : param datainfo: data

set_theory(theory_list=None)

split_string(item)

receive a word containing dot and split it. used to split parameterset name into model name and parameter name example:

paramaterset (item) = M1.A
Will return model_name = M1 , parameter name = A

stop_fit(uid)

Stop the fit

store_data(uid, data_list=None, caption=None)

Recieve a list of data and store them ans well as a caption of the fit page where they come from. :param uid: if related to a fit page :param data_list: list of data to fit :param caption: caption of the window related to these data

update_custom_combo()

Update custom model list in the fitpage combo box

update_fit(result=None, msg='')

sas.sasgui.perspectives.fitting.fitting_widgets module

class sas.sasgui.perspectives.fitting.fitting_widgets.BatchDataDialog(parent=None, *args, **kwds)

Bases: wx._windows.Dialog

The current design of Batch fit allows only of type of data in the data set. This allows the user to make a quick selection of the type of data to use in fit tab.

get_data()

return 1 if user requested Data1D , 2 if user requested Data2D

class sas.sasgui.perspectives.fitting.fitting_widgets.DataDialog(data_list, parent=None, text='', nb_data=4, *args, **kwds)

Bases: wx._windows.Dialog

Allow file selection at loading time

get_data()

return the selected data

class sas.sasgui.perspectives.fitting.fitting_widgets.DialogPanel(*args, **kwds)

Bases: wx.lib.scrolledpanel.ScrolledPanel

sas.sasgui.perspectives.fitting.gpu_options module

Module provides dialog for setting SAS_OPENCL variable, which defines device choice for OpenCL calculation

Created on Nov 29, 2016

@author: wpotrzebowski

class sas.sasgui.perspectives.fitting.gpu_options.CustomMessageBox(parent, msg, title)

Bases: wx._windows.Dialog

Custom message box for OpenCL results

class sas.sasgui.perspectives.fitting.gpu_options.GpuOptions(*args, **kwds)

Bases: wx._windows.Dialog

“OpenCL options” Dialog Box

Provides dialog for setting SAS_OPENCL variable, which defines device choice for OpenCL calculation

on_OK(event)

Close window on accpetance

on_check(event)

Action triggered when box is selected :param event: :return:

on_help(event)

Provide help on opencl options.

on_reset(event)

Resets selected values

on_test(event)

Run sasmodels check from here and report results from

sas.sasgui.perspectives.fitting.hint_fitpage module

This class provide general structure of fitpanel page

class sas.sasgui.perspectives.fitting.hint_fitpage.HelpWindow(parent, id, title)

Bases: wx._windows.Frame

class sas.sasgui.perspectives.fitting.hint_fitpage.HintFitPage(parent)

Bases: wx._windows.ScrolledWindow, sas.sasgui.guiframe.panel_base.PanelBase

This class provide general structure of fitpanel page

createMemento()

do_layout()

Draw the page

window_caption = 'Hint page '

window_name = 'Hint Page'

sas.sasgui.perspectives.fitting.model_thread module

Calculation thread for modeling

class sas.sasgui.perspectives.fitting.model_thread.Calc1D(model, page_id, data, fid=None, qmin=None, qmax=None, weight=None, smearer=None, toggle_mode_on=False, state=None, completefn=None, update_chisqr=True, source='model', updatefn=None, yieldtime=0.01, worktime=0.01, exception_handler=None)

Bases: sas.sascalc.data_util.calcthread.CalcThread

Compute 1D data

compute()

Compute model 1d value given qmin , qmax , x value

results()

Send resuts of the computation

class sas.sasgui.perspectives.fitting.model_thread.Calc2D(data, model, smearer, qmin, qmax, page_id, state=None, weight=None, fid=None, toggle_mode_on=False, completefn=None, updatefn=None, update_chisqr=True, source='model', yieldtime=0.04, worktime=0.04, exception_handler=None)

Bases: sas.sascalc.data_util.calcthread.CalcThread

Compute 2D model This calculation assumes a 2-fold symmetry of the model where points are computed for one half of the detector and I(qx, qy) = I(-qx, -qy) is assumed.

compute()

Compute the data given a model function

sas.sasgui.perspectives.fitting.models module

Utilities to manage models

class sas.sasgui.perspectives.fitting.models.ModelList

Bases: object

Contains dictionary of model and their type

get_list()

return all the list stored in a dictionary object

reset_list(name, mylist)

Parameters:

• name – the type of the list
• mylist – the list to add

set_list(name, mylist)

Parameters:

• name – the type of the list
• mylist – the list to add

class sas.sasgui.perspectives.fitting.models.ModelManager

Bases: object

implement model

cat_model_list = [<class 'sasmodels.sasview_model.guinier_porod'>, <class 'sasmodels.sasview_model.cylinder'>, <class 'sasmodels.sasview_model.polymer_excl_volume'>, <class 'sasmodels.sasview_model.lamellar_stack_paracrystal'>, <class 'sasmodels.sasview_model.gel_fit'>, <class 'sasmodels.sasview_model.teubner_strey'>, <class 'sasmodels.sasview_model.multilayer_vesicle'>, <class 'sasmodels.sasview_model.core_shell_cylinder'>, <class 'sasmodels.sasview_model.lamellar_hg'>, <class 'sasmodels.sasview_model.barbell'>, <class 'sasmodels.sasview_model.fuzzy_sphere'>, <class 'sasmodels.sasview_model.sphere'>, <class 'sasmodels.sasview_model.triaxial_ellipsoid'>, <class 'sasmodels.sasview_model.lorentz'>, <class 'sasmodels.sasview_model.mono_gauss_coil'>, <class 'sasmodels.sasview_model.core_shell_bicelle'>, <class 'sasmodels.sasview_model.mass_surface_fractal'>, <class 'sasmodels.sasview_model.flexible_cylinder'>, <class 'sasmodels.sasview_model.flexible_cylinder_elliptical'>, <class 'sasmodels.sasview_model.mass_fractal'>, <class 'sasmodels.sasview_model.hollow_rectangular_prism_thin_walls'>, <class 'sasmodels.sasview_model.core_multi_shell'>, <class 'sasmodels.sasview_model.adsorbed_layer'>, <class 'sasmodels.sasview_model.spherical_sld'>, <class 'sasmodels.sasview_model.hollow_rectangular_prism'>, <class 'sasmodels.sasview_model.ellipsoid'>, <class 'sasmodels.sasview_model.two_lorentzian'>, <class 'sasmodels.sasview_model.fractal_core_shell'>, <class 'sasmodels.sasview_model.capped_cylinder'>, <class 'sasmodels.sasview_model.core_shell_ellipsoid'>, <class 'sasmodels.sasview_model.stickyhardsphere'>, <class 'sasmodels.sasview_model.fcc_paracrystal'>, <class 'sasmodels.sasview_model.poly_gauss_coil'>, <class 'sasmodels.sasview_model.squarewell'>, <class 'sasmodels.sasview_model.broad_peak'>, <class 'sasmodels.sasview_model.hayter_msa'>, <class 'sasmodels.sasview_model.surface_fractal'>, <class 'sasmodels.sasview_model.two_power_law'>, <class 'sasmodels.sasview_model.core_shell_parallelepiped'>, <class 'sasmodels.sasview_model.power_law'>, <class 'sasmodels.sasview_model.guinier'>, <class 'sasmodels.sasview_model.elliptical_cylinder'>, <class 'sasmodels.sasview_model.peak_lorentz'>, <class 'sasmodels.sasview_model.binary_hard_sphere'>, <class 'sasmodels.sasview_model.dab'>, <class 'sasmodels.sasview_model.pearl_necklace'>, <class 'sasmodels.sasview_model.gaussian_peak'>, <class 'sasmodels.sasview_model.star_polymer'>, <class 'sasmodels.sasview_model.vesicle'>, <class 'sasmodels.sasview_model.unified_power_Rg'>, <class 'sasmodels.sasview_model.rpa'>, <class 'sasmodels.sasview_model.polymer_micelle'>, <class 'sasmodels.sasview_model.parallelepiped'>, <class 'sasmodels.sasview_model.hollow_cylinder'>, <class 'sasmodels.sasview_model.spinodal'>, <class 'sasmodels.sasview_model.be_polyelectrolyte'>, <class 'sasmodels.sasview_model.linear_pearls'>, <class 'sasmodels.sasview_model.pringle'>, <class 'sasmodels.sasview_model.line'>, <class 'sasmodels.sasview_model.raspberry'>, <class 'sasmodels.sasview_model.fractal'>, <class 'sasmodels.sasview_model.sc_paracrystal'>, <class 'sasmodels.sasview_model.lamellar_hg_stack_caille'>, <class 'sasmodels.sasview_model.correlation_length'>, <class 'sasmodels.sasview_model.lamellar'>, <class 'sasmodels.sasview_model.onion'>, <class 'sasmodels.sasview_model.core_shell_bicelle_elliptical'>, <class 'sasmodels.sasview_model.porod'>, <class 'sasmodels.sasview_model.lamellar_stack_caille'>, <class 'sasmodels.sasview_model.gauss_lorentz_gel'>, <class 'sasmodels.sasview_model.rectangular_prism'>, <class 'sasmodels.sasview_model.bcc_paracrystal'>, <class 'sasmodels.sasview_model.core_shell_sphere'>, <class 'sasmodels.sasview_model.stacked_disks'>, <class 'sasmodels.sasview_model.hardsphere'>]

findModels()

get_model_dictionary()

get_model_list()

get_model_name_list()

is_changed()

model_name = 'hardsphere'

plugins_reset()

populate_menu(modelmenu, event_owner)

update()

class sas.sasgui.perspectives.fitting.models.ModelManagerBase

Base class for the model manager

event_owner = None

findModels()

find plugin model in directory of plugin .recompile all file in the directory if file were modified

form_factor_dict = {}

get_model_dictionary()

return dictionary linking model names to objects

get_model_list()

return dictionary of models for fitpanel use

get_model_name_list()

return regular model name list

is_changed()

check the last time the plugin dir has changed and return true is the directory was modified else return false

last_time_dir_modified = 0

model_combobox = <sas.sasgui.perspectives.fitting.models.ModelList object at 0x00000000183F69E8>

multi_func_list = [<class 'sasmodels.sasview_model.core_multi_shell'>, <class 'sasmodels.sasview_model.onion'>, <class 'sasmodels.sasview_model.rpa'>, <class 'sasmodels.sasview_model.spherical_sld'>, <class 'sasmodels.sasview_model.unified_power_Rg'>]

multiplication_factor = [<class 'sasmodels.sasview_model.core_multi_shell'>, <class 'sasmodels.sasview_model.core_shell_cylinder'>, <class 'sasmodels.sasview_model.core_shell_ellipsoid'>, <class 'sasmodels.sasview_model.core_shell_parallelepiped'>, <class 'sasmodels.sasview_model.core_shell_sphere'>, <class 'sasmodels.sasview_model.cylinder'>, <class 'sasmodels.sasview_model.ellipsoid'>, <class 'sasmodels.sasview_model.elliptical_cylinder'>, <class 'sasmodels.sasview_model.fractal_core_shell'>, <class 'sasmodels.sasview_model.fuzzy_sphere'>, <class 'sasmodels.sasview_model.hollow_cylinder'>, <class 'sasmodels.sasview_model.hollow_rectangular_prism'>, <class 'sasmodels.sasview_model.hollow_rectangular_prism_thin_walls'>, <class 'sasmodels.sasview_model.multilayer_vesicle'>, <class 'sasmodels.sasview_model.onion'>, <class 'sasmodels.sasview_model.parallelepiped'>, <class 'sasmodels.sasview_model.pearl_necklace'>, <class 'sasmodels.sasview_model.pringle'>, <class 'sasmodels.sasview_model.rectangular_prism'>, <class 'sasmodels.sasview_model.sphere'>, <class 'sasmodels.sasview_model.spherical_sld'>, <class 'sasmodels.sasview_model.triaxial_ellipsoid'>, <class 'sasmodels.sasview_model.vesicle'>]

plugins = []

plugins_reset()

return a dictionary of model

struct_factor_dict = {}

struct_list = [<class 'sasmodels.sasview_model.hardsphere'>, <class 'sasmodels.sasview_model.hayter_msa'>, <class 'sasmodels.sasview_model.squarewell'>, <class 'sasmodels.sasview_model.stickyhardsphere'>]

update()

return a dictionary of model if new models were added else return empty dictionary

class sas.sasgui.perspectives.fitting.models.ReportProblem

Class to check for problems with specific values

sas.sasgui.perspectives.fitting.models.compile_file(dir)

Compile a py file

sas.sasgui.perspectives.fitting.models.find_plugins_dir()

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

sas.sasgui.perspectives.fitting.models.get_model_python_path()

Returns the python path for a model

sas.sasgui.perspectives.fitting.models.plugin_log(message)

Log a message in a file located in the user’s home directory

sas.sasgui.perspectives.fitting.pagestate module

Class that holds a fit page state

class sas.sasgui.perspectives.fitting.pagestate.PageState(parent=None, model=None, data=None)

Bases: object

Contains information to reconstruct a page of the fitpanel.

clone()

Create a new copy of the current object

from_xml(file=None, node=None)

Load fitting state from a file

Parameters:

• file – .fitv file
• node – node of a XML document to read from

static param_remap_from_sasmodels_convert(params)

Converts {name : value} map back to [] param list :param params: parameter map returned from sasmodels :return: None

static param_remap_to_sasmodels_convert(params, is_string=False)

Remaps the parameters for sasmodels conversion

Parameters:params – list of parameters (likely self.parameters) Returns:remapped dictionary of parameters

report(figs=None, canvases=None)

Invoke report dialog panel

: param figs: list of pylab figures [list]

set_plot_state(figs, canvases)

Build image state that wx.html understand by plotting, putting it into wx.FileSystem image object

set_report_string()

Get the values (strings) from __str__ for report

to_xml(file='fitting_state.fitv', doc=None, entry_node=None, batch_fit_state=None)

Writes the state of the fit panel to file, as XML.

Compatible with standalone writing, or appending to an already existing XML document. In that case, the XML document is required. An optional entry node in the XML document may also be given.

Parameters:

• file – file to write to
• doc – XML document object [optional]
• entry_node – XML node within the XML document at which we will append the data [optional]
• batch_fit_state – simultaneous fit state

class sas.sasgui.perspectives.fitting.pagestate.Reader(call_back=None, cansas=True)

Bases: sas.sascalc.dataloader.readers.cansas_reader.Reader

Class to load a .fitv fitting file

ext = ['.fitv', '.FITV', '.svs', 'SVS']

get_state()

read(path)

Load a new P(r) inversion state from file

Parameters:path – file path

type = ['Fitting files (*.fitv)|*.fitvSASView file (*.svs)|*.svs']

type_name = 'Fitting'

write(filename, datainfo=None, fitstate=None)

Write the content of a Data1D as a CanSAS XML file only for standalone

Parameters:

• filename – name of the file to write
• datainfo – Data1D object
• fitstate – PageState object

write_toXML(datainfo=None, state=None, batchfit=None)

Write toXML, a helper for write(), could be used by guimanager._on_save()

: return: xml doc

sas.sasgui.perspectives.fitting.pagestate.parse_entry_helper(node, item)

Create a numpy list from value extrated from the node

Parameters:

• node – node from each the value is stored
• item – list name of three strings.the two first are name of data attribute and the third one is the type of the value of that attribute. type can be string, float, bool, etc.

: return: numpy array

sas.sasgui.perspectives.fitting.report_dialog module

Dialog report panel to show and summarize the results of the fitting calculation.

class sas.sasgui.perspectives.fitting.report_dialog.ReportDialog(report_list, *args, **kwds)

Bases: sas.sasgui.guiframe.report_dialog.BaseReportDialog

The report dialog box.

onSave(event=None)

Save

sas.sasgui.perspectives.fitting.resultpanel module

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.

class sas.sasgui.perspectives.fitting.resultpanel.ResultPanel(parent, manager=None, *args, **kwargs)

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

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.

CENTER_PANE = True

get_frame()

on_close(event)

on_plot_results(event)

window_caption = 'Result Panel'

window_name = 'Result panel'

sas.sasgui.perspectives.fitting.simfitpage module

Simultaneous fit page

class sas.sasgui.perspectives.fitting.simfitpage.ConstraintLine(model_cbox, param_cbox, egal_txt, constraint, btRemove, sizer)

Bases: tuple

btRemove

Alias for field number 4

constraint

Alias for field number 3

egal_txt

Alias for field number 2

model_cbox

Alias for field number 0

param_cbox

Alias for field number 1

sizer

Alias for field number 5

class sas.sasgui.perspectives.fitting.simfitpage.SimFitPageState

State of the simultaneous fit page for saving purposes

load_from_save_state(fit)

Load in a simultaneous/constrained fit from a save state :param fit: Fitpanel object :return: None

class sas.sasgui.perspectives.fitting.simfitpage.SimultaneousFitPage(parent, page_finder={}, id=-1, batch_on=False, *args, **kwargs)

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

Simultaneous fitting panel All that needs to be defined are the two data members window_name and window_caption

ID_ADD = 180

ID_DOC = 177

ID_FIT = 179

ID_SET_ALL = 178

check_all_model_name(event=None)

check all models names

check_model_name(event)

Save information related to checkbox and their states

define_page_structure()

Create empty sizers, their hierarchy and set the sizer for the panel

draw_page()

Construct the Simultaneous/Constrained fit page. fills the first region (sizer1) with the list of available fit page pairs of data and models. Then fills sizer2 with the checkbox for adding constraints, and finally fills sizer3 with the fit button and instructions.

get_state()

Return the state of the current page :return: self.state

on_fit(event)

signal for fitting

on_remove(event)

Remove constraint fields

on_set_focus(event=None)

The derivative class is on focus if implemented

set_fitbutton()

Set fit button label depending on the fit_started

set_manager(manager)

set panel manager

Parameters:manager – instance of plugin fitting

set_state()

Define a set of state parameters for saving simultaneous fits.

window_caption = 'Simultaneous Fit Page'

window_name = 'Simultaneous Fit Page'

sas.sasgui.perspectives.fitting.simfitpage.get_fittableParam(model)

return list of fittable parameters from a model

Parameters:model – the model used

sas.sasgui.perspectives.fitting.simfitpage.setComboBoxItems(cbox, items)

sas.sasgui.perspectives.fitting.utils module

Module contains functions frequently used in this package

sas.sasgui.perspectives.fitting.utils.get_weight(data, is2d, flag=None)

Received flag and compute error on data. :param flag: flag to transform error of data. :param is2d: flag to distinguish 1D to 2D Data

Module contents

sas.sasgui.perspectives.fitting.data_files()

Return the data files associated with media.

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

sas.sasgui.perspectives.fitting.get_data_path(media)