nomad_camels_driver_demo_instrument package

Submodules

nomad_camels_driver_demo_instrument.demo_instrument module

class nomad_camels_driver_demo_instrument.demo_instrument.subclass(**kwargs)

Bases: Device

class nomad_camels_driver_demo_instrument.demo_instrument.subclass_config(parent=None, data='', settings_dict=None, config_dict=None, additional_info=None, **kwargs)

Bases: Device_Config

get_settings()

Updates the settings_dict with the current settings. Overwrite this function for each device to specify the settings. It is recommended to still call the super() method for the connection-settings.

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

nomad_camels_driver_demo_instrument.demo_instrument_ophyd module

class nomad_camels_driver_demo_instrument.demo_instrument_ophyd.Demo_Device(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, motor_noises=None, detector_noises=None, sigmas=None, mus=None, amps=None, set_delays=None, system_delays=None, **kwargs)

Bases: Device

component_names = ('motorX', 'motorY', 'motorZ', 'detectorX', 'detectorY', 'detectorZ', 'detectorComm')
det_func(n)
detectorComm

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__

detectorX

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__

detectorY

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__

detectorZ

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__

finalize_steps()
motorX

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__

motorY

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__

motorZ

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__

motor_func(val, motor)
motor_read_func(n)
printing_function(new_lines=True)
subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
nomad_camels_driver_demo_instrument.demo_instrument_ophyd.gauss(x, sig, a, mu)

Module contents