Skip to content
pymmcore-widgets PyPI version

ChannelWidget

ChannelWidgetChannelWidget

Screenshot generated from the example below.

Example

examples/channel_widget.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 ChannelWidget class.

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

from pymmcore_plus import CMMCorePlus
from qtpy.QtWidgets import QApplication

from pymmcore_widgets import ChannelWidget

app = QApplication([])

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

ch_wdg = ChannelWidget()
ch_wdg.show()

app.exec()

API

Bases: QWidget

Combo box that shows and sets the current channel.

The choices are the presets of the channel group.

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

Parameters:

Name Type Description Default
channel_group str | None

Name of the micromanager group defining the microscope channels. By default, it will be guessed using the CMMCorePlus.getOrGuessChannelGroup method and a choice dialog will be presented if there are multiple options. This method looks for a group configuration name matching the default regex re.compile("(chan{1,2}(el)?|filt(er)?)s?", re.IGNORECASE). A different string/regex can be set with the CMMCorePlus.channelGroup_pattern property.

 None
parent QWidget | None

Optional parent widget. By default, None.

 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: