IDSPeak.IDSPeak Class Reference

Tell the Controller to attempt to connect to an IDS camera via the IDSPeak SDK. More...

Inheritance diagram for IDSPeak.IDSPeak:

Collaboration diagram for IDSPeak.IDSPeak:

Public Member Functions
	disconnect (self)
	Called when ENLIGHTEN is shutting down.
	format_callback (self)
	get_configuration (self)
	End backwards compatible object-returning wrappers #####.
	get_spectrometer_with_laser (self)
	This method is provided to override ctl.multispec.current_spectrometer().
	roi_callback (self)
	update_visibility (self)
	Something has happened – a new spectrometer may have connected – so update field state.
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.
	wavelength_to_pixel (self, wavelength)
	wavenumber_to_pixel (self, wavenumber)

Public Attributes
	get_spectrometer_with_laser = DeviceID(label="IDSPeak")
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

Tell the Controller to attempt to connect to an IDS camera via the IDSPeak SDK.

Member Function Documentation

disconnect()

IDSPeak.IDSPeak.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.

format_callback()

IDSPeak.IDSPeak.format_callback

(

self

)

get_configuration()

IDSPeak.IDSPeak.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.

get_spectrometer_with_laser()

IDSPeak.IDSPeak.get_spectrometer_with_laser

(

self

)

This method is provided to override ctl.multispec.current_spectrometer().

It returns a handle to the first connected enlighten.devices.Spectrometer with a laser, or None if one can't be found

roi_callback()

IDSPeak.IDSPeak.roi_callback

(

self

)

update_visibility()

IDSPeak.IDSPeak.update_visibility

(

self

)

Something has happened – a new spectrometer may have connected – so update field state.

Reimplemented from EnlightenPlugin.EnlightenPluginBase.

Member Data Documentation

get_spectrometer_with_laser

IDSPeak.IDSPeak.get_spectrometer_with_laser = DeviceID(label="IDSPeak")

---

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

• plugins/Network/IDSPeak.py