Skip to main content

Save multidimensional file as folder of tifs

Project description

napari-file2folder

License MIT PyPI Python Version 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

How to cite

If you use this plugin for your research, please cite us using the following reference:

  • Jules Vanaret, Alice Gros, Valentin Dunsing-Eichenauer, Agathe Rostan, Philippe Roudot, Pierre-François Lenne, Léo Guignard, Sham Tlili (2025) A quantitative pipeline for whole-mount deep imaging and analysis of multi-layered organoids across scales. eLife 14:RP107154 ; doi:https://doi.org/10.7554/eLife.107154.2

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-1.0.0.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napari_file2folder-1.0.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: napari_file2folder-1.0.0.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for napari_file2folder-1.0.0.tar.gz
Algorithm Hash digest
SHA256 0c7b4d5f8fee0b8b1dcfbf1e7e64e6f9d9fd10e5631e92666e5146bf328fd021
MD5 07b44d5f542e2b496661df4498a3e486
BLAKE2b-256 d3b1c9c7699a52c6794e8ce90a263acf07d9025a93d32f0b601d3c357d8effc9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for napari_file2folder-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5866abb286c21712177b915cd4f661bedc7dc300e74b86d0180d382d9c0c018e
MD5 d57ba5e5200ad03a350b1c467b6ce468
BLAKE2b-256 1ac96f8610d30a55860fcef400d135bec819b001fb796bc32453c4fc65876a0f

See more details on using hashes here.

Supported by

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