Skip to main content

Save multidimensional file as folder of tifs

Project description

napari-file2folder

License MIT PyPI Python Version tests codecov napari hub

A plugin to inspect bioimages (e.g. .tif, .czi, .nd2, .lsm...) and save them as individual .tif files in a folder.

napari-file2folder is a napari plugin that is part of the Tapenade project. Tapenade is a tool for the analysis of dense 3D tissues acquired with deep imaging microscopy. It is designed to be user-friendly and to provide a comprehensive analysis of the data.

If you use this plugin for your research, please cite us.

Overview

This plugin allows you to inspect (possibly large) bioimages by displaying their shape (number of elements in each dimension), and allowing you to save each element along a chosen dimension as a separate .tif file in a folder. This is useful when you have a large movie or stack of images and you want to save each frame or slice as a separate file. Optionally, the plugin allows the user to visualize the middle element of a given dimension to help the user decide which dimension to save as separate files.

The plugin currently supports the following file formats:

  • .tif
  • .ome.tiff
  • .zarr
  • .ome.zarr
  • .nd2
  • .lsm
  • .czi

This plugin leverages tifffile, bioio, and zarr to circumvent loading the entire images in memory, which allows inspection of very large images.

[!CAUTION] When inspecting the middle element of a dimension, or when saving one element of a dimension as a separate file, the plugin loads the element in memory, which means that at least this lone element must fit in memory.

Installation

The plugin obviously requires napari to run. If you don't have it yet, follow the instructions here.

The simplest way to install napari-file2folder is via the napari plugin manager. Open Napari, go to Plugins > Install/Uninstall Packages... and search for napari-file2folder. Click on the install button and you are ready to go!

You can install napari-file2folder via pip:

pip install napari-file2folder

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, "napari-file2folder" is free and open source software

Issues

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


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

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

napari_file2folder-0.0.1.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

napari_file2folder-0.0.1-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file napari_file2folder-0.0.1.tar.gz.

File metadata

  • Download URL: napari_file2folder-0.0.1.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.14

File hashes

Hashes for napari_file2folder-0.0.1.tar.gz
Algorithm Hash digest
SHA256 c3d7cb07094d25c1df9fe9dd63ae54bd0c9ceb9dec74a145f97e8b5bf751c519
MD5 6c3a6e3ee1cdd0af5b4a0c9c33c1348a
BLAKE2b-256 88e08a6b9d1cbb258119e9625fe41e45e9517a28862f84bd3a3b964df558645f

See more details on using hashes here.

File details

Details for the file napari_file2folder-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_file2folder-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b26472c6211621aaa6408326ff4706d915d4a04c9bff491ae88c16153a213291
MD5 b0310d4e5a746cf54c61c934a8b4463c
BLAKE2b-256 f2018eb8ca4abf062840417c558e213f6e76a1bea4ba17f867b3dbaeb95035dc

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