Qudi
Public Member Functions | List of all members
thorlabs_DCx.CameraThorlabs Class Reference

Main class of the module. More...

Inheritance diagram for thorlabs_DCx.CameraThorlabs:
Inheritance graph
[legend]
Collaboration diagram for thorlabs_DCx.CameraThorlabs:
Collaboration graph
[legend]

Public Member Functions

def on_activate (self)
 Initialisation performed during activation of the module.
 
def set_image_size (self, width=None, height=None)
 Set the size of the image, here the camera will acquire only part of the image from a given position.
 
def set_image_position (self, pos_x, pos_y)
 Set image position reference coordinate.
 
def on_deactivate (self)
 Deinitialisation performed during deactivation of the module.
 
def get_name (self)
 Return a name for the camera.
 
def get_size (self)
 Return the max size of the camera.
 
def support_live_acquisition (self)
 Return whether or not this camera support live acquisition.
 
def start_live_acquisition (self)
 Set the camera in live mode.
 
def start_single_acquisition (self)
 Start the acquisition of a single image.
 
def stop_acquisition (self)
 Stop live acquisition.
 
def get_acquired_data (self)
 Return last acquired data from the dll.
 
def get_bit_depth (self)
 Return the bit depth of the image.
 
def set_exposure (self, time)
 
def get_exposure (self)
 Return current exposure.
 
def get_ready_state (self)
 Return whether or not the camera is ready for an acquisition.
 
def set_gain (self, gain)
 Set the gain.
 
def get_gain (self)
 Get the gain.
 
- Public Member Functions inherited from core.module.BaseMixin
def __init__ (self, manager, name, config=None, callbacks=None, kwargs)
 Initialise Base class object and set up its state machine. More...
 
def log (self)
 Returns a logger object.
 
def is_module_threaded (self)
 Returns whether the module shall be started in a thread.
 
def on_activate (self)
 Method called when module is activated. More...
 
def on_deactivate (self)
 Method called when module is deactivated. More...
 
def getStatusVariables (self)
 Return a dict of variable names and their content representing the module state for saving. More...
 
def setStatusVariables (self, variableDict)
 Give a module a dict of variable names and their content representing the module state. More...
 
def getConfiguration (self)
 Return the configration dictionary for this module. More...
 
def get_connector (self, connector_name)
 Return module connected to the given named connector. More...
 
- Public Member Functions inherited from core.module.ModuleMeta
def __new__ (cls, name, bases, attrs)
 Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More...
 

Additional Inherited Members

- Public Attributes inherited from core.module.BaseMixin
 module_state
 
 connectors
 

Detailed Description

Main class of the module.

Example config for copy-paste:

thorlabs_camera: module 'camera.thorlabs.thorlabs_DCx.CameraThorlabs' default_exposure 0.1 default_gain 1.0 id_camera 0 # if more tha one camera is present


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