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
ome_types
czifile

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.13.tar.gz (116.5 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.13-py3-none-any.whl (148.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brighteyes_ffs-0.0.13.tar.gz
  • Upload date:
  • Size: 116.5 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.13.tar.gz
Algorithm Hash digest
SHA256 8e243b054896247d73b844f7fdc1de15dc79031f12bb48a9c2005e7641891c28
MD5 85a1bf6233096d2c6b6e5de20ed9d5c9
BLAKE2b-256 efb38aa821be5ab521a415be5cbf37ac9e5736fedb596083e63b24d626813569

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for brighteyes_ffs-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 57cec7d54fa2cb41475f955e541426b19e752847e7584bc54b2cfa5615230cac
MD5 59715f0cbd899de3cc78e26ebfbc41f1
BLAKE2b-256 1f1a1a2b35ed1276953c759f0e3862534d41e2c3f5a4332cdcf62874bf75eb8e

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