ENLIGHTEN
Cross-platform desktop GUI for Wasatch Photonics spectrometers
Loading...
Searching...
No Matches
enlighten.post_processing.DarkFeature.DarkFeature Class Reference

Public Member Functions

 __init__ (self, ctl)
 Encapsulates storage and display of dark spectra (but not the actual dark correction).
 
 clear (self, quiet=False, spec=None)
 
 clear_callback (self)
 
 display (self)
 
 laser_control_enabled (self)
 
 load (self)
 Prompts the user to select a previously-saved Measurement (from disk, not a loaded thumbnail), and pull the "Dark" column from that.
 
 load_callback (self)
 
 populate_placeholder_scope_setup (self)
 
 preset_changed (self, ignore)
 
 register_observer (self, callback)
 
 store (self, dark=None, spec=None)
 Store a new dark.
 
 store_callback (self)
 
 toggle (self, spec=None)
 
 toggle_callback (self)
 This function is here to eat positional callback args.
 
 update_enable (self)
 
 update_visibility (self)
 

Public Attributes

 button_toggle = cfu.pushButton_scope_toggle_dark
 
 clear_callback
 
 ctl = ctl
 
 curve
 
 laser_control_enabled
 
 load_callback
 
 observers = set()
 
 store_callback
 
 toggle_callback
 

Protected Member Functions

 _enable_buttons (self, flag=True, tt=None)
 

Constructor & Destructor Documentation

◆ __init__()

enlighten.post_processing.DarkFeature.DarkFeature.__init__ ( self,
ctl )

Encapsulates storage and display of dark spectra (but not the actual dark correction).

Member Function Documentation

◆ _enable_buttons()

enlighten.post_processing.DarkFeature.DarkFeature._enable_buttons ( self,
flag = True,
tt = None )
protected

◆ clear()

enlighten.post_processing.DarkFeature.DarkFeature.clear ( self,
quiet = False,
spec = None )

◆ clear_callback()

enlighten.post_processing.DarkFeature.DarkFeature.clear_callback ( self)

◆ display()

enlighten.post_processing.DarkFeature.DarkFeature.display ( self)

◆ laser_control_enabled()

enlighten.post_processing.DarkFeature.DarkFeature.laser_control_enabled ( self)

◆ load()

enlighten.post_processing.DarkFeature.DarkFeature.load ( self)

Prompts the user to select a previously-saved Measurement (from disk, not a loaded thumbnail), and pull the "Dark" column from that.

  • If no dark is found in the selected measurement, does nothing.
  • If dark is a column of zeros, uses that.
  • If multiple Measurements are in the file, uses the first.

Better design: add drop-down "..." menu to every ThumbnailWidget, to which we can add a bunch of functions, including "Load dark" and "Load reference". This would provide better support for "Export" files, where the Measurement we want actually is buried within a larger set.

◆ load_callback()

enlighten.post_processing.DarkFeature.DarkFeature.load_callback ( self)

◆ populate_placeholder_scope_setup()

enlighten.post_processing.DarkFeature.DarkFeature.populate_placeholder_scope_setup ( self)

◆ preset_changed()

enlighten.post_processing.DarkFeature.DarkFeature.preset_changed ( self,
ignore )

◆ register_observer()

enlighten.post_processing.DarkFeature.DarkFeature.register_observer ( self,
callback )

◆ store()

enlighten.post_processing.DarkFeature.DarkFeature.store ( self,
dark = None,
spec = None )

Store a new dark.

If one was passed, use that; otherwise take the latest recordable_dark from the current spectrometer.

Note
While we track reference_excitation for offset, we don't for dark because it is assumed that the laser is off.
Don't use this function directly for GUI callbacks, as they will pass Qt arguments along. This is what the otherwise-spurious _callback() versions are for, to ignore any extra arguments.
Parameters
darkcould come from Reading in BatchCollection

◆ store_callback()

enlighten.post_processing.DarkFeature.DarkFeature.store_callback ( self)

◆ toggle()

enlighten.post_processing.DarkFeature.DarkFeature.toggle ( self,
spec = None )

◆ toggle_callback()

enlighten.post_processing.DarkFeature.DarkFeature.toggle_callback ( self)

This function is here to eat positional callback args.

◆ update_enable()

enlighten.post_processing.DarkFeature.DarkFeature.update_enable ( self)

◆ update_visibility()

enlighten.post_processing.DarkFeature.DarkFeature.update_visibility ( self)

Member Data Documentation

◆ button_toggle

enlighten.post_processing.DarkFeature.DarkFeature.button_toggle = cfu.pushButton_scope_toggle_dark

◆ clear_callback

enlighten.post_processing.DarkFeature.DarkFeature.clear_callback

◆ ctl

enlighten.post_processing.DarkFeature.DarkFeature.ctl = ctl

◆ curve

enlighten.post_processing.DarkFeature.DarkFeature.curve

◆ laser_control_enabled

enlighten.post_processing.DarkFeature.DarkFeature.laser_control_enabled

◆ load_callback

enlighten.post_processing.DarkFeature.DarkFeature.load_callback

◆ observers

enlighten.post_processing.DarkFeature.DarkFeature.observers = set()

◆ store_callback

enlighten.post_processing.DarkFeature.DarkFeature.store_callback

◆ toggle_callback

enlighten.post_processing.DarkFeature.DarkFeature.toggle_callback

The documentation for this class was generated from the following file: