extension to allow use of multichannel volumetric images
Project description
ndx-multichannel-volume Extension for NWB
This extension is to add support for volumetric multichannel images. This extends existing NWB functions for optophysiology imaging to allow for 3 dimensions and a flexible number of channels. There is additional support for adding metadata that is necessary for imaging in C. Elegans.
Installation
To install this package on Unix/macOS, run in command line python3 -m pip install --index-url https://pypi.org/simple/ --no-deps ndx-multichannel-volume
On windows, run
py -m pip install --index-url https://pypi.org/simple/ --no-deps ndx-multichannel-volume
Usage
This extension is to add support for volumetric multichannel images. This extends existing NWB functions for optophysiology imaging to allow for 3 dimensions and a flexible number of channels. There is additional support for adding metadata that is necessary for imaging in C. Elegans.
New classes added in this extension are:
CElegansSubject - extension of the base subject class with additional attributes for metadata specific to C. Elegans.
MultiChannelVolumeSeries - extension of the base TimeSeries class to support multiple channels and 3 dimensions.
MultiChannelVolume - class for storing mutlichannel volumetric images with a flexible number of channels.
ImagingVolume - alternate version of the native ImagingPlane class for supporting metadata associated with volumetric multichannel images. Contains a list of optical channel references as well as an ordered list of how those channels index to the channels in the image.
OpticalChannelPlus - extension of the OpticalChannel class to support additional information including emission_range, excitation_range, and excitation_lambda.
OpticalChannelReferences - contains ordered list of optical channel to represent the order of the optical channels in the reference volume.
VolumeSegmentation - contains segmentation masks for image volumes. There are options to use either a standard voxel_mask with XYZ information as well as a Cell ID label, or color_voxel_mask which has RGBW information as well as XYZ.
Please see https://github.com/focolab/ndx-multichannel-volume/blob/main/src/pynwb/create_NWB.ipynb for example code on how to use these new data types/classes
This extension was created using ndx-template.
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
Hashes for ndx-multichannel-volume-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 830f8f4bd7daebde034bb0b729c22163fd5844ae30610ea583636ee2286c3215 |
|
MD5 | 2af21cc882a9c633b929bc5674340e90 |
|
BLAKE2b-256 | db0e30785303fa732686a956213857d1bb061382bf61b796662b9fd55e6604ae |
Hashes for ndx_multichannel_volume-0.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad128350accc287a87a0e518a93e60ae0d323ddde0b6129758568f7261ab3d97 |
|
MD5 | 4a32f840cf0c06ee21c3efbecbbf8cf7 |
|
BLAKE2b-256 | c38e4c8fafab4b22142f9f9c721cc1132d60f01e82057cdef8a9ffedb1261598 |