Skip to main content

Toolbox for analysing FCS/FFS data with array detectors

Project description

BrightEyes-FFS

A toolbox for analysing Fluorescence Correlation Spectroscopy (FCS) and Fluorescence Fluctuation Spectroscopy (FFS) data with array detectors. The fcs module contains libraries for:

  • Calculating autocorrelations and cross-correlations of raw FCS/FFS data (i.e. photon counts vs. time)
  • Fitting correlations to various 2D and 3D diffusion models
  • Calibration-free FCS/FFS analysis such as circular-scanning FCS and iMSD analysis
  • Miscellaneous tools

The fcs_gui module contains libraries for:

  • Storing and loading FCS/FFS analysis sessions, as used in the GUI

The dataio module contains libraries for:

  • Fitting various models to data (polynomial, Gaussian, power law, etc.)
  • Stokes-Einstein relation
  • Save/load 2D arrays to/from .csv files
  • Save data to .tiff file
  • Miscellaneous tools

Installation

You can install brighteyes-ffs via [pip] directly from [PyPI]:

pip install brighteyes-ffs

or using the version on GitHub:

pip install git+https://github.com/VicidominiLab/BrightEyes-FFS

or:

pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple brighteyes-ffs

It requires the following Python packages

h5py
joblib
matplotlib>=3.3.2
multipletau>=0.3.3
numpy>=1.19.4
pandas>=1.1.4
scipy
tifffile>=2020.9.29
seaborn
imutils
PyQt5
qdarkstyle
nbformat

License

Distributed under the terms of the [GNU GPL v3.0] license, "BrightEyes-FFS" is free and open source software

Contributing

You want to contribute? Great! Contributing works best if you creat a pull request with your changes.

  1. Fork the project.
  2. Create a branch for your feature: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'My new feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request!

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

brighteyes_ffs-0.0.10.tar.gz (115.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

brighteyes_ffs-0.0.10-py3-none-any.whl (147.0 kB view details)

Uploaded Python 3

File details

Details for the file brighteyes_ffs-0.0.10.tar.gz.

File metadata

  • Download URL: brighteyes_ffs-0.0.10.tar.gz
  • Upload date:
  • Size: 115.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.7

File hashes

Hashes for brighteyes_ffs-0.0.10.tar.gz
Algorithm Hash digest
SHA256 40d05fda6580ba512e18e73fa491f9ccdac59f084430dfa989f5096e3a90f54f
MD5 268ab4d8971ee7e61f8b50212bbf2924
BLAKE2b-256 89c4a7f3ec1879136425a57df783b68811690e61c5c6a52b2a490c5fb2af26d9

See more details on using hashes here.

File details

Details for the file brighteyes_ffs-0.0.10-py3-none-any.whl.

File metadata

File hashes

Hashes for brighteyes_ffs-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 e95837ba19dc72256ab42fabef73ae9ce98e7409ccf00d7aa172a012aa99324b
MD5 5a11200d1889869a8c2ff72fdcf1fe7e
BLAKE2b-256 34689e04b269d8777617a601a1aa71dc119e2a10d915431b6aa59a7dee8f8567

See more details on using hashes here.

Supported by

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