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

Uploaded Python 3

File details

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

File metadata

  • Download URL: brighteyes_ffs-0.0.9.tar.gz
  • Upload date:
  • Size: 115.1 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.9.tar.gz
Algorithm Hash digest
SHA256 a28c53ea3aca3f17fb4da428e7bc6e42f5758b6a1582abf9f70ffb51a899772d
MD5 de4cc130d17d8c196cc2309a95bada72
BLAKE2b-256 3faf900165eb6867c049bb4b900b6e4946ae664f899fe40b096c8e6aee671837

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brighteyes_ffs-0.0.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8e06ff8a8356b758a7ff3fd92c8cab7441ac3aa2713c18df241f63bf90856d9f
MD5 8248de342ab2a929f096c8ee8db0e9e6
BLAKE2b-256 0bd14829fc0cb7ea75217139ba6852859adeb365f12f459b73974277f2a9bc67

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