sas.qtgui.Calculators.Shape2SAS package

Subpackages

Submodules

sas.qtgui.Calculators.Shape2SAS.ButtonOptions module

class sas.qtgui.Calculators.Shape2SAS.ButtonOptions.ButtonOptions(parent=None)

Bases: QWidget, Ui_ButtonOptions

close, reset and help options

__annotations__ = {}
__doc__ = 'close, reset and help options'
__firstlineno__ = 8
__init__(parent=None)
__module__ = 'sas.qtgui.Calculators.Shape2SAS.ButtonOptions'
__static_attributes__ = ()
staticMetaObject = PySide6.QtCore.QMetaObject("ButtonOptions" inherits "QWidget": )

sas.qtgui.Calculators.Shape2SAS.Constraints module

class sas.qtgui.Calculators.Shape2SAS.Constraints.Constraints(parent=None)

Bases: QWidget, Ui_Constraints

__annotations__ = {}
__doc__ = None
__firstlineno__ = 21
__init__(parent=None)
__module__ = 'sas.qtgui.Calculators.Shape2SAS.Constraints'
__static_attributes__ = ('buttonOptions', 'constraintText', 'constraintTextEditor', 'createPlugin', 'variableTable')
clearConstraints()

Clear text editor containing constraints

getConstraintText(fit_params: str) → str

Get the default text for the constraints editor

static getPosition(item: str | int | float, itemLists: list[list[str | int | float]]) → tuple[int, int]

Find position of an item in lists

ifParameterExists(lineNames: list[str], modelPars: list[list[str]]) → bool

Check if parameter exists in model parameters

log_embedded(message: str)

Log a message in the embedded logbook.

log_embedded_error(message: str)

Log an error message in the embedded logbook.

onClosingConstraints()

Close constraints page

parseConstraintsText(text: str, fitPar: list[str], modelPars: list[list[str]], modelVals: list[list[float]], checkedPars: list[list[bool]]) → tuple[list[str], str, str, list[list[bool]]]

Parse the text in the constraints editor and return a dictionary of parameters

static removeFromList(listItems: list[str | int | float], listToCompare: list[str | int | float])

Remove items from a list if in another list

setConstraints(parameter_text: str)

Insert the text into the constraints editor

staticMetaObject = PySide6.QtCore.QMetaObject("Constraints" inherits "QWidget": )

sas.qtgui.Calculators.Shape2SAS.DesignWindow module

class sas.qtgui.Calculators.Shape2SAS.DesignWindow.DesignWindow(parent=None)

Bases: QDialog, Ui_Shape2SAS, Perspective

Main window for the Shape2SAS fitting tool

__annotations__ = {}
__doc__ = 'Main window for the Shape2SAS fitting tool'
__firstlineno__ = 44
__init__(parent=None)
__module__ = 'sas.qtgui.Calculators.Shape2SAS.DesignWindow'
__static_attributes__ = ('SAXSTabButtons', '_manager', 'canvas', 'checkTheoreticalScattering', 'communicator', 'constraint', 'line1', 'line2', 'modelTabButtonOptions', 'parent', 'plot', 'plotBoxLayout', 'plotSAXS', 'plugin', 'scatteringProf', 'scatteringScene', 'sendSimToSasView', 'setFig', 'subunitTable', 'viewerModel')
addToVariableTable()

Set up parameters to the variable table

checkStateOfConstraints(fitPar: list[str], modelPars: list[list[str]], modelVals: list[list[float]], checkedPars: list[list[bool]]) → tuple[str, str, str]

Check if the user has written constraints. Otherwise return Default

checkedVariables()

Get checked variables from the variable table with inserted restricted rows

deleteFromVariableTable()

Delete parameters from the variable table

enableButtons(toggle: bool)
ext = 'data_file'
getAllTableNames(condition: MethodType, **kwargs) → list[list[str]]

Get all parameter names in the subunit table

getConstraintsToTextEditor()

Set translation and parameters constraints to the text editor

getFitParameters() → list[str]

return names of the chosen fit parameters

getModelData(condition: MethodType, **kwargs) → list[list[float | str]]

Get all data in the subunit table

getModelProfile(condition: MethodType, **kwargs) → ModelProfile

Get model profile

getPluginModel()

Generating a plugin model and sends it to the Plugin Models folder in SasView

getSimulatedSAXSData()

Generating simulated data and sends it to the Data Explorer in SasView

getStandardReadOfTableData() → list[list[float | str]]

Get a standard data read from subunit TableView

getStructureFactorValues()

Read structure factor options from chosen structure factor in Virtual SAXS experiment tab

getSubunitTableCell(row: int, column: int) → float | str

Get model data from a single cell.

getSubunitTableRow(condition: MethodType, row: int, **kwargs) → list[float | str]

Get model data from a single row

