Skip to content

Commit 42b5e56

Browse files
update documentation
1 parent 7642ad6 commit 42b5e56

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

docs/source/format.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,24 @@ Container for multiple PlanarMicroscopySeries.
194194
doc: PlanarMicroscopySeries object(s) containing imaging data for a single depth scan.
195195
quantity: "+"
196196
197+
MultiChannelMicroscopyContainer
198+
^^^^^^^^^^^^^^^^^^^^^^^^^
199+
Container for multiple PlanerMicroscopySeries or VolumetricMicroscopySeries acquired from different channels.
200+
201+
.. code-block:: yaml
202+
203+
groups:
204+
- neurodata_type_def: MultiChannelMicroscopyContainer
205+
neurodata_type_inc: NWBDataInterface
206+
default_name: MultiChannelMicroscopyContainer
207+
doc:
208+
Imaging data acquired over several channels; for instance, when using multiple excitation wavelengths
209+
or multiple indicators. Each channel is stored in a separate PlanarMicroscopySeries or VolumetricMicroscopySeries object.
210+
groups:
211+
- neurodata_type_inc: MicroscopySeries
212+
doc: MicroscopySeries object containing imaging data for a single channel scan.
213+
quantity: "+"
214+
197215
Illumination Pattern Components
198216
--------------------------
199217

docs/source/getting_started.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ Data Series
6868
- **PlanarMicroscopySeries**: 2D time series data
6969
- **VolumetricMicroscopySeries**: 3D time series data
7070
- **MultiPlaneMicroscopyContainer**: Multiple imaging planes
71+
- **MultiChannelMicroscopyContainer**: Multiple channel imaging data
7172

7273
Quick Start Example
7374
================

docs/source/release_notes.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,29 @@
44
Release Notes
55
*************
66

7+
Version 0.3.0 (May, 2025)
8+
==============================
9+
10+
Deprecations and Changes
11+
-------------------------
12+
13+
Features
14+
--------
15+
16+
* Added `MultiChannelMicroscopyContainer` class to support multi-channel imaging data.
17+
* This class allows for the storage of multiple `MicroscopySeries` objects, each representing a different channel of imaging data.
18+
* It provides methods to access and manipulate individual channels, facilitating the analysis of multi-channel datasets.
19+
20+
Improvements
21+
------------
22+
23+
* Improved organization of multi channel imaging data
24+
25+
26+
Notes
27+
------
28+
29+
730
Version 0.2.0 (March 19, 2025)
831
==============================
932

0 commit comments

Comments
 (0)