Skip to main content

Read fluorescence correlation spectroscopy (FCS) data files

Project description

Fcsfiles is a Python library to read Carl Zeiss(r) ConfoCor(r) RAW and ASCII measurement data files.

Author:

Christoph Gohlke

License:

BSD 3-Clause

Version:

2025.1.1

Quickstart

Install the fcsfiles package and all dependencies from the Python Package Index:

python -m pip install -U fcsfiles

See Examples for using the programming interface.

Source code and support are available on GitHub.

Requirements

This revision was tested with the following requirements and dependencies (other versions may work):

  • CPython 3.10.11, 3.11.9, 3.12.8, 3.13.1 64-bit

  • NumPy 2.1.3

Revisions

2025.1.1

  • Improve type hints.

  • Drop support for Python 3.9, support Python 3.13.

2024.5.24

  • Support NumPy 2.

  • Fix docstring examples not correctly rendered on GitHub.

2023.8.30

  • Fix linting issues.

  • Add py.typed marker.

  • Convert to Google style docstrings.

  • Drop support for Python 3.8 and numpy < 1.22 (NEP29).

2022.9.28

  • Update metadata.

2022.2.2

  • Add type hints.

  • Use float64 or int64 for ConfoCor3Fcs arrays.

  • Drop support for Python 3.7 and numpy < 1.19 (NEP29).

2021.6.6

  • Drop support for Python 3.6 (NEP 29).

2020.9.18

  • Relax ConfoCor3Raw header requirement.

  • Support os.PathLike file names.

2020.1.1

  • Drop support for Python 2.7 and 3.5.

Notes

“Carl Zeiss” and “ConfoCor” are registered trademarks of Carl Zeiss, Inc.

The use of this implementation may be subject to patent or license restrictions.

The API is not stable yet and is expected to change between revisions.

This module does not read flow cytometry standard FCS files.

Examples

Read the CountRateArray from a ConfoCor3 ASCII file as a numpy array:

>>> fcs = ConfoCor3Fcs('ConfoCor3.fcs')
>>> fcs['FcsData']['FcsEntry'][0]['FcsDataSet']['CountRateArray'].shape
(60000, 2)
>>> print(fcs)  # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
Carl Zeiss ConfoCor3 - measurement data file - version 3.0 ANSI
BEGIN FcsData 30000
        Name = Fluorescein
        Comment =
        AverageFlags = Repeat|Position|Average_Fit_Results
        SortOrder = Channel-Repeat-Position-Kinetics
        BEGIN FcsEntry1 10000
...

Read data and metadata from a ConfoCor3 RAW file:

>>> fcs = ConfoCor3Raw('ConfoCor3.raw')
>>> fcs.filename
'f5ee4f36488fca2f89cb6b8626111006_R1_P1_K1_Ch1.raw'
>>> fcs.frequency
20000000
>>> times = fcs.asarray()
>>> int(times[10858])
1199925494
>>> times, bincounts = fcs.asarray(bins=1000)
>>> times.shape
(1000,)
>>> int(bincounts[618])
23
>>> fcs.close()

Read data and metadata from a ConfoCor2 RAW file:

>>> fcs = ConfoCor2Raw('ConfoCor2.raw')
>>> fcs.frequency
20000000
>>> ch0, ch1 = fcs.asarray()
>>> int(ch1[4812432])
999999833
>>> times, ch0, ch1 = fcs.asarray(bins=1000)
>>> times.shape
(1000,)
>>> int(ch1[428])
10095
>>> fcs.close()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fcsfiles-2025.1.1.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

fcsfiles-2025.1.1-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file fcsfiles-2025.1.1.tar.gz.

File metadata

  • Download URL: fcsfiles-2025.1.1.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for fcsfiles-2025.1.1.tar.gz
Algorithm Hash digest
SHA256 894ac48260d4da05a91f4d77c89b57749351d4482dbf82157a1f5529d8b08b9a
MD5 328bc3fb03fda21fdbe44575cafba965
BLAKE2b-256 f9c3f236abcfb9321c739755c53fcc02cdabaa4631bed6349411e9cc97ac8071

See more details on using hashes here.

File details

Details for the file fcsfiles-2025.1.1-py3-none-any.whl.

File metadata

  • Download URL: fcsfiles-2025.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for fcsfiles-2025.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7955c91903ebc1ab74bfdd19013f9e1b14e17bcf5698f573945669821125cd07
MD5 bd833a45bdbe2c5ad2b49c9d8fea3298
BLAKE2b-256 8156544e5e3f038697ab1ab7b790bf460909f26ab518ffcc6ed77ed5459f0543

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page