ENLIGHTEN
Cross-platform desktop GUI for Wasatch Photonics spectrometers
Loading...
Searching...
No Matches
qt_interface.Interface Class Reference

Interface provides a GUI to interact with the camera, but it is not necessary to understand how to use the API of ids_peak or ids_peak_ipl. More...

Inheritance diagram for qt_interface.Interface:
[legend]
Collaboration diagram for qt_interface.Interface:
[legend]

Public Member Functions

 __init__ (self, Camera cam_module=None)
 :param cam_module: Camera object to access parameters
 
 __init__ (self, Camera cam_module=None)
 :param cam_module: Camera object to access parameters
 
 __init__ (self, Optional[Camera] cam_module=None)
 :param cam_module: Camera object to access parameters
 
 change_pixel_format (self)
 
 change_pixel_format (self)
 
 change_slider_fps (self, val)
 
 change_slider_gain (self, val)
 
 done_recording (self, RecordingStatistics stats)
 
 information (self, str message)
 
 information (self, str message)
 
 information (self, str message)
 
 is_gui (self)
 
 is_gui (self)
 
 message (self, str typ, str message)
 
 message (self, str typ, str message)
 
 message (self, str type_, str message)
 
 on_aboutqt_link_activated (self, str link)
 
 on_aboutqt_link_activated (self, str link)
 
 on_aboutqt_link_activated (self, str link)
 
 on_image_received (self, image)
 Processes the received image for the video stream.
 
 on_image_received (self, image)
 Processes the received image for the video stream.
 
 on_image_received (self, image)
 Processes the received image for the video stream.
 
 reenable_button (self)
 
 set_camera (self, cam_module)
 
 set_camera (self, cam_module)
 
 set_camera (self, cam_module)
 
 start (self)
 
 start_interface (self)
 
 start_interface (self)
 
 start_interface (self)
 
 start_window (self)
 
 start_window (self)
 
 start_window (self)
 
 warning (self, str message)
 
 warning (self, str message)
 
 warning (self, str message)
 

Public Attributes

 acquisition_thread = None
 
 change_pixel_format = ids_peak.NodeAccessStatus_NotImplemented
 
 change_slider_fps
 
 change_slider_gain
 
 display = None
 
 message
 
 on_aboutqt_link_activated = QtWidgets.QLabel(status_bar)
 
int recording_time = 10
 
 reenable_button
 
 start = QtWidgets.QPushButton("Start recording")
 
 widget = QtWidgets.QWidget(self)
 

Static Public Attributes

 messagebox_signal = QtCore.Signal((str, str))
 
 start_button_signal = QtCore.Signal()
 

Protected Member Functions

 _close (self)
 
 _close (self)
 
 _close (self)
 
 _create_button_bar (self)
 
 _create_button_bar (self)
 
 _create_button_bar (self)
 
 _create_statusbar (self)
 
 _create_statusbar (self)
 
 _create_statusbar (self)
 
 _start_acquisition (self)
 
 _start_acquisition (self)
 
 _stop_acquisition (self)
 
 _stop_acquisition (self)
 
 _trigger_sw_trigger (self)
 
 _trigger_sw_trigger (self)
 
 _update_fps (self, val)
 
 _update_gain (self, val)
 

Protected Attributes

 _button_exit = None
 
 _button_software_trigger = None
 
 _button_start = None
 
 _button_start_acquisition = None
 
 _button_stop_acquisition = None
 
 _camera = cam_module
 
 _checkbox_save = None
 
 _close
 
 _dropdown_pixel_format = None
 
int _error_cont = 0
 
 _fps_label = None
 
 _fps_slider = None
 
int _frame_count = 0
 
 _gain_label = None
 
 _gain_slider = None
 
 _label_aboutqt = None
 
 _label_infos = None
 
 _label_version = None
 
 _layout = QtWidgets.QVBoxLayout()
 
 _qt_instance = qt_instance
 
 _spinbox_fps = QtWidgets.QDoubleSpinBox()
 
 _spinbox_gain = QtWidgets.QDoubleSpinBox()
 
 _start_acquisition
 
 _stop_acquisition
 
 _timer = time.time()
 
 _trigger_sw_trigger
 
 _update_fps = QtWidgets.QSlider()
 
 _update_gain = QtWidgets.QSlider()
 

Private Attributes

 __camera = cam_module
 
 __layout = QtWidgets.QVBoxLayout()
 
 __qt_instance = qt_instance
 

Detailed Description

Interface provides a GUI to interact with the camera, but it is not necessary to understand how to use the API of ids_peak or ids_peak_ipl.

This class is not part of the sample, but to improve the UX and give the user an interface to interact with for understanding the actual sample's behaviour.

Constructor & Destructor Documentation

