Skip to content

ConfigWizard

ConfigWizard widget

This image generated from example code below.

ConfigWizard #

Bases: QWizard

Hardware Configuration Wizard for Micro-Manager.

It can be used to create a new configuration file or edit an existing one.

Parameters:

Name Type Description Default
config_file str

Path to a configuration file to load, by default "".

''
core CMMCorePlus

A CMMCorePlus instance, by default, uses the global singleton.

None
parent QWidget

The parent widget, by default None.

None

accept() -> None #

Accept the wizard and save the configuration to a file.

closeEvent(event: QCloseEvent | None) -> None #

Called when the window is closed.

microscopeModel() -> Microscope #

Return the microscope model.

reject() -> None #

Reject the wizard and reload the prior configuration.

save(path: str | Path) -> None #

Save the configuration to a file.

sizeHint() -> QSize #

Return the size hint for the wizard.

Example#

config_wizard.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from pymmcore_plus import CMMCorePlus
from qtpy.QtWidgets import QApplication

from pymmcore_widgets.hcwizard.config_wizard import ConfigWizard

app = QApplication([])

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

wiz = ConfigWizard()
wiz.show()

app.exec_()