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

Volatile attributes (must persist here for multi-spectrometers). More...

Public Member Functions

 __init__ (self)
 
 dump (self, label=None)
 
 ignore_timeouts_for (self, sec)
 
 set (self, name, value)
 
 stringify_bad_pixel_mode (self)
 
 stringify_trigger_source (self)
 
 to_dict (self)
 

Public Attributes

bool analog_out_enabled = False
 
int analog_out_mode = 0
 
int analog_out_value = 0
 
bool area_scan_enabled = False
 
bool area_scan_fast = True
 
bool area_scan_first_trigger_sent = False
 
int area_scan_line_step = 1
 
int background_subtraction_half_width = 0
 
int bad_pixel_mode = self.BAD_PIXEL_MODE_AVERAGE
 
bool battery_charging = False
 
float battery_percentage = 0.0
 
 battery_raw = None
 
 battery_timestamp = None
 
int boxcar_half_width = 0
 
 detector_regions = None
 
 detector_temperature_raw = None
 
 detector_temperature_raw_last_refreshed = None
 
list edc_buffer = []
 
bool edc_enabled = False
 
bool fan_enabled = False
 
bool firmware_logging_enabled = False
 
int gain_db = 8
 
bool graph_alternating_pixels = False
 
bool high_gain_mode_enabled = False
 
 ignore_timeouts_until = None
 
int integration_time_ms = 0
 
bool lamp_enabled = False
 
bool laser_enabled = False
 
 laser_enabled_last_refreshed = None
 
bool laser_power_high_resolution = True
 
 laser_power_mW = None
 
int laser_power_perc = 0
 
bool laser_power_require_modulation = False
 
bool laser_tec_enabled = False
 
int laser_tec_mode = 0
 
int laser_tec_setpoint = 800
 
int laser_temperature_setpoint_raw = 0
 
 laser_warning_delay_sec = None
 
int laser_watchdog_sec = 0
 
int max_usb_interval_ms = 0
 
int min_usb_interval_ms = 0
 
bool mod_enabled = False
 
int mod_period_us = 0
 
int mod_width_us = 0
 
bool onboard_averaging = False
 
 poll_status = PollStatus.UNDEFINED
 
int position = 0
 
int prev_integration_time_ms = 10
 
int raman_delay_ms = 0
 
bool raman_mode_enabled = False
 
 region = None
 
int scans_to_average = 1
 
bool secondary_adc_enabled = False
 
 selected_adc = None
 
int selected_laser = 0
 
bool shutter_enabled = False
 
bool swap_alternating_pixels = False
 
bool tec_enabled = False
 
int tec_setpoint_degC = 15
 
int trigger_source = self.TRIGGER_SOURCE_INTERNAL
 
bool use_mW = False
 
int wavenumber_correction = 0
 

Static Public Attributes

int BAD_PIXEL_MODE_AVERAGE = 1
 
int BAD_PIXEL_MODE_NONE = 0
 
int TRIGGER_SOURCE_EXTERNAL = 1
 
int TRIGGER_SOURCE_INTERNAL = 0
 

Detailed Description

Volatile attributes (must persist here for multi-spectrometers).

Note that these should generally not include READOUTS from the spectrometer like temperature, ADC etc...unless that proves convenient.

Constructor & Destructor Documentation

◆ __init__()

wasatch.SpectrometerState.SpectrometerState.__init__ ( self)

Member Function Documentation

◆ dump()

wasatch.SpectrometerState.SpectrometerState.dump ( self,
label = None )

◆ ignore_timeouts_for()

wasatch.SpectrometerState.SpectrometerState.ignore_timeouts_for ( self,
sec )

◆ set()

wasatch.SpectrometerState.SpectrometerState.set ( self,
name,
value )

◆ stringify_bad_pixel_mode()

wasatch.SpectrometerState.SpectrometerState.stringify_bad_pixel_mode ( self)

◆ stringify_trigger_source()

wasatch.SpectrometerState.SpectrometerState.stringify_trigger_source ( self)

