Skip to content

czitools.metadata_tools.microscope #

Microscope metadata utilities for CZI files.

Provides CziMicroscope, which extracts the microscope system name and identifier from CZI metadata.

Classes:

  • CziMicroscope

    A class to represent a microscope from CZI image data.

CziMicroscope dataclass #

CziMicroscope(
    czisource: Union[str, PathLike[str], Box],
    verbose: bool = False,
)

A class to represent a microscope from CZI image data.

Attributes:

  • czisource (Union[str, PathLike[str], Box]) –

    The source of the CZI image data, which can be a file path or a Box object.

  • Id (Optional[str]) –

    The identifier of the microscope.

  • Name (Optional[str]) –

    The name of the microscope.

  • System (Optional[str]) –

    The system of the microscope.

  • verbose (bool) –

    Flag to enable verbose logging.