Skip to main content

A python wrapper for the non-rigid-registration code match-series

Project description

Actions Status Coverage Status PyPI Code style: black

Description

This is a tool for non-rigid registration, primarily for atomic resolution STEM images, and is a python wrapper of the 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.

Try it out here: Binder

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyMatchSeries-0.1.0.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

pyMatchSeries-0.1.0-py3-none-any.whl (26.7 kB view details)

Uploaded Python 3

File details

Details for the file pyMatchSeries-0.1.0.tar.gz.

File metadata

  • Download URL: pyMatchSeries-0.1.0.tar.gz
  • Upload date:
  • Size: 25.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for pyMatchSeries-0.1.0.tar.gz
Algorithm Hash digest
SHA256 37325ef7fa457eff84097cb0166004754d100a50802af47512055e405df62c65
MD5 5a15b6a7684b111c1c16cea999f1b191
BLAKE2b-256 ea5cfc38b3783b668b45a4e1229889cbb9eaa4c08e6c08902b7b5639c90ac1cc

See more details on using hashes here.

File details

Details for the file pyMatchSeries-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pyMatchSeries-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 26.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for pyMatchSeries-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5c6b7d540a32e98ba25374281471e20e0519e74f43a298113fcb65a012d32e2
MD5 8a4569cd3a12d171ef266ea7e521d8cb
BLAKE2b-256 90b99c386c29aaf2b121afb9a0fe03459730c21fc6c83577450203694b15ece2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page