Adds min, max and mean series to the ENLIGHTEN scope. More...

Inheritance diagram for Analysis.Stats.Stats:

Collaboration diagram for Analysis.Stats.Stats:

Public Member Functions
	callback_all (self)
	Allow user to dynamically decide whether to support multiple spectrometers, including loaded spectra.

	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)

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

Adds min, max and mean series to the ENLIGHTEN scope.

All stats are on-going, with a manual "reset" button to clear them.

See StatsBuffer for additional statistics which require keeping a buffer of historical spectra in memory.

Todo: "stitch" spectra from multiple spectrometer ranges? would require tracking x-coord of each pixel, in all 3 axes?

Member Function Documentation

◆ callback_all()

Analysis.Stats.Stats.callback_all ( self )

Allow user to dynamically decide whether to support multiple spectrometers, including loaded spectra.

Doing this as a callback rather than checking request.fields["All"] within process_request because if All is not already checked, process_request may not be called for loaded spectra (so there's no chance to check the field value).

◆ get_configuration()

Analysis.Stats.Stats.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.Stats.Stats.process_request	(		self,
			request )

Reimplemented from EnlightenPlugin.EnlightenPluginBase.

◆ reset()

Analysis.Stats.Stats.reset ( self )

Member Data Documentation

◆ metrics

Analysis.Stats.Stats.metrics = Metrics(spectrum)

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

plugins/Analysis/Stats.py

Public Member Functions

Public Attributes

Additional Inherited Members