napari-live-recording
This napari plugin was generated with Cookiecutter using with @napari's cookiecutter-napari-plugin template.
Description
napari-live-recording (or nlr, if you like acronyms) is a medium-weight plugin part of the napari ecosystem that provides an easy
access point for controlling area detector devices (most commonly reffered to as cameras) with a common interface.
Other than that, the plugin also allows to create computation pipelines that can be executed real-time in a flow starting directly from the camera stream.
[!NOTE]
Why medium weight?
napari-live-recordingrelies on multithreading to handle camera control, image processing and data storage via a common pipelined infrastructure. More details are provided in the documentation.
The plugin allows the following operations:
- snapping: capture a single image
- live view: continously acquiring from the currently active camera and show the collected data on the napari viewer;
- recording: stream data to disk from the currently active cameras
When recording, the plugin allows to store images according to the following formats:
- ImageJ TIFF
- OME-TIFF
[!NOTE] Future releases will also add further file formats to the recording options, specifically:
- HDF5
- MP4
We will also provide a method to add custom metadata to the recorded image files.
Supported cameras
napari-live-recording aims to maintain itself agnostic for the type of cameras it controls. Via a common API (Application Programming Interface),
it possible to define a controller for a specific camera. Instructions
on how to do so are provided in the documentation.
By default, the plugin is shipped with the following interfaces:
- an OpenCV camera grabber;
- a Micro-Manager interface via the package
pymmcore-plus; - an interface to the microscope python package.
Documentation
To install and use the plugin you can review the documentation here.
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.
Acknowledgments
The developers would like to thank the Chan-Zuckerberg Initiative (CZI) for providing funding for this project via the napari Ecosystem Grants.
License
Distributed under the terms of the MIT license, "napari-live-recording" is free and open source software
Issues
If you encounter any problems, please file an issue along with a detailed description.
1 maintainer
Metadata
1 maintainer
Release files for napari-live-recording 0.3.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| napari-live-recording-0.3.8.tar.gz | 861.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| napari_live_recording-0.3.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.5 MB
Release files / napari-live-recording-0.3.8.tar.gz
| Download URL | napari-live-recording-0.3.8.tar.gz |
|---|---|
| Size | 861.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5bc06130032780cec852882d464f301a58d27abb3cc50539e90aa5a1b4a263aa
|
|
BLAKE2b-256 checksum How to use checksums |
9905ba41881e15eba63a3c6ef8fe5fe792bd23748132c1ca5aaddad025817bdf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
Release files / napari_live_recording-0.3.8-py3-none-any.whl
| Download URL | napari_live_recording-0.3.8-py3-none-any.whl |
|---|---|
| Size | 597.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bd726ca2e3ec119e03ee00c46d0e409002067994dc6ad3a7d47b96e98539862f
|
|
BLAKE2b-256 checksum How to use checksums |
506e36d177c8b048b49613afc829d7696b83d7c76af1cb27d880192be8571214
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
Security for napari-live-recording 0.3.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
