Qudi
Public Member Functions | Public Attributes | List of all members
winspec_spectrometer.WinSpec32 Class Reference

Hardware module for reading spectra from the WinSpec32 spectrometer software. More...

Inheritance diagram for winspec_spectrometer.WinSpec32:
Inheritance graph
[legend]
Collaboration diagram for winspec_spectrometer.WinSpec32:
Collaboration graph
[legend]

Public Member Functions

def on_activate (self)
 Activate module.
 
def on_deactivate (self)
 Deactivate module.
 
def recordSpectrum (self)
 Record spectrum from WinSpec32 software. More...
 
def saveSpectrum (self, path, postfix='')
 Save spectrum from WinSpec32 software. More...
 
def getExposure (self)
 Get exposure. More...
 
def setExposure (self, exposureTime)
 Set exposure. 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

 expt_is_running
 
 path
 
 prefix
 
 querytime
 
 WinspecDoc
 
 WinspecDocs
 
 WinspecExpt
 
 status
 
- Public Attributes inherited from core.module.BaseMixin
 module_state
 
 connectors
 

Detailed Description

Hardware module for reading spectra from the WinSpec32 spectrometer software.

Example config for copy-paste:

spectrometer_dummy: module 'spectrometer.winspec_spectrometer.WinSpec32'

Member Function Documentation

◆ getExposure()

def winspec_spectrometer.WinSpec32.getExposure (   self)

Get exposure.

Returns
float: exposure

Not implemented.

◆ recordSpectrum()

def winspec_spectrometer.WinSpec32.recordSpectrum (   self)

Record spectrum from WinSpec32 software.

Returns
[]: spectrum data

◆ saveSpectrum()

def winspec_spectrometer.WinSpec32.saveSpectrum (   self,
  path,
  postfix = '' 
)

Save spectrum from WinSpec32 software.

Parameters
strpath: path to save origial spectrum
strpostfix: file posfix

◆ setExposure()

def winspec_spectrometer.WinSpec32.setExposure (   self,
  exposureTime 
)

Set exposure.

Parameters
floatexposureTime: exposure

Not implemented.


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