ccpn.ui.gui.popups package

Submodules

ccpn.ui.gui.popups.AboutPopup module

Module Documentation here

class ccpn.ui.gui.popups.AboutPopup.AboutPopup(parent=None, title='About CcpNmr', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

ccpn.ui.gui.popups.AssignAmbiguousNmrAtomsPopup module

This popup is used for selecting nmrAtoms when drag&dropping to peaks from sidebar and multiple options are available. No assignment is actually done here.

class ccpn.ui.gui.popups.AssignAmbiguousNmrAtomsPopup.AssignNmrAtoms4AxisCodesPopup(parent=None, mainWindow=None, title='NmrAtoms assignment options', axisCode4NmrAtomsDict=None, checkedAxisCode4NmrAtomsDict=None, peaks=None, uncheckableObjects=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

FIXEDHEIGHT = False

FIXEDWIDTH = False

getSelectedObjects()

title = 'NmrAtoms assignment options'

class ccpn.ui.gui.popups.AssignAmbiguousNmrAtomsPopup.ObjectsSelectionWidget(parent, mainWindow, labelName, objects, checkedObjects=None, dimLabel=None, priorityNames=None, enabledAll=True, **kwds)

Bases: ccpn.ui.gui.widgets.Widget.Widget

getSelectedObjects()

ccpn.ui.gui.popups.AtomPopup module

Module Documentation here

class ccpn.ui.gui.popups.AtomPopup.AtomEditPopup(parent=None, mainWindow=None, obj=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

Atom attributes edit existing popup

attributes = [('Pid', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, None, None, None, {}), ('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, None, <function AtomEditPopup._setAtomName>, None, {'editable': False}), ('Residue', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, None, <function _setResidue>, None, {'editable': False})]

klass

alias of ccpn.core.Atom.Atom

restoreWidgetState()

Restore the state of the checkBoxes

storeWidgetState()

Store the state of the checkBoxes between popups

class ccpn.ui.gui.popups.AtomPopup.AtomNewPopup(parent=None, mainWindow=None, obj=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

Atom attributes new popup

attributes = [('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, None, <function AtomNewPopup._setAtomName>, None, {'editable': False}), ('Residue', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, None, <function _setResidue>, None, {'editable': False})]

klass

alias of ccpn.core.Atom.Atom

restoreWidgetState()

Restore the state of the checkBoxes

storeWidgetState()

Store the state of the checkBoxes between popups

ccpn.ui.gui.popups.AttributeEditorPopupABC module

Abstract base class to easily implement a popup to edit attributes of V3 layer objects

class ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeABC(attributeList, queueStates=True, newContainer=True, hWidth=100, group=None, **kwds)

Bases: object

ATTRIBUTELISTTYPE = 0

addAttribItem(parentRoot, attribItem)

createContainer(parent, attribParent, grid=None, gridSpan=(1, 1))

nextGridPosition()

nextPosition()

Move the pointer to the next position

class ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC(parent=None, mainWindow=None, obj=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Abstract base class to implement a popup for editing properties

EDITMODE = True

ENABLEREVERT = True

FIXEDHEIGHT = True

FIXEDWIDTH = True

WINDOWPREFIX = 'Edit '

attributes = []

hWidth = None

klass = None

class ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeItem(attr, attrType, getFunction, setFunction, presetFunction, callback, kwds)

Bases: tuple

attr

Alias for field number 0

attrType

Alias for field number 1

callback

Alias for field number 5

getFunction

Alias for field number 2

kwds

Alias for field number 6

presetFunction

Alias for field number 4

setFunction

Alias for field number 3

class ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeListType(value)

Bases: ccpn.util.LabelledEnum.LabelledEnum

An enumeration.

EMPTYFRAME = 5

HORIZONTAL = 1

MORELESS = 2

TAB = 4

TABFRAME = 3

VERTICAL = 0

class ccpn.ui.gui.popups.AttributeEditorPopupABC.ComplexAttributeEditorPopupABC(parent=None, mainWindow=None, obj=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

Abstract base class to implement a popup for editing complex properties

attributes = <ccpn.ui.gui.popups.AttributeEditorPopupABC.VList object>

class ccpn.ui.gui.popups.AttributeEditorPopupABC.HList(attributeList, queueStates=True, newContainer=True, hWidth=100, group=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeABC

ATTRIBUTELISTTYPE = 1

nextPosition()

Move the pointer to the next position

class ccpn.ui.gui.popups.AttributeEditorPopupABC.MoreLess(attributeList, queueStates=True, newContainer=True, hWidth=100, group=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeABC

ATTRIBUTELISTTYPE = 2

createContainer(parent, attribParent, grid=None, gridSpan=(1, 1))

class ccpn.ui.gui.popups.AttributeEditorPopupABC.VList(attributeList, queueStates=True, newContainer=True, hWidth=100, group=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeABC

ccpn.ui.gui.popups.AttributeEditorPopupABC.getAttributeTipText(klass, attr)

Generate a tipText from the attribute of the given class.

tipText is of the form:

klass.attr

Type: <type of the attribute>

DocString: <string read from klass.attr.__doc__>

Parameters

• klass – klass containing the attribute

• attr – attribute name

Returns

tipText string

ccpn.ui.gui.popups.AxisOrderingPopup module

Module Documentation here

class ccpn.ui.gui.popups.AxisOrderingPopup.AxisOrderingPopup(parent=None, mainWindow=None, spectrum=None, title='Set Spectrum Axis Ordering', label='', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Set the axis ordering for the new spectrumDisplay from a popup

ccpn.ui.gui.popups.AxisOrderingPopup.checkSpectraToOpen(mainWindow, spectra)

ccpn.ui.gui.popups.CalibrateSpectraFromPeaksPopup module

Module Documentation here

class ccpn.ui.gui.popups.CalibrateSpectraFromPeaksPopup.CalibrateSpectraFromPeaksPopup1d(parent=None, mainWindow=None, strip=None, spectrumCount=None, title: str = 'Calibrate Spectra from Peaks', **kwds)

Bases: ccpn.ui.gui.popups.CalibrateSpectraFromPeaksPopup.CalibrateSpectraFromPeaksPopupNd

Popup to allow calibrating of spectra from a selection of peaks in the same spectrumDisplay Specifically for a 1d spectrumDisplay

Calibration is applied to the current selection of peaks

A single peak is selected as the primary peak from the pullDown, all other spectra are updated to align peaks with the primary peak

class ccpn.ui.gui.popups.CalibrateSpectraFromPeaksPopup.CalibrateSpectraFromPeaksPopupNd(parent=None, mainWindow=None, strip=None, spectrumCount=None, title: str = 'Calibrate Spectra from Peaks', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

Popup to allow calibrating of spectra from a selection of peaks in the same spectrumDisplay Specifically for an Nd spectrumDisplay

Calibration is applied to the current selection of peaks

A single peak is selected as the primary peak from the pullDown, all other spectra are updated to align peaks with the primary peak

ccpn.ui.gui.popups.ChainPopup module

Module Documentation here

class ccpn.ui.gui.popups.ChainPopup.ChainPopup(parent=None, mainWindow=None, obj=None, size=None, **kwds)

Bases: ccpn.ui.gui.popups.SimpleAttributeEditorPopupABC.SimpleAttributeEditorPopupABC

Chain attributes editor popup

attributes = [('Name', <built-in function getattr>, <built-in function setattr>, {'backgroundText': '> Enter name <'}), ('Comment', <built-in function getattr>, <built-in function setattr>, {'backgroundText': '> Optional <'}), ('Compound Name', <built-in function getattr>, None, {}), ('NmrChain', <built-in function getattr>, None, {})]

klass

alias of ccpn.core.Chain.Chain

ccpn.ui.gui.popups.ChemicalShiftListPopup module

Module Documentation here

class ccpn.ui.gui.popups.ChemicalShiftListPopup.ChemicalShiftListEditor(parent=None, mainWindow=None, editMode=True, obj=None, defaultItems=None, size=(600, 350), **kwds)

Bases: ccpn.ui.gui.popups._GroupEditorPopupABC._GroupEditorPopupABC

A popup to create and manage SpectrumGroups

Used in ‘New’ or ‘Edit’ mode: - For creating new SpectrumGroup (editMode==False); optionally uses passed in spectra list

i.e. NewSpectrumGroup of SideBar and Context menu of SideBar

• For editing existing SpectrumGroup (editMode==True); requires spectrumGroup argument i.e. Edit of SpectrumGroup of SideBar

or

For selecting and editing SpectrumGroup (editMode==True) i.e. Menu Spectrum->Edit SpectrumGroup…

ccpn.ui.gui.popups.CollectionPopup module

Module Documentation here

class ccpn.ui.gui.popups.CollectionPopup.CollectionPopup(parent=None, mainWindow=None, obj=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

Collection attributes editor popup

attributes = [('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Enter name <'}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.Collection.Collection

ccpn.ui.gui.popups.ComplexEditorPopup module

Module Documentation here

class ccpn.ui.gui.popups.ComplexEditorPopup.ComplexEditorPopup(parent=None, mainWindow=None, editMode=True, obj=None, defaultItems=None, size=(500, 350), **kwds)

Bases: ccpn.ui.gui.popups._GroupEditorPopupABC._GroupEditorPopupABC

A popup to create and manage Complexes

ccpn.ui.gui.popups.ConcentrationUnitsPopup module

Module Documentation here

class ccpn.ui.gui.popups.ConcentrationUnitsPopup.ConcentrationUnitsPopup(parent=None, mainWindow=None, obj=None, names=[], values=None, unit=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

EDITMODE = True

WINDOWPREFIX = 'Setup '

klass = <ccpn.ui.gui.popups.ConcentrationUnitsPopup._ConcentrationUnitsObject object>

ccpn.ui.gui.popups.CopyPeakListPopup module

Module Documentation here

class ccpn.ui.gui.popups.CopyPeakListPopup.CopyPeakListPopup(parent=None, mainWindow=None, title='Copy PeakList', spectrumDisplay=None, selectItem=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

setWidgets()

ccpn.ui.gui.popups.CopyPeaksPopup module

class ccpn.ui.gui.popups.CopyPeaksPopup.CopyPeaks(parent=None, mainWindow=None, title='Copy Peaks to PeakLists', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

clearSelections()

ccpn.ui.gui.popups.CopyStripFlippedAxesPopup module

Module Documentation here

class ccpn.ui.gui.popups.CopyStripFlippedAxesPopup.CopyStripFlippedSpectraPopup(parent=None, mainWindow=None, strip=None, title='Copy Strip with Axes Flipped', label='', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Set the axis ordering for the new spectrumDisplay from a popup

ccpn.ui.gui.popups.CreateChainPopup module

Module Documentation here

class ccpn.ui.gui.popups.CreateChainPopup.CreateChainPopup(parent=None, mainWindow=None, project=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

Create new chain popup

EDITMODE = False

ENABLEREVERT = True

FIXEDHEIGHT = False

FIXEDWIDTH = False

WINDOWPREFIX = 'New '

attributes = []

klass

alias of ccpn.core.Chain.Chain

ccpn.ui.gui.popups.CreateNmrChainPopup module

Module Documentation here

class ccpn.ui.gui.popups.CreateNmrChainPopup.CreateNmrChainPopup(parent=None, mainWindow=None, project=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

ccpn.ui.gui.popups.DataTablePopup module

Module Documentation here

class ccpn.ui.gui.popups.DataTablePopup.DataTablePopup(parent=None, mainWindow=None, obj=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

DataTable attributes editor popup

attributes = [('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Enter name <'}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.DataTable.DataTable

ccpn.ui.gui.popups.DeleteItems module

Module Documentation here

class ccpn.ui.gui.popups.DeleteItems.DeleteItemsPopup(parent=None, mainWindow=None, title='Delete Items', items=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Open a small popup to allow deletion of selected ‘current’ items. Items is a tuple of tuples: indexed by the name of the items, containing a list of the items for deletion i.e. ((‘Peaks’, peakList), (‘Multiplets’,multipletList))

ccpn.ui.gui.popups.Dialog module

Module Documentation here

class ccpn.ui.gui.popups.Dialog.CcpnDialog(parent=None, windowTitle='', setLayout=False, size=(300, 100), **kwds)

Bases: PyQt5.QtWidgets.QDialog, ccpn.ui.gui.widgets.Base.Base

Class to handle popup dialogs

APPLYBUTTONTEXT = 'Apply'

CANCELBUTTONTEXT = 'Cancel'

CLOSEBUTTONTEXT = 'Close'

OKBUTTONTEXT = 'OK'

REVERTBUTTONTEXT = 'Revert'

fixedSize()

setDefaultButton(button)

class ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget(parent=None, windowTitle='', setLayout=False, orientation='horizontal', size=None, minimumSize=None, **kwds)

Bases: PyQt5.QtWidgets.QDialog, ccpn.ui.gui.widgets.Base.Base

Class to handle popup dialogs

APPLYBUTTON = 33554432

APPLYBUTTONTEXT = 'Apply'

CANCELBUTTON = 4194304

CANCELBUTTONTEXT = 'Cancel'

CLOSEBUTTON = 2097152

CLOSEBUTTONTEXT = 'Close'

DEFAULTBUTTON = 2097152

DEFAULTMARGINS = (14, 14, 14, 14)

DISABLEOK = False

DISCARDBUTTON = 8388608

EDITMODE = True

ENABLEICONS = False

FIXEDHEIGHT = True

FIXEDWIDTH = True

HELPBUTTON = 16777216

OKBUTTON = 1024

OKBUTTONTEXT = 'OK'

RESETBUTTON = 67108864

REVERTBUTTONTEXT = 'Revert'

USERBUTTON = '_userButton'

USERBUTTON2 = '_userButton2'

USESCROLLWIDGET = False

accept(self)

fixedSize()

getActiveTabList()

Get a list of tabs for calulating the changes to settings

getButton(buttonName)

Get the button from the buttonNames defined in the class

handleUserClicked()

Context manager to handle user actions in dialogs.

reject(self)

restoreWidgetState()

Restore the state of any required widgets

setApplyButton(callback=None, text=None, tipText='Apply changes', icon='icons/orange-apply', enabled=True, visible=True)

Add an Apply button to the dialog box

setCancelButton(callback=None, text=None, tipText='Roll-back all applied changes and close', icon='icons/window-close', enabled=True, visible=True)

Add a Cancel button to the dialog box

setCloseButton(callback=None, text=None, tipText='Keep all applied changes and close', icon='icons/window-close', enabled=True, visible=True)

Add a Close button to the dialog box

setDefaultButton(button=2097152)

Set the default dialog button

setDiscardButton(callback=None, text=None, tipText='Discard changes', icon='icons/orange-apply', enabled=True, visible=True)

Add an Apply button to the dialog box

setHelpButton(callback=None, text=None, tipText='Help', icon='icons/system-help', enabled=True, visible=True)

Add a Help button to the dialog box

setOkButton(callback=None, text=None, tipText='Apply changes and close', icon='icons/dialog-apply.png', enabled=True, visible=True)

Add an Ok button to the dialog box

setRevertButton(callback=None, text='Revert', tipText='Roll-back all applied changes', icon='icons/undo', enabled=True, visible=True)

Add a Revert button to the dialog box

setUserButton(callback=None, text=None, tipText='User action', icon='icons/orange-apply', enabled=True, visible=True)

Add a User button to the dialog box

setUserButton2(callback=None, text=None, tipText='User action 2', icon='icons/orange-apply', enabled=True, visible=True)

Add 2nd User button to the dialog box

storeStateOnReject = False

storeWidgetState()

Store the state of any required widgets between popups

ccpn.ui.gui.popups.Dialog.dialogErrorReport(self, undo, es)

Show warning popup and check the undo stack for items that need to be culled

ccpn.ui.gui.popups.Dialog.handleDialogApply(self)

Context manager to wrap the apply button for dialogs Error trapping is contained inside the undoBlockWithoutSideBar, any error raised is placed in the errorValue of the yielded object and a warning popup is raised

e.g.

with handleDialogApply(self) as error:

… code block here …

if error.errorValue:

# an error occurred in the code block

ccpn.ui.gui.popups.DistanceRestraintPopup module

This popup is used for creating distance Restraints from a peakList containing assigned peaks. Alpha release and called from a macro.

class ccpn.ui.gui.popups.DistanceRestraintPopup.CalculateDistanceRestraintsPopup(parent=None, mainWindow=None, title='Calculate Distance Restraints (Alpha)', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

FIXEDHEIGHT = False

FIXEDWIDTH = True

property params

- None, immutable -

title = 'Calculate Distance Restraints (Alpha)'

ccpn.ui.gui.popups.EditMultipletPopup module

class ccpn.ui.gui.popups.EditMultipletPopup.EditMultipletPopup(parent=None, mainWindow=None, multiplet=None, spectrum=None, isNewMultipletList=False, title='Multiplet Editor ', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

clearSelections()

ccpn.ui.gui.popups.EstimateNoisePopup module

Module Documentation here

class ccpn.ui.gui.popups.EstimateNoisePopup.EstimateNoisePopup(parent=None, mainWindow=None, title='Estimate Noise', strip=None, orderedSpectrumViews=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Class to implement a popup for estimating noise in a set of spectra

restoreWidgetState()

Restore the state of the checkBoxes

storeWidgetState()

Store the state of the checkBoxes between popups

class ccpn.ui.gui.popups.EstimateNoisePopup.NoiseTab(parent=None, mainWindow=None, spectrum=None, strip=None, **kwds)

Bases: ccpn.ui.gui.widgets.Widget.Widget

Class to contain the information for a single pectrum in the spectrum display Holds the common values for 1d and Nd spectra

class ccpn.ui.gui.popups.EstimateNoisePopup.NoiseTabNd(parent=None, mainWindow=None, spectrum=None, strip=None, **kwds)

Bases: ccpn.ui.gui.popups.EstimateNoisePopup.NoiseTab

Class to contain the information for a single spectrum in the spectrum display Holds the extra widgets for changing Nd contour settings

ccpn.ui.gui.popups.EstimateVolumes module

Module Documentation here

class ccpn.ui.gui.popups.EstimateVolumes.EstimateVolumes(parent=None, mainWindow=None, title='Estimate Volumes', spectra=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Popup to estimate volumes of peaks in peakList from selected spectrum. Spectra are all those in the project. A spectrum is selected from the spectra in the current.strip if current.strip exists.

FIXEDHEIGHT = True

FIXEDWIDTH = True

checkPeakListSelection()

Check whether there is only one peakList and select

ccpn.ui.gui.popups.ExperimentFilterPopup module

class ccpn.ui.gui.popups.ExperimentFilterPopup.ExperimentFilterPopup(parent=None, mainWindow=None, spectrum=None, title: str = 'Experiment Type Filter', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

FIXEDHEIGHT = True

FIXEDWIDTH = True

close(self) → bool

updateChoices()

ccpn.ui.gui.popups.ExperimentTypePopup module

class ccpn.ui.gui.popups.ExperimentTypePopup.ExperimentTypePopup(parent=None, mainWindow=None, title: str = 'Experiment Type Selection', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

FIXEDWIDTH = True

USESCROLLWIDGET = True

editedExpTypeChecker(pulldown, items)

keyPressEvent(self, QKeyEvent)

raiseExperimentFilterPopup(spectrum, spectrumIndex, atomCodes)

ccpn.ui.gui.popups.ExportDialog module

Module Documentation here

class ccpn.ui.gui.popups.ExportDialog.ExportDialogABC(parent=None, mainWindow=None, title='Export to File', fileMode='anyFile', acceptMode='export', selectFile=None, fileFilter='*', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Class to handle printing strips to file

ACCEPTTEXT = 'Select'

FIXEDHEIGHT = False

FIXEDWIDTH = False

PATHTEXT = 'Filename'

REJECTTEXT = None

actionButtons()

Set the cancel/export buttons

buildParameters()

build parameters dict from the user widgets, to be passed to the export method. To be overridden when sub-classed by user

Returns

dict - user parameters

closeEvent(QCloseEvent)

Close the dialog

exec_() → Optional[dict]

Popup the dialog

exportToFile(filename=None, params=None)

Export to file To be overridden when sub-classed by user

Parameters

• filename – filename to export

• params – dict - user defined parameters for export

getPathHistory()

getSaveTextWidget()

Read the contents of the saveText widget and return as a Path

initialise(userFrame)

Initialise the frame containing the user widgets To be overridden when sub-classed by user

Parameters

userFrame – frame widget to insert user widgets into

populate(userFrame)

Populate the user widgets To be overridden when sub-classed by user

Parameters

userFrame – user frame widget

setPathHistory(filename: ccpn.util.Path.Path)

setSave(fileName)

Set the save fileName in the dialog shown form the dialog button

setSaveTextWidget(value)

Write value to the saveText widget

updateDialog()

Create the dialog for the file button To be subclassed as required.

updateFilename(filename)

ccpn.ui.gui.popups.ExportNefPopup module

Module Documentation here

class ccpn.ui.gui.popups.ExportNefPopup.ExportNefPopup(parent=None, mainWindow=None, title='Export to File', fileMode='anyFile', acceptMode='export', selectFile=None, fileFilter='*.nef', **kwds)

Bases: ccpn.ui.gui.popups.ExportDialog.ExportDialogABC

Class to handle exporting Nef files

buildParameters()

build parameters dict from the user widgets, to be passed to the export method. :return: dict - user parameters

exportToFile(filename=None, params=None)

Export to file :param filename: filename to export :param params: dict - user defined parameters for export

initialise(userFrame)

Initialise the frame containing the user widgets To be overridden when sub-classed by user

Parameters

userFrame – frame widget to insert user widgets into

populate(userframe)

Populate the widgets with project

updateDialog()

Create the Nef dialog

ccpn.ui.gui.popups.ExportNefPopup.main()

ccpn.ui.gui.popups.ExportStripToFile module

Module Documentation here

class ccpn.ui.gui.popups.ExportStripToFile.ExportStripToFilePopup(parent=None, mainWindow=None, title='Export Strip to File', fileMode='anyFile', acceptMode='export', selectFile=None, fileFilter='pdf files (*.pdf)', strips=None, selectedStrip=None, includeSpectrumDisplays=True, **kwds)

Bases: ccpn.ui.gui.popups.ExportDialog.ExportDialogABC

Class to handle printing strips to file

EDITMODE = False

actionButtons()

Set the cancel/export buttons

buildParameters()

build parameters dict from the user widgets, to be passed to the export method. :return: dict - user parameters

eventFilter(obj, event)

Event filter to handle focus change on spinboxes

exec_() → Optional[dict]

Disable strip updating while the popup is visible

exportToFile(filename=None, params=None)

Export to file :param filename: filename to export :param params: dict - user defined parameters for export

initialise(userFrame)

Create the widgets for the userFrame

keyPressEvent(a0: PyQt5.QtGui.QKeyEvent) → None

Subclass keypress to stop enter/return on default button

populate(userframe)

Populate the widgets with project

restoreWidgetState()

Restore the state of the widgets

storeStateOnReject = True

storeWidgetState()

Store the state of the widgets between popups

ccpn.ui.gui.popups.ExportStripToFile.main()

ccpn.ui.gui.popups.FeedbackPopup module

Module Documentation here

class ccpn.ui.gui.popups.FeedbackPopup.FeedbackPopup(parent=None, title='Feedback Form', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

FIXEDHEIGHT = False

FIXEDWIDTH = False

ccpn.ui.gui.popups.ImportNefPopup module

Module Documentation here

class ccpn.ui.gui.popups.ImportNefPopup.ImportNefPopup(parent, mainWindow, project, dataLoader, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Nef management class

DEFAULTMARGINS = (5, 5, 5, 5)

FIXEDHEIGHT = False

FIXEDWIDTH = False

USESCROLLWIDGET = True

accept()

Accept the dialog

exec_(self) → int

fillPopup()

getActiveNefReader()

Get the current active nef reader for the dialog

getNewCollections()

Get the dict of new collections to create after loading

setActiveNefWindow(value)

Set the number of the current active nef window for returning values from the dialog

setNefObjects(nefObjects)

setWidgets()

Initialise the main widgets for the form

class ccpn.ui.gui.popups.ImportNefPopup.NefDictFrame(parent, mainWindow, nefLoader, dataBlock, pathName, enableCheckBoxes=False, enableRename=False, enableFilterFrame=False, enableMouseMenu=False, showBorder=True, borderColour=None, _splitterMargins=(8, 8, 8, 8), **kwds)

Bases: ccpn.ui.gui.widgets.Frame.Frame

Class to handle a nef dictionary editor

DEFAULTMARGINS = (8, 8, 8, 8)

EDITMODE = True

applyCheckBoxes = {'ccpn_collection': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_collection_', mappingCode='ccpn_collections'), 'ccpn_complex': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_complex_chain_', mappingCode='ccpn_complex'), 'ccpn_dataset': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_calculation_step_', mappingCode='ccpn_dataset'), 'ccpn_datatable': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_datatable_data_', mappingCode='ccpn_datatable'), 'ccpn_dihedral_restraint_violation_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_dihedral_restraint_violation_', mappingCode='ccpn_dihedral_restraint_violation_list'), 'ccpn_distance_restraint_violation_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_distance_restraint_violation_', mappingCode='ccpn_distance_restraint_violation_list'), 'ccpn_integral_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_integral_', mappingCode='ccpn_integral_list', checkID='_importIntegrals'), 'ccpn_internal_data': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_internal_data_', mappingCode='ccpn_additional_data'), 'ccpn_logging': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_history_', mappingCode='ccpn_logging'), 'ccpn_multiplet_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_multiplet_', mappingCode='ccpn_multiplet_list', checkID='_importMultiplets'), 'ccpn_note': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_note_', mappingCode='ccpn_notes'), 'ccpn_parameter': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_dataframe_', mappingCode='ccpn_parameter'), 'ccpn_peak_cluster_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_peak_cluster_', mappingCode='ccpn_peak_cluster'), 'ccpn_peak_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='nef_peak_', mappingCode='nef_peak', checkID='_importPeaks'), 'ccpn_rdc_restraint_violation_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_rdc_restraint_violation_', mappingCode='ccpn_rdc_restraint_violation_list'), 'ccpn_restraint_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_restraint_', mappingCode='ccpn_restraint_list'), 'ccpn_sample': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_sample_component_', mappingCode='ccpn_sample'), 'ccpn_spectrum_group': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_group_spectrum_', mappingCode='ccpn_spectrum_group'), 'ccpn_substance': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='ccpn_substance_synonym_', mappingCode='ccpn_substance'), 'nef_chemical_shift_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='nef_chemical_shift_', mappingCode='nef_chemical_shift_list'), 'nef_dihedral_restraint_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='nef_dihedral_restraint_', mappingCode='nef_dihedral_restraint_list'), 'nef_distance_restraint_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='nef_distance_restraint_', mappingCode='nef_distance_restraint_list'), 'nef_peak_restraint_link': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='nef_peak_restraint_', mappingCode='nef_peak_restraint_link'), 'nef_peak_restraint_links': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='nef_peak_restraint_', mappingCode='nef_peak_restraint_links'), 'nef_rdc_restraint_list': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='nef_rdc_restraint_', mappingCode='nef_rdc_restraint_list'), 'nef_sequence': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='nef_sequence_', mappingCode='nef_sequence_chain_code'), 'nmr_chain': functools.partial(<function NefDictFrame.apply_checkBox_item>, prefix='nmr_chain_', mappingCode='nmr_chain')}

apply_checkBox_item(name=None, saveFrame=None, parentGroup=None, prefix=None, mappingCode=None, checkID='_importRows')

exitNefDictFrame()

Finalise the state of the nefDictFrame ready for the actual loading

getItemsToImport()

handleParentGroups = {'additionalData': None, 'ccpnDataSetParameters': None, 'ccpnLogging': None, 'chains': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='nef_sequence_chain_code'), 'chemicalShiftLists': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='nef_chemical_shift_list'), 'complexes': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='ccpn_complex'), 'dataTables': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='ccpn_datatable'), 'integralLists': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='ccpn_integral_list'), 'multipletLists': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='ccpn_multiplet_list'), 'nmrChains': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='nmr_chain'), 'notes': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='ccpn_notes'), 'peakClusters': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='ccpn_peak_cluster_list'), 'peakLists': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='nef_peak'), 'restraintLinks': None, 'restraintTables': functools.partial(<function NefDictFrame.handleTreeViewParentGeneralStructureData>, mappingCode='nef_distance_restraint_list'), 'samples': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='ccpn_sample'), 'spectrumGroups': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='ccpn_spectrum_group'), 'structureData': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='ccpn_dataset'), 'substances': functools.partial(<function NefDictFrame.handleTreeViewParentGeneral>, mappingCode='ccpn_substance'), 'violationTables': functools.partial(<function NefDictFrame.handleTreeViewParentGeneralStructureData>, mappingCode='ccpn_distance_restraint_violation_list')}

handleSaveFrames = {'ccpn_collection': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneralNoCollection>, prefix='ccpn_collection_', mappingCode='ccpn_collections', errorCode='ccpn_collections', tableColourFunc=<function NefDictFrame.table_ccpn_collections>), 'ccpn_complex': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneral>, prefix='ccpn_complex_chain_', mappingCode='ccpn_complex', errorCode='ccpn_complex', tableColourFunc=None), 'ccpn_dataset': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneral>, prefix='ccpn_calculation_step_', mappingCode='ccpn_dataset', errorCode='ccpn_dataset', tableColourFunc=None), 'ccpn_datatable': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneral>, prefix='ccpn_datatable_data_', mappingCode='ccpn_datatable', errorCode='ccpn_datatable', tableColourFunc=None), 'ccpn_dihedral_restraint_violation_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionStructureDataParent>, prefix='ccpn_dihedral_restraint_violation_', mappingCode='ccpn_dihedral_restraint_violation_list', errorCode='ccpn_dihedral_restraint_violation_list', tableColourFunc=None), 'ccpn_distance_restraint_violation_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionStructureDataParent>, prefix='ccpn_distance_restraint_violation_', mappingCode='ccpn_distance_restraint_violation_list', errorCode='ccpn_distance_restraint_violation_list', tableColourFunc=None), 'ccpn_integral_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionCcpnList>, prefix='ccpn_integral_', mappingCode='ccpn_integral_list', errorCode='ccpn_integral_list_serial', tableColourFunc=functools.partial(<function NefDictFrame.table_lists>, listName='ccpn_integral')), 'ccpn_internal_data': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneralNoCollection>, prefix='ccpn_internal_data_', mappingCode='ccpn_additional_data', errorCode='ccpn_additional_data', tableColourFunc=None), 'ccpn_logging': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneralNoCollection>, prefix='ccpn_history_', mappingCode='ccpn_logging', errorCode='ccpn_logging', tableColourFunc=None), 'ccpn_multiplet_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionCcpnList>, prefix='ccpn_multiplet_', mappingCode='ccpn_multiplet_list', errorCode='ccpn_multiplet_list_serial', tableColourFunc=functools.partial(<function NefDictFrame.table_lists>, listName='ccpn_multiplet')), 'ccpn_note': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneral>, prefix='ccpn_note_', mappingCode='ccpn_notes', errorCode='ccpn_notes', tableColourFunc=<function NefDictFrame.table_ccpn_notes>), 'ccpn_parameter': functools.partial(<function NefDictFrame.handleTreeViewSelectionStructureDataParentNoCollection>, prefix='ccpn_dataframe_', mappingCode='ccpn_parameter', errorCode='ccpn_parameter', tableColourFunc=None), 'ccpn_peak_cluster_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneralNoCollection>, prefix='ccpn_peak_cluster_', mappingCode='ccpn_peak_cluster', errorCode='ccpn_peak_cluster_serial', tableColourFunc=<function NefDictFrame.table_peak_clusters>), 'ccpn_peak_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionCcpnList>, prefix='nef_peak_', mappingCode='nef_peak', errorCode='ccpn_peak_list_serial', tableColourFunc=<function NefDictFrame.table_peak_lists>), 'ccpn_rdc_restraint_violation_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionStructureDataParent>, prefix='ccpn_rdc_restraint_violation_', mappingCode='ccpn_rdc_restraint_violation_list', errorCode='ccpn_rdc_restraint_violation_list', tableColourFunc=None), 'ccpn_restraint_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneral>, prefix='ccpn_restraint_', mappingCode='ccpn_restraint_list', errorCode='ccpn_restraint_list', tableColourFunc=None), 'ccpn_sample': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneral>, prefix='ccpn_sample_component_', mappingCode='ccpn_sample', errorCode='ccpn_sample', tableColourFunc=None), 'ccpn_spectrum_group': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneral>, prefix='ccpn_group_spectrum_', mappingCode='ccpn_spectrum_group', errorCode='ccpn_spectrum_group', tableColourFunc=None), 'ccpn_substance': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneral>, prefix='ccpn_substance_synonym_', mappingCode='ccpn_substance', errorCode='ccpn_substance', tableColourFunc=None), 'nef_chemical_shift_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneral>, prefix='nef_chemical_shift_', mappingCode='nef_chemical_shift_list', errorCode='nef_chemical_shift_list', tableColourFunc=None), 'nef_dihedral_restraint_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionStructureDataParent>, prefix='nef_dihedral_restraint_', mappingCode='nef_dihedral_restraint_list', errorCode='nef_dihedral_restraint_list', tableColourFunc=None), 'nef_distance_restraint_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionStructureDataParent>, prefix='nef_distance_restraint_', mappingCode='nef_distance_restraint_list', errorCode='nef_distance_restraint_list', tableColourFunc=None), 'nef_peak_restraint_links': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneralNoCollection>, prefix='nef_peak_restraint_', mappingCode='nef_peak_restraint_links', errorCode='nef_peak_restraint_links', tableColourFunc=None), 'nef_rdc_restraint_list': functools.partial(<function NefDictFrame.handleTreeViewSelectionStructureDataParent>, prefix='nef_rdc_restraint_', mappingCode='nef_rdc_restraint_list', errorCode='nef_rdc_restraint_list', tableColourFunc=None), 'nef_sequence': functools.partial(<function NefDictFrame.handleTreeViewSelectionGeneral>, prefix='nef_sequence_', mappingCode='nef_sequence_chain_code', errorCode='nef_sequence_chain_code', tableColourFunc=<function NefDictFrame.table_nef_molecular_system>), 'nmr_chain': functools.partial(<function NefDictFrame.handleTreeViewSelectionAssignment>, prefix='nmr_chain_', mappingCode='nmr_chain', errorCode='nmr_chain_serial', tableColourFunc=<function NefDictFrame.table_ccpn_assignment>)}

