Skip to content

Add typed table constraints to DynamicTableRegion columns in ecephys, misc, and ophys #696

Description

@ehennestad

Summary

Several DynamicTableRegion columns across the core schema carry no table attribute specifying which table they reference. By contrast, the icephys relational tables (SimultaneousRecordingsTable, SequentialRecordingsTable, etc.) do declare typed table constraints via a dtype refspec on the table attribute. This inconsistency means the schema cannot validate that these region columns point to the correct table.

Affected fields

File Type Field Suggested target type
nwb.ecephys.yaml ElectricalSeries electrodes ElectrodesTable
nwb.ecephys.yaml FeatureExtraction electrodes ElectrodesTable
nwb.misc.yaml Units electrodes ElectrodesTable
nwb.misc.yaml DecompositionSeries source_channels ElectrodesTable ??
nwb.ophys.yaml RoiResponseSeries rois PlaneSegmentation

Current icephys pattern (for reference)

The icephys relational tables use a typed table attribute with a dtype refspec to enforce the target table type. This is the pattern that should be adopted here for consistency.

Open questions

  • Does source_channels in DecompositionSeries have a well-defined target table to constrain to?

Metadata

Metadata

Assignees

No one assigned

    Labels

    category: proposalproposed enhancements or new featurespriority: mediumnon-critical problem and/or affecting only a small set of NWB users

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions