|
1 | 1 | blinx
|
2 | 2 | =====
|
| 3 | +A Bayesian method to Count the Number of Molecules within a Diffraction Limited Spot |
| 4 | +-- |
3 | 5 |
|
4 |
| -A tool to estimate the number of blinking fluorescent molecules in a spatially un-resolvable region. |
| 6 | +- **[Introduction](#introduction)** |
| 7 | +- **[Installation](#installation)** |
| 8 | +- **[Examples](#examples)** |
| 9 | +- **[Citation](#citation)** |
5 | 10 |
|
6 | 11 |
|
7 |
| -Check out the [documentation](https://funkelab.github.io/blinx/) |
| 12 | +# Introduction |
| 13 | +This repository contains code to estimate the number of fluorescent emitters |
| 14 | +when only their combined intensity can be measured. |
8 | 15 |
|
| 16 | +`blinx` directly models the photo-physics of the system as well as temporal |
| 17 | +fluctuations in intensity to produce a probabilistic estimate of the molecular count. |
9 | 18 |
|
10 |
| -`blinx` is designed to work with any type of stochastically blinking emitters, but was specifically built with the analysis of |
11 |
| -[DNA-PAINT](https://www.nature.com/articles/nprot.2017.024) experiments in mind. |
| 19 | + |
12 | 20 |
|
| 21 | +Detailed documentation can be found: [here](https://funkelab.github.io/blinx/) |
13 | 22 |
|
14 |
| -At the base level, `blinx` works on a piece of data called the *intensity trace*, which is an ordered sequence of intensity measurements over time. |
| 23 | +# Installation |
| 24 | +For a basic CPU installation: |
| 25 | +```bash |
| 26 | +conda create -n blinx python |
| 27 | +conda activate blinx |
| 28 | +git clone https://github.com/funkelab/blinx.git |
| 29 | +cd blinx |
| 30 | +pip install . |
| 31 | +``` |
15 | 32 |
|
| 33 | +For a GPU installation specific versions of jax and jaxlib must be pinned: |
| 34 | +```bash |
| 35 | +conda create -n blinx python cudatoolkit=11.4 cudatoolkit-dev=11.4 cudnn=8.2 -c conda-forge |
| 36 | +conda activate blinx |
| 37 | +git clone https://github.com/funkelab/blinx.git |
| 38 | +cd blinx |
| 39 | +pip install . |
| 40 | +pip install 'jax==0.4.1' 'jaxlib==0.4.1+cuda11.cudnn82' -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html |
| 41 | + |
| 42 | +``` |
| 43 | +# Examples |
| 44 | +`blinx` contains two primary modules. An estimate module to determine the posterior over molecular count, |
| 45 | +and a forward model to generate simulated traces from a given set of parameters. |
| 46 | + |
| 47 | +### Fitting: |
| 48 | + |
| 49 | +`blinx.estimate` |
| 50 | + |
| 51 | + |
| 52 | +### Forward Model: |
| 53 | + |
| 54 | +`blinx.trace_model.generate_trace` |
0 commit comments