pymmcore_plus.core.events package#
Module contents#
- class CMMCoreSignaler(*args, **kwargs)[source]#
Bases:
pymmcore_plus.core.events._prop_event_mixin._DevicePropertyEventMixin
Signals that will be emitted from CMMCorePlus and RemoteMMCore objects.
- SLMExposureChanged: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- XYStagePositionChanged: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- autoShutterSet: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- channelGroupChanged: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- configDefined: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- configDeleted: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- configGroupChanged: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- configGroupDeleted: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- configSet: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- exposureChanged: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- imageSnapped: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- mdaEngineRegistered: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- pixelSizeAffineChanged: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- pixelSizeChanged: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- propertiesChanged: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- propertyChanged: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- roiSet: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- property sLMExposureChanged#
- stagePositionChanged: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- startContinuousSequenceAcquisition: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- startSequenceAcquisition: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- stopSequenceAcquisition: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- systemConfigurationLoaded: PSignalInstance#
Declares a signal emitter on a class.
This is class implements the [descriptor protocol](https://docs.python.org/3/howto/descriptor.html#descriptorhowto) and is designed to be used as a class attribute, with the supported signature types provided in the contructor:
```python from psygnal import Signal
- class MyEmitter:
changed = Signal(int)
- def receiver(arg: int):
print(“new value:”, arg)
emitter = MyEmitter() emitter.changed.connect(receiver) emitter.changed.emit(1) # prints ‘new value: 1’ ```
!!! note
in the example above,
MyEmitter.changed
is an instance ofSignal
, andemitter.changed
is an instance ofSignalInstance
. See the documentation on [SignalInstance
][psygnal.SignalInstance] for details on how to connect to and/or emit a signal on an instance of an object that has aSignal
.- Parameters
*types (Union[Type[Any], Signature]) – A sequence of individual types, or a single [
inspect.Signature
][] object.description (str) – Optional descriptive text for the signal. (not used internally).
name (Optional[str]) – Optional name of the signal. If it is not specified then the name of the class attribute that is bound to the signal will be used. default None
check_nargs_on_connect (bool) – Whether to check the number of positional args against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_nargs=True)
. By default, True.check_types_on_connect (bool) – Whether to check the callback parameter types against
signature
when connecting a new callback. This can also be provided at connection time usingconnect(..., check_types=True)
. By default, False.
- property xYStagePositionChanged#
- class PCoreSignaler(*args, **kwargs)[source]#
Bases:
Protocol
- SLMExposureChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- XYStagePositionChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- autoShutterSet: pymmcore_plus.core.events._protocol.PSignalInstance#
- channelGroupChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- configDefined: pymmcore_plus.core.events._protocol.PSignalInstance#
- configDeleted: pymmcore_plus.core.events._protocol.PSignalInstance#
- configGroupChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- configGroupDeleted: pymmcore_plus.core.events._protocol.PSignalInstance#
- configSet: pymmcore_plus.core.events._protocol.PSignalInstance#
- exposureChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- imageSnapped: pymmcore_plus.core.events._protocol.PSignalInstance#
- mdaEngineRegistered: pymmcore_plus.core.events._protocol.PSignalInstance#
- pixelSizeAffineChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- pixelSizeChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- propertiesChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- propertyChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- roiSet: pymmcore_plus.core.events._protocol.PSignalInstance#
- sLMExposureChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- stagePositionChanged: pymmcore_plus.core.events._protocol.PSignalInstance#
- startContinuousSequenceAcquisition: pymmcore_plus.core.events._protocol.PSignalInstance#
- startSequenceAcquisition: pymmcore_plus.core.events._protocol.PSignalInstance#
- stopSequenceAcquisition: pymmcore_plus.core.events._protocol.PSignalInstance#
- systemConfigurationLoaded: pymmcore_plus.core.events._protocol.PSignalInstance#
- xYStagePositionChanged: pymmcore_plus.core.events._protocol.PSignalInstance#