Metadata-Version: 2.1
Name: finder_smlm
Version: 0.0.4
Summary: FINDER algorithm for SMLM
Author: Andreas Nold, Pietro Verzelli
License: MIT License
        
        Copyright (c) 2022 Pietro Verzelli
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# FINDER

-----------
by Andreas Nold and Pietro Verzelli


`FINDER` is a (meta)-clustering algorithm developed for Single Molecule Localization Microscopy (SMLM).
It was introduced in our paper 
['Unbiased choice of global clustering parameters for single-molecule localization microscopy'](https://www.nature.com/articles/s41598-022-27074-1).


Please consider citing it:

```
@article{verzelli2022unbiased,
  title={Unbiased choice of global clustering parameters for single-molecule localization microscopy},
  author={Verzelli, Pietro and Nold, Andreas and Sun, Chao and Heilemann, Mike and Schuman, Erin M and Tchumatchenko, Tatjana},
  journal={Scientific Reports},
  volume={12},
  number={1},
  pages={22561},
  year={2022},
  publisher={Nature Publishing Group UK London}
}
```

For some examples of its usage and all the code used to generate the experiments of the paper, you can refer to 
[this repo](https://github.com/NoldAndreas/FINDER).

# Installation

----------------

The simplest way to install Spektral is from PyPi:
```shell
pip install finder_smlm 
```

To install FINDER on Google Colab:

```python
! pip install finder_smlm
```

## Using FINDER

---------------

Using `FINDER` is really simple.
Here we provide a minimal working example in which we cluster some randomly generated data.

```python
from finder import Finder
import numpy as np

XC = np.random.rand(100, 2) # generate random data to cluster

FD = Finder() # define the model
labels = FD.fit(XC) # fit the data, returning the labels
result = FD.selected_parameters 
print(result)
```

to your code, analogous to DBSCAN in the `sklearn.cluster` package.
FINDER will choose global clustering parameters according to the overall noise levels / the robustness detected in the dataset.
