czi2ometiff
czi2ometiff is a Python tool for converting Zeiss CZI microscopy files into OME-TIFF, a widely used open standard for bioimaging data.
It provides a simple, reliable interface for extracting image data, channel names, and pixel sizes from CZI files and exporting them into high-quality OME-TIFF files.
Features
- Easy to use — convert a CZI file to OME-TIFF with a single function call.
- Automatic metadata extraction:
- Channel names (from CZI metadata if available)
- Pixel sizes in X, Y, and Z (converted to micrometers)
- Flexible output — works with multi-channel and multi-Z images.
- OME-TIFF pyramids — optional downsampled pyramid levels for fast viewing in tools like QuPath, OMERO, and napari.
- Built on numpy2ometiff — leverages robust OME-TIFF writing from the
numpy2ometifflibrary.
Installation
Install directly via pip:
pip install czi2ometiff
Example Usage
from czi2ometiff import convert_czi_to_ometiff
# Input CZI file
input_file = "example_image.czi"
# Optional: specify output path
output_file = "example_image.ome.tiff"
# Convert to OME-TIFF
output_path = convert_czi_to_ometiff(
input_path=input_file,
output_path=output_file, # Optional—defaults to input filename with .ome.tiff
downsample_count=8 # Number of pyramid levels
)
print("Saved OME-TIFF:", output_path)
How It Works
czi2ometiff automatically:
- Reads the CZI file using
czifile - Extracts image data as a NumPy array
- Detects channel names from CZI metadata
- Extracts pixel sizes (stored in meters in CZI; converted to micrometers)
- Reformats data into the (Z, C, Y, X) layout expected by OME-TIFF
- Writes the final OME-TIFF using the
numpy2ometiff.write_ome_tiff()function
All required metadata is set for compatibility with standard bioimaging software.
Contributing
Contributions are welcome!
If you'd like to add features, improve metadata parsing, or enhance compatibility with other CZI variants:
- Fork the repository
- Create a feature branch
- Submit a pull request
For major changes, please open an issue first to discuss your ideas.
License
This project is licensed under the BSD 3-Clause License — see the LICENSE file for details.
Metadata
Release files for czi2ometiff 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| czi2ometiff-0.1.0.tar.gz | 6.3 kB | Without provenance | Details for czi2ometiff-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| czi2ometiff-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for czi2ometiff-0.1.0-py3-none-any.whl |
Total release size: 12.9 kB
Release files / czi2ometiff-0.1.0.tar.gz
| Download URL | czi2ometiff-0.1.0.tar.gz |
|---|---|
| Size | 6.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9ed0d90a11348689a2f3cb9a36691cea679db48fed3dc8dac63f1b503d22105c
|
|
BLAKE2b-256 checksum How to use checksums |
e598f18f96075ea775f31c0a5266543de8490925b9264afc09563a82492fab0b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
Release files / czi2ometiff-0.1.0-py3-none-any.whl
| Download URL | czi2ometiff-0.1.0-py3-none-any.whl |
|---|---|
| Size | 6.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0251b8c908fd1d884d73b5cd896ed985988a341926c20cc291a7b3b620baf68a
|
|
BLAKE2b-256 checksum How to use checksums |
19bb7863c518ca3d897029e5ec139683f224901ad973689cf8e5048e4dd13890
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
Security for czi2ometiff 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.