Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Oliver Ruebel <[email protected]>
  • Loading branch information
stephprince and oruebel authored Jan 11, 2024
1 parent 5abcbe0 commit 93a2c63
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
7 changes: 4 additions & 3 deletions docs/gallery/domain/plot_icephys.py
Original file line number Diff line number Diff line change
Expand Up @@ -459,9 +459,10 @@
)

#####################################################################
# One predefined subcategory column is the stimulus template column in the stimuli table. This column can be used to
# store stimulus template waveforms that were generated by the recording software. Similar to the stimulus and response
# columns, we can specify a relevant time range.
# One predefined subcategory column is the ``stimulus_template`` column in the stimuli table. This column is
# used to store template waveforms of stimuli in addition to the actual recorded stimulus that is stored in the
# ``stimulus`` column. Similar to the ``stimulus`` and ``response`` columns, we can specify a relevant
# time range.

nwbfile.intracellular_recordings.add_column(
name="stimulus_template",
Expand Down
12 changes: 7 additions & 5 deletions src/pynwb/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -505,11 +505,13 @@ def empty(cls, timeseries):
When missing data needs to be represented, NWB defines ``None`` for the complex data type ``(idx_start,
count, TimeSeries)`` as (-1, -1, TimeSeries) for storage. The exact timeseries object will technically not
matter since the empty reference is a way of indicating a NaN value. In practice, this may be used in the
:py:class:`~pynwb.icephys.IntracellularRecordingsTable` where only one of stimulus or response data was
recorded. In such cases, the timeseries object for the empty stimulus TimeSeriesReference could be set to the
response series or vice versa (the timeseries object for the empty response TimeSeriesReference could be set
to the stimulus)
matter since the empty reference is a way of indicating a NaN value. in a
:py:class:`~pynwb.base.TimeSeriesReferenceVectorData` column.
An example, where this functionality is used is :py:class:`~pynwb.icephys.IntracellularRecordingsTable`
where only one of stimulus or response data was recorded. In such cases, the timeseries object for the
empty stimulus :py:class:`~pynwb.base.TimeSeriesReference` could be set to the response series, or
vice versa.
:returns: Returns :py:class:`~pynwb.base.TimeSeriesReference`
"""
Expand Down

0 comments on commit 93a2c63

Please sign in to comment.