A simple plug-in to add Raman lines from common test samples to the current spectra. More...

Inheritance diagram for RamanLines.RamanLines:

Collaboration diagram for RamanLines.RamanLines:

Public Member Functions
	generate_points (self, sample)
	Generate Raman lines as a list of (x, y) tuples, where x is the Raman shift in wavenumbers and y is the relative intensity scaled to the current spectrum, cropping to only those points visible within the horizontal ROI.

	get_configuration (self)
	These would be better as a single drop-down combo box, but we haven't yet added that as a supported plugin input type.

	get_samples (self)

	process_request (self, request)

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

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

	disconnect (self)
	Called when ENLIGHTEN is shutting down.

	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_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
	samples = self.get_samples()

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

Static Public Attributes
float	MIN_REL_INTENSITY = 0.2

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

list	_fields = []

Detailed Description

A simple plug-in to add Raman lines from common test samples to the current spectra.

The lines displayed are limited to those appearing within the current spectrometer's configured wavecal and ROI. Lines are scaled to the current spectrum, and relative intensities are roughly set to approximate typical appearance against common transmission curves.

Member Function Documentation

◆ generate_points()

RamanLines.RamanLines.generate_points	(		self,
			sample )

Generate Raman lines as a list of (x, y) tuples, where x is the Raman shift in wavenumbers and y is the relative intensity scaled to the current spectrum, cropping to only those points visible within the horizontal ROI.

◆ get_configuration()

RamanLines.RamanLines.get_configuration ( self )

These would be better as a single drop-down combo box, but we haven't yet added that as a supported plugin input type.

Reimplemented from EnlightenPlugin.EnlightenPluginBase.

◆ get_samples()

RamanLines.RamanLines.get_samples ( self )

See also: https://www.chem.ualberta.ca/~mccreery/ramanmaterials.html

◆ process_request()

RamanLines.RamanLines.process_request	(		self,
			request )

Reimplemented from EnlightenPlugin.EnlightenPluginBase.

Member Data Documentation

◆ MIN_REL_INTENSITY

float RamanLines.RamanLines.MIN_REL_INTENSITY = 0.2

static

◆ samples

RamanLines.RamanLines.samples = self.get_samples()

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

plugins/Raman/RamanLines.py

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members