Skip to main content

A Python package for fast and robust Image Stitching

Project description

stitching

A Python package for fast and robust Image Stitching.

Based on opencv's stitching module and inspired by the stitching_detailed.py python command line tool.

inputs

result

Installation

use the docker image

or pip to install stitching from PyPI.

pip install stitching

Usage

Python CLI

The command line interface (cli) is available after installation

stitch -h show the help

stitch *.jpg stitches all jpg files in the current directory

stitch img_dir/IMG*.jpg stitches all files in the img_dir directory starting with "IMG" and ending with ".jpg"

stitch img1.jpg img2.jpg img3.jpg stitches the 3 explicit files of the current directory

Enable verbose mode with stitch *.jpg -v. This will create a folder where all intermediate results are stored so that you can find out where there are problems with your images, if any

Docker CLI

If you are familiar with Docker and don't feel like setting up Python and an environment, you can also use the openstitching/stitch Docker image

docker container run --rm -v /path/to/data:/data openstitching/stitch:{version} -h

You can use the Python CLI as described above (read "current directory" as "/data directory").

Python Script

You can also use the Stitcher class in your script

from stitching import Stitcher
stitcher = Stitcher()

Specify your custom settings as

stitcher = Stitcher(detector="sift", confidence_threshold=0.2)

or

settings = {"detector": "sift", "confidence_threshold": 0.2}
stitcher = Stitcher(**settings)

Create a Panorama from your Images:

  • from a list of filenames
panorama = stitcher.stitch(["img1.jpg", "img2.jpg", "img3.jpg"])
  • from a single item list with a wildcard
panorama = stitcher.stitch(["img?.jpg"])
  • from a list of already loaded images
panorama = stitcher.stitch([cv.imread("img1.jpg"), cv.imread("img2.jpg")])

The equivalent of the --affine cli parameter within the script is

from stitching import AffineStitcher
stitcher = AffineStitcher()
panorama = stitcher.stitch(...)

The equivalent of the -v/--verbose cli parameter within the script is

panorama = stitcher.stitch_verbose(...)

Questions

For questions please use our discussions. Please do not use our issue section for questions.

Contribute

Read through how to contribute for information on topics like finding and fixing bugs and improving / maintaining this package.

Tutorial

This package provides utility functions to deeply analyse what's happening behind the stitching. A tutorial was created as Jupyter Notebook. The preview is here.

You can e.g. visualize the RANSAC matches between the images or the seam lines where the images are blended:

matches1 matches2 seams1 seams2

Literature

This package was developed and used for our paper Automatic stitching of fragmented construction plans of hydraulic structures

License

Apache License 2.0

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

stitching-0.6.1.tar.gz (30.5 kB view details)

Uploaded Source

Built Distribution

stitching-0.6.1-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file stitching-0.6.1.tar.gz.

File metadata

  • Download URL: stitching-0.6.1.tar.gz
  • Upload date:
  • Size: 30.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for stitching-0.6.1.tar.gz
Algorithm Hash digest
SHA256 50cef52aa2bfc8f615e1296d50b085063b4b1034ea95f87b99f0b9d8154acc45
MD5 f37fe42cc77c648dac6eea92c3e304b2
BLAKE2b-256 8267386522eb119fd077228d8c3b75f8a32b746f1f39edae15b97489b05f8b88

See more details on using hashes here.

File details

Details for the file stitching-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: stitching-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 30.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for stitching-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 656997250436e41ba40369cc4778ecc756b792b38a727514242cc73abd3be1d9
MD5 0ed798962d75bd4b02a6d4cdaad7928a
BLAKE2b-256 ff692b5294bab519ea34162fc44977376cdccc27cf6a3117072bce684260a735

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