Skip to main content

A plugin to visualize, deskew, and combine Snouty data.

Project description

snouty-viewer

License MIT PyPI Python Version tests codecov napari hub

Description

Easy to use plugin for opening raw Snouty files and converting them to native view.

Allows for saving to ome.tif files with corresponding OME-XML based metadata.

Also allows for bulk deskewing and saving directories.

Example

Intended Audience & Supported Data

This plugin is intended for those using a SOLS (Snouty) microscope collected via Alfred Millett-Sikking's code.

This plugin accepts a folder with at least subdirectories of data and metadata as an input.

Quickstart

A. Getting the plugin working (choose either a or b, you don't have to do both)

a. Through pip-install:

  1. pip install snouty-viewer (within a virtual environment of Python 3.8, 3.9, or 3.10 recommended)
  2. Open up napari

b. Through Napari:

  1. Open up napari
  2. Plugins > Install/Uninstall plugins
  3. Search for "snouty-viewer"
  4. Install
  5. (Maybe need to) reopen napari

B. Viewing raw Snouty data

  • Drag and drop a root folder of your Snouty data. This is the folder that includes the data and metadata subfolders.
  • Select "Snouty Viewer" for opening.

C. Converting raw Snouty data to its native view

  1. Click plugins, snouty-viewer -> Native View
  2. Select the file you want to convert
  3. Press Deskew

D. Saving your native view file

  1. Select the channel (or multi-channel) layer you want to save
  2. File > Save Selected Layer(s)...
  3. Select where you want to save your file
  4. Title your file, ".ome.tif" will automatically be appended.
  5. Save with "Snouty Writer"
  6. Wait (this could take a few minutes depending on your file's size and your hardware)

E. Batch saving

  1. Click plugins, snouty-viewer -> Batch Deskew & Save
  2. Input a directory (without quotes) that contains 1 or more Snouty-acquired directories.
  3. If you want to view your deskewed outputs, check the box.
  4. If you want to automatically save the deskewed outputs, check the box.
  5. Press Deskew and save
  6. Wait (this could take a few minutes depending on your files' sizes and your hardware)

Getting Help


This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.

Installation

You can install snouty-viewer via pip:

pip install snouty-viewer

To install latest development version :

pip install git+https://github.com/aelefebv/snouty-viewer.git

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the MIT license, "snouty-viewer" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

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

snouty_viewer-0.2.3.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

snouty_viewer-0.2.3-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file snouty_viewer-0.2.3.tar.gz.

File metadata

  • Download URL: snouty_viewer-0.2.3.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for snouty_viewer-0.2.3.tar.gz
Algorithm Hash digest
SHA256 43fc9bb720876d4158311750ff2c370979b66d80cbb3c553bf72802cfccef03c
MD5 f17dde4fa67ac0de1b0b8e6d399800a9
BLAKE2b-256 b373d3f7fdc658a5a36775d99b6090138f1e902293176ac82561cd9285ba4986

See more details on using hashes here.

File details

Details for the file snouty_viewer-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: snouty_viewer-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for snouty_viewer-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 353ecdf1912247f32d09549ba9325b59d9161a308e553b3ec631c29d3013d16d
MD5 fb3b009866c3b1480f36e7b663bacd19
BLAKE2b-256 0617d79cdc93b7e88f20495cdda5fa0cd2ae184d33bc454c011069a12ac965c7

See more details on using hashes here.

Supported by

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