microscope.cameras.pvcam.PVParam Class Reference

Inheritance diagram for microscope.cameras.pvcam.PVParam:

Public Member Functions
def	__init__ (self, camera, param_id)
def	set_value (self, new_value)
def	access (self)
def	available (self)
def	count (self)
def	values (self)
def	current (self)

Static Public Member Functions
def	factory (camera, param_id)

Public Attributes
	cam
	param_id
	name
	dtype

Detailed Description

A wrapper around PVCAM parameters.

Definition at line 1199 of file pvcam.py.

Constructor & Destructor Documentation

__init__()

def microscope.cameras.pvcam.PVParam.__init__	(		self,
			camera,
			param_id
	)

Definition at line 1224 of file pvcam.py.

    def __init__(self, camera, param_id):
        # Use a weakref back to the camera to avoid circular dependency.
        self.cam = weakref.proxy(camera)
        self.param_id = param_id
        self.name = _param_to_name[param_id]
        self._pvtype = param_id >> 24 & 255
        if self.name == "PARAM_READOUT_TIME":
            # Bugged. Here is what the SDK says: "The parameter type is
            # incorrectly defined. The actual type is TYPE_UNS32."
            self._pvtype = TYPE_UNS32
        self.dtype = _dtypemap[self._pvtype]
        self._ctype = _typemap[self._pvtype]
        self.__cache = {}
 

Member Function Documentation

access()

def microscope.cameras.pvcam.PVParam.access

(

self

)

Return parameter access attribute.

Definition at line 1303 of file pvcam.py.

    def access(self):
        """Return parameter access attribute."""
        return int(
            _get_param(self.cam.handle, self.param_id, ATTR_ACCESS).value
        )
 

References microscope.cameras.pvcam.PVParam.cam, and microscope.cameras.pvcam.PVParam.param_id.

available()

def microscope.cameras.pvcam.PVParam.available

(

self

)

Return whether or not parameter is available on hardware.

Definition at line 1310 of file pvcam.py.

    def available(self):
        """Return whether or not parameter is available on hardware."""
        return bool(
            _get_param(self.cam.handle, self.param_id, ATTR_AVAIL).value
        )
 

References microscope.cameras.pvcam.PVParam.cam, and microscope.cameras.pvcam.PVParam.param_id.

Referenced by microscope.cameras.pvcam.PVParam.set_value().

count()

def microscope.cameras.pvcam.PVParam.count

(

self

)

Return count of parameter enum entries.

Definition at line 1317 of file pvcam.py.

    def count(self):
        """Return count of parameter enum entries."""
        return int(
            _get_param(self.cam.handle, self.param_id, ATTR_COUNT).value
        )
 

References microscope.cameras.pvcam.PVParam.cam, and microscope.cameras.pvcam.PVParam.param_id.

Referenced by microscope.device_server.Filter.filter(), and microscope.cameras.pvcam.PVEnumParam.values().

current()

def microscope.cameras.pvcam.PVParam.current

(

self

)

Return the current (or cached) parameter value.

Subclasses should override this for more complex data types.

Reimplemented in microscope.cameras.pvcam.PVEnumParam, and microscope.cameras.pvcam.PVStringParam.

Definition at line 1331 of file pvcam.py.

    def current(self):
        """Return the current (or cached) parameter value.
 
        Subclasses should override this for more complex data types."""
        return self._query()
 
 

References microscope.cameras.pvcam.PVParam._query().

factory()

def microscope.cameras.pvcam.PVParam.factory (   camera,   param_id  )

static

Create a PVParam or appropriate subclass

Definition at line 1203 of file pvcam.py.

    def factory(camera, param_id):
        """Create a PVParam or appropriate subclass"""
        # A mapping of pv parameters types to python types.
        #   None means unsupported.
        #   Parameters omitted from the mapping will default to PVParam.
        __types__ = {
            TYPE_SMART_STREAM_TYPE: None,
            TYPE_SMART_STREAM_TYPE_PTR: None,
            TYPE_VOID_PTR: None,
            TYPE_VOID_PTR_PTR: None,
            TYPE_ENUM: PVEnumParam,
            TYPE_CHAR_PTR: PVStringParam,
        }
        # Determine the appropiate type from its id.
        pvtype = __types__.get(param_id >> 24 & 255, PVParam)
        if pvtype is None:
            raise microscope.LibraryLoadError(
                "Parameter %s not supported" % _param_to_name[param_id]
            )
        return pvtype(camera, param_id)
 

