Skip to content

czitools.metadata_tools.boundingbox #

Bounding box helpers for CZI files.

This module exposes CziBoundingBox, a small helper that reads scene and total bounding rectangles from a CZI using pylibCZIrw. The class is defensive: missing metadata fields are represented as None and diagnostic messages are emitted only when verbose is True.

Classes:

  • CziBoundingBox –

    A class to represent and handle bounding boxes from CZI image data.

CziBoundingBox dataclass #

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

A class to represent and handle bounding boxes from CZI image data.

Attributes:

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

    The source of the CZI file, which can be a string, a path-like object, or a Box object.

  • scenes_bounding_rect (Optional[Dict[int, Rectangle]]) –

    A dictionary containing the bounding rectangles for each scene in the CZI file.

  • scenes_bounding_rect_no_pyramid (Optional[Dict[int, Rectangle]]) –

    A dictionary containing the bounding rectangles for each scene in the CZI file without a pyramid.

  • total_rect (Optional[Rectangle]) –

    The total bounding rectangle for the entire CZI file.

  • total_rect_no_pyramid (Optional[Rectangle]) –

    The total bounding rectangle for the entire CZI file without a pyramid.

  • total_bounding_box (Optional[Dict[str, tuple]]) –

    A dictionary containing the total bounding box.

  • total_bounding_box_no_pyramid (Optional[Dict[str, tuple]]) –

    A dictionary containing the total bounding box coordinates without a pyramid.

  • verbose (bool) –

    Flag to enable verbose logging.