mecheye.shared.RoiArrayParameter

class mecheye.shared.RoiArrayParameter(*args, **kwargs)

Typed roi array device parameter.

get_value()

Return (status, value) for this typed parameter.

Check the status before reading the value.

_Bool = 2
_Enum = 3
_Float = 1
_FloatArray = 6
_Int = 0
_ProfileRoi = 8
_Range = 5
_Roi = 4
_RoiArray = 7
classmethod convert_from_parameter(param)

Return a typed view when param has this subclass’s parameter kind.

Parameters:

param – A Parameter handle or None.

Returns:

A typed handle, or None if the handle is absent or its kind differs.

Raises:

TypeError – A non-Parameter value is supplied.

description()

Return the SDK-provided description for this parameter.

is_readable()

Return whether the parameter is currently readable.

is_writable()

Return whether the parameter is currently writable.

name()

Return the device parameter’s SDK identifier.

type()

Return the Parameter._* type identifier.