nomad_camels_driver_cam_control_pylablib package

Submodules

nomad_camels_driver_cam_control_pylablib.cam_control_pylablib module

class nomad_camels_driver_cam_control_pylablib.cam_control_pylablib.subclass(**kwargs): Bases: Device

class nomad_camels_driver_cam_control_pylablib.cam_control_pylablib.subclass_config(parent=None, data='', settings_dict=None, config_dict=None, additional_info=None)

Bases: Simple_Config

staticMetaObject = PySide6.QtCore.QMetaObject("subclass_config" inherits "Simple_Config": )

nomad_camels_driver_cam_control_pylablib.cam_control_pylablib_ophyd module

class nomad_camels_driver_cam_control_pylablib.cam_control_pylablib_ophyd.Cam_Control_Pylablib(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, host_ip='127.0.0.1', port=18923, byte_length=9000000, overwrite_exposure_time=True, **kwargs)

Bases: Device

complete_settings

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

cls (class) –
Class of signal to create. The required signature of cls.__init__ is (if suffix is given):
```
def __init__(self, pv_name, parent=None, **kwargs):
```
or (if suffix is None)
```
def __init__(self, parent=None, **kwargs):
```
The class may have a wait_for_connection() which is called during the component instance creation.
suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix
lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.
trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.
add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )
doc (str, optional) – string to attach to component DvcClass.component.__doc__

complete_settings_function()

component_names = ('exposure_time', 'path_suffix', 'frame_average', 'get_single_frame', 'get_background_frame', 'complete_settings', 'set_roi')

exposure_time

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

cls (class) –
Class of signal to create. The required signature of cls.__init__ is (if suffix is given):
```
def __init__(self, pv_name, parent=None, **kwargs):
```
or (if suffix is None)
```
def __init__(self, parent=None, **kwargs):
```
The class may have a wait_for_connection() which is called during the component instance creation.
suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix
lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.
trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.
add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )
doc (str, optional) – string to attach to component DvcClass.component.__doc__

exposure_time_function(exposure_time=100)

finalize_steps()

frame_average

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

cls (class) –
Class of signal to create. The required signature of cls.__init__ is (if suffix is given):
```
def __init__(self, pv_name, parent=None, **kwargs):
```
or (if suffix is None)
```
def __init__(self, parent=None, **kwargs):
```
The class may have a wait_for_connection() which is called during the component instance creation.
suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix
lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.
trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.
add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )
doc (str, optional) – string to attach to component DvcClass.component.__doc__

frame_average_function()

get_background_frame

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

cls (class) –
Class of signal to create. The required signature of cls.__init__ is (if suffix is given):
```
def __init__(self, pv_name, parent=None, **kwargs):
```
or (if suffix is None)
```
def __init__(self, parent=None, **kwargs):
```
The class may have a wait_for_connection() which is called during the component instance creation.
suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix
lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.
trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.
add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )
doc (str, optional) – string to attach to component DvcClass.component.__doc__

get_background_frame_function()

get_single_frame

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

cls (class) –
Class of signal to create. The required signature of cls.__init__ is (if suffix is given):
```
def __init__(self, pv_name, parent=None, **kwargs):
```
or (if suffix is None)
```
def __init__(self, parent=None, **kwargs):
```
The class may have a wait_for_connection() which is called during the component instance creation.
suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix
lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.
trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.
add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )
doc (str, optional) – string to attach to component DvcClass.component.__doc__

get_single_frame_function()

grab_background()

path_suffix

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

cls (class) –
Class of signal to create. The required signature of cls.__init__ is (if suffix is given):
```
def __init__(self, pv_name, parent=None, **kwargs):
```
or (if suffix is None)
```
def __init__(self, parent=None, **kwargs):
```
The class may have a wait_for_connection() which is called during the component instance creation.
suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix
lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.
trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.
add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )
doc (str, optional) – string to attach to component DvcClass.component.__doc__

save_snapshot()

set_roi

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

cls (class) –
Class of signal to create. The required signature of cls.__init__ is (if suffix is given):
```
def __init__(self, pv_name, parent=None, **kwargs):
```
or (if suffix is None)
```
def __init__(self, parent=None, **kwargs):
```
The class may have a wait_for_connection() which is called during the component instance creation.
suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix
lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.
trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.
add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )
doc (str, optional) – string to attach to component DvcClass.component.__doc__

set_roi_function(value)

start_saving()

stop_saving()

subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

nomad_camels_driver_cam_control_pylablib package

Submodules

nomad_camels_driver_cam_control_pylablib.cam_control_pylablib module

nomad_camels_driver_cam_control_pylablib.cam_control_pylablib_ophyd module

Module contents