title – The experiment title
procedure – The procedure object
analyse – Post-analysis function, which takes a pandas dataframe as input and
│ │ │ returns it with added (analysed) columns. The analysed results are accessible via
│ │ │ -experiment.data, as opposed to experiment.results.data for the ‘raw’ data. (default: <function Experiment.<lambda> at 0x7f8384fc3a00>)
<function Experiment.<lambda> at 0x7f7a96c7ba00>)
│ │ │ _data_timeout – Time limit for how long live plotting should wait for datapoints.
timeout – The maximum time the waiting is allowed to take. If
│ │ │ timeout is exceeded, a TimeoutError is raised. If
│ │ │ timeout is set to zero, no timeout will be used. (default: 3600)
should_stop – Optional function (returning a bool) to allow the
│ │ │ -waiting to be stopped before its end. (default: <function Agilent33220A.<lambda> at 0x7f83848ea8d0>)
<function Agilent33220A.<lambda> at 0x7f7a965bbe20>)
│ │ │ timeout – The maximum time the waiting is allowed to take. If
│ │ │ timeout is exceeded, a TimeoutError is raised. If
│ │ │ timeout is set to zero, no timeout will be used. (default: 3600)
should_stop – Optional function (returning a bool) to allow the
│ │ │ -waiting to be stopped before its end. (default: <function Agilent33500.<lambda> at 0x7f83849473d0>)
<function Agilent33500.<lambda> at 0x7f7a965e89e0>)
│ │ │ Blocks the process until the current has stabilized. A
│ │ │ provided function has_aborted can be supplied, which
│ │ │ is checked after each delay time (in seconds) in addition to the
│ │ │ stability check. This allows an abort feature to be integrated.
has_aborted – A function that returns True if the process should stop waiting (default: <function Danfysik8500.<lambda> at 0x7f838050b950>)
has_aborted – A function that returns True if the process should stop waiting (default: <function Danfysik8500.<lambda> at 0x7f7a921b7480>)
delay – The delay time in seconds between each check for stability (default: 0.01)
Blocks the process until the instrument is ready. A
│ │ │ provided function has_aborted can be supplied, which
│ │ │ is checked after each delay time (in seconds) in addition to the
│ │ │ readiness check. This allows an abort feature to be integrated.
has_aborted – A function that returns True if the process should stop waiting (default: <function Danfysik8500.<lambda> at 0x7f838050bc10>)
has_aborted – A function that returns True if the process should stop waiting (default: <function Danfysik8500.<lambda> at 0x7f7a921b7740>)
delay – The delay time in seconds between each check for readiness (default: 0.01)
get_command (str | None) – A string command that asks for the value, set to None
│ │ │ if get is not supported (see also setting()).
set_command (str | None) – A string command that writes the value, set to None
│ │ │ if set is not supported (see also measurement()).
docs (str) – A docstring that will be included in the documentation
validator (Callable[[Any, TypeVar(Vs)], TypeVar(V2)]) – A function that takes both a value and a group of valid values
│ │ │ -and returns a valid value, while it otherwise raises an exception (default: <function CommonBase.<lambda> at 0x7f8390f66da0>)
<function CommonBase.<lambda> at 0x7f7aa2a8eda0>)
│ │ │ values (TypeVar(Vs)) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
get_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f66e50>)
get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f8390f66f00>)
<function CommonBase.<lambda> at 0x7f7aa2a8ee50>)
│ │ │ +get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f7aa2a8ef00>)
set_process (Callable[[TypeVar(V2)], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f66fb0>)
<function CommonBase.<lambda> at 0x7f7aa2a8efb0>)
│ │ │ command_process (Callable | None) –
A function that takes a command and allows processing │ │ │ before executing the command
│ │ │Deprecated since version 0.12: Use a dynamic property instead. (default: None)
check_set_errors (bool) – Toggles checking errors after setting (default: False)
get_command (str) – A string command that asks for the value
docs (str) – A docstring that will be included in the documentation
values (Any) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
get_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f671c0>)
get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f8390f67270>)
<function CommonBase.<lambda> at 0x7f7aa2a8f1c0>)
│ │ │ +get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f7aa2a8f270>)
command_process (Callable | None) –
A function that take a command and allows processing │ │ │ before executing the command, for getting
│ │ │Deprecated since version 0.12: Use a dynamic property instead. (default: None)
check_get_errors (bool) – Toggles checking errors after getting (default: False)
set_command (str) – A string command that writes the value
docs (str) – A docstring that will be included in the documentation
validator (Callable[[Any, TypeVar(Vs)], Any]) – A function that takes both a value and a group of valid values
│ │ │ -and returns a valid value, while it otherwise raises an exception (default: <function CommonBase.<lambda> at 0x7f8390f67480>)
<function CommonBase.<lambda> at 0x7f7aa2a8f480>)
│ │ │ values (TypeVar(Vs)) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
set_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f67530>)
<function CommonBase.<lambda> at 0x7f7aa2a8f530>)
│ │ │ check_set_errors (bool) – Toggles checking errors after setting (default: False)
dynamic (bool) – Specify whether the property parameters are meant to be changed in
│ │ │ instances or subclasses. See control() for an usage example. (default: False)
property | DynamicProperty
Block the program, waiting for a full buffer. This function
│ │ │ returns early if the should_stop function returns True or
│ │ │ the timeout is reached before the buffer is full.
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f837c49d7a0>)
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f7a8df4d6f0>)
timeout – A time in seconds after which this function should return early (default: 60)
interval – A time in seconds for how often to check if the buffer is full (default: 0.1)
Block the program, waiting for a full buffer. This function
│ │ │ returns early if the should_stop function returns True or
│ │ │ the timeout is reached before the buffer is full.
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f837c49d7a0>)
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f7a8df4d6f0>)
timeout – A time in seconds after which this function should return early (default: 60)
interval – A time in seconds for how often to check if the buffer is full (default: 0.1)
Block the program, waiting for a full buffer. This function
│ │ │ returns early if the should_stop function returns True or
│ │ │ the timeout is reached before the buffer is full.
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f837c49d7a0>)
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f7a8df4d6f0>)
timeout – A time in seconds after which this function should return early (default: 60)
interval – A time in seconds for how often to check if the buffer is full (default: 0.1)
Block the program, waiting for a full buffer. This function
│ │ │ returns early if the should_stop function returns True or
│ │ │ the timeout is reached before the buffer is full.
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f837c49d7a0>)
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f7a8df4d6f0>)
timeout – A time in seconds after which this function should return early (default: 60)
interval – A time in seconds for how often to check if the buffer is full (default: 0.1)
Block the program, waiting for a full buffer. This function
│ │ │ returns early if the should_stop function returns True or
│ │ │ the timeout is reached before the buffer is full.
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f837c49d7a0>)
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f7a8df4d6f0>)
timeout – A time in seconds after which this function should return early (default: 60)
interval – A time in seconds for how often to check if the buffer is full (default: 0.1)
Block the program, waiting for a full buffer. This function
│ │ │ returns early if the should_stop function returns True or
│ │ │ the timeout is reached before the buffer is full.
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f837c49d7a0>)
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f7a8df4d6f0>)
timeout – A time in seconds after which this function should return early (default: 60)
interval – A time in seconds for how often to check if the buffer is full (default: 0.1)
Block the program, waiting for the temperature to stabilize at the temperature setpoint.
│ │ │tolerance – Maximum allowed deviation from temperature setpoint,
│ │ │ in degrees Centigrade. (default: 0.1)
period – Time period over which stability is checked, in seconds. (default: 10)
should_stop – Function that returns True to stop waiting. (default: <function Keithley2510.<lambda> at 0x7f837c1e2140>)
should_stop – Function that returns True to stop waiting. (default: <function Keithley2510.<lambda> at 0x7f7a8de8a090>)
timeout – Maximum waiting time, in seconds. (default: 60)
True when stable, False if stopped by should_stop.
│ │ │Block the program, waiting for a full buffer. This function
│ │ │ returns early if the should_stop function returns True or
│ │ │ the timeout is reached before the buffer is full.
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f837c49d7a0>)
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f7a8df4d6f0>)
timeout – A time in seconds after which this function should return early (default: 60)
interval – A time in seconds for how often to check if the buffer is full (default: 0.1)
Block the program, waiting for a full buffer. This function
│ │ │ returns early if the should_stop function returns True or
│ │ │ the timeout is reached before the buffer is full.
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f837c49d7a0>)
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f7a8df4d6f0>)
timeout – A time in seconds after which this function should return early (default: 60)
interval – A time in seconds for how often to check if the buffer is full (default: 0.1)
Block the program, waiting for a full buffer. This function
│ │ │ returns early if the should_stop function returns True or
│ │ │ the timeout is reached before the buffer is full.
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f837c49d7a0>)
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f7a8df4d6f0>)
timeout – A time in seconds after which this function should return early (default: 60)
interval – A time in seconds for how often to check if the buffer is full (default: 0.1)
Block the program, waiting for a full buffer. This function
│ │ │ returns early if the should_stop function returns True or
│ │ │ the timeout is reached before the buffer is full.
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f837c49d7a0>)
should_stop – A function that returns True when this function should return early (default: <function KeithleyBuffer.<lambda> at 0x7f7a8df4d6f0>)
timeout – A time in seconds after which this function should return early (default: 60)
interval – A time in seconds for how often to check if the buffer is full (default: 0.1)
Wait until the triggering has finished.
│ │ │The method sends *OPC? and waits until the instrument returns "1".
timeout (float | None) – Maximum number of seconds to wait. None waits indefinitely. (default: None)
should_stop (Callable[[], bool]) – Callback returning True to abort waiting early. (default: <function Keysight33250A.<lambda> at 0x7f837a3c19b0>)
should_stop (Callable[[], bool]) – Callback returning True to abort waiting early. (default: <function Keysight33250A.<lambda> at 0x7f7a8c009220>)
TimeoutError – If timeout is not None and expires before completion.
None
get_command (str | None) – A string command that asks for the value, set to None
│ │ │ if get is not supported (see also setting()).
set_command (str | None) – A string command that writes the value, set to None
│ │ │ if set is not supported (see also measurement()).
docs (str) – A docstring that will be included in the documentation
validator (Callable[[Any, TypeVar(Vs)], TypeVar(V2)]) – A function that takes both a value and a group of valid values
│ │ │ -and returns a valid value, while it otherwise raises an exception (default: <function CommonBase.<lambda> at 0x7f8390f66da0>)
<function CommonBase.<lambda> at 0x7f7aa2a8eda0>)
│ │ │ values (TypeVar(Vs)) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
get_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f66e50>)
get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f8390f66f00>)
<function CommonBase.<lambda> at 0x7f7aa2a8ee50>)
│ │ │ +get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f7aa2a8ef00>)
set_process (Callable[[TypeVar(V2)], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f66fb0>)
<function CommonBase.<lambda> at 0x7f7aa2a8efb0>)
│ │ │ command_process (Callable | None) –
A function that takes a command and allows processing │ │ │ before executing the command
│ │ │Deprecated since version 0.12: Use a dynamic property instead. (default: None)
check_set_errors (bool) – Toggles checking errors after setting (default: False)
get_command (str) – A string command that asks for the value
docs (str) – A docstring that will be included in the documentation
values (Any) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
get_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f671c0>)
get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f8390f67270>)
<function CommonBase.<lambda> at 0x7f7aa2a8f1c0>)
│ │ │ +get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f7aa2a8f270>)
command_process (Callable | None) –
A function that take a command and allows processing │ │ │ before executing the command, for getting
│ │ │Deprecated since version 0.12: Use a dynamic property instead. (default: None)
check_get_errors (bool) – Toggles checking errors after getting (default: False)
set_command (str) – A string command that writes the value
docs (str) – A docstring that will be included in the documentation
validator (Callable[[Any, TypeVar(Vs)], Any]) – A function that takes both a value and a group of valid values
│ │ │ -and returns a valid value, while it otherwise raises an exception (default: <function CommonBase.<lambda> at 0x7f8390f67480>)
<function CommonBase.<lambda> at 0x7f7aa2a8f480>)
│ │ │ values (TypeVar(Vs)) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
set_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f67530>)
<function CommonBase.<lambda> at 0x7f7aa2a8f530>)
│ │ │ check_set_errors (bool) – Toggles checking errors after setting (default: False)
dynamic (bool) – Specify whether the property parameters are meant to be changed in
│ │ │ instances or subclasses. See control() for an usage example. (default: False)
property | DynamicProperty
timeout – The maximum time the waiting is allowed to take. If
│ │ │ timeout is exceeded, a TimeoutError is raised. If
│ │ │ timeout is set to zero, no timeout will be used. (default: 3600)
should_stop – Optional function (returning a bool) to allow the
│ │ │ -waiting to be stopped before its end. (default: <function Agilent33500.<lambda> at 0x7f83849473d0>)
<function Agilent33500.<lambda> at 0x7f7a965e89e0>)
│ │ │ get_command (str | None) – A string command that asks for the value, set to None
│ │ │ if get is not supported (see also setting()).
set_command (str | None) – A string command that writes the value, set to None
│ │ │ if set is not supported (see also measurement()).
docs (str) – A docstring that will be included in the documentation
validator (Callable[[Any, TypeVar(Vs)], TypeVar(V2)]) – A function that takes both a value and a group of valid values
│ │ │ -and returns a valid value, while it otherwise raises an exception (default: <function CommonBase.<lambda> at 0x7f8390f66da0>)
<function CommonBase.<lambda> at 0x7f7aa2a8eda0>)
│ │ │ values (TypeVar(Vs)) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
get_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f66e50>)
get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f8390f66f00>)
<function CommonBase.<lambda> at 0x7f7aa2a8ee50>)
│ │ │ +get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f7aa2a8ef00>)
set_process (Callable[[TypeVar(V2)], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f66fb0>)
<function CommonBase.<lambda> at 0x7f7aa2a8efb0>)
│ │ │ command_process (Callable | None) –
A function that takes a command and allows processing │ │ │ before executing the command
│ │ │Deprecated since version 0.12: Use a dynamic property instead. (default: None)
check_set_errors (bool) – Toggles checking errors after setting (default: False)
get_command (str) – A string command that asks for the value
docs (str) – A docstring that will be included in the documentation
values (Any) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
get_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f671c0>)
get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f8390f67270>)
<function CommonBase.<lambda> at 0x7f7aa2a8f1c0>)
│ │ │ +get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f7aa2a8f270>)
command_process (Callable | None) –
A function that take a command and allows processing │ │ │ before executing the command, for getting
│ │ │Deprecated since version 0.12: Use a dynamic property instead. (default: None)
check_get_errors (bool) – Toggles checking errors after getting (default: False)
set_command (str) – A string command that writes the value
docs (str) – A docstring that will be included in the documentation
validator (Callable[[Any, TypeVar(Vs)], Any]) – A function that takes both a value and a group of valid values
│ │ │ -and returns a valid value, while it otherwise raises an exception (default: <function CommonBase.<lambda> at 0x7f8390f67480>)
<function CommonBase.<lambda> at 0x7f7aa2a8f480>)
│ │ │ values (TypeVar(Vs)) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
set_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f67530>)
<function CommonBase.<lambda> at 0x7f7aa2a8f530>)
│ │ │ check_set_errors (bool) – Toggles checking errors after setting (default: False)
dynamic (bool) – Specify whether the property parameters are meant to be changed in
│ │ │ instances or subclasses. See control() for an usage example. (default: False)
property | DynamicProperty
get_command (str | None) – A string command that asks for the value, set to None
│ │ │ if get is not supported (see also setting()).
set_command (str | None) – A string command that writes the value, set to None
│ │ │ if set is not supported (see also measurement()).
docs (str) – A docstring that will be included in the documentation
validator (Callable[[Any, TypeVar(Vs)], TypeVar(V2)]) – A function that takes both a value and a group of valid values
│ │ │ -and returns a valid value, while it otherwise raises an exception (default: <function CommonBase.<lambda> at 0x7f8390f66da0>)
<function CommonBase.<lambda> at 0x7f7aa2a8eda0>)
│ │ │ values (TypeVar(Vs)) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
get_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f66e50>)
get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f8390f66f00>)
<function CommonBase.<lambda> at 0x7f7aa2a8ee50>)
│ │ │ +get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f7aa2a8ef00>)
set_process (Callable[[TypeVar(V2)], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f66fb0>)
<function CommonBase.<lambda> at 0x7f7aa2a8efb0>)
│ │ │ command_process (Callable | None) –
A function that takes a command and allows processing │ │ │ before executing the command
│ │ │Deprecated since version 0.12: Use a dynamic property instead. (default: None)
check_set_errors (bool) – Toggles checking errors after setting (default: False)
get_command (str) – A string command that asks for the value
docs (str) – A docstring that will be included in the documentation
values (Any) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
get_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f671c0>)
get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f8390f67270>)
<function CommonBase.<lambda> at 0x7f7aa2a8f1c0>)
│ │ │ +get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f7aa2a8f270>)
command_process (Callable | None) –
A function that take a command and allows processing │ │ │ before executing the command, for getting
│ │ │Deprecated since version 0.12: Use a dynamic property instead. (default: None)
check_get_errors (bool) – Toggles checking errors after getting (default: False)
set_command (str) – A string command that writes the value
docs (str) – A docstring that will be included in the documentation
validator (Callable[[Any, TypeVar(Vs)], Any]) – A function that takes both a value and a group of valid values
│ │ │ -and returns a valid value, while it otherwise raises an exception (default: <function CommonBase.<lambda> at 0x7f8390f67480>)
<function CommonBase.<lambda> at 0x7f7aa2a8f480>)
│ │ │ values (TypeVar(Vs)) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
set_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f67530>)
<function CommonBase.<lambda> at 0x7f7aa2a8f530>)
│ │ │ check_set_errors (bool) – Toggles checking errors after setting (default: False)
dynamic (bool) – Specify whether the property parameters are meant to be changed in
│ │ │ instances or subclasses. See control() for an usage example. (default: False)
property | DynamicProperty
unit – ‘kelvin’, ‘celsius’, or ‘sensor’ specifying the unit
│ │ │ for queried temperature values. (default: 'kelvin')
accuracy – An acceptable percentage deviation between the
│ │ │ target and temperature. (default: 0.1)
interval – Interval time in seconds between queries. (default: 1)
timeout – A timeout in seconds after which an exception is raised (default: 360)
should_stop – A function that returns True if waiting should stop, by
│ │ │ -default this always returns False (default: <function LakeShoreTemperatureChannel.<lambda> at 0x7f837982b480>)
<function LakeShoreTemperatureChannel.<lambda> at 0x7f7a8b5df740>)
│ │ │ get_command (str | None) – A string command that asks for the value, set to None
│ │ │ if get is not supported (see also setting()).
set_command (str | None) – A string command that writes the value, set to None
│ │ │ if set is not supported (see also measurement()).
docs (str) – A docstring that will be included in the documentation
validator (Callable[[Any, TypeVar(Vs)], TypeVar(V2)]) – A function that takes both a value and a group of valid values
│ │ │ -and returns a valid value, while it otherwise raises an exception (default: <function CommonBase.<lambda> at 0x7f8390f66da0>)
<function CommonBase.<lambda> at 0x7f7aa2a8eda0>)
│ │ │ values (TypeVar(Vs)) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
get_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f66e50>)
get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f8390f66f00>)
<function CommonBase.<lambda> at 0x7f7aa2a8ee50>)
│ │ │ +get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f7aa2a8ef00>)
set_process (Callable[[TypeVar(V2)], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f66fb0>)
<function CommonBase.<lambda> at 0x7f7aa2a8efb0>)
│ │ │ command_process (Callable | None) –
A function that takes a command and allows processing │ │ │ before executing the command
│ │ │Deprecated since version 0.12: Use a dynamic property instead. (default: None)
check_set_errors (bool) – Toggles checking errors after setting (default: False)
get_command (str) – A string command that asks for the value
docs (str) – A docstring that will be included in the documentation
values (Any) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
get_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f671c0>)
get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f8390f67270>)
<function CommonBase.<lambda> at 0x7f7aa2a8f1c0>)
│ │ │ +get_process_list (Callable[[list[Any]], Any]) – A function that takes the value list and processes it. (default: <function CommonBase.<lambda> at 0x7f7aa2a8f270>)
command_process (Callable | None) –
A function that take a command and allows processing │ │ │ before executing the command, for getting
│ │ │Deprecated since version 0.12: Use a dynamic property instead. (default: None)
check_get_errors (bool) – Toggles checking errors after getting (default: False)
set_command (str) – A string command that writes the value
docs (str) – A docstring that will be included in the documentation
validator (Callable[[Any, TypeVar(Vs)], Any]) – A function that takes both a value and a group of valid values
│ │ │ -and returns a valid value, while it otherwise raises an exception (default: <function CommonBase.<lambda> at 0x7f8390f67480>)
<function CommonBase.<lambda> at 0x7f7aa2a8f480>)
│ │ │ values (TypeVar(Vs)) – A list, tuple, range, or dictionary of valid values, that can be used
│ │ │ as to map values if map_values is True. (default: ())
map_values (bool) – A boolean flag that determines if the values should be
│ │ │ interpreted as a map (default: False)
set_process (Callable[[Any], Any]) – A function that takes a value and allows processing
│ │ │ -before value mapping, returning the processed value (default: <function CommonBase.<lambda> at 0x7f8390f67530>)
<function CommonBase.<lambda> at 0x7f7aa2a8f530>)
│ │ │ check_set_errors (bool) – Toggles checking errors after setting (default: False)
dynamic (bool) – Specify whether the property parameters are meant to be changed in
│ │ │ instances or subclasses. See control() for an usage example. (default: False)
property | DynamicProperty
delay – Time in seconds between each query into the state of the instrument. (default: 1)
max_wait_time – Maximum time in seconds to wait before is at rest. If the system is
│ │ │ not at rest within this time a TimeoutError is raised. None is
│ │ │ interpreted as no maximum time. (default: None)
should_stop – A function that returns True when this function should return
│ │ │ -early. (default: <function IPS120_10.<lambda> at 0x7f83786f43b0>)
<function IPS120_10.<lambda> at 0x7f7a8a4a8300>)
│ │ │ 3600)
│ │ │ check_interval – The time between temperature queries to the ITC. (default: 0.5)
stability_interval – The time over which the temperature_error is
│ │ │ to be below error to be considered stable. (default: 10)
thermalize_interval – The time to wait after stabilizing for the
│ │ │ system to thermalize. (default: 300)
should_stop – Optional function (returning a bool) to allow the
│ │ │ -waiting to be stopped before its end. (default: <function ITC503.<lambda> at 0x7f83786d8a90>)
<function ITC503.<lambda> at 0x7f7a8a4a09e0>)
│ │ │ Block the program, waiting for the temperature to stabilize at the temperature setpoint.
│ │ │tolerance – Maximum allowed deviation from temperature setpoint,
│ │ │ in degrees Centigrade. (default: 0.1)
period – Time period over which stability is checked, in seconds. (default: 10)
should_stop – Function that returns True to stop waiting. (default: <function LDC500SeriesTEC.<lambda> at 0x7f8376f2c880>)
should_stop – Function that returns True to stop waiting. (default: <function LDC500SeriesTEC.<lambda> at 0x7f7a88c78a90>)
timeout – Maximum waiting time, in seconds. (default: 60)
True when stable, False if stopped by should_stop.
│ │ │Block the program, waiting for the sweep to complete.
│ │ │should_stop – Function that returns True to stop waiting. (default: <function AQ6370Series.<lambda> at 0x7f8375ea3950>)
should_stop – Function that returns True to stop waiting. (default: <function AQ6370Series.<lambda> at 0x7f7a87ba77f0>)
timeout – Maximum waiting time, in seconds. (default: 3600)
delay – Delay between checks for sweep completion, in seconds. (default: 0)
True when sweep completed, False if stopped by should_stop.
│ │ │