Skip to content

Commit

Permalink
Add DfOverF to docs (#1351)
Browse files Browse the repository at this point in the history
Co-authored-by: Ryan Ly <[email protected]>
  • Loading branch information
bendichter and rly authored May 11, 2021
1 parent 4ad902c commit 497c215
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/gallery/domain/ophys.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@


####################
# .. tip::
# You can also store dF/F data using the :py:class:`~pynwb.ophys.DfOverF` class, which works the same way as
# :py:class:`~pynwb.ophys.Fluorescence`.
#
# Because this data stores information about specific ROIs, you will need to provide a reference to the ROIs
# that you will be storing data for. This is done using a :py:class:`~pynwb.core.DynamicTableRegion`, which can be
# created with :py:func:`~pynwb.ophys.PlaneSegmentation.create_roi_table_region`.
Expand Down Expand Up @@ -227,8 +231,6 @@
# one's life much simpler. NWB currently does not have the ability to read and parse native image formats. It
# is up to downstream users to read these file formats.
#
# .. [#] You can also store dF/F data using the :py:class:`~pynwb.ophys.DfOverF` class.
#
# .. [#] Neurodata sets can be *very* large, so individual components of the dataset are only loaded into memory when
# you request them. This functionality is only possible if closing of the :py:class:`~pynwb.NWBHDF5IO`
# object is handled by the user.
Expand Down

0 comments on commit 497c215

Please sign in to comment.