CMMCorePlus ¶

Print information table with the current configuration.

Intended to provide a quick overview of the microscope configuration during interactive terminal usage.

Returns the module and device interface versions.

Displays core version.

Return the global singleton instance of CMMCorePlus.

In many cases, a single instance of CMMCorePlus is all that will be created in a given session. This class method provides a convenient way to access that instance.

A static method that does nothing.

Unloads all devices from the core, clears all configuration data and property blocks.

Waits (blocks the calling thread) for specified time in milliseconds.

Return info on the current state of the core.

Set the MDA Engine to be used on run_mda.

This will unregister the previous engine and emit an mdaEngineRegistered signal. The current Engine must not be running an MDA in order to register a new engine.

Parameters:

registerCallback is disallowed in pymmcore-plus!

If you want to connect callbacks to events, use the CMMCorePlus.events property instead.

Run a sequence of useq.MDAEvent on a new thread.

The currently registered MDAEngine (core.mda.engine) will be responsible for executing the acquisition.

After starting the sequence you can pause or cancel the mda with the mda object's set_paused and cancel methods.

Parameters:

Returns:

Return the entire system state.

Why Override? The pymmcore_plus.Configuration object returned when native=False (the default) provides a nicer Mapping interface. Pass native=True to get the original pymmcore.Configuration object.

Return the entire system state from cache.

Why Override? The pymmcore_plus.Configuration object returned when native=False (the default) provides a nicer Mapping interface. Pass native=True to get the original pymmcore.Configuration object.

Load a system config file conforming to the MM .cfg format.

https://micro-manager.org/Micro-Manager_Configuration_Guide#configuration-file-syntax

For relative paths, the current working directory is first checked, then the then device adapter path is checked.

Why Override? This method overrides the default implementation to A) allow loading the MMConfig_demo.cfg file by default, B) to provide more flexible path declarations and C) better error messages when the file cannot be found.

Loads the system configuration from the text file conforming to the MM specific format.

Saves the current system configuration to a text file.

Why Override? To also save pixel size configurations.

Saves the current system state to a text file of the MM specific format.

Set core properties in a context restoring the initial values on exit.

Parameters:

Examples:

core = CMMCorePlus.instance()

with core.setContext(autoShutter=False):
    assert not core.getAutoShutter()
    # do other stuff
    ...

# autoShutter is restored to its original value when the context exits
assert core.getAutoShutter()

Sets all properties contained in the Configuration object.

Return the path to the last loaded system configuration file, or None.

Updates the state of the entire hardware.

Blocks until all devices in the system become ready (not-busy).

Tries to communicate to a device through a given serial port.

Used to automate discovery of correct serial port. Also configures the serial port correctly.

Why Override? The returned pymmcore_plus.DeviceDetectionStatus enum is more interpretable than the raw int returned by pymmcore

Checks the busy status of the specific device.

Checks the busy status for all devices of the specific type.

Return an Adapter object bound to library_name on this core.

Adapter objects are a convenient object oriented way to interact with device adapters. They allow you to call any method on CMMCore that normally requires a library_name as the first argument as an argument-free method on the Adapter object.

Get descriptions for available devices from the specified library.

Get available devices from the specified device library.

Get type information for available devices from the specified library.

Return the current device of type device_type.

Only the following device types have a "current" device: - CameraDevice - ShutterDevice - StageDevice - XYStageDevice - AutoFocusDevice - SLMDevice - GalvoDevice - ImageProcessorDevice

Calling this method with any other device type will raise a ValueError.

Parameters:

Returns:

Raises:

Return the names of discoverable device adapters.

Return the current device adapter search paths.

Reports action delay in milliseconds for the specific device.

Returns description text for a given device label. "Description" is determined by the library and is immutable.

Queries the initialization state of the given device.

Why Override? The returned pymmcore_plus.DeviceInitializationState enum is more interpretable than the raw int returned by pymmcore

Returns device library (aka module, device adapter) name.

Returns device name for a given device label.

Return a Device object bound to device_label on this core.

Device objects are a convenient object oriented way to interact with devices. They allow you to call any method on CMMCore that normally requires a deviceLabel as the first argument as an argument-free method on the Device object.

Parameters:

Examples:

>>> core = CMMCorePlus()
>>> cam = core.getDeviceObject("DemoCamera")
>>> cam.isLoaded()
False
>>> cam.load("DemoCamera", "DCam")
>>> cam.isLoaded()
True
>>> cam.initialize()

get the device schema

>>> cam.schema()
{
    'title': 'DCam',
    'description': 'Demo camera',
    'type': 'object',
    'properties': {
        'HubID': {'type': 'string', 'readOnly': True, 'default': ''},
        'MaximumExposureMs': {'type': 'number', 'preInit': True},
        'TransposeCorrection': {'type': 'boolean'},
        'TransposeMirrorX': {'type': 'boolean'},
        'TransposeMirrorY': {'type': 'boolean'},
        'TransposeXY': {'type': 'boolean'}
    }
}

Return JSON-schema describing device device_label and its properties.

This method is new in CMMCorePlus. It provides a convenient way to get all of the information about a device in a single call.

Returns:

Examples:

>>> core = CMMCorePlus()
>>> core.loadDevice("DemoCamera", "DemoCamera", "DCam")
>>> core.getDeviceSchema("DemoCamera")
{
    'title': 'DCam',
    'description': 'Demo camera',
    'type': 'object',
    'properties': {
        'HubID': {'type': 'string', 'readOnly': True, 'default': ''},
        'MaximumExposureMs': {'type': 'number', 'preInit': True},
        'TransposeCorrection': {'type': 'boolean'},
        'TransposeMirrorX': {'type': 'boolean'},
        'TransposeMirrorY': {'type': 'boolean'},
        'TransposeXY': {'type': 'boolean'}
    }
}

Returns the per-device timeout in milliseconds, or the default if not set.

Return device type for a given device.

Why Override? The returned pymmcore_plus.DeviceType enum is more interpretable than the raw int returned by pymmcore

Returns description from the specified peripheral on hubLabel device.

Performs auto-detection and loading of child devices that are attached to a Hub device.

Raises RuntimeError if hubLabel is not a hub device.

Returns an array of labels for currently loaded devices.