Skip to content
pymmcore-widgets PyPI version

LiveButton

LiveButtonLiveButton

Screenshot generated from the example below.

Example

examples/live_button.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
"""Example usage of the LiveButton class.

Check also the 'image_preview.py' example to see the LiveButton
used in combination of other widgets.
"""

from pymmcore_plus import CMMCorePlus
from qtpy.QtWidgets import QApplication

from pymmcore_widgets import LiveButton

app = QApplication([])

mmc = CMMCorePlus.instance()
mmc.loadSystemConfiguration()

live_btn = LiveButton()
live_btn.show()

app.exec()

API

Bases: QPushButton

Button that starts and stops live mode.

When pressed, a continuous sequence acquisition is started or stopped and a pymmcore-plus signal continuousSequenceAcquisitionStarted or sequenceAcquisitionStopped is emitted.

See the ImagePreview example for this widget combined with an image preview and other controls.

Parameters:

Name Type Description Default
parent QWidget | None

Optional parent widget.

 None
mmcore CMMCorePlus | None

Optional pymmcore_plus.CMMCorePlus micromanager core. By default, None. If not specified, the widget will use the active (or create a new) CMMCorePlus.instance.

 None
Referenced by:

button_text_on property writable 

button_text_on: str

Set the live button text for when live mode is on.

Default = "Live."

button_text_off property writable 

button_text_off: str

Set the live button text for when live mode is off.

Default = "Stop."

icon_color_on property writable 

icon_color_on: COLOR_TYPE

Set the live button color for when live mode is on.

Default = (0. 255, 0).

icon_color_off property writable 

icon_color_off: COLOR_TYPE

Set the live button color for when live mode is off.

Default = "magenta".