References microscope.cameras.pvcam.PVParam.__cache, microscope.cameras.pvcam.PVParam._ctype, microscope.cameras.pvcam.PVParam._pvtype, microscope.cameras.pvcam.PVParam.cam, microscope.abc._Setting.dtype, microscope.cameras.pvcam.PVParam.dtype, microscope.abc._Setting.name, microscope.cameras._SDK3.dllFunction.name, microscope.cameras.atmcd.dllFunction.name, microscope.cameras.pvcam.dllFunction.name, microscope.cameras.pvcam.PVParam.name, BioImager.Automation.Action.name, BioImager.Automation.Recording.name, BioImager.Filt.name, BioImager.Function.name, BioImager.ImageJ.RoiDecoder.name, BioImager.LightSource.name, BioImager.Plot.name, BioImager.Scripting.Script.name, and microscope.cameras.pvcam.PVParam.param_id.

set_value()

def microscope.cameras.pvcam.PVParam.set_value	(		self,
			new_value
	)

Set a parameter value.

Subclasses should do whatever processing they need on new_value,
then call super().set_value(new_value)

Reimplemented in microscope.cameras.pvcam.PVEnumParam, and microscope.cameras.pvcam.PVStringParam.

Definition at line 1238 of file pvcam.py.

    def set_value(self, new_value):
        """Set a parameter value.
 
        Subclasses should do whatever processing they need on new_value,
        then call super().set_value(new_value)"""
        try:
            ref = ctypes.byref(new_value)
        except TypeError:
            # Need to convert python type to ctype first.
            ref = ctypes.byref(self._ctype(new_value))
        _set_param(self.cam.handle, self.param_id, ref)
        # Read back the value to update cache.
        self._query(force_query=True)
 

References microscope.cameras.pvcam.PVParam.__cache, microscope.cameras.pvcam.PVParam._ctype, microscope.cameras.pvcam.PVParam._query(), microscope.cameras.pvcam.PVParam.available(), microscope.cameras.pvcam.PVParam.cam, microscope.abc._Setting.name, microscope.cameras._SDK3.dllFunction.name, microscope.cameras.atmcd.dllFunction.name, microscope.cameras.pvcam.dllFunction.name, microscope.cameras.pvcam.PVParam.name, BioImager.Automation.Action.name, BioImager.Automation.Recording.name, BioImager.Filt.name, BioImager.Function.name, BioImager.ImageJ.RoiDecoder.name, BioImager.LightSource.name, BioImager.Plot.name, BioImager.Scripting.Script.name, microscope.cameras.pvcam.PVParam.param_id, and microscope.cameras.pvcam.PVParam.set_value().

Referenced by microscope.stages.linkam._LinkamMDSMixin.move_to(), microscope.stages.linkam.LinkamCMS.refill_chamber(), microscope.stages.linkam.LinkamCMS.refill_dewar(), microscope.stages.linkam.LinkamCMS.set_condensor(), microscope.stages.linkam.LinkamCMS.set_light(), and microscope.cameras.pvcam.PVParam.set_value().

values()

def microscope.cameras.pvcam.PVParam.values

(

self

)

Get parameter min and max values.

Subclasses for strings and enum override this.

Reimplemented in microscope.cameras.pvcam.PVEnumParam, and microscope.cameras.pvcam.PVStringParam.

Definition at line 1324 of file pvcam.py.

    def values(self):
        """Get parameter min and max values.
 
        Subclasses for strings and enum override this."""
        return (self._query(ATTR_MIN), self._query(ATTR_MAX))
 

References microscope.cameras.pvcam.PVParam._query().

Referenced by microscope.cameras.pvcam.PVEnumParam.set_value().

Member Data Documentation

cam

microscope.cameras.pvcam.PVParam.cam

Definition at line 1226 of file pvcam.py.

Referenced by microscope.cameras.pvcam.PVParam.access(), microscope.cameras.pvcam.PVParam.available(), microscope.cameras.pvcam.PVParam.count(), microscope.cameras.pvcam.PVParam.factory(), microscope.cameras.pvcam.PVParam.set_value(), and microscope.cameras.pvcam.PVEnumParam.values().

dtype

microscope.cameras.pvcam.PVParam.dtype

Definition at line 1234 of file pvcam.py.

Referenced by microscope.cameras.pvcam.PVParam.factory(), and microscope.abc._Setting.set().

name

microscope.cameras.pvcam.PVParam.name

Definition at line 1228 of file pvcam.py.

Referenced by microscope.cameras.pvcam.PVParam.factory(), microscope.cameras.pvcam.PVParam.set_value(), and microscope.cameras.pvcam.PVEnumParam.set_value().

param_id

microscope.cameras.pvcam.PVParam.param_id

Definition at line 1227 of file pvcam.py.

Referenced by microscope.cameras.pvcam.PVParam.access(), microscope.cameras.pvcam.PVParam.available(), microscope.cameras.pvcam.PVParam.count(), microscope.cameras.pvcam.PVParam.factory(), microscope.cameras.pvcam.PVParam.set_value(), microscope.cameras.pvcam.PVEnumParam.values(), and microscope.cameras.pvcam.PVStringParam.values().

---

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

• F:/repos/BioImager/BioImager/PythonMicroscope/microscope/cameras/pvcam.py