◆ to_dict()

wasatch.SpectrometerState.SpectrometerState.to_dict ( self)

Member Data Documentation

◆ analog_out_enabled

bool wasatch.SpectrometerState.SpectrometerState.analog_out_enabled = False

◆ analog_out_mode

int wasatch.SpectrometerState.SpectrometerState.analog_out_mode = 0

◆ analog_out_value

int wasatch.SpectrometerState.SpectrometerState.analog_out_value = 0

◆ area_scan_enabled

wasatch.SpectrometerState.SpectrometerState.area_scan_enabled = False

◆ area_scan_fast

bool wasatch.SpectrometerState.SpectrometerState.area_scan_fast = True

◆ area_scan_first_trigger_sent

bool wasatch.SpectrometerState.SpectrometerState.area_scan_first_trigger_sent = False

◆ area_scan_line_step

int wasatch.SpectrometerState.SpectrometerState.area_scan_line_step = 1

◆ background_subtraction_half_width

wasatch.SpectrometerState.SpectrometerState.background_subtraction_half_width = 0

◆ bad_pixel_mode

int wasatch.SpectrometerState.SpectrometerState.bad_pixel_mode = self.BAD_PIXEL_MODE_AVERAGE

◆ BAD_PIXEL_MODE_AVERAGE

int wasatch.SpectrometerState.SpectrometerState.BAD_PIXEL_MODE_AVERAGE = 1
static

◆ BAD_PIXEL_MODE_NONE

int wasatch.SpectrometerState.SpectrometerState.BAD_PIXEL_MODE_NONE = 0
static

◆ battery_charging

bool wasatch.SpectrometerState.SpectrometerState.battery_charging = False

◆ battery_percentage

float wasatch.SpectrometerState.SpectrometerState.battery_percentage = 0.0

◆ battery_raw

wasatch.SpectrometerState.SpectrometerState.battery_raw = None

◆ battery_timestamp

wasatch.SpectrometerState.SpectrometerState.battery_timestamp = None

◆ boxcar_half_width

wasatch.SpectrometerState.SpectrometerState.boxcar_half_width = 0

◆ detector_regions

wasatch.SpectrometerState.SpectrometerState.detector_regions = None

◆ detector_temperature_raw

wasatch.SpectrometerState.SpectrometerState.detector_temperature_raw = None

◆ detector_temperature_raw_last_refreshed

wasatch.SpectrometerState.SpectrometerState.detector_temperature_raw_last_refreshed = None

◆ edc_buffer

list wasatch.SpectrometerState.SpectrometerState.edc_buffer = []

◆ edc_enabled

bool wasatch.SpectrometerState.SpectrometerState.edc_enabled = False

◆ fan_enabled

bool wasatch.SpectrometerState.SpectrometerState.fan_enabled = False

◆ firmware_logging_enabled

bool wasatch.SpectrometerState.SpectrometerState.firmware_logging_enabled = False

◆ gain_db

wasatch.SpectrometerState.SpectrometerState.gain_db = 8

◆ graph_alternating_pixels

bool wasatch.SpectrometerState.SpectrometerState.graph_alternating_pixels = False

◆ high_gain_mode_enabled

wasatch.SpectrometerState.SpectrometerState.high_gain_mode_enabled = False

◆ ignore_timeouts_until

wasatch.SpectrometerState.SpectrometerState.ignore_timeouts_until = None

◆ integration_time_ms

int wasatch.SpectrometerState.SpectrometerState.integration_time_ms = 0

◆ lamp_enabled

bool wasatch.SpectrometerState.SpectrometerState.lamp_enabled = False

◆ laser_enabled

wasatch.SpectrometerState.SpectrometerState.laser_enabled = False

◆ laser_enabled_last_refreshed

wasatch.SpectrometerState.SpectrometerState.laser_enabled_last_refreshed = None

◆ laser_power_high_resolution

bool wasatch.SpectrometerState.SpectrometerState.laser_power_high_resolution = True

