Skip to main content

Czifile is a Python library to read Carl Zeiss Image (CZI) files, the native file format of the ZEN(r) software by Carl Zeiss Microscopy GmbH. CZI files contain multidimensional images and metadata from microscopy experiments.

Author:

Christoph Gohlke

Organization:

Laboratory for Fluorescence Dynamics. University of California, Irvine

Version:

2019.1.1

Requirements

Revisions

2019.1.1

Update copyright year.

2018.10.18

Rename zisraw package to czifile.

2018.8.29

Move czifile.py and related modules into zisraw package. Move usage examples to main docstring. Require imagecodecs package for decoding JpegXrFile, JpgFile, and LZW.

2018.6.18

Save CZI metadata to TIFF description in czi2tif. Fix AttributeError using max_workers=1. Make Segment.SID and DimensionEntryDV1.dimension str types. Return metadata as XML unicode string or dict, not etree. Return timestamps, focus positions, events, and luts as tuple or ndarray

2017.7.21

Use multi-threading in CziFile.asarray to decode and copy segment data. Always convert BGR to RGB. Remove bgr2rgb options. Decode JpegXR directly from byte arrays.

2017.7.13

Add function to convert CZI file to memory-mappable TIFF file.

2017.7.11

Add ‘out’ parameter to CziFile.asarray. Remove memmap option from CziFile.asarray (backwards incompatible). Change spline interpolation order to 0 (backwards incompatible). Make axes return a string. Require tifffile 2017.7.11.

2014.10.10

Read data into a memory mapped array (optional).

2013.12.4

Decode JpegXrFile and JpgFile via _czifle extension module. Attempt to reconstruct tiled mosaic images.

2013.11.20

Initial release.

Notes

The API is not stable yet and might change between revisions.

Python 2.7 and 3.4 are deprecated.

“ZEISS” and “Carl Zeiss” are registered trademarks of Carl Zeiss AG.

The ZISRAW file format design specification [1] is confidential and the licence agreement does not permit to write data into CZI files.

Only a subset of the 2016 specification is implemented. Specifically, multifile images, image pyramids, and topography images are not yet supported.

Tested on Windows with a few example files only.

Other libraries for reading CZI files (GPL licensed):

References

  1. ZISRAW (CZI) File Format Design specification Release Version 1.2.2. CZI 07-2016/CZI-DOC ZEN 2.3/DS_ZISRAW-FileFormat.pdf (confidential). Documentation can be requested at https://www.zeiss.com/microscopy/us/products/microscope-software/zen/czi.html

Examples

Read image data from a CZI file as numpy array:

>>> image = imread('test.czi')
>>> image.shape
(3, 3, 3, 250, 200, 3)
>>> image[0, 0, 0, 0, 0]
array([10, 10, 10], dtype=uint8)

Release files for czifile 2019.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for czifile 2019.1.1
File Size Uploaded
czifile-2019.1.1.tar.gz 16.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for czifile 2019.1.1
File Interpreter ABI Platform
czifile-2019.1.1-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 33.3 kB

Release files / czifile-2019.1.1.tar.gz

Download URL czifile-2019.1.1.tar.gz
Size 16.7 kB
Tags Source
SHA-256 checksum
How to use checksums
764bffb21052afb9a2a5a87a4906ed51e0feebde074ae881959f0eebf51deb61
BLAKE2b-256 checksum
How to use checksums
23bacd262672fcdbcd9977e5d926edcdfbafcf1bbb84c5b0e0dead726f010cca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2

Release files / czifile-2019.1.1-py2.py3-none-any.whl

Download URL czifile-2019.1.1-py2.py3-none-any.whl
Size 16.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
f6905c0307cd8d794dcdc350c84a1b574d7455165e60e85198c43324d420e79a
BLAKE2b-256 checksum
How to use checksums
b756ac05889d88e734bccbb8bc3c9e95fe1f5ca55838c3d2de67b556d9830686
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page