Skip to content

Commit

Permalink
Add tests, small updates to spec
Browse files Browse the repository at this point in the history
  • Loading branch information
rly committed Apr 21, 2024
1 parent eb86335 commit d08b2cb
Show file tree
Hide file tree
Showing 6 changed files with 743 additions and 242 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ classDiagram
<<Not sure what type>>
name : str
manufactuer : str
manufacturer : str
model : str
contour : List[Tuple[float, float], Tuple[float, float, float]]
contact_table : ContactsTable
Expand All @@ -151,7 +151,7 @@ classDiagram
--------------------------------------
name : str
description : str
--------------------------------------
columns
--------------------------------------
Expand All @@ -163,7 +163,7 @@ classDiagram
}
}
ExtracellularSeries ..> ChannelsTable : links with channels
ProbeModel *--> ContactTable : contains
Expand Down
61 changes: 32 additions & 29 deletions spec/ndx-extracellular-channels.extensions.yaml
Original file line number Diff line number Diff line change
@@ -1,27 +1,7 @@
groups:
- neurodata_type_def: ProbeInsertion
neurodata_type_inc: NWBContainer
doc: Metadata about the insertion of a probe into the brain, which can be used to
determine the location of the probe in the brain.
attributes:
- name: reference
dtype: text
doc: Reference point for `insertion_position_in_mm` coordinates, e.g., "bregma
at the cortical surface".
required: false
- name: hemisphere
dtype: text
doc: The hemisphere ("left" or "right") of the targeted location of the optogenetic
stimulus site. Should be consistent with `insertion_position_in_mm.ml` coordinate
(left = ml < 0, right = ml > 0).
required: false
- name: depth_in_mm
dtype: float
doc: Depth that the probe was driven along `insertion_angle` starting from `insertion_position_in_mm`,
in millimeters.
required: false
- neurodata_type_def: ContactsTable
neurodata_type_inc: DynamicTable
default_name: contacts_table
doc: Metadata about the contacts of a probe, compatible with the ProbeInterface
specification.
datasets:
Expand Down Expand Up @@ -79,20 +59,20 @@ groups:
doc: The axes defining the contact plane. See https://probeinterface.readthedocs.io/en/main/format_spec.html
for more details.
quantity: '?'
- name: radius
- name: radius_in_um
neurodata_type_inc: VectorData
dtype: float
doc: Radius of a circular contact.
doc: Radius of a circular contact, in micrometers.
quantity: '?'
- name: width
- name: width_in_um
neurodata_type_inc: VectorData
dtype: float
doc: Width of a rectangular or square contact.
doc: Width of a rectangular or square contact, in micrometers.
quantity: '?'
- name: height
- name: height_in_um
neurodata_type_inc: VectorData
dtype: float
doc: Height of a rectangular contact.
doc: Height of a rectangular contact, in micrometers.
quantity: '?'
- name: device_channel_index_pi
neurodata_type_inc: VectorData
Expand Down Expand Up @@ -151,8 +131,31 @@ groups:
- name: probe_model
target_type: ProbeModel
doc: The model of the probe used to record the data.
- neurodata_type_def: ProbeInsertion
neurodata_type_inc: NWBContainer
default_name: probe_insertion
doc: Metadata about the insertion of a probe into the brain, which can be used to
determine the location of the probe in the brain.
attributes:
- name: reference
dtype: text
doc: Reference point for `insertion_position_in_mm` coordinates, e.g., "bregma
at the cortical surface".
required: false
- name: hemisphere
dtype: text
doc: The hemisphere ("left" or "right") of the targeted location of the optogenetic
stimulus site. Should be consistent with `insertion_position_in_mm.ml` coordinate
(left = ml < 0, right = ml > 0).
required: false
- name: depth_in_mm
dtype: float
doc: Depth that the probe was driven along `insertion_angle` starting from `insertion_position_in_mm`,
in millimeters.
required: false
- neurodata_type_def: ChannelsTable
neurodata_type_inc: DynamicTable
default_name: ChannelsTable
doc: Metadata about the channels used in an extracellular recording from a single
probe.
attributes:
Expand Down Expand Up @@ -263,9 +266,9 @@ groups:
to 'volts'. Actual stored values are not necessarily stored in these units.
To access the data in these units, multiply 'data' by 'conversion', followed
by 'channel_conversion' (if present), and then add 'offset'.
- name: contacts
- name: channels
neurodata_type_inc: DynamicTableRegion
doc: DynamicTableRegion pointer to rows in a ContactsTable that represent the
doc: DynamicTableRegion pointer to rows in a ChannelsTable that represent the
channels used to collect the data in this recording.
- name: channel_conversion
dtype: float
Expand Down
Empty file.
Loading

0 comments on commit d08b2cb

Please sign in to comment.