A package for stitching mosaics from Cockpit with (or without) ROIs
Project description
StitchM
StitchM stitches together mosaic images taken in Cockpit (Micron) into a universally readable format, currently '.ome.tiff'.
The current output is an 16bit greyscale image when stitching the mosaic. Markers exported from Cockpit can be added as rectangular ROIs within the OME metadata stored in the image header. ROIs can be imported and displayed using bioformats in FIJI/ImageJ.
Installation
Using pip: python -m pip install StitchM
Available on PyPI and conda-forge. To use conda-forge, you may need to setup your conda by following instructions found here.
Using StitchM:
- Command line script interface (accessible via
StitchM
orstitchm
, use argument--help
for more details) - Drag and drop shortcut (created using
StitchM setup --windows-shortcut
) that processes mosaic .txt file and optional marker file if dragged on together, but cannot do batch processing of directories - Module entry point (
python -m stitch_m
), which takes the paths of the mosaic and marker files in any order - Imported package:
import stitch_m
orfrom stitch_m import stitch_and_save, stitch, save
Motivation
To make a mosaic image that can be easily viewed and can be used for automatic alignment with a separate grid image (using gridSNAP).
Features
- Creates OME-TIFF file from Cockpit's saved mosaic .txt file, which links to an .mrc file
- OME metadata
- Slight exposure trimming to remove extreme highlights
- Image normalisation to fit data type
- Optional filtering to remove fluorecence images (default can be changed in config file)
- Supports adding regions of interests (ROIs) to metadata using a .txt file containing markers, as can be saved from Cockpit
- Various default behaviours can be changed by editing a user config file (created using
StitchM setup --config
)
Copyright
StitchM is licensed under a BSD license, please see LICENSE file. Copyright (c) 2019-2021, Diamond Light Source Ltd. All rights reserved.
Additional information
StitchM uses OME metadata.
As Cockpit creates the images and accompanying files, so was referenced for the creation of this software. Cockpit is licensed under GNU and can be found at https://github.com/MicronOxford/cockpit
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file stitchm-1.7.0.tar.gz
.
File metadata
- Download URL: stitchm-1.7.0.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ea5720518af53361d7175d23abf8f1adbb09fbf46be4f6f87e78ef320d6ba31 |
|
MD5 | d00fe003d5500bf65fed587aa0648909 |
|
BLAKE2b-256 | 1ae5e88e05f57cb22bf8cabdc54b82a2ff889e37ba261d56f736465d6d98422c |
File details
Details for the file stitchm-1.7.0-py3-none-any.whl
.
File metadata
- Download URL: stitchm-1.7.0-py3-none-any.whl
- Upload date:
- Size: 4.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6be3eb784cfaf1f3441329716aae9ad8329230e2253c5172a7097e404f951b1b |
|
MD5 | 1a297a5892c60f2e873bb8373b52c876 |
|
BLAKE2b-256 | d365e0ceba9cacdf3fb420da879ed38425667ae8caac6982d3cb8bbed7287db9 |