zitmen/thunderstorm-algorithms

A collection of image and data analysis algorithms used in ThunderSTORM

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.zitmen:thunderstorm-algorithms:'
	}
	dependencies {
		implementation("com.github.zitmen:thunderstorm-algorithms:")
	}
	<dependency>
	    <groupId>com.github.zitmen</groupId>
	    <artifactId>thunderstorm-algorithms</artifactId>
	    <version></version>
	</dependency>

                            
    libraryDependencies += "com.github.zitmen" % "thunderstorm-algorithms" % ""
        
        

                            
    :dependencies [[com.github.zitmen/thunderstorm-algorithms ""]]

Readme

Important: do not rely on the API until the stable version 1.0 is released as it is still subject to change!

Build Status codecov

This is a collection of image and data analysis algorithms used in ThunderSTORM. We provide the algorithms as a separate light-weight library for better reusability.

Links

About ThunderSTORM

ThunderSTORM is an open-source, interactive, and modular plug-in for ImageJ designed for automated processing, analysis, and visualization of data acquired by single molecule localization microscopy methods such as PALM and STORM. Our philosophy in developing ThunderSTORM has been to offer an extensive collection of processing and post-processing methods so that users can easily adapt the process of analysis to their data.

Getting started

Currently the most simple approach to link our library to your project is using JitPack. Look here for the instructions.

How to cite ThunderSTORM

If you use ThunderSTORM or any of its components to process your data, please, cite our paper:

  • M. Ovesný, P. Křížek, J. Borkovec, Z. Švindrych, G. M. Hagen. ThunderSTORM: a comprehensive ImageJ plugin for PALM and STORM data analysis and super-resolution imaging. Bioinformatics 30(16):2389-2390, 2014.