Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add DfOverF to docs #1351

Merged
merged 3 commits into from
May 11, 2021
Merged

Add DfOverF to docs #1351

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d73fb69
Add `DfOverF` to docs
bendichter Apr 13, 2021
58598bb
Merge branch 'dev' into doc/df_over_f
bendichter Apr 13, 2021
7decdf5
Merge branch 'dev' into doc/df_over_f
rly May 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/gallery/domain/ophys.py
View file
Open in desktop
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