Qudi
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
spectrometer_dummy.SpectrometerInterfaceDummy Class Reference

Dummy spectrometer module. More...

Inheritance diagram for spectrometer_dummy.SpectrometerInterfaceDummy:
Inheritance graph
[legend]
Collaboration diagram for spectrometer_dummy.SpectrometerInterfaceDummy:
Collaboration graph
[legend]

Public Member Functions

def on_activate (self)
 Activate module.
 
def on_deactivate (self)
 Deactivate module.
 
def recordSpectrum (self)
 Record a dummy spectrum. More...
 
def saveSpectrum (self, path, postfix='')
 Dummy save function. More...
 
def getExposure (self)
 Get exposure time. More...
 
def setExposure (self, exposureTime)
 Set exposure time. 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

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

Static Public Attributes

 fitlogic = Connector(interface='FitLogic')
 

Detailed Description

Dummy spectrometer module.

Shows a silicon vacancy spectrum at liquid helium temperatures.

Example config for copy-paste:

spectrometer_dummy: module 'spectrometer.spectrometer_dummy.SpectrometerInterfaceDummy' fitlogic 'fitlogic' # name of the fitlogic module, see default config

Member Function Documentation

◆ getExposure()

def spectrometer_dummy.SpectrometerInterfaceDummy.getExposure (   self)

Get exposure time.

Returns
float: exposure time

◆ recordSpectrum()

def spectrometer_dummy.SpectrometerInterfaceDummy.recordSpectrum (   self)

Record a dummy spectrum.

Returns
ndarray: 1024-value ndarray containing wavelength and intensity of simulated spectrum

◆ saveSpectrum()

def spectrometer_dummy.SpectrometerInterfaceDummy.saveSpectrum (   self,
  path,
  postfix = '' 
)

Dummy save function.

Parameters
strpath: path of saved spectrum
strpostfix: postfix of saved spectrum file

◆ setExposure()

def spectrometer_dummy.SpectrometerInterfaceDummy.setExposure (   self,
  exposureTime 
)

Set exposure time.

Parameters
floatexposureTime: exposure time

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