_SDK3Cam.py

Go to the documentation of this file.

#!/usr/bin/env python3
 
 
 
from microscope.cameras import _SDK3 as SDK3
 
 
class ATProperty:
    def connect(self, handle, propertyName):
        self.handle = handle
        self.propertyName = propertyName
 
    def isImplemented(self):
        return SDK3.IsImplemented(self.handle, self.propertyName).value
 
    def isReadable(self):
        return SDK3.IsReadable(self.handle, self.propertyName).value
 
    def isWritable(self):
        return SDK3.IsWritable(self.handle, self.propertyName).value
 
    def isReadOnly(self):
        return SDK3.IsReadOnly(self.handle, self.propertyName).value
 
 
class ATInt(ATProperty):
    def getValue(self):
        return SDK3.GetInt(self.handlehandle, self.propertyNamepropertyName).value
 
    def setValue(self, val):
        SDK3.SetInt(self.handlehandle, self.propertyNamepropertyName, val)
 
    def max(self):
        return SDK3.GetIntMax(self.handlehandle, self.propertyNamepropertyName).value
 
    def min(self):
        return SDK3.GetIntMin(self.handlehandle, self.propertyNamepropertyName).value
 
 
class ATBool(ATProperty):
    def getValue(self):
        return SDK3.GetBool(self.handlehandle, self.propertyNamepropertyName).value > 0
 
    def setValue(self, val):
        SDK3.SetBool(self.handlehandle, self.propertyNamepropertyName, val)
 
 
class ATFloat(ATProperty):
    def getValue(self):
        return SDK3.GetFloat(self.handlehandle, self.propertyNamepropertyName).value
 
    def setValue(self, val):
        SDK3.SetFloat(self.handlehandle, self.propertyNamepropertyName, val)
 
    def max(self):
        return SDK3.GetFloatMax(self.handlehandle, self.propertyNamepropertyName).value
 
    def min(self):
        return SDK3.GetFloatMin(self.handlehandle, self.propertyNamepropertyName).value
 
 
class ATString(ATProperty):
    def getValue(self):
        return SDK3.GetString(self.handlehandle, self.propertyNamepropertyName, 255).value
 
    def setValue(self, val):
        SDK3.SetString(self.handlehandle, self.propertyNamepropertyName, val)
 
    def maxLength(self):
        return SDK3.GetStringMaxLength(self.handlehandle, self.propertyNamepropertyName).value
 
 
class ATEnum(ATProperty):
    def getIndex(self):
        return SDK3.GetEnumIndex(self.handlehandle, self.propertyNamepropertyName).value
 
    def setIndex(self, val):
        SDK3.SetEnumIndex(self.handlehandle, self.propertyNamepropertyName, val)
 
    def getString(self):
        return self.__getitem__(self.getIndex())
 
    def setString(self, val):
        SDK3.SetEnumString(self.handlehandle, self.propertyNamepropertyName, val)
 
    def __len__(self):
        return SDK3.GetEnumCount(self.handlehandle, self.propertyNamepropertyName).value
 
    def __getitem__(self, key):
        return SDK3.GetEnumStringByIndex(
            self.handlehandle, self.propertyNamepropertyName, key, 255
        ).value
 
    def getAvailableValues(self):
        n = SDK3.GetEnumCount(self.handlehandle, self.propertyNamepropertyName).value
        return [
            SDK3.GetEnumStringByIndex(
                self.handlehandle, self.propertyNamepropertyName, i, 255
            ).value
            for i in range(n)
            if SDK3.IsEnumIndexAvailable(
                self.handlehandle, self.propertyNamepropertyName, i
            ).value
        ]
 
    def getAvailableValueMap(self):
        n = SDK3.GetEnumCount(self.handlehandle, self.propertyNamepropertyName).value
        return {
            i: SDK3.GetEnumStringByIndex(
                self.handlehandle, self.propertyNamepropertyName, i, 255
            ).value
            for i in range(n)
            if SDK3.IsEnumIndexAvailable(
                self.handlehandle, self.propertyNamepropertyName, i
            ).value
        }
 
 
class ATCommand(ATProperty):
    def __call__(self):
        return SDK3.Command(self.handlehandle, self.propertyNamepropertyName)
 
 
class camReg:
    # keep track of the number of cameras initialised so we can initialise and finalise the library
    numCameras = 0
 
    @classmethod
    def regCamera(cls):
        if cls.numCameras == 0:
            SDK3.InitialiseLibrary()
 
        cls.numCameras += 1
 
    @classmethod
    def unregCamera(cls):
        cls.numCameras -= 1
        if cls.numCameras == 0:
            SDK3.FinaliseLibrary()
 
 
# make sure the library is intitalised
camReg.regCamera()
 
 
def GetNumCameras():
    return SDK3.GetInt(SDK3.AT_HANDLE_SYSTEM, "DeviceCount").value
 
 
def GetSoftwareVersion():
    return SDK3.GetString(SDK3.AT_HANDLE_SYSTEM, "SoftwareVersion", 255)
 
 
class SDK3Camera:
    def __init__(self, camNum):
        """camera initialisation - note that this should be called  from derived classes
        *AFTER* the properties have been defined"""
        # camReg.regCamera() #initialise the library if needed
        self.camNum = camNum
 
    def Init(self):
        self.handle = SDK3.Open(self.camNum)
        self.connectProperties()
 
    def connectProperties(self):
        for name, var in self.__dict__.items():
            if isinstance(var, ATProperty):
                var.connect(self.handle, name)
 
    def shutdown(self):
        SDK3.Close(self.handle)
        # camReg.unregCamera()