handleTreeViewParentGeneral(parentItem=None, parentItemName=None, mappingCode=None, _handleAutoRename=False)

handleTreeViewParentGeneralStructureData(parentItem=None, parentItemName=None, mappingCode=None, _handleAutoRename=False)

handleTreeViewSelectionAssignment(name=None, saveFrame=None, parentGroup=None, prefix=None, mappingCode=None, errorCode=None, tableColourFunc=None, _handleAutoRename=False)

handleTreeViewSelectionCcpnList(name=None, saveFrame=None, parentGroup=None, prefix=None, mappingCode=None, errorCode=None, tableColourFunc=None, _handleAutoRename=False)

handleTreeViewSelectionGeneral(name=None, saveFrame=None, parentGroup=None, prefix=None, mappingCode=None, errorCode=None, tableColourFunc=None, _handleAutoRename=False)

handleTreeViewSelectionGeneralNoCollection(name=None, saveFrame=None, parentGroup=None, prefix=None, mappingCode=None, errorCode=None, tableColourFunc=None, _handleAutoRename=False)

handleTreeViewSelectionStructureDataParent(name=None, saveFrame=None, parentGroup=None, prefix=None, mappingCode=None, errorCode=None, tableColourFunc=None, _handleAutoRename=False)

handleTreeViewSelectionStructureDataParentNoCollection(name=None, saveFrame=None, parentGroup=None, prefix=None, mappingCode=None, errorCode=None, tableColourFunc=None, _handleAutoRename=False)

