Metadata-Version: 2.1
Name: pyMatchSeries
Version: 0.1.0
Summary: A python wrapper for the non-rigid-registration code match-series
Home-page: https://github.com/din14970/pyMatchSeries
Author: Niels Cautaerts
Author-email: nielscautaerts@hotmail.com
License: GPL-3.0
Keywords: TEM
Platform: UNKNOWN
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Requires-Dist: hyperspy (>=1.6.1)
Requires-Dist: Pillow
Requires-Dist: tabulate
Provides-Extra: dev
Requires-Dist: black (>=19.3b0) ; extra == 'dev'
Requires-Dist: pre-commit (>=1.16) ; extra == 'dev'
Requires-Dist: sphinx (>=3.0.2) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (>=0.4.3) ; extra == 'dev'
Requires-Dist: pytest (>=5.4) ; extra == 'dev'
Requires-Dist: pytest-cov (>=2.8.1) ; extra == 'dev'
Requires-Dist: coverage (>=5.0) ; extra == 'dev'
Provides-Extra: doc
Requires-Dist: sphinx (>=3.0.2) ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme (>=0.4.3) ; extra == 'doc'
Provides-Extra: tests
Requires-Dist: pytest (>=5.4) ; extra == 'tests'
Requires-Dist: pytest-cov (>=2.8.1) ; extra == 'tests'
Requires-Dist: coverage (>=5.0) ; extra == 'tests'

<p align="center">
<a href="https://github.com/din14970/pyMatchSeries/actions"><img alt="Actions Status" src="https://github.com/din14970/pyMatchSeries/workflows/build/badge.svg"></a>
<a href="https://coveralls.io/github/din14970/pyMatchSeries?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/din14970/pyMatchSeries/badge.svg?branch=master"></a>
<a href="https://pypi.org/project/pyMatchSeries/"><img alt="PyPI" src="https://img.shields.io/pypi/v/pyMatchSeries.svg?style=flat"></a>
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>

# Description
This is a tool for non-rigid registration, primarily for atomic resolution STEM images, and is a python wrapper of the [match-series](https://github.com/berkels/match-series) code developed by B. Berkels. When using this tool, please cite the papers mentioned in that repository. 

The goal of match-series is to remove slow and fast scan noise in STEM image stacks by comparing the various images against each other. The output of the code are X and Y deformation fields for each image in the stack. These deformations can then be applied to stacks of images or to EDX/EELS spectum maps that were acquired frame by frame. The goal of pymatchseries is to facilitate the set-up of the calculation and to work with the results in python. It is intended to use this tool mainly semi-interactively in a Jupyter notebook, see [the example](https://github.com/din14970/pyMatchSeries/blob/master/examples/example.ipynb).

Try it out here:
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/din14970/pyMatchSeries/testing)

To install, simply pip install:
```
$ pip install --user pyMatchSeries
```

Note that, since it directly tries to call the matchSeries binary in a subprocess, **you must compile and/or install match-series on your own**. The program is available via conda install:

```
$ conda install -c conda-forge match-series
```

# Changelog

## v0.1.0
* Significantly simplified the API and made code more future proof
* Trying out CI/CD pipelines


