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.7.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.7-py3-none-any.whl (146.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brighteyes_ffs-0.0.7.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.7.tar.gz
Algorithm Hash digest
SHA256 e6c5604bd62991754a644dc72885bb2680733137e1c1a4efdff580e737c8b96d
MD5 855e6345e1c9b76cdcdb1d075e06997b
BLAKE2b-256 8ed320dbeb7aef5e82c83482a07a9dc3fe91f0b5478f74e2ec2cb8a021bb8832

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brighteyes_ffs-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 146.8 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d199c8ca0b0373c2e1c565ea1bace20c2f80fca195ea57ef4dc992a2c9614ff0
MD5 cbb974fe8588a192e4d412b771ecd99f
BLAKE2b-256 43fb207c4f01fc40b792e7bebfc5122078722497668c4512890df9931e77e907

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