# -*- coding: utf-8 -*-
"""
Define camera driver classes for Thorlabs cameras via pylablibInterface
"""
import numpy as np
from .PylablibInterfaceClassDef import PylablibInterfaceClass
try :
from pylablib.devices import Photometrics
pylablibPVCAMDriverInstalled = True
except :
print('ERROR ! : Tried to load pylablib Photmetrics driver, but it is not installed')
pylablibPVCAMDriverInstalled = False
[docs]
class PhotometricsClass(PylablibInterfaceClass) :
"""Parent class for all camera Photometrics classes using pylablib python driver.
Used as generic driver class if no model-specific child class is defined in same file below"""
[docs]
def __init__(self, cameraNumber, triggerMode=0, exposurems=1,
gaindB=1, camROI=None, loadDefault = False) :
"""Initialize the Camera object
Warning:
Contrary to other camera driver allowing for search of a camera with serial number,
HERE cameraConfig['serial'] is passed as the camera index assigned by AndorSDK.
Hopefully this won't change from day to day but this could be an issue.
If this is an issue, modify the initalization procedure to connect and grab serial until found.
Contact developper if you can't solve this by yourself.
Args:
cameraNumber (int) : index of camera in camerasConfigs list
Keyword Args:
triggerMode=0 (int) : 0 for hardware/external, 1 for software/internal
exposurems=1. (float) : Exposition duration (exposure) in ms.
gaindB=0. (float) : hardware gain of the camera in dB.
camROI=None (None or [int]*4) : Camera region of interest to read from sensor
[x offset , y offset , x size , y size ] (binning is not implemented)
loadDefault = True (bool): Decide if default values from cameraConfigs should be set at creation
Return:
PhotometricsClass camera object
"""
super().__init__(cameraNumber, triggerMode=triggerMode, exposurems=exposurems,
gaindB=gaindB, camROI=camROI, loadDefault=loadDefault)
#check if pylablib and pylablib Thorlabs are installed, if no return
if not(self.cameraDriverInstalled) or not(pylablibPVCAMDriverInstalled) :
self.cameraDriverInstalled = False
return
# check if camera is here
if not( str(self.cameraConfig['serial']) in Photometrics.list_cameras() ) :
print('ERROR ! : Could not find camera '+str(cameraNumber)+' with its serial number used as name among connected cameras')
return
# here is the main camera object that will be used to access camera via driver
try :
self.pylablibCamera = Photometrics.PvcamCamera(str(self.cameraConfig['serial']))
except :
print('ERROR ! : Could not connect camera '+str(cameraNumber))
return
#checked if connected
if not(self.pylablibCamera.is_opened()) :
print('ERROR ! : Could not connect camera '+str(cameraNumber))
return
# set bitdepth as the one obtained from camera (here by default do not change the image format)
self.imageBitDepth = int(self.pylablibCamera.cav["BIT_DEPTH"])
if self.imageBitDepth != int(self.cameraConfig['imageBitDepth']) :
print('Warning ! : Overwrite Camera.imageBitDepth with the one abtained from Photometrics camera S/N '+str(self.cameraConfig['serial']))
if self.imageBitDepth <= 8 :
self.imageDtype = np.uint8
elif self.imageBitDepth <= 16 :
self.imageDtype = np.uint16
elif self.imageBitDepth <= 32:
self.imageDtype = np.uint32
else :
print('ERROR ! : Camera return bit depth larger than 32 !')
return
# set trigger mode
self.setTriggerMode(self.triggerMode)
#get min and max exposure and Set of exposure
exposuremsset = self.exposurems
try :
self.setExposurems(1.e-6) # we don't need less than that for cold atom imaging
self.exposuremsMin = self.exposurems
self.setExposurems(1.e3) # we don't need more than that for cold atom imaging
self.exposuremsMax = self.exposurems
except :
self.exposuremsMin = 1.e-6
self.exposuremsMax = 1.e3
self.setExposurems(exposuremsset)
# gaindB is set at 0 for these cameras
self.gaindBMin, self.gaindBMax = (0.,0.)
self.gaindB = 0.
# set camera ROI,
self.setCamROI(ROI=self.camROI)
# numpy image array
self.imageSize = (self.hpx,self.wpx)
self.image = np.array(self.imageSize, dtype=self.imageDtype)
# image scaling and properties
self.pixelCalXumperpx = self.cameraConfig['pixelCalXumperpx']
self.pixelCalYumperpx = self.cameraConfig['pixelCalYumperpx']
self.reversedAxes = self.cameraConfig['reversedAxes']
self.maxLevel = 2**self.imageBitDepth - 1
self.imageLimits = [-self.wpx/2*self.pixelCalXumperpx,
self.wpx/2*self.pixelCalXumperpx,
-self.hpx/2*self.pixelCalYumperpx,
self.hpx/2*self.pixelCalYumperpx]
#start acquisition
self.startAcquisition()
self.cameraConnected = True
[docs]
def __del__(self) :
"""Delete the Camera object by calling close function
Close the Camera and free memory"""
super().__del__() #ALWAYS call at end of any child class del
[docs]
def setTriggerMode(self, triggerMode):
"""Set the trigger mode
Args:
triggerMode (int) : 0 for hardware/external, 1 for software/internal
"""
# common to Icamera interface but args,kwargs depend on camera driver/model
self.triggerMode = triggerMode
if triggerMode==0:#'external'
self.pylablibCamera.set_trigger_mode('e_rise_edge')
elif triggerMode==1:#'software'
self.pylablibCamera.set_trigger_mode('e_soft_edge')
else : raise NameError('Trigger mode number not defined ')
self.startAcquisition() # restart acquisition because 'software' reset auto_start=True otherwise
[docs]
def sendSoftwareTrigger(self):
"""Send a software trigger to the camera to start an exposure"""
self.pylablibCamera.send_software_trigger()
[docs]
def setGaindB(self, gaindB) :
"""Set the hardware gain of camera readout
WARNING : Not Defined for PhotometricsClass camera .
Args:
gaindB (float) : hardware gain of the camera in dB.
"""
print("Warning : setGaindB Not Defined for PhotometricsClass camera.")
self.gaindB = 0
[docs]
def startAcquisition(self):
"""Start acquisition or restart if already running """
# common to Icamera interface but args,kwargs depend on camera driver/model
self.pylablibCamera.start_acquisition(frames_per_trigger=1, auto_start=False, nframes=20) #set buffer size to 20
class ExampleModelClass(PhotometricsClass) :
"""Model-specific class for ... Photometrics camera using pylablib python driver.
Child Class of PhotometricsClass.
Use to implement specific initialization for this camera model"""
def __init__(self, cameraNumber, triggerMode=0, exposurems=1,
gaindB=1, camROI=None, loadDefault = False) :
"""Initialize the Camera object
Args:
cameraNumber (int) : index of camera in camerasConfigs list
Keyword Args:
triggerMode=0 (int) : 0 for hardware/external, 1 for software/internal
exposurems=1. (float) : Exposition duration (exposure) in ms.
gaindB=0. (float) : hardware gain of the camera in dB.
camROI=None (None or [int]*4) : Camera region of interest to read from sensor
[x offset , y offset , x size , y size ] (binning is not implemented)
loadDefault = True (bool): Decide if default values from cameraConfigs should be set at creation
Return:
ExampleModelClass camera object
"""
super().__init__(cameraNumber, triggerMode=triggerMode, exposurems=exposurems,
gaindB=gaindB, camROI=camROI, loadDefault=loadDefault)
def __del__(self) :
"""Delete the Camera object by calling close function
Close the Camera and free memory"""
super().__del__() #ALWAYS call at end of any child class del