◆ __init__() [1/3]

qt_interface.Interface.__init__ ( self,
Optional[Camera] cam_module = None )

:param cam_module: Camera object to access parameters

◆ __init__() [2/3]

qt_interface.Interface.__init__ ( self,
Camera cam_module = None )

:param cam_module: Camera object to access parameters

◆ __init__() [3/3]

qt_interface.Interface.__init__ ( self,
Camera cam_module = None )

:param cam_module: Camera object to access parameters

Member Function Documentation

◆ _close() [1/3]

qt_interface.Interface._close ( self)
protected

◆ _close() [2/3]

qt_interface.Interface._close ( self)
protected

◆ _close() [3/3]

qt_interface.Interface._close ( self)
protected

◆ _create_button_bar() [1/3]

qt_interface.Interface._create_button_bar ( self)
protected

◆ _create_button_bar() [2/3]

qt_interface.Interface._create_button_bar ( self)
protected

◆ _create_button_bar() [3/3]

qt_interface.Interface._create_button_bar ( self)
protected

◆ _create_statusbar() [1/3]

qt_interface.Interface._create_statusbar ( self)
protected

◆ _create_statusbar() [2/3]

qt_interface.Interface._create_statusbar ( self)
protected

◆ _create_statusbar() [3/3]

qt_interface.Interface._create_statusbar ( self)
protected

◆ _start_acquisition() [1/2]

qt_interface.Interface._start_acquisition ( self)
protected

◆ _start_acquisition() [2/2]

qt_interface.Interface._start_acquisition ( self)
protected

◆ _stop_acquisition() [1/2]

qt_interface.Interface._stop_acquisition ( self)
protected

◆ _stop_acquisition() [2/2]

qt_interface.Interface._stop_acquisition ( self)
protected

◆ _trigger_sw_trigger() [1/2]

qt_interface.Interface._trigger_sw_trigger ( self)
protected

◆ _trigger_sw_trigger() [2/2]

qt_interface.Interface._trigger_sw_trigger ( self)
protected

◆ _update_fps()

qt_interface.Interface._update_fps ( self,
val )
protected

◆ _update_gain()

qt_interface.Interface._update_gain ( self,
val )
protected

◆ change_pixel_format() [1/2]

qt_interface.Interface.change_pixel_format ( self)

◆ change_pixel_format() [2/2]

qt_interface.Interface.change_pixel_format ( self)

◆ change_slider_fps()

qt_interface.Interface.change_slider_fps ( self,
val )

◆ change_slider_gain()

qt_interface.Interface.change_slider_gain ( self,
val )

◆ done_recording()

qt_interface.Interface.done_recording ( self,
RecordingStatistics stats )

◆ information() [1/3]

qt_interface.Interface.information ( self,
str message )

◆ information() [2/3]

qt_interface.Interface.information ( self,
str message )

◆ information() [3/3]

qt_interface.Interface.information ( self,
str message )

◆ is_gui() [1/2]

qt_interface.Interface.is_gui ( self)

◆ is_gui() [2/2]

qt_interface.Interface.is_gui ( self)

◆ message() [1/3]

qt_interface.Interface.message ( self,
str typ,
str message )

◆ message() [2/3]

qt_interface.Interface.message ( self,
str typ,
str message )

◆ message() [3/3]

qt_interface.Interface.message ( self,
str type_,
str message )

◆ on_aboutqt_link_activated() [1/3]

qt_interface.Interface.on_aboutqt_link_activated ( self,
str link )

◆ on_aboutqt_link_activated() [2/3]

qt_interface.Interface.on_aboutqt_link_activated ( self,
str link )

◆ on_aboutqt_link_activated() [3/3]

qt_interface.Interface.on_aboutqt_link_activated ( self,
str link )

◆ on_image_received() [1/3]

qt_interface.Interface.on_image_received ( self,
image )

Processes the received image for the video stream.

:param image: takes an image for the video preview seen onscreen

◆ on_image_received() [2/3]

qt_interface.Interface.on_image_received ( self,
image )

Processes the received image for the video stream.

:param image: takes an image for the video preview seen onscreen

◆ on_image_received() [3/3]

qt_interface.Interface.on_image_received ( self,
image )

Processes the received image for the video stream.

:param image: takes an image for the video preview seen onscreen

◆ reenable_button()

qt_interface.Interface.reenable_button ( self)

◆ set_camera() [1/3]

qt_interface.Interface.set_camera ( self,
cam_module )

◆ set_camera() [2/3]

qt_interface.Interface.set_camera ( self,
cam_module )

◆ set_camera() [3/3]

qt_interface.Interface.set_camera ( self,
cam_module )

◆ start()

qt_interface.Interface.start ( self)

◆ start_interface() [1/3]

