ESIBD Explorer Logo

Contents:

  • 1. Installation
    • 1.1. Standalone Windows installer
    • 1.2. From PyPi
    • 1.3. From source (Miniconda)
    • 1.4. From source (Miniconda offline)
    • 1.5. From PyPi (Linux)
    • 1.6. From source (other)
  • 2. Electrospray ion-beam deposition
  • 3. User’s Guide
    • 3.1. Getting started
    • 3.2. User interface overview
    • 3.3. Settings
      • 3.3.1. General settings
      • 3.3.2. Session settings
      • 3.3.3. Acquisition settings
      • 3.3.4. Other settings
    • 3.4. Explorer
    • 3.5. UCM
    • 3.6. PID
    • 3.7. Devices
      • 3.7.1. Device settings
      • 3.7.2. Custom device
      • 3.7.3. ISEG
      • 3.7.4. RBD
      • 3.7.5. Pressure
      • 3.7.6. TIC
      • 3.7.7. MAXIGAUGE
      • 3.7.8. Temperature
      • 3.7.9. KEITHLEY
      • 3.7.10. MIPS
      • 3.7.11. NI9263
      • 3.7.12. PICO
      • 3.7.13. RSPD3303C
    • 3.8. Channels
    • 3.9. Scans
      • 3.9.1. Scan settings
      • 3.9.2. Genetic algorithm (GA)
      • 3.9.3. Omni scan
      • 3.9.4. Spectra scan
      • 3.9.5. Beam scan
      • 3.9.6. Energy scan
      • 3.9.7. Depo scan
    • 3.10. Custom extensions
    • 3.11. Displays
      • 3.11.1. Browser
      • 3.11.2. Notes
      • 3.11.3. Text
      • 3.11.4. Tree
      • 3.11.5. MS
      • 3.11.6. Line
      • 3.11.7. PDB
      • 3.11.8. Holo
    • 3.12. Live displays
    • 3.13. Device manager
    • 3.14. Console
  • 4. Plugin development
    • 4.1. Plugin
    • 4.2. PluginManager
    • 4.3. Devices
    • 4.4. Channels
    • 4.5. Scan
    • 4.6. DeviceController
  • 5. Library Reference
    • 5.1. The plugin module
      • ChannelManager
        • ChannelManager.ChannelPlot
        • ChannelManager.SignalCommunicate
        • ChannelManager.addChannel()
        • ChannelManager.channelConfigChanged()
        • ChannelManager.channelType
        • ChannelManager.channels
        • ChannelManager.close()
        • ChannelManager.closeCommunication()
        • ChannelManager.compareItemsConfig()
        • ChannelManager.convertDataDisplay()
        • ChannelManager.copyClipboard()
        • ChannelManager.exportConfiguration()
        • ChannelManager.finalizeInit()
        • ChannelManager.getChannelByName()
        • ChannelManager.getDefaultSettings()
        • ChannelManager.getSelectedChannel()
        • ChannelManager.initGUI()
        • ChannelManager.initializeCommunication()
        • ChannelManager.intervalChanged()
        • ChannelManager.isOn()
        • ChannelManager.liveDisplay
        • ChannelManager.loadConfiguration()
        • ChannelManager.loadValues()
        • ChannelManager.moveChannel()
        • ChannelManager.name
        • ChannelManager.optional
        • ChannelManager.plot()
        • ChannelManager.pluginType
        • ChannelManager.previewFileTypes
        • ChannelManager.runDataThread()
        • ChannelManager.staticDisplay
        • ChannelManager.supportsFile()
        • ChannelManager.toggleAdvanced()
        • ChannelManager.toggleRecording()
        • ChannelManager.updateChannelConfig()
        • ChannelManager.useAdvancedOptions
        • ChannelManager.useBackgrounds
        • ChannelManager.useDisplays
        • ChannelManager.useMonitors
        • ChannelManager.useOnOffLogic
        • ChannelManager.version
      • Device
        • Device.SignalCommunicate
        • Device.appendOutputData()
        • Device.applyValues()
        • Device.close()
        • Device.closeCommunication()
        • Device.documentation
        • Device.getDefaultSettings()
        • Device.getUnit()
        • Device.initializeCommunication()
        • Device.initialized()
        • Device.inout
        • Device.intervalChanged()
        • Device.moveChannel()
        • Device.name
        • Device.optional
        • Device.pluginType
        • Device.restoreOutputData()
        • Device.runDataThread()
        • Device.setBackground()
        • Device.startAcquisition()
        • Device.stopAcquisition()
        • Device.toggleRecording()
        • Device.unit
        • Device.updateValues()
        • Device.useBackgrounds
        • Device.version
      • DeviceManager
        • DeviceManager.SignalCommunicate
        • DeviceManager.afterFinalizeInit()
        • DeviceManager.closeCommunication()
        • DeviceManager.documentation
        • DeviceManager.getChannelByName()
        • DeviceManager.iconFile
        • DeviceManager.name
        • DeviceManager.optional
        • DeviceManager.pluginType
        • DeviceManager.previewFileTypes
        • DeviceManager.store()
        • DeviceManager.toggleAdvanced()
        • DeviceManager.toggleRecording()
        • DeviceManager.useAdvancedOptions
        • DeviceManager.version
      • LiveDisplay
        • LiveDisplay.clearPlot()
        • LiveDisplay.copyClipboard()
        • LiveDisplay.documentation
        • LiveDisplay.getDisplayTime()
        • LiveDisplay.getIcon()
        • LiveDisplay.initFig()
        • LiveDisplay.plot()
        • LiveDisplay.pluginType
        • LiveDisplay.toggleAdvanced()
        • LiveDisplay.useAdvancedOptions
      • PID
        • PID.PIDChannel
        • PID.afterFinalizeInit()
        • PID.channelType
        • PID.iconFile
        • PID.loadConfiguration()
        • PID.loadData()
        • PID.moveChannel()
        • PID.name
        • PID.optional
        • PID.pluginType
        • PID.previewFileTypes
        • PID.version
      • Plugin
        • Plugin.SignalCommunicate
        • Plugin.about()
        • Plugin.addAction()
        • Plugin.addContentLayout()
        • Plugin.addContentWidget()
        • Plugin.addMultiStateAction()
        • Plugin.addRightAxis()
        • Plugin.addStateAction()
        • Plugin.afterFinalizeInit()
        • Plugin.axes
        • Plugin.canvas
        • Plugin.close()
        • Plugin.closeGUI()
        • Plugin.closeUserGUI()
        • Plugin.copyClipboard()
        • Plugin.dependencyPath
        • Plugin.dock
        • Plugin.documentation
        • Plugin.fig
        • Plugin.finalizeInit()
        • Plugin.getDefaultSettings()
        • Plugin.getIcon()
        • Plugin.iconFile
        • Plugin.iconFileDark
        • Plugin.initDock()
        • Plugin.initFig()
        • Plugin.initGUI()
        • Plugin.initializedDock
        • Plugin.initializedGUI
        • Plugin.labelPlot()
        • Plugin.loadData()
        • Plugin.loading
        • Plugin.lock
        • Plugin.makeFigureCanvasWithToolbar()
        • Plugin.makeIcon()
        • Plugin.name
        • Plugin.navToolBar
        • Plugin.optional
        • Plugin.plot()
        • Plugin.pluginManager
        • Plugin.pluginType
        • Plugin.previewFileTypes
        • Plugin.print()
        • Plugin.provideDock()
        • Plugin.raiseDock()
        • Plugin.requireGroup()
        • Plugin.requiredPlugin()
        • Plugin.runTestParallel()
        • Plugin.scan
        • Plugin.setLabelMargin()
        • Plugin.supportedVersion
        • Plugin.supportsFile()
        • Plugin.test()
        • Plugin.testControl()
        • Plugin.titleBar
        • Plugin.titleBarLabel
        • Plugin.toggleAdvanced()
        • Plugin.toggleTitleBar()
        • Plugin.updateTheme()
        • Plugin.useAdvancedOptions
        • Plugin.version
        • Plugin.waitForCondition()
      • Scan
        • Scan.ScanChannel
        • Scan.SignalCommunicate
        • Scan.TreeSplitter
        • Scan.addInputChannel()
        • Scan.afterFinalizeInit()
        • Scan.channels
        • Scan.display
        • Scan.documentation
        • Scan.estimateScanTime()
        • Scan.file
        • Scan.finished
        • Scan.generatePythonPlotCode()
        • Scan.getChannelByName
        • Scan.getData()
        • Scan.getOutputIndex()
        • Scan.getSteps()
        • Scan.initScan()
        • Scan.inputs
        • Scan.loadDataInternal()
        • Scan.measurementsPerStep
        • Scan.outputs
        • Scan.plot()
        • Scan.pluginType
        • Scan.pythonPlotCode()
        • Scan.recording
        • Scan.run()
        • Scan.runThread
        • Scan.saveData()
        • Scan.saveScanParallel()
        • Scan.toggleAdvanced()
        • Scan.toggleRecording()
        • Scan.useAdvancedOptions
        • Scan.useDisplayChannel
        • Scan.useDisplayParameter
      • Settings
        • Settings.getDefaultSettings()
        • Settings.iconFile
        • Settings.incrementMeasurementNumber()
        • Settings.init()
        • Settings.loadSettings()
        • Settings.name
        • Settings.optional
        • Settings.pluginType
        • Settings.runTestParallel()
        • Settings.toggleAdvanced()
        • Settings.updateSessionPath()
        • Settings.useAdvancedOptions
        • Settings.version
      • SettingsManager
        • SettingsManager.initSettingsContextMenuBase()
        • SettingsManager.loadSettings()
        • SettingsManager.pluginType
        • SettingsManager.saveSettings()
        • SettingsManager.updateSettings()
        • SettingsManager.version
      • StaticDisplay
        • StaticDisplay.copyClipboard()
        • StaticDisplay.getIcon()
        • StaticDisplay.loadDataInternal()
        • StaticDisplay.plot()
        • StaticDisplay.pluginType
      • UCM
        • UCM.UCMChannel
        • UCM.afterFinalizeInit()
        • UCM.channelType
        • UCM.documentation
        • UCM.iconFile
        • UCM.initGUI()
        • UCM.loadConfiguration()
        • UCM.loadData()
        • UCM.moveChannel()
        • UCM.name
        • UCM.optional
        • UCM.pluginType
        • UCM.previewFileTypes
        • UCM.toggleRecording()
        • UCM.useMonitors
        • UCM.version
      • providePlugins()
    • 5.2. The core module
      • Action
        • Action.SignalCommunicate
      • Channel
        • Channel.SignalCommunicate
        • Channel.appendValue()
        • Channel.asDict()
        • Channel.backgrounds
        • Channel.device
        • Channel.displayedParameters
        • Channel.enabledChanged()
        • Channel.getDefaultChannel()
        • Channel.getSortedDefaultChannel()
        • Channel.getValues()
        • Channel.initGUI()
        • Channel.initSettingsContextMenuBase()
        • Channel.inout
        • Channel.insertDisplayedParameter()
        • Channel.lastAppliedValue
        • Channel.monitorChanged()
        • Channel.onDelete()
        • Channel.parameters
        • Channel.plotCurve
        • Channel.print
        • Channel.setDisplayedParameters()
        • Channel.tempParameters()
        • Channel.tree
        • Channel.updateColor()
        • Channel.values
      • CheckBox
        • CheckBox.SignalCommunicate
      • CloseDialog
      • CompactComboBox
      • ControlCursor
        • ControlCursor.setPosition()
      • DeviceController
        • DeviceController.SignalCommunicate
        • DeviceController.acquiring
        • DeviceController.acquisitionThread
        • DeviceController.closeCommunication()
        • DeviceController.fakeInitialization()
        • DeviceController.initComplete()
        • DeviceController.initThread
        • DeviceController.initializeCommunication()
        • DeviceController.initialized
        • DeviceController.initializing
        • DeviceController.lock
        • DeviceController.parent
        • DeviceController.port
        • DeviceController.print()
        • DeviceController.runAcquisition()
        • DeviceController.runInitialization()
        • DeviceController.serialRead()
        • DeviceController.serialWrite()
        • DeviceController.startAcquisition()
        • DeviceController.stopAcquisition()
        • DeviceController.updateValue()
      • DockWidget
        • DockWidget.SignalCommunicate
        • DockWidget.toggleTitleBar()
      • DynamicNp
        • DynamicNp.add()
        • DynamicNp.get()
      • EsibdExplorer
        • EsibdExplorer.closeEvent()
        • EsibdExplorer.loadPlugins()
        • EsibdExplorer.restoreUiState()
        • EsibdExplorer.saveUiState()
        • EsibdExplorer.toggleFullscreen()
      • Icon
      • IconStatusBar
        • IconStatusBar.iconClicked
      • LabelItem
      • LedIndicator
      • LineEdit
        • LineEdit.sizeHint()
        • LineEdit.userEditingFinished
        • LineEdit.validateInput()
      • Logger
        • Logger.close()
        • Logger.flush()
        • Logger.open()
        • Logger.openLog()
        • Logger.print()
        • Logger.printFromThreadSignal
        • Logger.write()
      • MZCalculator
        • MZCalculator.determine_mass_to_charge()
      • MetaChannel
      • MouseInterceptor
        • MouseInterceptor.eventFilter()
        • MouseInterceptor.rippleEffectSignal
      • MultiStateAction
      • NumberBar
      • Parameter
        • Parameter.TYPE
        • Parameter.advanced
        • Parameter.applyChangedEvent()
        • Parameter.applyWidget()
        • Parameter.attr
        • Parameter.displayDecimals
        • Parameter.equals()
        • Parameter.event
        • Parameter.extraEvents
        • Parameter.fixedItems
        • Parameter.fullName
        • Parameter.header
        • Parameter.indicator
        • Parameter.instantUpdate
        • Parameter.internal
        • Parameter.itemWidget
        • Parameter.items
        • Parameter.max
        • Parameter.min
        • Parameter.name
        • Parameter.print
        • Parameter.settingEvent()
        • Parameter.toolTip
        • Parameter.tree
        • Parameter.validateComboInput()
        • Parameter.value
        • Parameter.widget
        • Parameter.widgetType
      • PlotItem
        • PlotItem.parentPlot()
      • PlotWidget
      • PluginManager
        • PluginManager.SignalCommunicate
        • PluginManager.TYPE
        • PluginManager.addPluginTreeWidgetItem()
        • PluginManager.afterFinalizeInit()
        • PluginManager.closePlugins()
        • PluginManager.finalizeInit()
        • PluginManager.finalizeUiState()
        • PluginManager.getMainPlugins()
        • PluginManager.getPluginsByClass()
        • PluginManager.getPluginsByType()
        • PluginManager.loadPlugin()
        • PluginManager.loadPlugins()
        • PluginManager.loadPluginsFromModule()
        • PluginManager.loading
        • PluginManager.managePlugins()
        • PluginManager.plugins
        • PluginManager.provideDocks()
        • PluginManager.resetMainDisplayWidgetLimits()
        • PluginManager.runTestParallel()
        • PluginManager.test()
        • PluginManager.updateTheme()
      • QLabviewDoubleSpinBox
        • QLabviewDoubleSpinBox.stepBy()
        • QLabviewDoubleSpinBox.textFromValue()
      • QLabviewSciSpinBox
        • QLabviewSciSpinBox.FloatValidator
        • QLabviewSciSpinBox.stepBy()
        • QLabviewSciSpinBox.textFromValue()
      • QLabviewSpinBox
        • QLabviewSpinBox.stepBy()
      • RestoreFloatComboBox
      • RippleEffect
        • RippleEffect.expand()
        • RippleEffect.paintEvent()
      • ScanChannel
        • ScanChannel.getDefaultChannel()
        • ScanChannel.initGUI()
        • ScanChannel.onDelete()
        • ScanChannel.setDisplayedParameters()
        • ScanChannel.tempParameters()
      • SciAxisItem
      • Setting
        • Setting.resetWidget()
        • Setting.setWidget()
        • Setting.settingEvent()
      • SplashScreen
      • StateAction
      • TextEdit
      • ThemedConsole
      • ThemedNavigationToolbar
        • ThemedNavigationToolbar.updateNavToolbarTheme()
      • TimeoutLock
        • TimeoutLock.acquire_timeout()
      • ToolButton
        • ToolButton.SignalCommunicate
      • TreeWidget
        • TreeWidget.itemRect()
        • TreeWidget.totalItems()
      • VideoRecorder
      • parameterDict()
    • 5.3. Constants
      • Colors
      • INOUT
        • INOUT.ALL
        • INOUT.BOTH
        • INOUT.IN
        • INOUT.NONE
        • INOUT.OUT
      • PRINT
        • PRINT.DEBUG
        • PRINT.ERROR
        • PRINT.EXPLORER
        • PRINT.MESSAGE
        • PRINT.WARNING
      • getClipboardTheme()
      • getDPI()
      • getDarkMode()
      • getIconMode()
      • getShowDebug()
      • getTestMode()
      • makeSettingWrapper()
      • makeStateWrapper()
      • makeWrapper()
      • openInDefaultApplication()
      • setDarkMode()
      • smooth()
      • validatePath()
  • 6. Changelog
  • 7. Acknowledgments
  • 8. References
ESIBD Explorer
  • Search


© Copyright 2025, Tim Esser.

Built with Sphinx using a theme provided by Read the Docs.