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 GitHub:

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

or using the version on [PyPI]:

pip install 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.8.tar.gz (115.2 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.8-py3-none-any.whl (146.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brighteyes_ffs-0.0.8.tar.gz
  • Upload date:
  • Size: 115.2 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.8.tar.gz
Algorithm Hash digest
SHA256 10e74849d1d78673f2d9237e95ec6ab7680039d38f5a8ed5b120fa88bbcaedbc
MD5 c75e8adda73f7932b4fe8fe1f44169b4
BLAKE2b-256 41682c786be6d10176ec9d446ca71a600c4eb72adae657c6d90b0aa2a3f9d616

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brighteyes_ffs-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 146.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.7

File hashes

Hashes for brighteyes_ffs-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 ba7fc953c204211916a999dcea8a84b043c733c11574a43f14a6432c8f65ad2d
MD5 11aee7bf34b5d9bdc8b4ca7495c5f1a7
BLAKE2b-256 f26f4f45ca283cfe1e287fbd8d5178a587e3dfbf6718ad48907f2f78e5b65d23

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