Hardware class to controls a High Finesse Wavemeter. More...
Inheritance diagram for high_finesse_wavemeter.HighFinesseWavemeter:
Collaboration diagram for high_finesse_wavemeter.HighFinesseWavemeter:
Public Member Functions | |
| def | __init__ (self, config, kwargs) |
| def | on_activate (self) |
| def | on_deactivate (self) |
| def | handle_wavelength (self, wavelength1, wavelength2) |
| Methods of the main class. More... | |
| def | start_acqusition (self) |
| Method to start the wavemeter software. More... | |
| def | stop_acqusition (self) |
| Stops the Wavemeter from measuring and kills the thread that queries the data. More... | |
| def | get_current_wavelength (self, kind="air") |
| This method returns the current wavelength. More... | |
| def | get_current_wavelength2 (self, kind="air") |
| This method returns the current wavelength of the second input channel. More... | |
| def | get_timing (self) |
| Get the timing of the internal measurement thread. More... | |
| def | set_timing (self, timing) |
| Set the timing of the internal measurement thread. More... | |
 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... | |
Public Attributes | |
| threadlock | |
| hardware_thread | |
| Public Attributes inherited from core.module.BaseMixin | |
| module_state | |
| connectors | |
Static Public Attributes | |
| sig_handle_timer = QtCore.Signal(bool) | |
Detailed Description
Hardware class to controls a High Finesse Wavemeter.
Example config for copy-paste:
high_finesse_wavemeter: module 'high_finesse_wavemeter.HighFinesseWavemeter' measurement_timing 10.0 # in seconds
Member Function Documentation
◆ get_current_wavelength()
| def high_finesse_wavemeter.HighFinesseWavemeter.get_current_wavelength | ( | self, | |
kind = "air" |
|||
| ) |
This method returns the current wavelength.
- Parameters
-
string kind: can either be "air" or "vac" for the wavelength in air or vacuum, respectively.
- Returns
- float: wavelength (or negative value for errors)
◆ get_current_wavelength2()
| def high_finesse_wavemeter.HighFinesseWavemeter.get_current_wavelength2 | ( | self, | |
kind = "air" |
|||
| ) |
This method returns the current wavelength of the second input channel.
- Parameters
-
string kind: can either be "air" or "vac" for the wavelength in air or vacuum, respectively.
- Returns
- float: wavelength (or negative value for errors)
◆ get_timing()
| def high_finesse_wavemeter.HighFinesseWavemeter.get_timing | ( | self | ) |
Get the timing of the internal measurement thread.
- Returns
- float: clock length in second
◆ handle_wavelength()
| def high_finesse_wavemeter.HighFinesseWavemeter.handle_wavelength | ( | self, | |
| wavelength1, | |||
| wavelength2 | |||
| ) |
Methods of the main class.
Function to save the wavelength, when it comes in with a signal.
◆ set_timing()
| def high_finesse_wavemeter.HighFinesseWavemeter.set_timing | ( | self, | |
| timing | |||
| ) |
Set the timing of the internal measurement thread.
- Parameters
-
float timing: clock length in second
- Returns
- int: error code (0:OK, -1:error)
◆ start_acqusition()
| def high_finesse_wavemeter.HighFinesseWavemeter.start_acqusition | ( | self | ) |
Method to start the wavemeter software.
- Returns
- int: error code (0:OK, -1:error)
Also the actual threaded method for getting the current wavemeter reading is started.
◆ stop_acqusition()
| def high_finesse_wavemeter.HighFinesseWavemeter.stop_acqusition | ( | self | ) |
Stops the Wavemeter from measuring and kills the thread that queries the data.
- Returns
- int: error code (0:OK, -1:error)
The documentation for this class was generated from the following file:
- hardware/high_finesse_wavemeter.py
