This writes received spectra into a custom folder with a different file format than ENLIGHTEN (specifically, wavelength in Ångstrom and ABSOLUTE wavenumber (as opposed to "Raman shift in wavenumbers"). More...

Inheritance diagram for SaveAsAngstrom.SaveAsAngstrom:

[legend]

Collaboration diagram for SaveAsAngstrom.SaveAsAngstrom:

[legend]

Public Member Functions
	disconnect (self)
	Called when ENLIGHTEN is shutting down.

	factory_callback (self, measurement, event)
	This callback receives new enlighten.Measurement objects generated by MeasurementFactory.

	get_configuration (self)
	End backwards compatible object-returning wrappers #####.

Public Member Functions inherited from EnlightenPlugin.EnlightenPluginBase
	__init__ (self, ctl)

	connect (self)
	Do whatever you have to do to prepare for processing measurements.

	field (self, **kwargs)

	get_axis (self, processed_reading=None)

	get_axis_name (self)

	get_axis_short_name (self)

	get_configuration_obj (self)
	End functional-plugins backend ####.

	get_plugin_field (self, name)
	get the associated enlighten.Plugins.PluginFieldWidget (which IS a QWidget, mind you)

	get_widget_from_name (self, name)
	get the associated QLabel, QSpinBox, etc

	log (self, *msgs)
	Begin functional-plugins backend ###.

	output (self, name, value)

	plot (self, y, x=None, title=None, color=None)
	When plotting on the main scope graph the (co)domain matches that existing graph.

	process_request (self, request)

	process_request_obj (self, request)

	to_graph (self, x)
	Undo to_pixel conversion, and set point back to currently selected graph X-Axis.

	to_pixel (self, x, domain=None)
	domain is an array where the index corresponds to a detector pixel number.

	update_visibility (self)
	Something has happened which might cause the plugin to wish to refresh its visible state – perhaps a new spectrometer was connected.

	wavelength_to_pixel (self, wavelength)

	wavenumber_to_pixel (self, wavenumber)

Public Attributes
	directory = os.path.join(self.ctl.save_options.get_directory(), "SaveAsAngstrom")

	factory_callback

bool	multi_device = True

Public Attributes inherited from EnlightenPlugin.EnlightenPluginBase
	auto_enable = None

bool	block_enlighten = False

	ctl = ctl

	error_message = None

bool	has_other_graph = False

bool	is_blocking = False

bool	lock_enable = False

	logfile = os.path.join(common.get_default_data_dir(), 'plugin.log')

	marquee_message = None

dict	metadata = {}

bool	multi_devices = False

	name = None

dict	outputs = {}

dict	overrides = {}

bool	process_requests = True

dict	series = {}

list	signals = []

bool	streaming = True

	table = None

	x_axis_label = None

	y_axis_label = None

Additional Inherited Members
Protected Attributes inherited from EnlightenPlugin.EnlightenPluginBase
	_config = None

list	_fields = []

Detailed Description

This writes received spectra into a custom folder with a different file format than ENLIGHTEN (specifically, wavelength in Ångstrom and ABSOLUTE wavenumber (as opposed to "Raman shift in wavenumbers").

This is demonstrating how a plug-in can register for ENLIGHTEN events (in this case, "save").

Member Function Documentation

◆ disconnect()

SaveAsAngstrom.SaveAsAngstrom.disconnect ( self )

Called when ENLIGHTEN is shutting down.

Release any resources you have. The next time you're needed, there will be a new call to connect().

Reimplemented from EnlightenPlugin.EnlightenPluginBase.

◆ factory_callback()

SaveAsAngstrom.SaveAsAngstrom.factory_callback	(	self,
		measurement,
		event )

This callback receives new enlighten.Measurement objects generated by MeasurementFactory.

◆ get_configuration()

SaveAsAngstrom.SaveAsAngstrom.get_configuration ( self )

End backwards compatible object-returning wrappers #####.

Can be called BEFORE or AFTER connect. Should be idempotent. Ideally should return same object on multiple calls, but at least should be "equivalent" objects.

Returns: an EnlightenPluginConfiguration

Reimplemented from EnlightenPlugin.EnlightenPluginBase.

Member Data Documentation

◆ directory

SaveAsAngstrom.SaveAsAngstrom.directory = os.path.join(self.ctl.save_options.get_directory(), "SaveAsAngstrom")

◆ factory_callback

SaveAsAngstrom.SaveAsAngstrom.factory_callback

◆ multi_device

bool SaveAsAngstrom.SaveAsAngstrom.multi_device = True

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

plugins/Exporters/SaveAsAngstrom.py

Public Member Functions

Public Attributes

Additional Inherited Members