Skip to content
This repository has been archived by the owner on Jan 17, 2020. It is now read-only.

jries/fit3Dcspline

Repository files navigation

Important: fit3Dcspline has been fully integrated in SMAP and is now archived. Clone SMAP to have access to fit3Dcspline.

fit3Dcspline

fit3Dcspline is a GPU based 3D single molecule fitter for arbitrary, experimental point spread functions (PSF). The fitting speeds achieves more than 10^5 fits/s on a consumer graphic card GTX 1070. The implmentation of the fitting algorithm is based on maximum likelihood estimation and employs Levenberg-Marquardt optimization routine, which reaches theoretical minimum uncertainty. Both the EMCCD and sCMOS noise model are included. The softare package also includes tools to robustly model beads based experimental PSFs of different modality and correct for depth induce aberrations.

Requirements

  • Matlab R2016a or newer
    • Curve Fitting Toolbox
    • Optimization Toolbox

The GPU fitter requires:

  • Microsoft Windows 7 or newer, 64-bit
  • CUDA capable graphics card, minimum Compute Capability 3.0
  • CUDA 8 compatible graphics driver (for GeForce products 378.66 or later)

The CPU version runs on macOS and Microsoft Windows 7 or newer, 64-bit

How to run

Example code is avalible in file example_3D_fit.m. The required 3D image stacks for the demo code can be found in the folder by following this link. A full instruction guide can be found in User_guide_Ries.pdf.

Contact

For any questions / comments about this software, please contact Ries Lab.

Copyright and Software License

Copyright (c) 2017 Ries Lab, European Molecular Biology Laboratory, Heidelberg.

fit3Dcspline also includes OME Bio-Formats package for reading and converting biological file formats in folder bfmatlab which comes with a separate copyright.

The fit3Dcspline is licenced under the GNU GPL.

How to cite fit3Dcspline

If you use fit3Dcspline to process your data, please, cite our paper:

  • Yiming Li, Markus Mund, Philipp Hoess, Joran Deschamps, Ulf Matti, Bianca Nijmeijer, Vilma Jimenez Sabinina, Jan Ellenberg, Ingmar Schoen, Jonas Ries. Real-time 3D single-molecule localization using experimental point spread functions. Nat. Methods 15, 367–369 (2018).

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published