Metadata-Version: 2.0
Name: microscopestitching
Version: 0.1.2
Summary: Automatic merge/stitching of regular spaced images
Home-page: https://github.com/arve0/microscopestitching
Author: Arve Seljebu
Author-email: arve.seljebu@gmail.com
License: MIT
Keywords: microscopestitching
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: imreg-dft
Requires-Dist: scikit-image
Requires-Dist: numpy
Requires-Dist: joblib

microscopestitching
===================

|build-status-image| |pypi-version| |wheel|

Overview
--------

This software aims to be a reliable way to stitch your microscope
images. To get good results, a couple of assumptions should be true
about your dataset:

-  images are regular spaced
-  images are of same size
-  side by side images have translation only in one dimension
-  (if not, check your scanning mirror rotation)
-  scale in edge of images are constant

Installation
------------

Install using ``pip``...

.. code:: bash

    pip install microscopestitching

Example
-------

.. code:: python

    from microscopestitching import stitch
    from skimage.io import imsave

    images = []
    for i in range(50):
        row = i // 10
        col = i % 10
        images.append(('%d.png' % i, row, col))

    merged = stitch(images)
    imsave('merged.png', merged)

See also `notebook
examples <http://nbviewer.ipython.org/github/arve0/microscopestitching/blob/master/notebooks/>`__.

API reference
-------------

API reference is at http://microscopestitching.rtfd.org.

Development
-----------

Install dependencies and link development version of microscopestitching
to pip:

.. code:: bash

    git clone https://github.com/arve0/microscopestitching
    cd microscopestitching
    pip install -r requirements.txt # install dependencies and microscopestitching-package

Testing
~~~~~~~

.. code:: bash

    tox

Build documentation locally
~~~~~~~~~~~~~~~~~~~~~~~~~~~

To build the documentation:

.. code:: bash

    pip install -r docs/requirements.txt
    make docs

.. |build-status-image| image:: https://secure.travis-ci.org/arve0/microscopestitching.png?branch=master
   :target: http://travis-ci.org/arve0/microscopestitching?branch=master
.. |pypi-version| image:: https://pypip.in/version/microscopestitching/badge.svg
   :target: https://pypi.python.org/pypi/microscopestitching
.. |wheel| image:: https://pypip.in/wheel/microscopestitching/badge.svg
   :target: https://pypi.python.org/pypi/microscopestitching