qt_interface.Interface.start_interface ( self)

◆ start_interface() [2/3]

qt_interface.Interface.start_interface ( self)

◆ start_interface() [3/3]

qt_interface.Interface.start_interface ( self)

◆ start_window() [1/3]

qt_interface.Interface.start_window ( self)

◆ start_window() [2/3]

qt_interface.Interface.start_window ( self)

◆ start_window() [3/3]

qt_interface.Interface.start_window ( self)

◆ warning() [1/3]

qt_interface.Interface.warning ( self,
str message )

◆ warning() [2/3]

qt_interface.Interface.warning ( self,
str message )

◆ warning() [3/3]

qt_interface.Interface.warning ( self,
str message )

Member Data Documentation

◆ __camera

qt_interface.Interface.__camera = cam_module
private

◆ __layout

qt_interface.Interface.__layout = QtWidgets.QVBoxLayout()
private

◆ __qt_instance

qt_interface.Interface.__qt_instance = qt_instance
private

◆ _button_exit

qt_interface.Interface._button_exit = None
protected

◆ _button_software_trigger

qt_interface.Interface._button_software_trigger = None
protected

◆ _button_start

qt_interface.Interface._button_start = None
protected

◆ _button_start_acquisition

qt_interface.Interface._button_start_acquisition = None
protected

◆ _button_stop_acquisition

qt_interface.Interface._button_stop_acquisition = None
protected

◆ _camera

qt_interface.Interface._camera = cam_module
protected

◆ _checkbox_save

qt_interface.Interface._checkbox_save = None
protected

◆ _close

qt_interface.Interface._close
protected

◆ _dropdown_pixel_format

qt_interface.Interface._dropdown_pixel_format = None
protected

◆ _error_cont

int qt_interface.Interface._error_cont = 0
protected

◆ _fps_label

qt_interface.Interface._fps_label = None
protected

◆ _fps_slider

qt_interface.Interface._fps_slider = None
protected

◆ _frame_count

int qt_interface.Interface._frame_count = 0
protected

◆ _gain_label

qt_interface.Interface._gain_label = None
protected

◆ _gain_slider

qt_interface.Interface._gain_slider = None
protected

◆ _label_aboutqt

qt_interface.Interface._label_aboutqt = None
protected

◆ _label_infos

qt_interface.Interface._label_infos = None
protected

◆ _label_version

qt_interface.Interface._label_version = None
protected

◆ _layout

qt_interface.Interface._layout = QtWidgets.QVBoxLayout()
protected

◆ _qt_instance

qt_interface.Interface._qt_instance = qt_instance
protected

◆ _spinbox_fps

qt_interface.Interface._spinbox_fps = QtWidgets.QDoubleSpinBox()
protected

◆ _spinbox_gain

qt_interface.Interface._spinbox_gain = QtWidgets.QDoubleSpinBox()
protected

◆ _start_acquisition

qt_interface.Interface._start_acquisition
protected
Initial value:
= QtWidgets.QPushButton(
"Start Acquisition")

◆ _stop_acquisition

qt_interface.Interface._stop_acquisition
protected
Initial value:
= QtWidgets.QPushButton(
"Stop Acquisition")

◆ _timer

qt_interface.Interface._timer = time.time()
protected

◆ _trigger_sw_trigger

qt_interface.Interface._trigger_sw_trigger
protected
Initial value:
= QtWidgets.QPushButton(
"Software Trigger")

◆ _update_fps

qt_interface.Interface._update_fps = QtWidgets.QSlider()
protected

◆ _update_gain

qt_interface.Interface._update_gain = QtWidgets.QSlider()
protected

◆ acquisition_thread

qt_interface.Interface.acquisition_thread = None

◆ change_pixel_format

qt_interface.Interface.change_pixel_format = ids_peak.NodeAccessStatus_NotImplemented

◆ change_slider_fps

qt_interface.Interface.change_slider_fps

◆ change_slider_gain

qt_interface.Interface.change_slider_gain

◆ display

qt_interface.Interface.display = None

◆ message

qt_interface.Interface.message

◆ messagebox_signal

qt_interface.Interface.messagebox_signal = QtCore.Signal((str, str))
static

◆ on_aboutqt_link_activated

qt_interface.Interface.on_aboutqt_link_activated = QtWidgets.QLabel(status_bar)

◆ recording_time

int qt_interface.Interface.recording_time = 10

◆ reenable_button

qt_interface.Interface.reenable_button

◆ start

qt_interface.Interface.start = QtWidgets.QPushButton("Start recording")

◆ start_button_signal

qt_interface.Interface.start_button_signal = QtCore.Signal()
static

◆ widget

qt_interface.Interface.widget = QtWidgets.QWidget(self)

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