ENLIGHTEN
Cross-platform desktop GUI for Wasatch Photonics spectrometers
Loading...
Searching...
No Matches
Class Hierarchy

Go to the graphical class hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
 Cenlighten.post_processing.AbsorbanceFeature.AbsorbanceFeatureComputes absorbance using Beer's Law
 Cwasatch.AbstractUSBDevice.AbstractUSBDevice
 Cenlighten.device.AccessoryControlFeature.AccessoryControlFeatureSupport for the Gen 1.5 OEM External Accessory Connector
 Cenlighten.Controller.AcquiredReadingTrivial class to eliminate a tuple during memory profiling
 Csimple_live_windows_forms.AcquisitionWorker
 Csimple_live_wpf.AcquisitionWorker
 Cenlighten.KnowItAll.Feature.AliasedNameGiven that compounds may be referenced by either original name or aliases, provide a simple way to access the varied name types
 Cenlighten.device.AmbientTemperatureFeature.AmbientTemperatureFeature
 CApplication
 Cenlighten.measurement.AreaScanFeature.AreaScanFeatureImplements a 2D "area scan," displaying the full detector rows and columns rather than the usual 1D vertically-binned spectrum
 Cwasatch.AreaScanImage.AreaScanImage
 Cenlighten.scope.RamanShiftCorrectionFeature.ASTMCompoundAn ASTMCompound is a set of ASTMPeaks with one "primary" peak wavenumber
 Cenlighten.scope.RamanShiftCorrectionFeature.ASTMPeakOne peak of an ASTMCompound
 Cenlighten.ui.Authentication.AuthenticationEncapsulates the process of "logging-in" to ENLIGHTEN and enabling or displaying GUI widgets which should only be exposed to certain user classes
 CAutoFeatures
 Cwasatch.AutoRaman.AutoRamanEncapsulates Dieter's Auto-Raman algorithm, which optimizes integration time (and gain on XS series spectrometers) to achieve a target window of counts, then uses the configured measurement time to maximize scan averaging at with those acquisition parameters
 Cenlighten.post_processing.AutoRamanFeature.AutoRamanFeatureThis feature controls the (normally-hidden) "Auto-Raman Measurement" button on the Laser Control Widget
 Cwasatch.AutoRamanRequest.AutoRamanRequest
 Cenlighten.common.AxesHelper
 Cenlighten.scope.Cursor.AxisConverterMove to common.AxesHelper?
 Csimple_live_windows_forms.BackEnd
 Csimple_live_wpf.BackEnd
 Cwasatch.BalanceAcquisition.BalanceAcquisition
 Cenlighten.post_processing.BaselineCorrection.BaselineCorrectionEncapsulates baseline correction
 Cenlighten.timing.BatchCollection.BatchCollectionEncapsulates batch collection, which is the automated collection of a series of 'measurement_count' Step-And-Save events at a period of 'measurement_period_ms', captured to disk using the configured SaveOptions
 Cenlighten.device.BatteryFeature.BatteryFeature
 Cenlighten.network.BLEManager.BLEManagerProvides GUI allowing user to select a Wasatch Bluetooth® LE spectrometer for connection
 Cenlighten.post_processing.BoxcarFeature.BoxcarFeatureEncapsulate the high-frequency noise smoothing "boxcar" filter run at the end of post-processing
 Cenlighten.BusinessObjects.BusinessObjectsThis is sort of an "extension class" to Controller, or a "partial class" in C# terms
 Ccamera.CameraShowcases the usage of the ids_peak API in setting camera parameters, starting/stopping acquisition and how to record a video using the ids_peak_ipl API
 Cmain.Camera
 CChronometer
 Cenlighten.ui.Clipboard.ClipboardEncapsulates access to the host OS (Windows) copy-paste clipboard, allowing tabular data to be copied from ENLIGHTEN and pasted into other applications like Microsoft Excel
 Cenlighten.network.CloudManager.CloudManagerEncapsulates access to AWS-backed cloud features
 Cenlighten.data.ColorNames.ColorNamesThese are colors we can reference by name in .ini files or elsewhere
 Cenlighten.ui.Colors.ColorsEncapsulate access to stateful / dynamic color information
 Cenlighten.parser.ColumnFileParser.ColumnFileParserA file parser to deserialize one ENLIGHTEN-format Measurement from a column- ordered CSV file
 Cwasatch.CommandSettings.CommandSettingsEncapsulates information about the "ControlObject" settings supported by WasatchDevice hardware classes (FID and SP)
 Cwasatch.SPIDevice.CommandTuple
 Cenlighten.KnowItAll.Config.ConfigConfiguration of the KnowItAll module
 Cenlighten.file_io.Configuration.ConfigurationThis is a wrapper over ConfigParser
 Cenlighten.Controller.ControllerMain application controller class for ENLIGHTEN
 Cwasatch.ControlObject.ControlObjectA class holding setting-value pairs sent from ENLIGHTEN to the spectrometer
 Cwasatch.CSVLoader.CSVLoaderA file parser to deserialize one Measurement from a column-ordered CSV file
 Cenlighten.scope.Cursor.CursorEncapsulates the main Graph x-axis cursor (vertical red line)
 Cenlighten.post_processing.DarkFeature.DarkFeature
 Cenlighten.parser.DashFileParser.DashFileParserLoad the specified filename into a list of Measurements
 Cenlighten.parser.DashFileParser.DashMeasurementRepresents data that will go into the next Measurement we generate (or "could", for Dash data we don't actually disposition at this time)
 Cenlighten.parser.DashFileParser.DashSpectrometerA kind of mini-Spectrometer, holding state about a Spectrometer which will go into the next Measurement we generate
 Cenlighten.KnowItAll.Feature.DeclaredMatchThis is ultimately what we turn the KnowItAll list of possible matches into
 Cenlighten.post_processing.DespikingFeature.DespikingFeatureProvides access to the removal of cosmic spikes that could impact analysis
 Cwasatch.DetectorRegions.DetectorRegionsEncapsulates all of the DetectorROI regions that have been configured for the current detetor
 Cwasatch.DetectorROI.DetectorROISingle Detector Region-of-Interest for a single "region" of DetectorRegions
 Cenlighten.device.DetectorTemperatureFeature.DetectorTemperatureFeatureEncapsulate the monitoring and control of detector temperature
 CDevice
 CDeviceContext
 Cwasatch.DeviceFinderBLE.DeviceFinderBLE
 Cwasatch.DeviceFinderTCP.DeviceFinderTCPI started this class, but I'm not sure it's actually needed yet
 Cwasatch.DeviceFinderUSB.DeviceFinderUSBGenerates a list of DeviceID objects for all connected USB Wasatch Photonics spectrometers
 Cwasatch.DeviceID.DeviceIDRepresents a persistent unique identifier for a spectrometer device (USB, BLE, TCP, whatever) which should remain valid for connected devices in spite of hotplug events around them
 CDeviceUpdateInformation
 CFirmwareUpdateExample.DeviceUpdateInformation
 CDFUFeature.DFUFeature
 Cenlighten.ui.DidYouKnowFeature.DidYouKnowFeaturePop-up dialog when ENLIGHTEN launches, informing the user of new or lesser-known features they might otherwise not stumble across or notice in the GUI or manual
 Cwasatch.DeviceFinderBLE.DiscoveredBLEDevice
 Cwasatch.EEPROM.EEPROMEncapsulates the post-read parsing, pre-write marshalling, and current state of the 8-page EEPROM used to store non-volatile configuration data in Wasatch Photonics spectrometers
 Cenlighten.device.EEPROMEditor.EEPROMAttribute
 Cenlighten.device.EEPROMEditor.EEPROMEditorUnlike most business objects, just pass in self.form.ui to avoid a REALLY long list of widgets
 Cwasatch.EEPROM.EEPROMField
 Cenlighten.device.EEPROMWriter.EEPROMWriterEncapsulate reflashing the EEPROM to the device
 Cenlighten.post_processing.ElectricalDarkCorrectionFeature.ElectricalDarkCorrectionFeature
 Cenlighten.scope.EmissionLamps.EmissionLampEncapsulates static product data about a gas emission lamp for use by the Wavecal business object
 Cenlighten.scope.EmissionLamps.EmissionLampsConvenience class: instantiate one of these to get access to each EmissionLamp
 CEnlighten.EnlightenApplicationEncapsulates processing of command-line arguments, instantiates a Controller then passes control to the Qt framework
 Cscripts.Enlighten.EnlightenApplicationEncapsulates processing of command-line arguments, instantiates a Controller then passes control to the Qt framework
 CEnlightenPlugin.EnlightenPluginBaseAbstract Base Class (ABC) for all ENLIGHTEN-compatible plug-ins
 CEnlightenPlugin.EnlightenPluginConfigurationConfiguration of an entire EnlightenPlugin
 CEnlightenPlugin.EnlightenPluginFieldEach ENLIGHTEN plug-in will be visualized in the ENLIGHTEN GUI via a dynamically generated widget in the right-hand scrolling control list
 CEnlightenPlugin.EnlightenPluginRequestThis is a "request" object sent by the ENLIGHTEN GUI to the plug-in, containing a fresh measurement to be processed
 CEnlightenPlugin.EnlightenPluginResponseAfter a plug-in has received an EnlightenPluginRequest and processed it, the plug-in should instantiate and send an EnlightenPluginResponse in reply
 CEnum
 Cenlighten.parser.ExportFileParser.ExportedMeasurementA temporary pre-Measurement object built-up while reading an export file
 Cenlighten.parser.ExportFileParser.ExportFileParserA file parser to deserialize multiple Measurement objects from a column-ordered export file
 Cenlighten.device.ExternalTriggerFeature.ExternalTriggerFeatureEncapsulate external hardware triggering
 CFactoryStripChartFeature.FactoryStripChartFeatureManages the set of strip-charts on the Factory View which graph device characteristics against a time axis
 Cenlighten.common.FakeOutputHandleWe [think we] need to build Windows installers with PyInstaller
 Cenlighten.KnowItAll.Feature.FeatureEncapsulates all KnowItAll data, widgets and processing
 Cenlighten.file_io.FileManager.FileManagerEncapsulate operations managing files, directory trees etc
 Cwasatch.FirmwareRequirements.FirmwareRequirementsThis is a place to capture developmental, R&D features which are only available in specific firmware versions
 Cfirmware_update.FirmwareUpdateExample
 Cble-util.FixtureNote this script is currently coded to ENG-0120 BLE API rev 7
 Cenlighten.ui.FocusListener.FocusListenerCurrently used by ThumbnailWidget to detect when the user has tabbed or clicked out of an "open edit" QLineEdit
 CForm
 CFormWindowA strongly-typed resource class, for looking up localized strings, etc
 Cwasatch.FPGAOptions.FPGAOptionsEncapsulate the set of options used to compile the FPGA code in the firmware of the connected spectrometer
 CFrameStatistics
 Cenlighten.device.GainDBFeature.GainDBFeatureEncapsulates control of detector gain (decibels), currently used only for Sony IMX detectors (SiG)
 Cble-util.GenericEncapsulates paired setter and getter accessors for a single attribute
 Cwasatch.BLEDevice.GenericEncapsulates paired setter and getter accessors for a single attribute
 Cble-util.GenericsFacade to access all Generic attributes in the BLE interface
 Cwasatch.BLEDevice.GenericsFacade to access all Generic attributes in the BLE interface
 Cenlighten.scope.Graph.GraphEncapsulate the large graph in the center of ENLIGHTEN's Scope Capture screen
 Cenlighten.scope.GridFeature.GridFeature
 Cenlighten.ui.GUI.GUIThis is currently holding "GUI Utility" methods, but may grow to encapsulate more and more of the actual ENLIGHTEN GUI as we continue to prise functionality out of Controller
 Cenlighten.ui.GuideFeature.GuideFeatureRecommends "tips" that might be suggested to the user through the Marquee
 Cenlighten.file_io.HardwareFileOutputManager.HardwareFileOutputManager
 Cwasatch.HardwareInfo.HardwareInfoCaptures aspects of the hardware which normally ENLIGHTEN can't / shouldn't see, which isn't otherwise reliably inferred from EEPROM, ModelInfo etc
 CAnalysis.StripChart.HardwareState
 Cenlighten.ui.HelpFeature.HelpFeature
 Cenlighten.device.HighGainModeFeature.HighGainModeFeatureControl the "high gain" mode on Hamamatsu InGaAs detectors (on or off)
 Cenlighten.post_processing.HorizROIFeature.HorizROIFeatureEncapsulate the Horizontal ROI feature
 Cwasatch.IDSCamera.IDSCameraEncapsulates access to the IDS Peak SDK
 Cenlighten.ui.ImageResources.ImageResourcesDevice (model) images come from enlighten/assets/uic_qrc/images/devices
 Cwasatch.IMX385.IMX385Long-term, it might be worth having separate classes for HorizontalBinning and IMX385, which would allow characteristics for other sensors to go into other classes
 Cenlighten.device.IntegrationTimeFeature.IntegrationTimeFeature
 CIntEnum
 Ccli_interface.InterfaceInterface provides methods to interact with the camera on the command line, but it is not necessary to understand how to use the API of ids_peak or ids_peak_ipl
 Cwasatch.InterfaceDevice.InterfaceDevice
 Cenlighten.post_processing.InterpolationFeature.InterpolationFeatureEncapsulates interpolation of a ProcessedReading
 Cenlighten.device.LaserControlFeature.LaserControlFeatureEncapsulate laser control from the application side
 Cenlighten.device.LaserTemperatureFeature.LaserTemperatureFeature
 Cenlighten.device.LaserWatchdogFeature.LaserWatchdogFeature
 Cenlighten.file_io.LoggingFeature.LoggingFeatureCurrently this timer runs continuously, as it is what provides the "Hardware" Status Indicator
 Cwasatch.applog.MainLogger
 Cenlighten.ui.Marquee.MarqueeEncapsulate access to the "message display area" visible along the top of the ENLIGHTEN display
 Cenlighten.KnowItAll.Wrapper.MatchRequestAn inbound request being passed from Wrapper to the subprocess for writing to KIAConsole
 Cenlighten.KnowItAll.Wrapper.MatchResponseAn outbound response generated from the subprocess and passed back to Feature
 Cenlighten.KnowItAll.Wrapper.MatchResultEntryOne entry of many representing a compound potentially matched by KIAConsole within a larger MatchResult
 Cenlighten.measurement.Measurement.MeasurementEncapsulates a single saved measurement from one spectrometer, comprising a ProcessedReading (optionally containing the original Reading object that generated it), metadata (Settings), as well as a ThumbnailWidget for display on the capture bar
 Cenlighten.measurement.MeasurementFactory.MeasurementFactoryThis is a Factory used by Measurements to create Measurement objects, each coupled to a ThumbnailWidget
 Cenlighten.measurement.Measurements.MeasurementsSet of Measurement objects which have been saved during this session via the Acquire button or BatchCollection, or which have been loaded from disk via the Load button
 Cenlighten.ui.Marquee.Message
 Cwasatch.TCPDevice.MessagePacketEssentially a 6-byte simplified USB Setup Packet, with bmRequestType removed and wLength reduced to 1 byte
 CAnalysis.Stats.Metrics
 CAnalysis.StatsBuffer.Metrics
 CPixelNoise.Metrics
 Cenlighten.data.ModelFWHM.ModelFWHM
 Cenlighten.data.ModelInfo.ModelInfoConvenience class providing access to pre-built subtypes of WpModelInfo, plus ModelFWHM
 Cenlighten.device.MultiPos.MultiPosUsed for spectrometers with articulated optics
 Cenlighten.device.Multispec.MultispecOrchestrates ENLIGHTEN's simultaneous connection to multiple spectrometers in parallel
 Cwasatch.EEPROM.MultiWavelengthCalibrationSubformat 5: Multi-Wavelength
 Cenlighten.ui.PageNavigation.PageNavigationEncapsulates moving around different "screens" of ENLIGHTEN's GUI
 CLibraryMatching.Pearson
 CPictureBox
 Cenlighten.post_processing.PixelCalibration.PixelCalibrationSupport any additional pixel calibrations we may want to create which for whatever reason need an external file and can't be kept on the EEPROM
 Cenlighten.Plugins.PluginController.PluginController
 Cenlighten.Plugins.PluginGraphSeries.PluginGraphSeriesTHIS CLASS IS NOT DONE!
 Cenlighten.Plugins.PluginModuleInfo.PluginModuleInfoEncapsulates information about a specific ENLIGHTEN Plug-In (child of PluginBaseClass)
 Cenlighten.Plugins.PluginValidator.PluginValidatorThese are routines that I would have put into PluginBaseClass classes, but I can't trust that users won't accidentally contravene / delete / corrupt them when editting, so I'm putting them here
 Cenlighten.scope.PresetFeature.PresetFeatureThis feature allows the user to save named presets (referring to a snapshot of key acquisition parameters), irrespective of spectrometer serial number
 Cwasatch.ProcessedReading.ProcessedReadingEncapsulates anything done to a wasatch.Reading (usually generated by wasatch.WasatchDevice) after it has been received by ENLIGHTEN (usually Controller.process_reading)
 CFirmwareUpdateExample.Program
 Copen_camera.Program
 CReconnectCallbacks.Program
 Csimple_live_windows_forms.Program
 CQAbstractListModel
 CQtCore.QAbstractTableModel
 CQDialog
 CQtWidgets.QDialog
 CQtWidgets.QFrame
 CQGraphicsScene
 CQGraphicsView
 CQMainWindow
 CQtWidgets.QMainWindow
 CQMessageBox
 CQObject
 CQQuickPaintedItem
 CQSlider
 CQtWidgets.QWidget
 CQWidget
 Cenlighten.post_processing.RamanIntensityCorrection.RamanIntensityCorrectionRamanIntensityCorrection uses an EEPROM-stored calibration, generated in the factory with NIST SRM standards, to correct intensity (y-axis) on Raman spectra
 Cenlighten.scope.RamanShiftCorrectionFeature.RamanShiftCorrectionFeatureImplement ASTM 1840-96 (2014) by generating a scalar offset which will be applied to the wavenumber X-axis by taking a live measurement of a known Raman sample and comparing it to the "expected" peak x-coordinates
 Cenlighten.timing.Ramp.RampProvides a generic ramp that ticks a callback with ascending/descending value at a specified rate
 Cwasatch.Reading.ReadingA single set of data read from a device
 Cenlighten.ui.ReadingProgressBar.ReadingProgressBar
 Creconnect_callbacks.ReconnectExample
 Cscripts.interp-spectra.Record
 Cscripts.merge-spectra.Record
 Ccamera.RecordingStatistics
 Cenlighten.post_processing.ReferenceFeature.ReferenceFeatureSufficiently close to DarkFeature that it's tempting to make them one inherit the other, or derive both from a common ABC
 Cenlighten.ui.ResourceMonitorFeature.ResourceMonitorFeatureWas created a few years ago when we had a buried memory leak which only presented on Linux
 Cenlighten.post_processing.RichardsonLucy.RichardsonLucyDeconvolution filter which sharpens peaks back to their original optical resolution by removing the Gaussian blur point-spread function
 Cwasatch.ROI.ROIEncapsulates a Region Of Interest, which may be either horizontal (pixels) or vertical (rows/lines)
 Cenlighten.timing.RollingDataSet.RollingDataSetEncapsulates a "moving window" dataset such as used for detector temperature, laser temperature etc
 Cenlighten.measurement.SaveOptions.SaveOptionsEncapsulates the many options regarding how spectra are to be saved
 Cenlighten.post_processing.ScanAveragingFeature.ScanAveragingFeature
 CAnalysis.StripChart.Series
 Cwasatch.simulation_protocol.SimulateMaterialRead recorded spectrum from file, respond with noise on the baseline read from file
 CSoftwareTriggerWorker
 Cenlighten.ui.Sounds.SoundA single playable sound (.wav file, etc)
 Cenlighten.ui.Sounds.SoundsEncapsulates ENLIGHTEN's limited audio capabilities
 Cenlighten.parser.SPCFileParser.SPCFileParserThis is an SPC file parser, used to load and read SPC files in the ThermoScientific "Galactic" GRAMS SPC format
 Cenlighten.device.Spectrometer.SpectrometerRepresents an individual Spectrometer within the set of connected spectrometers managed by Multispec
 Cenlighten.device.SpectrometerApplicationState.SpectrometerApplicationStateThese are things that are very much ENLIGHTEN-specific and not generic enough to be in Wasatch.PY's SpectrometerState
 Cwasatch.SpectrometerRequest.SpectrometerRequest
 Cwasatch.SpectrometerResponse.SpectrometerResponse
 Cwasatch.SpectrometerSettings.SpectrometerSettingsEncapsulate a spectrometer's state, including compiled firmware (FPGAOptions), non-volatile configuration (EEPROM) and volatile state (SpectrometerState)
 Cwasatch.SpectrometerState.SpectrometerStateVolatile attributes (must persist here for multi-spectrometers)
 Cwasatch.FeatureIdentificationDevice.SpectrumAndRow
 Cenlighten.ui.StatusBarFeature.StatusBarFeatureEncapsulates the horizontal status bar at the bottom of the ENLIGHTEN Scope Capture screen
 Cenlighten.ui.StatusIndicators.StatusIndicatorsEncapsulates the 3 virtual status "LEDs" in the bottom-right of ENLIGHTEN's Scope view:
 Cwasatch.StatusMessage.StatusMessageAn outbound analog to ControlObject
 Cenlighten.ui.Stylesheets.StylesheetsEncapsulates application of CSS stylesheets to Qt widgets
 Cenlighten.KnowItAll.Wrapper.SubprocessArgsArguments passed to continuous_poll() when spawning the subprocess
 Cenlighten.post_processing.TakeOneFeature.TakeOneFeatureEncapsulates the collection of one averaged spectrum (optionally saved), either from one spectrometer or all
 Cwasatch.TakeOneRequest.TakeOneRequest
 Cwasatch.WasatchBus.TCPBus
 Cenlighten.common.TechniquesHelper
 Ctest_gui.TestGUI
 Ctest_usb.TestUSB
 Cenlighten.parser.TextFileParser.TextFileParserA file parser to deserialize one Measurement from a column-ordered CSV file with no header data
 Cthreading.Thread
 Cenlighten.ui.DidYouKnowFeature.TipDifferent than GuideFeature.Tip
 Cenlighten.ui.GuideFeature.Tip
 Cenlighten.post_processing.TransmissionFeature.TransmissionFeature
 Cenlighten.network.UpdateChecker.UpdateChecker
 Cwasatch.WasatchBus.USBBus
 Cenlighten.ui.VCRControls.VCRControlsEncapsulate the state, appearance and behavior of the seven VCR-style "Action Buttons" appearing along the top of the Scope Capture screen
 Cenlighten.common.ViewsHelper
 Cwasatch.WasatchBus.WasatchBusThe different bus classes don't use inheritance and don't follow a common ABC or interface, but each should have an update() method, and each should have a 'device_ids' array
 Cwasatch.WasatchDeviceWrapper.WasatchDeviceWrapperWrap WasatchDevice in a non-blocking interface run in a separate thread, using multiprocess.pipes to exchange data (SpectrometerSettings, Readings and StatusMessages) for multiprocessing-safe device communications and acquisition under Windows and Qt
 CWindow
 Cenlighten.data.ModelInfo.WpModelInfoAbstract Base Class (ABC) for actual per-model concrete classes
 Cenlighten.KnowItAll.Wrapper.WrapperEncapsulates ENLIGHTEN's interface to KnowItAll