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

This class is sufficiently close to DarkFeature that it's tempting to make them one inherit the other, or derive both from a common ABC. More...

Public Member Functions

 __init__ (self, ctl)
 
 clear (self, quiet=False)
 
 display (self)
 
 enable_buttons (self, flag=True, tt=None)
 
 load (self)
 Prompts the user to select a previously-saved Measurement (from disk, not a loaded thumbnail), and pull the "Dark" column from that.
 
 populate_placeholder_scope_setup (self)
 
 preset_changed (self, ignore)
 
 store (self)
 Take the last scan-averaged, boxcar-smoothed, dark-corrected processed spectrum we have (before post-processing was applied).
 
 toggle (self)
 
 update_enable (self)
 
 update_visibility (self)
 

Public Attributes

 button_toggle = cfu.pushButton_scope_toggle_reference
 
 clear
 
 ctl = ctl
 
 curve
 
 lb_timestamp = cfu.label_reference_timestamp
 
 load
 
 store
 
 toggle
 
list visibility_widgets
 

Detailed Description

This class is sufficiently close to DarkFeature that it's tempting to make them one inherit the other, or derive both from a common ABC.

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ clear()

enlighten.post_processing.ReferenceFeature.ReferenceFeature.clear ( self,
quiet = False )

◆ display()

enlighten.post_processing.ReferenceFeature.ReferenceFeature.display ( self)

◆ enable_buttons()

enlighten.post_processing.ReferenceFeature.ReferenceFeature.enable_buttons ( self,
flag = True,
tt = None )

◆ load()

enlighten.post_processing.ReferenceFeature.ReferenceFeature.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, 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.

◆ populate_placeholder_scope_setup()

enlighten.post_processing.ReferenceFeature.ReferenceFeature.populate_placeholder_scope_setup ( self)

◆ preset_changed()

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

◆ store()

enlighten.post_processing.ReferenceFeature.ReferenceFeature.store ( self)

Take the last scan-averaged, boxcar-smoothed, dark-corrected processed spectrum we have (before post-processing was applied).

Note that while DarkFeature.store() can take an argument, this method doesn't. That's because we have a use-case for automatically generated/ passed darks (BatchCollection), but currently don't for references (but could add one later). Eventually we should make this method match DarkFeature.store() in structure.

◆ toggle()

enlighten.post_processing.ReferenceFeature.ReferenceFeature.toggle ( self)

◆ update_enable()

enlighten.post_processing.ReferenceFeature.ReferenceFeature.update_enable ( self)

◆ update_visibility()

enlighten.post_processing.ReferenceFeature.ReferenceFeature.update_visibility ( self)

Member Data Documentation

◆ button_toggle

enlighten.post_processing.ReferenceFeature.ReferenceFeature.button_toggle = cfu.pushButton_scope_toggle_reference

◆ clear

enlighten.post_processing.ReferenceFeature.ReferenceFeature.clear

◆ ctl

enlighten.post_processing.ReferenceFeature.ReferenceFeature.ctl = ctl

◆ curve

enlighten.post_processing.ReferenceFeature.ReferenceFeature.curve

◆ lb_timestamp

enlighten.post_processing.ReferenceFeature.ReferenceFeature.lb_timestamp = cfu.label_reference_timestamp

◆ load

enlighten.post_processing.ReferenceFeature.ReferenceFeature.load

◆ store

enlighten.post_processing.ReferenceFeature.ReferenceFeature.store

◆ toggle

enlighten.post_processing.ReferenceFeature.ReferenceFeature.toggle

◆ visibility_widgets

list enlighten.post_processing.ReferenceFeature.ReferenceFeature.visibility_widgets
Initial value:
= [ cfu.frame_scopeSetup_spectra_reference_white,
self.button_toggle,
button_store,
self.ctl.save_options.cb_reference ]

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