Analysis.StatsBuffer.StatsBuffer Class Reference

This is similar to the Analysis.Stats plugin, but adds additional statistics (mode, median, stdev) which require that a buffer of recent spectra be cached in memory. More...

Inheritance diagram for Analysis.StatsBuffer.StatsBuffer:

Collaboration diagram for Analysis.StatsBuffer.StatsBuffer:

Public Member Functions
	get_configuration (self)
	End backwards compatible object-returning wrappers #####.
	process_request (self, request)
	reset (self)
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
	metrics = Metrics(spectrum, history)
list	series_names = ["Min", "Max", "Mean", "Median", "Mode", "Sigma.lo", "Sigma.hi"]
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 is similar to the Analysis.Stats plugin, but adds additional statistics (mode, median, stdev) which require that a buffer of recent spectra be cached in memory.

Allows the user to set the history size, and displays the buffer size as it fills.

Allows the computed median to be exported back to ENLIGHTEN as the next potential dark measurement, meaning that you can use this to generate a true "median dark" (which some spectroscopists prefer to "averaged dark").

Member Function Documentation

get_configuration()

Analysis.StatsBuffer.StatsBuffer.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.

process_request()

Analysis.StatsBuffer.StatsBuffer.process_request	(		self,
			request )

Reimplemented from EnlightenPlugin.EnlightenPluginBase.

reset()

Analysis.StatsBuffer.StatsBuffer.reset

(

self

)

Member Data Documentation

metrics

Analysis.StatsBuffer.StatsBuffer.metrics = Metrics(spectrum, history)

series_names

Analysis.StatsBuffer.StatsBuffer.series_names = ["Min", "Max", "Mean", "Median", "Mode", "Sigma.lo", "Sigma.hi"]

---

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

• plugins/Analysis/StatsBuffer.py