Qudi
Public Member Functions | Public Attributes | List of all members
lightfield_spectrometer.Lightfield Class Reference

Control Princeton Instruments Lightfield from Qudi. More...

Inheritance diagram for lightfield_spectrometer.Lightfield:
Inheritance graph
[legend]
Collaboration diagram for lightfield_spectrometer.Lightfield:
Collaboration graph
[legend]

Public Member Functions

def on_activate (self)
 Activate module. More...
 
def on_deactivate (self)
 Deactivate module. More...
 
def settingChangedCallback (self, sender, args)
 Lightfieldsettings changed. More...
 
def exitHandler (self, sender, args)
 Something went wrong, clean up. More...
 
def frameCallback (self, sender, args)
 A frame/spectrum was recorded. More...
 
def setAcquisitionComplete (self, sender, args)
 A frame/spectrum was recorded. More...
 
def getExperimentList (self)
 Get experiments configured in Lightfield.
 
def openExperiment (self, expName)
 Open experiments configured in Lightfield.
 
def buildFeatureList (self, feature)
 Get features supported by Lightfield.
 
def startAcquire (self)
 Acquire a frame/spectrum.
 
def setFilePathAndName (self, autoIncrement)
 Set the file path and name for storing recorded frame/spectrum.
 
def setBackgroundFile (self)
 Set the file path where dark image correction is stored.
 
def getROI (self)
 Get the region of interest.
 
def setROI (self)
 Set the region of interest.
 
def setShutter (self, isOpen)
 Set the camera/spectrometer shutter state.
 
def recordSpectrum (self)
 One-stop function to ecord a spectrum.
 
- 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

 au
 
 app
 
 exp
 
 prevExperimentName
 
 lastframe
 
 calibration
 
 calerrors
 
 intcal
 
- Public Attributes inherited from core.module.BaseMixin
 module_state
 
 connectors
 

Detailed Description

Control Princeton Instruments Lightfield from Qudi.

This hardware module needs a brave soul fluent in C# and Python, as it can only do one thing right now: crash Lightfield.

Example config for copy-paste:

lightfield_spectrometer: module 'spectrometer.lightfield_spectrometer.Lightfield'

Member Function Documentation

◆ exitHandler()

def lightfield_spectrometer.Lightfield.exitHandler (   self,
  sender,
  args 
)

Something went wrong, clean up.

◆ frameCallback()

def lightfield_spectrometer.Lightfield.frameCallback (   self,
  sender,
  args 
)

A frame/spectrum was recorded.

◆ on_activate()

def lightfield_spectrometer.Lightfield.on_activate (   self)

Activate module.

This method needs to set ip the CLR to Python binding and start Lightfield.

◆ on_deactivate()

def lightfield_spectrometer.Lightfield.on_deactivate (   self)

Deactivate module.

◆ setAcquisitionComplete()

def lightfield_spectrometer.Lightfield.setAcquisitionComplete (   self,
  sender,
  args 
)

A frame/spectrum was recorded.

◆ settingChangedCallback()

def lightfield_spectrometer.Lightfield.settingChangedCallback (   self,
  sender,
  args 
)

Lightfieldsettings changed.


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