paintEvent(ev)

Paint the border to the screen

table_ccpn_additional_data(saveFrame, item)

table_ccpn_assignment(saveFrame, item, listName=None)

table_ccpn_collections(saveFrame, item)

table_ccpn_notes(saveFrame, item)

table_lists(saveFrame, item, listName, postFix='list')

table_nef_molecular_system(saveFrame, item)

table_peak_clusters(saveFrame, item, listName=None)

table_peak_lists(saveFrame, item, listName=None)

ccpn.ui.gui.popups.ImportNefPopup.main()

Testing code for the new nef manager

ccpn.ui.gui.popups.ImportStarPopup module

A Pre-alpha BMRB Chemical Shift List Importer from NMR-STAR v3.1. This is not a full BMRB importer to Analysis V3. Please, read warnings and info message

Usage:

UI - Menu Menus > Macro > Run… > Select this file.py - select BMRB file of interest - select entries - Create Non-UI: - scroll down to “Init the macro section” - replace filename path and axesCodesMap accordingly - run the macro within V3

1. Menu Menus > Macro > Run… > Select this file.py

2. Menu Menus > View PythonConsole (space-space)

   %run -i your/path/to/this/file.py (without quotes)

class ccpn.ui.gui.popups.ImportStarPopup.StarImporterPopup(parent=None, axesCodesMap=None, bmrbFilePath=None, project=None, directory=None, dataBlock=None, title='Import From NMRSTAR', **kw)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

