sas.sasgui.perspectives.corfunc package

Submodules

sas.sasgui.perspectives.corfunc.corfunc module

Corfunc perspective

class sas.sasgui.perspectives.corfunc.corfunc.Plugin

Bases: sas.sasgui.guiframe.plugin_base.PluginBase

This class defines the interface for a plugin class for a correlation function perspective

clear_data()

delete_data(data)

Delete the data from the perspective

get_context_menu(plotpanel=None)

Get the context menu items available for Corfunc.

Parameters:plotpanel – A Plotter1D panel Returns:a list of menu items with call-back function Note:if Data1D was generated from Theory1D the fitting option is not allowed

get_panels(parent)

Define the GUI panels

set_data(data_list=None)

Load the data that’s been selected

Parameters:data_list – The data to load in

set_state(state=None, datainfo=None)

Callback for CorfuncState reader. Called when a .crf file is loaded

show_data(data, label, reset=False, active_ctrl=None)

Show data read from a file

Parameters:

• data – The data to plot (Data1D)
• label – What to label the plot. Also used as the plot ID
• reset – If True, all other plottables will be cleared

sas.sasgui.perspectives.corfunc.corfunc_panel module

class sas.sasgui.perspectives.corfunc.corfunc_panel.CorfuncPanel(parent, data=None, manager=None, *args, **kwds)

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

CENTER_PANE = True

compute_extrapolation(event=None)

Compute and plot the extrapolated data. Called when Extrapolate button is pressed.

compute_transform(event=None)

Compute and plot the transformed data. Called when Transform button is pressed.

extract_parameters(event=None)

Called when “Extract Parameters” is clicked

get_data()

get_save_flag()

get_state()

Return the state of the panel

onSetFocus(evt)

on_help(event=None)

Show the corfunc documentation

on_save(event=None)

Save corfunc state into a file

on_set_focus(event=None)

plot_qrange(active=None, leftdown=False)

radio_changed(event=None)

Called when the “Transform type” radio button are changed

save_project(doc=None)

Return an XML node containing the state of the panel

Parameters:doc – Am xml node to attach the project state to (optional)

set_background(bg)

set_data(data=None, set_qrange=True)

Update the GUI to reflect new data that has been loaded in

Parameters:data – The data that has been loaded

set_extracted_params(params=None, reset=False)

Displays the values of the parameters extracted from the Fourier transform

set_extrapolation_params(params=None)

Displays the value of the parameters calculated in the extrapolation

set_qmax(qmax)

set_qmin(qmin)

set_state(state=None, data=None)

Set the state of the panel. If no state is provided, the panel will be set to the default state.

Parameters:

• state – A CorfuncState object
• data – A Data1D object

transform_complete(transforms=None)

Called from FourierThread when calculation has completed

transform_update(msg='')

Called from FourierThread to update on status of calculation

window_caption = 'Correlation Function'

window_name = 'Correlation Function'

sas.sasgui.perspectives.corfunc.corfunc_state module

class sas.sasgui.perspectives.corfunc.corfunc_state.CorfuncState

Bases: object

Stores information about the state of CorfuncPanel

fromXML(node)

Load corfunc states from a file

Parameters:node – node of an XML document to read from (optional)

set_saved_state(name, value)

Set a value in the current state.

Parameters:

• name – The name of the parameter to set
• value – The value to set the parameter to

toXML(filename='corfunc_state.crf', doc=None, entry_node=None)

Writes the state of the CorfuncPanel 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]

Returns:

None if no doc is provided, modified XML document if doc!=None

class sas.sasgui.perspectives.corfunc.corfunc_state.Reader(callback)

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

Reads a CanSAS file containing the state of a CorfuncPanel

ext = ['.crf', '.CRF', '.svs', '.SVS']

get_state()

read(path)

Load data and corfunc information frmo a CanSAS file.

Parameters:

path – The file path to read from

Returns:

Data1D object, a list of Data1D objects, or None

Raises:

• IOError – When the file can’t be found
• IOError – When the file is an invalid file type
• ValueError – When the length of the data vectors are inconsistent

type = ['Corfunc file (*.crf)|*.crf', 'SASView file (*.svs)|*.svs']

type_name = 'Corfunc'

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

Write the content of a Data1D as a CanSAS file.

: param filename: Name of the file to write : param datainfo: Data1D object : param state: CorfuncState object

sas.sasgui.perspectives.corfunc.plot_labels module

Module contents