◆ laser_power_mW

wasatch.SpectrometerState.SpectrometerState.laser_power_mW = None

◆ laser_power_perc

wasatch.SpectrometerState.SpectrometerState.laser_power_perc = 0

◆ laser_power_require_modulation

bool wasatch.SpectrometerState.SpectrometerState.laser_power_require_modulation = False

◆ laser_tec_enabled

bool wasatch.SpectrometerState.SpectrometerState.laser_tec_enabled = False

◆ laser_tec_mode

wasatch.SpectrometerState.SpectrometerState.laser_tec_mode = 0

◆ laser_tec_setpoint

wasatch.SpectrometerState.SpectrometerState.laser_tec_setpoint = 800

◆ laser_temperature_setpoint_raw

wasatch.SpectrometerState.SpectrometerState.laser_temperature_setpoint_raw = 0

◆ laser_warning_delay_sec

wasatch.SpectrometerState.SpectrometerState.laser_warning_delay_sec = None

◆ laser_watchdog_sec

wasatch.SpectrometerState.SpectrometerState.laser_watchdog_sec = 0

◆ max_usb_interval_ms

wasatch.SpectrometerState.SpectrometerState.max_usb_interval_ms = 0

◆ min_usb_interval_ms

wasatch.SpectrometerState.SpectrometerState.min_usb_interval_ms = 0

◆ mod_enabled

bool wasatch.SpectrometerState.SpectrometerState.mod_enabled = False

◆ mod_period_us

int wasatch.SpectrometerState.SpectrometerState.mod_period_us = 0

◆ mod_width_us

int wasatch.SpectrometerState.SpectrometerState.mod_width_us = 0

◆ onboard_averaging

bool wasatch.SpectrometerState.SpectrometerState.onboard_averaging = False

◆ poll_status

wasatch.SpectrometerState.SpectrometerState.poll_status = PollStatus.UNDEFINED

◆ position

wasatch.SpectrometerState.SpectrometerState.position = 0

◆ prev_integration_time_ms

int wasatch.SpectrometerState.SpectrometerState.prev_integration_time_ms = 10

◆ raman_delay_ms

int wasatch.SpectrometerState.SpectrometerState.raman_delay_ms = 0

◆ raman_mode_enabled

bool wasatch.SpectrometerState.SpectrometerState.raman_mode_enabled = False

◆ region

wasatch.SpectrometerState.SpectrometerState.region = None

◆ scans_to_average

wasatch.SpectrometerState.SpectrometerState.scans_to_average = 1

◆ secondary_adc_enabled

wasatch.SpectrometerState.SpectrometerState.secondary_adc_enabled = False

◆ selected_adc

wasatch.SpectrometerState.SpectrometerState.selected_adc = None

◆ selected_laser

int wasatch.SpectrometerState.SpectrometerState.selected_laser = 0

◆ shutter_enabled

bool wasatch.SpectrometerState.SpectrometerState.shutter_enabled = False

◆ swap_alternating_pixels

bool wasatch.SpectrometerState.SpectrometerState.swap_alternating_pixels = False

◆ tec_enabled

wasatch.SpectrometerState.SpectrometerState.tec_enabled = False

◆ tec_setpoint_degC

wasatch.SpectrometerState.SpectrometerState.tec_setpoint_degC = 15

◆ trigger_source

int wasatch.SpectrometerState.SpectrometerState.trigger_source = self.TRIGGER_SOURCE_INTERNAL

◆ TRIGGER_SOURCE_EXTERNAL

int wasatch.SpectrometerState.SpectrometerState.TRIGGER_SOURCE_EXTERNAL = 1
static

◆ TRIGGER_SOURCE_INTERNAL

int wasatch.SpectrometerState.SpectrometerState.TRIGGER_SOURCE_INTERNAL = 0
static

◆ use_mW

wasatch.SpectrometerState.SpectrometerState.use_mW = False

◆ wavenumber_correction

wasatch.SpectrometerState.SpectrometerState.wavenumber_correction = 0

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