This class encapsulates 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. More...

Public Member Functions
	__init__ (self, wasatch_device)

	bump_progress_bar (self)

	from_db_to_linear (self, x)

	from_linear_to_db (self, x)

	get_auto_spectrum (self, request)

	get_avg_spectrum (self, int_time, gain_db, num_avg, throwaway=True, first=None, label="unknown")
	Takes a single throwaway, then averages num_avg spectra.

	get_laser_warning_delay_sec (self)
	wrappers over stupidly complicated WasatchDevice interface

	get_spectrum (self)

	inter_spectrum_delay (self)

	measure (self, auto_raman_request)

	measure_firmware (self, auto_raman_request)

	measure_software (self, auto_raman_request)

	save (self, spectrum, label=None)
	Save each spectrum in row-ordered CSV if debug environment variable enabled.

	set_gain_db (self, db)

	set_integration_time_ms (self, ms)

	set_laser_enable (self, flag)

Public Attributes
	hardware = self.wasatch_device.hardware

bool	optimizing = False

int	progress_count = 0

int	progress_total = 0

	settings = self.wasatch_device.settings

	start_time = datetime.now()

	wasatch_device = wasatch_device

Static Public Attributes
int	INTER_SPECTRA_DELAY_MS = 50

Detailed Description

This class encapsulates 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.

As calling software will not necessarily expect the configured "default" integration time and gain to change, the class restores those to previous levels after a measurement.

Design Considerations

Mark made the following changes from Dieter's original algo:

don't take throwaways during averaged signal or dark collections, as acquisition parameters aren't changing and sensor should be stable
don't include laser warning delay when computing num_avg, since laser is already enabled and firing

Mark also made the following decisions regarding ENLIGHTEN integration:

return the optimized integration time and gain back to ENLIGHTEN in the Reading object so they will be the new GUI settings if the user simply hits "Play" to resume free-running spectra.
ENLIGHTEN will override the init_int_time and init_gain defaults in AutoRamanRequest so that if the user hits "Auto-Raman Measurement" a second time, the previous settings will be used as the new starting point, and (ideally) the initial spectrum will determine that no further optimization is required.

Points to consider:

consider rolling the "last optimization" measurement directly into the averaged sample spectra (since it had its own throwaway and presumably represents a "stable" reading). This could potentially allow for one more averaged dark, depending on max_ms.
ENLIGHTEN's laser button should still be able to turn the laser OFF at any point.

Constructor & Destructor Documentation

◆ init()

wasatch.AutoRaman.AutoRaman.__init__	(		self,
			wasatch_device )

Member Function Documentation

◆ bump_progress_bar()

wasatch.AutoRaman.AutoRaman.bump_progress_bar ( self )

◆ from_db_to_linear()

wasatch.AutoRaman.AutoRaman.from_db_to_linear	(		self,
			x )

Software Implementation # #

◆ from_linear_to_db()

wasatch.AutoRaman.AutoRaman.from_linear_to_db	(		self,
			x )

◆ get_auto_spectrum()

wasatch.AutoRaman.AutoRaman.get_auto_spectrum	(		self,
			request )

Returns: a Reading with specturm, dark and sum_count populated

◆ get_avg_spectrum()

wasatch.AutoRaman.AutoRaman.get_avg_spectrum	(	self,
		int_time,
		gain_db,
		num_avg,
		throwaway = True,
		first = None,
		label = "unknown" )

Takes a single throwaway, then averages num_avg spectra.

◆ get_laser_warning_delay_sec()

wasatch.AutoRaman.AutoRaman.get_laser_warning_delay_sec ( self )

wrappers over stupidly complicated WasatchDevice interface

◆ get_spectrum()

wasatch.AutoRaman.AutoRaman.get_spectrum ( self )

◆ inter_spectrum_delay()

wasatch.AutoRaman.AutoRaman.inter_spectrum_delay ( self )

◆ measure()

wasatch.AutoRaman.AutoRaman.measure	(		self,
			auto_raman_request )

◆ measure_firmware()

wasatch.AutoRaman.AutoRaman.measure_firmware	(		self,
			auto_raman_request )

Firmware Implementation # #

◆ measure_software()

wasatch.AutoRaman.AutoRaman.measure_software	(		self,
			auto_raman_request )

Returns: a Reading wrapped in a SpectrometerResponse

◆ save()

wasatch.AutoRaman.AutoRaman.save	(	self,
		spectrum,
		label = None )

Save each spectrum in row-ordered CSV if debug environment variable enabled.

◆ set_gain_db()

wasatch.AutoRaman.AutoRaman.set_gain_db	(		self,
			db )

◆ set_integration_time_ms()

wasatch.AutoRaman.AutoRaman.set_integration_time_ms	(		self,
			ms )

◆ set_laser_enable()

wasatch.AutoRaman.AutoRaman.set_laser_enable	(		self,
			flag )

Member Data Documentation

◆ hardware

wasatch.AutoRaman.AutoRaman.hardware = self.wasatch_device.hardware

◆ INTER_SPECTRA_DELAY_MS

int wasatch.AutoRaman.AutoRaman.INTER_SPECTRA_DELAY_MS = 50

static

◆ optimizing

bool wasatch.AutoRaman.AutoRaman.optimizing = False

◆ progress_count

int wasatch.AutoRaman.AutoRaman.progress_count = 0

◆ progress_total

wasatch.AutoRaman.AutoRaman.progress_total = 0

◆ settings

wasatch.AutoRaman.AutoRaman.settings = self.wasatch_device.settings

◆ start_time

wasatch.AutoRaman.AutoRaman.start_time = datetime.now()

◆ wasatch_device

wasatch.AutoRaman.AutoRaman.wasatch_device = wasatch_device

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

/Users/mzieg/work/code/Wasatch.PY/wasatch/AutoRaman.py

Public Member Functions

Public Attributes

Static Public Attributes