This interface is used to manage and visualize a simple camera. More...
Inheritance diagram for camera_interface.CameraInterface:
Collaboration diagram for camera_interface.CameraInterface:
Public Member Functions | |
| def | get_name (self) |
| Retrieve an identifier of the camera that the GUI can print. More... | |
| def | get_size (self) |
| Retrieve size of the image in pixel. More... | |
| def | support_live_acquisition (self) |
| Return whether or not the camera can take care of live acquisition. More... | |
| def | start_live_acquisition (self) |
| Start a continuous acquisition. More... | |
| def | start_single_acquisition (self) |
| Start a single acquisition. More... | |
| def | stop_acquisition (self) |
| Stop/abort live or single acquisition. More... | |
| def | get_acquired_data (self) |
| Return an array of last acquired image. More... | |
| def | set_exposure (self, exposure) |
| Set the exposure time in seconds. More... | |
| def | get_exposure (self) |
| Get the exposure time in seconds. More... | |
| def | set_gain (self, gain) |
| Set the gain. More... | |
| def | get_gain (self) |
| Get the gain. More... | |
| def | get_ready_state (self) |
| Is the camera ready for an acquisition ? More... | |
 Public Member Functions inherited from core.module.ModuleMeta | |
| def | __new__ (cls, name, bases, attrs) |
| Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More... | |
Detailed Description
This interface is used to manage and visualize a simple camera.
Member Function Documentation
◆ get_acquired_data()
| def camera_interface.CameraInterface.get_acquired_data | ( | self | ) |
Return an array of last acquired image.
- Returns
- numpy array: image data in format [[row],[row]...]
Each pixel might be a float, integer or sub pixels
◆ get_exposure()
| def camera_interface.CameraInterface.get_exposure | ( | self | ) |
Get the exposure time in seconds.
- Returns
- float exposure time
◆ get_gain()
| def camera_interface.CameraInterface.get_gain | ( | self | ) |
Get the gain.
- Returns
- float: exposure gain
◆ get_name()
| def camera_interface.CameraInterface.get_name | ( | self | ) |
Retrieve an identifier of the camera that the GUI can print.
- Returns
- string: name for the camera
◆ get_ready_state()
| def camera_interface.CameraInterface.get_ready_state | ( | self | ) |
Is the camera ready for an acquisition ?
- Returns
- bool: ready ?
◆ get_size()
| def camera_interface.CameraInterface.get_size | ( | self | ) |
Retrieve size of the image in pixel.
- Returns
- tuple: Size (width, height)
◆ set_exposure()
| def camera_interface.CameraInterface.set_exposure | ( | self, | |
| exposure | |||
| ) |
Set the exposure time in seconds.
- Parameters
-
float time: desired new exposure time
- Returns
- float: setted new exposure time
◆ set_gain()
| def camera_interface.CameraInterface.set_gain | ( | self, | |
| gain | |||
| ) |
Set the gain.
- Parameters
-
float gain: desired new gain
- Returns
- float: new exposure gain
◆ start_live_acquisition()
| def camera_interface.CameraInterface.start_live_acquisition | ( | self | ) |
Start a continuous acquisition.
- Returns
- bool: Success ?
◆ start_single_acquisition()
| def camera_interface.CameraInterface.start_single_acquisition | ( | self | ) |
Start a single acquisition.
- Returns
- bool: Success ?
◆ stop_acquisition()
| def camera_interface.CameraInterface.stop_acquisition | ( | self | ) |
Stop/abort live or single acquisition.
- Returns
- bool: Success ?
◆ support_live_acquisition()
| def camera_interface.CameraInterface.support_live_acquisition | ( | self | ) |
Return whether or not the camera can take care of live acquisition.
- Returns
- bool: True if supported, False if not
The documentation for this class was generated from the following file:
- interface/camera_interface.py
