nomad_camels_driver_andor_shamrock_500 package

Submodules

nomad_camels_driver_andor_shamrock_500.andor_shamrock_500 module

class nomad_camels_driver_andor_shamrock_500.andor_shamrock_500.subclass(**kwargs)

Bases: Device

get_necessary_devices()

Returns a list of the devices that this device needs to function (e.g. for a PID controller).

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

Bases: Device_Config

get_config()

Returns the config_dict of the device. Overwrite this function for each device to specify the 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": )
update_dll()

nomad_camels_driver_andor_shamrock_500.andor_shamrock_500_config module

class nomad_camels_driver_andor_shamrock_500.andor_shamrock_500_config.Ui_andor_shamrock500_config

Bases: object

retranslateUi(andor_shamrock500_config)
setupUi(andor_shamrock500_config)

nomad_camels_driver_andor_shamrock_500.andor_shamrock_500_config_sub module

class nomad_camels_driver_andor_shamrock_500.andor_shamrock_500_config_sub.subclass_config_sub(config_dict=None, parent=None, settings_dict=None)

Bases: Device_Config_Sub, Ui_andor_shamrock500_config

get_config()
load_config()
staticMetaObject = PySide6.QtCore.QMetaObject("subclass_config_sub" inherits "Device_Config_Sub": )

nomad_camels_driver_andor_shamrock_500.andor_shamrock_500_manual_control module

class nomad_camels_driver_andor_shamrock_500.andor_shamrock_500_manual_control.Andor_Manual_Control(parent=None, control_data=None)

Bases: Manual_Control

change_camera_config(x, conf)
close(self) → bool
closeEvent(a0)

Overwritten, so that self.closing is emitted, telling the main UI window that this manual control is no longer opened.

continuous_spectra()
device_ready()

Called when the devices are ready to be used, i.e. when the instantiate_devices_thread is finished.

measure_spectrum()
save_spectrum()
set_grating()
set_horizontal_flip()
set_input_port()
set_input_slit_size()
set_output_port()
set_output_slit_size()
set_wavelength()
show_spectrum(wl, intensity)
start_job()
staticMetaObject = PySide6.QtCore.QMetaObject("Andor_Manual_Control" inherits "Manual_Control": )
stop_job()
update_cam_config(config_dict)
update_config(config_dict)
class nomad_camels_driver_andor_shamrock_500.andor_shamrock_500_manual_control.Andor_Manual_Control_Config(parent=None, control_data=None)

Bases: Manual_Control_Config

accept()
staticMetaObject = PySide6.QtCore.QMetaObject("Andor_Manual_Control_Config" inherits "Manual_Control_Config": )
class nomad_camels_driver_andor_shamrock_500.andor_shamrock_500_manual_control.Spectrometer_Work_Thread(parent=None, spectrometer=None)

Bases: QThread

change_camera_config(value)
continuous_function()
do_function(name, value)
job_done
measure_spectrum(value)
new_cam_config
new_spec_config
run(self) → None
set_grating(value)
set_input_port(value)
set_input_slit_size(value)
set_output_port(value)
set_output_slit_size(value)
set_wavelength(value)
spectrum_data_signal
staticMetaObject = PySide6.QtCore.QMetaObject("Spectrometer_Work_Thread" inherits "QThread": Methods:   #12 type=Signal, signature=job_done()   #13 type=Signal, signature=spectrum_data_signal(PyObject,PyObject), parameters=PyObject, PyObject   #14 type=Signal, signature=new_spec_config(QVariantMap), parameters=QVariantMap   #15 type=Signal, signature=new_cam_config(QVariantMap), parameters=QVariantMap )
update_configs()

nomad_camels_driver_andor_shamrock_500.andor_shamrock_500_ophyd module

class nomad_camels_driver_andor_shamrock_500.andor_shamrock_500_ophyd.Andor_Shamrock_500(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, spectrometer='', dll_path='', **kwargs)

Bases: Sequential_Device

Driver for the Andor Shamrock 500 spectrometer (not the camera!). The camera is implemented separately.

camera

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__

camera_function(value)
center_wavelength

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__

center_wavelength_function(value)
component_names = ('spectrum', 'wavelength', 'set_grating_number', 'center_wavelength', 'input_port', 'output_port', 'camera', 'input_slit_size', 'output_slit_size', 'horizontal_cam_flip')
finalize_steps()
get_camera_device()
get_wavelengths()
horizontal_cam_flip

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__

horizontal_cam_flip_function(value)
input_port

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__

input_port_function(value)
input_slit_size

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__

input_slit_size_function(value)
output_port

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__

output_port_function(value)
output_slit_size

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__

output_slit_size_function(value)
read_spectrum()
set_grating_number

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_grating_number_function(value)
spectrum

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__

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

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__

Module contents