Merge pull request #523 from catalystneuro/add_one_photon_series

Add OnePhotonSeries
NeurodataWithoutBorders · Oct 24, 2022 · e870091 · e870091
2 parents 47f997f + c95d689
commit e870091
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 4 deletions.
diff --git a/core/nwb.ophys.yaml b/core/nwb.ophys.yaml
@@ -1,4 +1,39 @@
 groups:
+- neurodata_type_def: OnePhotonSeries
+  neurodata_type_inc: ImageSeries
+  doc: Image stack recorded over time from 1-photon microscope.
+  attributes:
+  - name: pmt_gain
+    dtype: float32
+    doc: Photomultiplier gain.
+    required: false
+  - name: scan_line_rate
+    dtype: float32
+    doc: Lines imaged per second. This is also stored in /general/optophysiology but
+      is kept here as it is useful information for analysis, and so good to be stored
+      w/ the actual data.
+    required: false
+  - name: exposure_time
+    dtype: float32
+    doc: Exposure time of the sample; often the inverse of the frequency.
+    required: false
+  - name: binning
+    dtype: uint8
+    doc: Amount of pixels combined into 'bins'; could be 1, 2, 4, 8, etc.
+    required: false
+  - name: power
+    dtype: float32
+    doc: Power of the excitation in mW, if known.
+    required: false
+  - name: intensity
+    dtype: float32
+    doc: Intensity of the excitation in mW/mm^2, if known.
+    required: false
+  links:
+  - name: imaging_plane
+    target_type: ImagingPlane
+    doc: Link to ImagingPlane object from which this TimeSeries data was generated.
+
 - neurodata_type_def: TwoPhotonSeries
   neurodata_type_inc: ImageSeries
   doc: Image stack recorded over time from 2-photon microscope.

diff --git a/docs/format/source/conf.py b/docs/format/source/conf.py
@@ -83,9 +83,9 @@ def setup(app):
 # built documents.
 #
 # The short X.Y version.
-version = '2.5.0'
+version = '2.6.0'
 # The full version, including alpha/beta/rc tags.
-release = '2.5.0'
+release = '2.6.0-alpha'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst
@@ -3,8 +3,13 @@
 Release Notes
 =============
 
-2.6.0 (Upcoming)
-----------------
+
+2.6.0-alpha (Upcoming)
+----------------------
+
+Minor changes
+^^^^^^^^^^^^^
+- Added OnePhotonSeries. (#523)
 - ``Subject.age`` has a new optional attribute, ``reference``, which can take a value of "birth" (default) or "gestational". (#525)
 - Add "in seconds" to the doc of Units.spike_times. (#530)