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 or photon arrival time traces). Supported file types include .h5, .ptu, and .czi.
- Fitting correlations to various 2D and 3D diffusion models
- Calibration-free FCS/FFS analysis such as circular-scanning FCS and pair-correlation analysis
- Miscellaneous tools
The fcs_gui module contains libraries for:
- Storing and loading FCS/FFS analysis sessions, as used in the GUI
The pch module contains libraries for:
- Calculating photon counting histograms
- Fitting histograms with Fluorescence Intensity Distribution Analysis (FIDA)
The tools 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
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
brighteyes_ism
notebook
ptufile
phconvert
GUI
For quick and common types of analysis, you can use the GUI (https://github.com/VicidominiLab/BrightEyes-FFS-GUI), which contains most of the basic features. In addition, there is an automatic Jupyter Notebook writing tool to convert an analysis session started in the GUI to a Notebook.
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.
- Fork the project.
- Create a branch for your feature:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'My new feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request!
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file brighteyes_ffs-0.1.7.tar.gz.
File metadata
- Download URL: brighteyes_ffs-0.1.7.tar.gz
- Upload date:
- Size: 157.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1c2e8b2bc9ece4d0dd54c374d148be41e2f96dc914505a0048c4590ed345daf9
|
|
| MD5 |
3e7e28472cf9434e7c17f98449713823
|
|
| BLAKE2b-256 |
22407cd743ffb48457dbe0873ad6d22293537c2028369eeacda43a7c3bcf7f27
|
File details
Details for the file brighteyes_ffs-0.1.7-py3-none-any.whl.
File metadata
- Download URL: brighteyes_ffs-0.1.7-py3-none-any.whl
- Upload date:
- Size: 193.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3e532f00e59f1ad5b9d64e3e25607e1128f2197da270afa86c9472056c30fc60
|
|
| MD5 |
ca8d965f8d3bf4772113ccfc36989149
|
|
| BLAKE2b-256 |
329bdee90fa1edd81f4ae88ef96760041169e09aefcf259a34bcad431fd5e2ec
|
