Define the controls for a wavemeter hardware. More...
Inheritance diagram for wavemeter_interface.WavemeterInterface:
Collaboration diagram for wavemeter_interface.WavemeterInterface:
Public Member Functions | |
| 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.ModuleMeta | |
| def | __new__ (cls, name, bases, attrs) |
| Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More... | |
Detailed Description
Define the controls for a wavemeter hardware.
Member Function Documentation
◆ get_current_wavelength()
| def wavemeter_interface.WavemeterInterface.get_current_wavelength | ( | self, | |
kind = "air" |
|||
| ) |
This method returns the current wavelength.
- Parameters
-
str 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 wavemeter_interface.WavemeterInterface.get_current_wavelength2 | ( | self, | |
kind = "air" |
|||
| ) |
This method returns the current wavelength of the second input channel.
- Parameters
-
str 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 wavemeter_interface.WavemeterInterface.get_timing | ( | self | ) |
Get the timing of the internal measurement thread.
- Returns
- float: clock length in second
◆ set_timing()
| def wavemeter_interface.WavemeterInterface.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 wavemeter_interface.WavemeterInterface.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 wavemeter_interface.WavemeterInterface.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:
- interface/wavemeter_interface.py