getSubunitTableSets(condition: MethodType, rows: list[int], **kwargs) → list[list[float | str]]

Get a set of rows per column in subunit table

getTableName(column: int, row: int) → str

Get the parameter name of a cell in the subunit table

getTableNames(condition: MethodType, column: int, **kwargs) → list[str]

Get the parameter names of a column in the subunit table

getViewFeatures() → ViewerPlotDesign

Get values affecting the illustrative aspect of Viewer

static ifEmptyName(name: str, names: list[str], **kwargs)

condition method. Append if not empty

static ifEmptyValue(value: float | str, values: list[float | str], *args, **kwargs)

condition method. Append if not empty

static ifFitPar(value: float | str, values: list[float | str], *args, **kwargs)

condition method. Append FitPar if condition. Otherwise append constant

static ifNoCondition(name: str, names: list[str], **kwargs)

condition method. Append

name = 'Shape2SAS'
onCheckingInput(input: str, default: str) → str

Check if the input not None. Otherwise, return default value

onClickingClose()

Close Shape2SAS GUI

onClickingPlot()

Get 3D plot of the designed model in the Build model tab. If checked, plot theoretical scattering from the designed model.

onConstraintReset()

Reset Constraint window to default

onHelp()

Opening the help window

onSAXSExperimentReset()

Reset Virtual SAXS Experiment tab to default

onSubunitTableReset()

Reset subunit table to default

plotSimulatedSAXSData()

Plotting simulated SAXS data in the Virtual SAXS Experiment tab

sendSimulatedSAXSToDataExplorer()

Send simulated data to the Data Explorer in SasView

setConstraintsToTextEditor()

Set constraints to the text editor

showConstraintWindow()

Get the Constraint window

showSimulatedSAXSData()

Plotting simulated SAXS data in the Virtual SAXS Experiment tab

showStructureFactorOptions()

Show options for structure factor

staticMetaObject = PySide6.QtCore.QMetaObject("DesignWindow" inherits "QDialog": )
property title: str

Window title

updateDeleteButton()

sas.qtgui.Calculators.Shape2SAS.ViewerAllOptions module

class sas.qtgui.Calculators.Shape2SAS.ViewerAllOptions.ViewerButtons(parent=None)

Bases: QWidget, Ui_ViewerButtons

XY, XZ, YZ view axis buttons

__annotations__ = {}
__doc__ = 'XY, XZ, YZ view axis buttons'
__firstlineno__ = 9
__init__(parent=None)
__module__ = 'sas.qtgui.Calculators.Shape2SAS.ViewerAllOptions'
__static_attributes__ = ()
staticMetaObject = PySide6.QtCore.QMetaObject("ViewerButtons" inherits "QWidget": )
class sas.qtgui.Calculators.Shape2SAS.ViewerAllOptions.ViewerModelRadius(parent=None)

Bases: QWidget, Ui_ViewerModelRadius

Model radius view

__annotations__ = {}
__doc__ = 'Model radius view'
__firstlineno__ = 17
__init__(parent=None)
__module__ = 'sas.qtgui.Calculators.Shape2SAS.ViewerAllOptions'
__static_attributes__ = ()
staticMetaObject = PySide6.QtCore.QMetaObject("ViewerModelRadius" inherits "QWidget": )

sas.qtgui.Calculators.Shape2SAS.ViewerModel module

class sas.qtgui.Calculators.Shape2SAS.ViewerModel.ViewerModel(parent=None)

Bases: QWidget

Graphics view of designed model

__annotations__ = {}
__doc__ = 'Graphics view of designed model'
__firstlineno__ = 17
__init__(parent=None)
__module__ = 'sas.qtgui.Calculators.Shape2SAS.ViewerModel'
__static_attributes__ = ('Viewmodel_modul', 'X_ax', 'Y_ax', 'Z_ax', 'dict_series', 'scatter', 'scatterContainer', 'scattering', 'scene', 'seriesBlue', 'seriesGreen', 'seriesRed', 'viewerButtons', 'viewerModelRadius')
initialiseAxis()

Initialise axis for the model

onXYClicked()

XY view

onYZClicked()

YZ view

onZXClicked()

ZX view

onZoomChanged()

Change zoom value on doubleSpinBox

setAxis(x_range: (<class 'float'>, <class 'float'>), y_range: (<class 'float'>, <class 'float'>), z_range: (<class 'float'>, <class 'float'>))

Set axis for the model with equal aspect ratio

setClearModelPlot()

Clear the model plot

setClearScatteringPlot()

Clear the Scattering plot

setPlot(distr: ModelPointDistribution, design: ViewerPlotDesign)

Plot the model

setScatteringPlot(theo: TheoreticalScattering)

Set the scattering plot

setZoom()

Zoom in/out

staticMetaObject = PySide6.QtCore.QMetaObject("ViewerModel" inherits "QWidget": )

Module contents