class ccpn.ui.gui.popups.ImportStarPopup.TreeCheckBoxes(parent=None, orderedDataDict=None, checkList=None, selectableItems=None, maxSize=(250, 300), **kwds)

Bases: PyQt5.QtWidgets.QTreeWidget, ccpn.ui.gui.widgets.Base.Base

getItems()

Get checked state of objects

getSelectedItems()

Get selected objects from the check boxes

getSelectedObjects()

Get selected objects from the check boxes

getSelectedObjectsPids()

Get the pids of the selected objects

selectObjects(texts)

handle changing the state of checkboxes

ccpn.ui.gui.popups.IntegralListPopup module

Module Documentation here

class ccpn.ui.gui.popups.IntegralListPopup.IntegralListPopup(parent=None, mainWindow=None, integralList=None, title='IntegralList', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

ccpn.ui.gui.popups.IntegralListPropertiesPopup module

Module Documentation here

class ccpn.ui.gui.popups.IntegralListPropertiesPopup.IntegralListPropertiesPopup(parent=None, mainWindow=None, integralList=None, title=None, **kwds)

Bases: ccpn.ui.gui.popups.PMIListPropertiesPopupABC.PMIListPropertiesPopupABC

Popup to handle changing parameters in multipletLists

attributes = [('Id', <built-in function getattr>, None, {'backgroundText': '> Not defined <'}), ('Comment', <built-in function getattr>, <built-in function setattr>, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.IntegralList.IntegralList

ccpn.ui.gui.popups.MultipletListPropertiesPopup module

Module Documentation here

class ccpn.ui.gui.popups.MultipletListPropertiesPopup.MultipletListPropertiesPopup(parent=None, mainWindow=None, multipletList=None, title=None, **kwds)

Bases: ccpn.ui.gui.popups.PMIListPropertiesPopupABC.PMIListPropertiesPopupABC

Popup to handle changing parameters in multipletLists

attributes = [('Id', <built-in function getattr>, None, {'backgroundText': '> Not defined <'}), ('Comment', <built-in function getattr>, <built-in function setattr>, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.MultipletList.MultipletList

ccpn.ui.gui.popups.NmrAtomPopup module

Module Documentation here

class ccpn.ui.gui.popups.NmrAtomPopup.NmrAtomEditPopup(parent=None, mainWindow=None, obj=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

NmrAtom attributes edit existing popup

attributes = [('Pid', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, None, None, None, {}), ('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, None, <function _getNmrAtomName>, None, {'editable': True}), ('NmrResidue', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, <function NmrAtomEditPopup._getNmrResidueTypes>, <function NmrAtomEditPopup._nmrResidueCallback>, {'editable': False}), ('IsotopeCode', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, None, None, None, {}), ('Merge to Existing', <class 'ccpn.ui.gui.widgets.CompoundWidgets.CheckBoxCompoundWidget'>, None, None, None, None, {'checkable': True}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.NmrAtom.NmrAtom

restoreWidgetState()

Restore the state of the checkBoxes

storeWidgetState()

Store the state of the checkBoxes between popups

class ccpn.ui.gui.popups.NmrAtomPopup.NmrAtomNewPopup(parent=None, mainWindow=None, obj=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

NmrAtom attributes new popup

attributes = [('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, None, <function _getNmrAtomName>, None, {'editable': True}), ('NmrResidue', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, <function NmrAtomNewPopup._getNewNmrResidueTypes>, <function NmrAtomNewPopup._nmrResidueCallback>, {'editable': False}), ('IsotopeCode', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, <function _getNmrAtomIsotopeCodes>, <function _isotopeCodeCallback>, {'editable': True}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.NmrAtom.NmrAtom

restoreWidgetState()

Restore the state of the checkBoxes

storeWidgetState()

Store the state of the checkBoxes between popups

ccpn.ui.gui.popups.NmrChainPopup module

Module Documentation here

class ccpn.ui.gui.popups.NmrChainPopup.NmrChainPopup(parent=None, mainWindow=None, obj=None, size=None, **kwds)

Bases: ccpn.ui.gui.popups.SimpleAttributeEditorPopupABC.SimpleAttributeEditorPopupABC

NmrChain attributes editor popup

attributes = [('Name', <built-in function getattr>, <built-in function setattr>, {'backgroundText': '> Enter name <'}), ('Comment', <built-in function getattr>, <built-in function setattr>, {'backgroundText': '> Optional <'}), ('Is Connected', <built-in function getattr>, None, {}), ('Chain', <built-in function getattr>, None, {})]

klass

alias of ccpn.core.NmrChain.NmrChain

ccpn.ui.gui.popups.NmrResiduePopup module

class ccpn.ui.gui.popups.NmrResiduePopup.NmrResidueEditPopup(parent=None, mainWindow=None, obj=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

NmrResidue attributes editor popup

New checkBox Create New if checked

if the nmrChain doesn’t exist, create a new nmrChain If the sequenceCode doesn’t exist, create a new nmrResidue

else

if merge checked

merge into the existing nmrResidue, if found

else

rename the current nmrResidue sequenceCode and residueType

attributes = [('Pid', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, None, None, None, {}), ('NmrChain', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, <function NmrResidueEditPopup._getNmrChainList>, None, {}), ('Sequence Code', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {}), ('Residue Type', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, <function _getResidueTypeProb>, <function _checkNmrResidue>, {}), ('Merge to Existing', <class 'ccpn.ui.gui.widgets.CompoundWidgets.CheckBoxCompoundWidget'>, None, None, None, None, {'checked': False, 'checkable': True}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.NmrResidue.NmrResidue

restoreWidgetState()

Restore the state of the checkBoxes

storeWidgetState()

Store the state of the checkBoxes between popups

class ccpn.ui.gui.popups.NmrResiduePopup.NmrResidueNewPopup(parent=None, mainWindow=None, obj=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

NmrResidue attributes new popup

attributes = [('NmrChain', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, <function NmrResidueNewPopup._getNmrChainList>, None, {}), ('Sequence Code', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {}), ('Residue Type', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, <function _getResidueTypeProb>, <function _checkNmrResidue>, {}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.NmrResidue.NmrResidue

restoreWidgetState()

Restore the state of the checkBoxes

storeWidgetState()

Store the state of the checkBoxes between popups

ccpn.ui.gui.popups.NotesPopup module

Module Documentation here

class ccpn.ui.gui.popups.NotesPopup.NotesPopup(parent=None, mainWindow=None, obj=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

Notes attributes editor popup

attributes = [('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Enter name <'}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.Note.Note

ccpn.ui.gui.popups.PMIListPropertiesPopupABC module

Module Documentation here

class ccpn.ui.gui.popups.PMIListPropertiesPopupABC.PMIListPropertiesPopupABC(parent=None, mainWindow=None, ccpnList=None, spectrum=None, title=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Abstract Base Class for popups for Peak/Multiplet/Integral

EDITMODE = True

LIVEDIALOG = True

attributes = []

klass = None

ccpn.ui.gui.popups.PPDimensionSelector module

Module Documentation here

class ccpn.ui.gui.popups.PPDimensionSelector.PPdimensionSelector(parent=None, mainWindow=None, title='Select Dimension', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

ccpn.ui.gui.popups.PeakFind module

Module Documentation here

class ccpn.ui.gui.popups.PeakFind.ExcludeRegions(parent, peakList)

Bases: PyQt5.QtWidgets.QWidget, ccpn.ui.gui.widgets.Base.Base

class ccpn.ui.gui.popups.PeakFind.PeakFindPopup(parent=None, mainWindow=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

PeakFind for nD spectra This popup works only for nDs. (Should be renamed?)

raiseExcludedRegionsPopup()

ccpn.ui.gui.popups.PeakListPropertiesPopup module

Module Documentation here

class ccpn.ui.gui.popups.PeakListPropertiesPopup.PeakListPropertiesPopup(parent=None, mainWindow=None, peakList=None, spectrum=None, title=None, **kwds)

Bases: ccpn.ui.gui.popups.PMIListPropertiesPopupABC.PMIListPropertiesPopupABC

Popup to handle changing parameters in peakLists

attributes = [('Id', <built-in function getattr>, None, {'backgroundText': '> Not defined <'}), ('Comment', <built-in function getattr>, <built-in function setattr>, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.PeakList.PeakList

ccpn.ui.gui.popups.PickPeaks1DPopup module

Module Documentation here

class ccpn.ui.gui.popups.PickPeaks1DPopup.ExcludeRegions(parent=None, selectionLabel='Select Regions (ppm) or \nsolvents to exclude', labelAlign='c', **kwds)

Bases: ccpn.ui.gui.widgets.Widget.Widget

This creates a widget group to exclude Regions from the Spectrum when automatically peak picking

getSolventsAndValues()

selectionLabelDefault = 'Select Regions (ppm) or \nsolvents to exclude'

solvents = {'Acetic Acid-d4': [0, 0, 2.14, 2.0, 11.75, 11.65], 'Acetone-d6 & Water': [0, 0, 2.15, 2.0, 2.9, 2.8], 'Acetonitrile-d3 & water': [0, 0, 2.2, 1.94], 'Benzene-d6 & water': [0, 0, 0.6, 0.5, 7.25, 7.15], 'Carbon Tetrachloride & water ': [0, 0, 1.2, 1.1], 'Chloroform-d': [0, 0, 1.6, 1.5, 7.35, 7.25], 'Deuterium Oxide': [0, 0, 4.75, 4.65], 'Dichloromethane-d2 & water': [0, 0, 1.6, 1.5, 5.42, 5.32], 'Dimethyl Sulfoxide-d6': [0, 0, 2.6, 2.5, 3.4, 3.3], 'Dimethylformamide-d7 & water': [0, 0, 8.11, 8.01, 2.99, 2.91, 2.83, 2.73, 3.6, 3.5], 'Ethanol-d6 & water': [0, 0, 1.21, 1.11, 3.66, 3.56, 5.4, 5.29], 'Methanol-d4': [0, 0, 3.4, 3.3, 4.9, 4.8], 'New regions': [0, 0, 0.2, 0.1], 'Pyridine-d5 & water': [0, 0, 8.74, 8.84, 7.68, 7.58, 7.32, 7.22, 5.1, 5.0], 'Tetrachloromethane-d2 & water': [0, 0, 1.7, 1.6, 6.1, 6.0], 'Tetrahydrofuran-d8 & water': [0, 0, 3.68, 3.58, 2.6, 2.5, 1.83, 1.73], 'Toulene-d8 & water': [0, 0, 7.18, 6.98, 2.19, 2.09, 2.5, 2.4, 5.1, 5.0], 'Trifluoroacetic acid-d': [0, 0, 11.6, 11.5], 'Trifluoroethanol-d3 & water': [0, 0, 5.12, 5.02, 3.98, 3.88], 'Water': [0, 0, 5, 4.5], 'p-Dioxane-d8 & water': [0, 0, 2.6, 2.5, 3.63, 3.5]}

class ccpn.ui.gui.popups.PickPeaks1DPopup.PickPeak1DPopup(parent=None, mainWindow=None, title='Pick 1D Peaks', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

ccpn.ui.gui.popups.PreferencesPopup module

Module Documentation here

class ccpn.ui.gui.popups.PreferencesPopup.PreferencesPopup(parent=None, mainWindow=None, preferences=None, title='Preferences', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

FIXEDHEIGHT = False

FIXEDWIDTH = False

getActiveTabList()

Return the list of active tabs

reject(self)

setFontText(widget, fontString)

Set the contents of the widget the details of the font

setXAxisUnits(value)

Set the xAxisUnits

setYAxisUnits(value)

Set the yAxisUnits

ccpn.ui.gui.popups.PrintSpectrumPopup module

Module Documentation here

class ccpn.ui.gui.popups.PrintSpectrumPopup.SelectSpectrumDisplayPopup(parent=None, mainWindow=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

getStripToPrint()

ccpn.ui.gui.popups.ProjectSummaryPopup module

Module Documentation here

class ccpn.ui.gui.popups.ProjectSummaryPopup.ProjectSummaryPopup(parent=None, mainWindow=None, title='Project Summary', modal=False, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

ccpn.ui.gui.popups.RegisterPopup module

Module Documentation here

class ccpn.ui.gui.popups.RegisterPopup.NewTermsConditionsPopup(parent=None, trial: int = 0, version='3', title='Agree to Terms and Conditions', modal=False, **kwds)

Bases: ccpn.ui.gui.popups.RegisterPopup.RegisterPopup

class ccpn.ui.gui.popups.RegisterPopup.RegisterPopup(parent=None, trial: int = 0, version='3', title='Register with CCPN', modal=False, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

ccpn.ui.gui.popups.ReorderPeakListAxes module

Module Documentation here

class ccpn.ui.gui.popups.ReorderPeakListAxes.ReorderPeakListAxes(parent=None, mainWindow=None, peakList=None, selectFirstItem=True, title='Reorder PeakList Axes', label='', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Set the axis ordering for the selected peakLists

selectPeakList(peakList=None)

Manually select a PeakList from the pullDown

ccpn.ui.gui.popups.RestraintTablePopup module

Module Documentation here

class ccpn.ui.gui.popups.RestraintTablePopup.RestraintTableEditPopup(parent=None, mainWindow=None, obj=None, restraintTable=None, structureData=None, **kwds)

Bases: ccpn.ui.gui.popups.RestraintTablePopup.RestraintTablePopupABC

RestraintTable attributes editor popup

attributes = [('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Enter name <'}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'}), ('Restraint Type', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, None, None, None, {})]

class ccpn.ui.gui.popups.RestraintTablePopup.RestraintTableNewPopup(parent=None, mainWindow=None, obj=None, restraintTable=None, structureData=None, **kwds)

Bases: ccpn.ui.gui.popups.RestraintTablePopup.RestraintTablePopupABC

RestraintTable attributes editor popup

attributes = [('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Enter name <'}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'}), ('Restraint Type', <class 'ccpn.ui.gui.widgets.CompoundWidgets.PulldownListCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, <function RestraintTablePopupABC._getRestraintTypes>, None, {})]

class ccpn.ui.gui.popups.RestraintTablePopup.RestraintTablePopupABC(parent=None, mainWindow=None, obj=None, restraintTable=None, structureData=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

Base class for RestraintTable attributes editor popups

attributes = []

klass

alias of ccpn.core.RestraintTable.RestraintTable

ccpn.ui.gui.popups.SampleComponentPropertiesPopup module

Module Documentation here

class ccpn.ui.gui.popups.SampleComponentPropertiesPopup.SampleComponentPopup(parent=None, mainWindow=None, obj=None, sample=None, sampleComponent=None, newSampleComponent=False, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.ComplexAttributeEditorPopupABC

SampleComponent attributes editor popup

ENABLEREVERT = True

FIXEDHEIGHT = True

FIXEDWIDTH = True

HWIDTH = 150

LABELEDITING = True

attributes = <ccpn.ui.gui.popups.AttributeEditorPopupABC.VList object>

klass

alias of ccpn.core.SampleComponent.SampleComponent

ccpn.ui.gui.popups.SamplePropertiesPopup module

Module Documentation here

class ccpn.ui.gui.popups.SamplePropertiesPopup.SamplePropertiesPopup(parent=None, mainWindow=None, obj=None, sample=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.ComplexAttributeEditorPopupABC

Sample attributes editor popup

ENABLEREVERT = True

FIXEDHEIGHT = True

FIXEDWIDTH = True

HWIDTH = 50

SHORTWIDTH = 140

attributes = <ccpn.ui.gui.popups.AttributeEditorPopupABC.VList object>

klass

alias of ccpn.core.Sample.Sample

ccpn.ui.gui.popups.SelectObjectsPopup module

Module Documentation here

class ccpn.ui.gui.popups.SelectObjectsPopup.SelectObjectsPopup(parent=None, mainWindow=None, dim=None, objects=None, title='Select Objects', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

ccpn.ui.gui.popups.SetPeakAliasing module

Module Documentation here

class ccpn.ui.gui.popups.SetPeakAliasing.SetPeakAliasingPopup(parent=None, mainWindow=None, title='Set Aliasing', peaks=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Open a small popup to allow setting aliasing value of selected ‘current’ items

FIXEDHEIGHT = True

FIXEDWIDTH = True

restoreWidgetState()

Restore the state of the checkBoxes

storeStateOnReject = True

storeWidgetState()

Store the state of the checkBoxes between popups

ccpn.ui.gui.popups.SetupNmrResiduesPopup module

Module Documentation here

class ccpn.ui.gui.popups.SetupNmrResiduesPopup.SetupNmrResiduesPopup(parent=None, mainWindow=None, title='Set up nmrResidues', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Dialog to handle creating new nmrAtoms for peaks that have not been assigned

restoreWidgetState()

Restore the state of the checkBoxes

storeWidgetState()

Store the state of the checkBoxes between popups

ccpn.ui.gui.popups.ShortcutsPopup module

class ccpn.ui.gui.popups.ShortcutsPopup.ShortcutWidget(parent, mainWindow=None, setLayout=True, **kwds)

Bases: ccpn.ui.gui.widgets.Frame.Frame

getShortcuts()

validateFunction(i)

class ccpn.ui.gui.popups.ShortcutsPopup.ShortcutsPopup(parent=None, mainWindow=None, title='Define User Shortcuts', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

USESCROLLWIDGET = True

save()

saveAndQuit()

class ccpn.ui.gui.popups.ShortcutsPopup.UserShortcuts(mainWindow=None)

Bases: object

addUserShortcut(funcName, funcStr)

runUserShortcut(funcStr)

ccpn.ui.gui.popups.SimpleAttributeEditorPopupABC module

Abstract base class to easily implement a popup to edit attributes of V3 layer objects

class ccpn.ui.gui.popups.SimpleAttributeEditorPopupABC.SimpleAttributeEditorPopupABC(parent=None, mainWindow=None, obj=None, size=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

Abstract base class to implement a popup for editing simple properties

FIXEDHEIGHT = True

FIXEDWIDTH = True

attributes = []

hWidth = None

klass = None

ccpn.ui.gui.popups.SpectrumGroupEditor module

Module Documentation here

class ccpn.ui.gui.popups.SpectrumGroupEditor.SeriesFrame(parent=None, mainWindow=None, spectrumGroup=None, editMode=False, showCopyOptions=False, defaultItems=None)

Bases: ccpn.ui.gui.widgets.Frame.Frame

class ccpn.ui.gui.popups.SpectrumGroupEditor.SpectrumGroupEditor(parent=None, mainWindow=None, editMode=True, obj=None, defaultItems=None, size=(700, 550), **kwds)

Bases: ccpn.ui.gui.popups._GroupEditorPopupABC._GroupEditorPopupABC

A popup to create and manage SpectrumGroups

Used in ‘New’ or ‘Edit’ mode: - For creating new SpectrumGroup (editMode==False); optionally uses passed in spectra list

i.e. NewSpectrumGroup of SideBar and Context menu of SideBar

• For editing existing SpectrumGroup (editMode==True); requires spectrumGroup argument i.e. Edit of SpectrumGroup of SideBar

or

For selecting and editing SpectrumGroup (editMode==True) i.e. Menu Spectrum->Edit SpectrumGroup…

connectSignals()

copySpectra(fromSpectrum, toSpectra)

Copy the contents of tabs to other spectra

getActiveTabList()

Return the list of active tabs

ccpn.ui.gui.popups.SpectrumProjectionPopup module

Module Documentation here

class ccpn.ui.gui.popups.SpectrumProjectionPopup.SpectrumProjectionPopup(parent=None, mainWindow=None, title='Spectrum Projection', **kwds)

Bases: ccpn.ui.gui.popups.ExportDialog.ExportDialogABC

FIXEDHEIGHT = True

actionButtons()

Set the cancel/export buttons

property axisCodes

- None, immutable - Return axisCodes of projected spectra (as defined by self.projectionAxisCode)

initialise(userFrame)

Create the widgets for the userFrame

makeProjection()

populate(userFrame)

populate the widgets

property projectionAxisCode

- None, immutable -

ccpn.ui.gui.popups.SpectrumPropertiesPopup module

Module Documentation here

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.Colour1dFrame(parent=None, mainWindow=None, container=None, editMode=False, spectrumGroup=None, item=None, **kwds)

Bases: ccpn.ui.gui.popups.SpectrumPropertiesPopup.ColourFrameABC

NEGATIVECOLOUR = False

POSITIVECOLOUR = False

SLICECOLOUR = True

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.ColourFrameABC(parent=None, mainWindow=None, container=None, editMode=False, spectrumGroup=None, item=None, **kwds)

Bases: ccpn.ui.gui.widgets.Frame.Frame

EDITMODE = True

NEGATIVECOLOUR = False

POSITIVECOLOUR = False

SLICECOLOUR = False

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.ColourNdFrame(parent=None, mainWindow=None, container=None, editMode=False, spectrumGroup=None, item=None, **kwds)

Bases: ccpn.ui.gui.popups.SpectrumPropertiesPopup.ColourFrameABC

NEGATIVECOLOUR = True

POSITIVECOLOUR = True

SLICECOLOUR = False

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.ColourTab(parent=None, mainWindow=None, spectrum=None, item=None, colourOnly=False, showCopyOptions=False, copyToSpectra=None)

Bases: ccpn.ui.gui.widgets.Widget.Widget

setCopyOptionsVisible(value)

Show/hide the copyOptions widgets

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.ContoursTab(parent=None, mainWindow=None, spectrum=None, showCopyOptions=False, copyToSpectra=None)

Bases: ccpn.ui.gui.widgets.Widget.Widget

setCopyOptionsVisible(value)

Show/hide the copyOptions widgets

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.DimensionsTab(parent=None, mainWindow=None, spectrum=None, dimensions=None)

Bases: ccpn.ui.gui.widgets.Widget.Widget

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.GeneralTab(parent=None, mainWindow=None, spectrum=None, item=None, colourOnly=False)

Bases: ccpn.ui.gui.widgets.Widget.Widget

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.SpectrumDisplayPropertiesPopup1d(parent=None, mainWindow=None, spectrum=None, orderedSpectrumViews=None, title='SpectrumDisplay Properties', **kwds)

Bases: ccpn.ui.gui.popups.SpectrumPropertiesPopup.SpectrumPropertiesPopupABC

All spectra in the current display are added as tabs The apply button then steps through each tab, and calls each function in the _changes dictionary in order to set the parameters.

copySpectra(fromSpectrum, toSpectra)

Copy the contents of tabs to other spectra

getActiveTabList()

Return the list of active tabs

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.SpectrumDisplayPropertiesPopupNd(parent=None, mainWindow=None, spectrum=None, orderedSpectrumViews=None, title='SpectrumDisplay Properties', **kwds)

Bases: ccpn.ui.gui.popups.SpectrumPropertiesPopup.SpectrumPropertiesPopupABC

All spectra in the current display are added as tabs The apply button then steps through each tab, and calls each function in the _changes dictionary in order to set the parameters.

copySpectra(fromSpectrum, toSpectra)

Copy the contents of tabs to other spectra

getActiveTabList()

Return the list of active tabs

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.SpectrumPropertiesPopup(parent=None, mainWindow=None, spectrum=None, title='Spectrum Properties', **kwds)

Bases: ccpn.ui.gui.popups.SpectrumPropertiesPopup.SpectrumPropertiesPopupABC

getActiveTabList()

Return the list of active tabs

class ccpn.ui.gui.popups.SpectrumPropertiesPopup.SpectrumPropertiesPopupABC(parent=None, mainWindow=None, spectrum=None, title='Spectrum Properties', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

BORDER_OFFSET = 20

FIXEDHEIGHT = False

FIXEDWIDTH = False

MINIMUM_WIDTH = 500

MINIMUM_WIDTH_PER_TAB = 120

copySpectra(fromSpectrum, toSpectra)

Copy the contents of tabs to other spectra

getActiveTabList()

Return the list of active tabs

ccpn.ui.gui.popups.StripPlotPopup module

Module Documentation here

class ccpn.ui.gui.popups.StripPlotPopup.StripPlotPopup(parent=None, mainWindow=None, spectrumDisplay=None, title='StripPlot', includePeakLists=False, includeNmrChains=False, includeNmrChainPullSelection=False, includeSpectrumTable=False, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

restoreWidgetState()

Restore the state of the widgets

storeWidgetState()

Store the state of the widgets between popups

ccpn.ui.gui.popups.StructureDataPopup module

Module Documentation here

class ccpn.ui.gui.popups.StructureDataPopup.StructureDataPopup(parent=None, mainWindow=None, obj=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

StructureData attributes editor popup

attributes = [('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Enter name <'}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'}), ('Program Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'}), ('Program Version', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'}), ('Data Path', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'}), ('Uuid', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'}), ('Molecule FilePath', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {})]

klass

alias of ccpn.core.StructureData.StructureData

ccpn.ui.gui.popups.StructureEnsemblePopup module

Module Documentation here

class ccpn.ui.gui.popups.StructureEnsemblePopup.StructureEnsemblePopup(parent=None, mainWindow=None, obj=None, editMode=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

StructureEnsemble attributes editor popup

attributes = [('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Enter name <'}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.StructureEnsemble.StructureEnsemble

ccpn.ui.gui.popups.SubmitMacroPopup module

Module Documentation here

class ccpn.ui.gui.popups.SubmitMacroPopup.SubmitMacroPopup(parent=None, title='Submit Macro Form', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialogMainWidget

FIXEDHEIGHT = False

FIXEDWIDTH = False

ccpn.ui.gui.popups.SubstancePropertiesPopup module

Module Documentation here

class ccpn.ui.gui.popups.SubstancePropertiesPopup.SubstancePropertiesPopup(parent=None, mainWindow=None, substance=None, sampleComponent=None, newSubstance=False, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.ComplexAttributeEditorPopupABC

Substance attributes editor popup

FIXEDHEIGHT = False

FIXEDWIDTH = False

HWIDTH = 150

LABELEDITING = True

USESCROLLWIDGET = True

attributes = <ccpn.ui.gui.popups.AttributeEditorPopupABC.VList object>

klass

alias of ccpn.core.Substance.Substance

ccpn.ui.gui.popups.ValidateSpectraPopup module

Module Documentation here

class ccpn.ui.gui.popups.ValidateSpectraPopup.PathRowABC(parentWidget, row, labelText, obj, enabled=True, callback=None)

Bases: object

Implements all functionality for a row with label, text and button to select a file path

LABELWIDGET_MIN_WIDTH = 200

colourRow()

Set colours of row depending on its state

dialogFileMode = 1

getDialogPath() → str

Get the directory path to start the selection dialog; optionally can be subclassed

getPath() → str

Get the path name from the object to edit; requires subclassing

getText()

Get the textWidget text

property hasChanged

- None, immutable - Return True if the text value has changed

property isNotValid

- None, immutable -

setColour(colour)

Set the (base) colour of the dataWidget

setEnabled(enable)

Enable or disable the row

setLabel(text)

Set the labelWidget to text

setPath(path)

Set the path name of the object; requires subclassing

setText(text)

Set the textWidget to text

setVisible(visible)

set visibilty of row

property text

- None, mutable - Return the text content of the dataWidget

update()

Call self.path with current value

validate()

Validate the row, return True if valid

validatorClass = None

class ccpn.ui.gui.popups.ValidateSpectraPopup.RedirectPathRow(parentWidget, row, labelText, obj, enabled=True, callback=None)

Bases: ccpn.ui.gui.popups.ValidateSpectraPopup.PathRowABC

A class to implement a row for Redirection object

dialogFileMode = 2

getPath()

Get the path name from the object to edit; requires subclassing

setPath(path)

Set the path name of the object; requires subclassing

class validatorClass(obj, parent=None, callback=None)

Bases: ccpn.ui.gui.popups.ValidateSpectraPopup.ValidatorABC

Validator implementation

isValid(value)

return True is value is valid

class ccpn.ui.gui.popups.ValidateSpectraPopup.SpectrumPathRow(*args, **kwds)

Bases: ccpn.ui.gui.popups.ValidateSpectraPopup.PathRowABC

A class to implement a row for spectrum paths

dialogFileMode = 1

getDialogPath() → str

Get the directory path to start the selection; traverse up the tree to find a valid directory

getPath() → str

Get the filePath from spectrum

property initialFilePath

- None, immutable - Return the initialFilePath if the obj is specified

setPath(path)

set the filePath of Spectrum

validatorClass

alias of ccpn.ui.gui.popups.ValidateSpectraPopup.SpectrumValidator

class ccpn.ui.gui.popups.ValidateSpectraPopup.SpectrumValidator(obj, parent=None, callback=None)

Bases: ccpn.ui.gui.popups.ValidateSpectraPopup.ValidatorABC

isValid(value)

return True is value is valid;

class ccpn.ui.gui.popups.ValidateSpectraPopup.ValidateSpectraPopup(parent=None, mainWindow=None, spectra=None, title='Validate Spectra', defaultSelected='all', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

Class to generate a popup to validate the paths of the (selected) spectra.

class ccpn.ui.gui.popups.ValidateSpectraPopup.ValidatorABC(obj, parent=None, callback=None)

Bases: PyQt5.QtGui.QValidator

isValid(value)

return True is value is valid; should be subclassed

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

ccpn.ui.gui.popups.ViolationTablePopup module

Module Documentation here

class ccpn.ui.gui.popups.ViolationTablePopup.ViolationTablePopup(parent=None, mainWindow=None, obj=None, violationTable=None, structureData=None, **kwds)

Bases: ccpn.ui.gui.popups.AttributeEditorPopupABC.AttributeEditorPopupABC

ViolationTable attributes editor popup

attributes = [('Name', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Enter name <'}), ('Comment', <class 'ccpn.ui.gui.widgets.CompoundWidgets.EntryCompoundWidget'>, <built-in function getattr>, <built-in function setattr>, None, None, {'backgroundText': '> Optional <'})]

klass

alias of ccpn.core.ViolationTable.ViolationTable

ccpn.ui.gui.popups.ZoomPopup module

Module Documentation here

class ccpn.ui.gui.popups.ZoomPopup.ZoomPopup(parent=None, mainWindow=None, **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

Set Zoom for for current.strip; works for 1D and nD

ccpn.ui.gui.popups.ZoomToPosition module

Module Documentation here

class ccpn.ui.gui.popups.ZoomToPosition.ZoomToPositionPopup(parent=None, mainWindow=None, strip=None, title='Zoom To Position', **kw)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog

ccpn.ui.gui.popups.testtabbed module

Module Documentation here

class ccpn.ui.gui.popups.testtabbed.ApplicationsTab(fileInfo, parent=None)

Bases: PyQt5.QtWidgets.QWidget

class ccpn.ui.gui.popups.testtabbed.GeneralTab(fileInfo, parent=None)

Bases: PyQt5.QtWidgets.QWidget

class ccpn.ui.gui.popups.testtabbed.PermissionsTab(fileInfo, parent=None)

Bases: PyQt5.QtWidgets.QWidget

class ccpn.ui.gui.popups.testtabbed.TabDialog(fileName, parent=None, title='Tab Dialog', **kwds)

Bases: ccpn.ui.gui.popups.Dialog.CcpnDialog