pymmcore_plus.metadata.functions ¶

Functions

Name	Description
`config_group`	Return a dictionary of configuration presets for a specific group.
`config_groups`	Return all configuration groups.
`device_info`	Return information about a specific device label.
`devices_info`	Return a dictionary of device information for all loaded devices.
`image_info`	Return information about the current camera image properties.
`image_infos`	Return information about the current image properties for all cameras.
`pixel_size_config`	Return info for a specific pixel size preset for a specific.
`pixel_size_configs`	Return a dictionary of pixel size configurations.
`position`	Return current position of active (and, optionally, all) stages.
`properties`	Return a dictionary of device properties values for all loaded devices.
`property_info`	Return information on a specific device property.
`system_info`	Return general system information.

Attributes

Name	Description
`DEFAULT_AFFINE`

Functions¶

device_info ¶

device_info(
    core: CMMCorePlus,
    *,
    label: str,
    cached: bool = True,
    include_property_details: bool = True,
) -> DeviceInfo

Return information about a specific device label.

system_info ¶

system_info(core: CMMCorePlus) -> SystemInfo

Return general system information.

image_info ¶

image_info(core: CMMCorePlus) -> ImageInfo

Return information about the current camera image properties.

image_infos ¶

image_infos(core: CMMCorePlus) -> tuple[ImageInfo, ...]

Return information about the current image properties for all cameras.

position ¶

position(core: CMMCorePlus, all_stages: bool = False) -> Position

Return current position of active (and, optionally, all) stages.

config_group ¶

config_group(core: CMMCorePlus, *, group_name: str) -> ConfigGroup

Return a dictionary of configuration presets for a specific group.

config_groups ¶

config_groups(core: CMMCorePlus) -> tuple[ConfigGroup, ...]

Return all configuration groups.

pixel_size_config ¶

pixel_size_config(
    core: CMMCorePlus, *, config_name: str
) -> PixelSizeConfigPreset

Return info for a specific pixel size preset for a specific.

devices_info ¶

devices_info(
    core: CMMCorePlus,
    cached: bool = True,
    include_property_details: bool = True,
) -> tuple[DeviceInfo, ...]

Return a dictionary of device information for all loaded devices.

property_info ¶

property_info(
    core: CMMCorePlus,
    device: str,
    prop: str,
    *,
    cached: bool = True,
    include_property_details: bool = True,
) -> PropertyInfo

Return information on a specific device property.

properties ¶

properties(
    core: CMMCorePlus,
    device: str,
    *,
    cached: bool = True,
    include_details: bool = True,
) -> tuple[PropertyInfo, ...]

Return a dictionary of device properties values for all loaded devices.

pixel_size_configs ¶

pixel_size_configs(core: CMMCorePlus) -> tuple[PixelSizeConfigPreset, ...]

Return a dictionary of pixel size configurations.

Attributes¶

DEFAULT_AFFINE ¶

DEFAULT_AFFINE = (1.0, 0.0, 0.0, 0.0, 1.0, 0.0)

Re-exports¶

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

Name	Description
`frame_metadata`	Return metadata for the current frame.
`summary_metadata`	Return a summary metadata for the current state of the system.