prsctrl.measurement.settings.LaserSettings#

class LaserSettings(power_mW: float = 1.0, mode: str = 'TTL')[source]#

Bases: SettingsClass

Methods

`apply`
`as_dict`	Convenience wrapper for dataclasses.asdict(self)
`from_dict`	Recursively construct a SettingsClass from a dictionary.
`load_yaml`
`save_yaml`

Attributes

`mode`
`power_mW`

__annotations__ = {'mode': <class 'str'>, 'power_mW': <class 'float'>}#

__dataclass_fields__ = {'mode': Field(name='mode',type=<class 'str'>,default='TTL',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'power_mW': Field(name='power_mW',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD)}#

__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False,match_args=True,kw_only=False,slots=False,weakref_slot=False)#

__dict__ = mappingproxy({'__module__': 'prsctrl.measurement.settings', '__firstlineno__': 96, '__annotations__': {'power_mW': <class 'float'>, 'mode': <class 'str'>}, 'power_mW': 1.0, 'mode': 'TTL', 'apply': <function LaserSettings.apply>, '__static_attributes__': (), '__doc__': "LaserSettings(power_mW: float = 1.0, mode: str = 'TTL')", '__dataclass_params__': _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False,match_args=True,kw_only=False,slots=False,weakref_slot=False), '__dataclass_fields__': {'power_mW': Field(name='power_mW',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'mode': Field(name='mode',type=<class 'str'>,default='TTL',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD)}, '__replace__': <function _replace>, '__hash__': None, '__init__': <function LaserSettings.__init__>, '__repr__': <function LaserSettings.__repr__>, '__eq__': <function LaserSettings.__eq__>, '__match_args__': ('power_mW', 'mode')})#

__eq__(other)#: Return self==value.

__firstlineno__ = 96#

__hash__ = None#

__init__(power_mW: float = 1.0, mode: str = 'TTL') → None#

__match_args__ = ('power_mW', 'mode')#

__module__ = 'prsctrl.measurement.settings'#

__or__(other)#: Merge with another settings class or a dictionary.

__replace__(**changes)#

__repr__()#: Return repr(self).

__static_attributes__ = ()#

__weakref__#: list of weak references to the object

apply(device: Laser)[source]#

as_dict() → dict#: Convenience wrapper for dataclasses.asdict(self)

classmethod from_dict(data: dict)#

Recursively construct a SettingsClass from a dictionary. If the value of a field is another SettingsClass, from_dict will be called for that field as well. Handled are: - SettingsClass - list[SettingsClass] - dict[<any>, SettingsClass] - all of the above as Optional

Raises:

ValueError – If data contains a value that has the wrong type for the field of cls (ONLY if the type is a subclass of SettingsClass! Other types are not enforced)
KeyError – If data contains a key that is not a field name of cls

classmethod load_yaml(yaml_path: str, loader=<class 'yaml.loader.Loader'>)#

mode: str = 'TTL'#

power_mW: float = 1.0#

save_yaml(yaml_path: str)#