pymmcore_plus.core.events ¶

Signals emitted by CMMCorePlus.events.

See PCoreSignaler for the list of signals.

Classes

Name	Description
`QCoreSignaler`	Signals that will be emitted from CMMCorePlus objects (Qt backend).

Classes¶

QCoreSignaler ¶

QCoreSignaler()

Bases: QObject

Signals that will be emitted from CMMCorePlus objects (Qt backend).

See PCoreSignaler for what each signal emits.

propertiesChanged ¶

propertiesChanged = Signal()

propertyChanged ¶

propertyChanged = Signal(str, str, object)

channelGroupChanged ¶

channelGroupChanged = Signal(str)

configGroupChanged ¶

configGroupChanged = Signal(str, str)

configSet ¶

configSet = Signal(str, str)

systemConfigurationLoaded ¶

systemConfigurationLoaded = Signal()

pixelSizeChanged ¶

pixelSizeChanged = Signal(float)

pixelSizeAffineChanged ¶

pixelSizeAffineChanged = Signal(float, float, float, float, float, float)

stagePositionChanged ¶

stagePositionChanged = Signal(str, float)

XYStagePositionChanged ¶

XYStagePositionChanged = Signal(str, float, float)

Used by:

API Reference pymmcore-plus pymmcore_plus core events Classes QCoreSignaler xYStagePositionChanged

xYStagePositionChanged ¶

xYStagePositionChanged = XYStagePositionChanged

exposureChanged ¶

exposureChanged = Signal(str, float)

SLMExposureChanged ¶

SLMExposureChanged = Signal(str, float)

Used by:

API Reference pymmcore-plus pymmcore_plus core events Classes QCoreSignaler sLMExposureChanged

sLMExposureChanged ¶

sLMExposureChanged = SLMExposureChanged

shutterOpenChanged ¶

shutterOpenChanged = Signal(str, bool)

imageSnapped ¶

imageSnapped = Signal(str)

sequenceAcquisitionStopped ¶

sequenceAcquisitionStopped = Signal(str)

sequenceAcquisitionStarted `property` ¶

sequenceAcquisitionStarted

mdaEngineRegistered ¶

mdaEngineRegistered = Signal(object, object)

continuousSequenceAcquisitionStarting ¶

continuousSequenceAcquisitionStarting = Signal()

continuousSequenceAcquisitionStarted ¶

continuousSequenceAcquisitionStarted = Signal()

sequenceAcquisitionStarting `property` ¶

sequenceAcquisitionStarting

autoShutterSet ¶

autoShutterSet = Signal(bool)

configGroupDeleted ¶

configGroupDeleted = Signal(str)

configDeleted ¶

configDeleted = Signal(str, str)

configDefined ¶

configDefined = Signal(str, str, str, str, str)

roiSet ¶

roiSet = Signal(str, int, int, int, int)

property_callbacks ¶

property_callbacks: PropKeyDict = {}

devicePropertyChanged ¶

devicePropertyChanged(
    device: str, property: str | None = None
) -> _PropertySignal

Return object to connect/disconnect to device/property-specific changes.

Note that the callback provided to .connect() must take two parameters (property_name, new_value) if only device is provided, and one parameter (new_value) of both device and property are provided.

Parameters:

Name	Type	Description	Default
`device`	`str`	A device label	required
`property`	`Optional[str]`	Optional property label. If not provided, all property changes on `device` will trigger an event emission. by default None	`None`

Returns:

Type	Description
`_PropertySignal`	Object with `connect` and `disconnect` methods that attach a callback to the change event of a specific property or device.

Examples:

>>> core.events.devicePropertyChanged("Camera", "Gain").connect(callback)
>>> core.events.devicePropertyChanged("Camera").connect(callback)

Re-exports¶

These can also be imported from this module, but each is documented under its shortest import path (linked below).

Name	Description
`CMMCoreSignaler`	Signals that will be emitted from CMMCorePlus objects (psygnal backend).
`PCoreSignaler`	Declares the protocol for all signals that will be emitted from CMMCorePlus.