Skip to content

Add WhiteMatterRecordingInterface #1060

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

Merged
bendichter merged 3 commits into from
Feb 20, 2026
Merged

Add WhiteMatterRecordingInterface #1060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8b6225
Add WhiteMatterRecordingInterface to supported interfaces
bendichter Feb 20, 2026
d2530ed
Regenerate storybook schemas for updated interfaces
bendichter Feb 20, 2026
96592fe
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 20, 2026
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
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,5 @@ src/build

# PyCharm
.idea/

ophys_testing_data/
6 changes: 3 additions & 3 deletions src/supported_interfaces.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,10 @@
"PlexonRecordingInterface",
"PlexonSortingInterface",
"AxonaRecordingInterface",
"VideoInterface",
"ExternalVideoInterface",
"NeuralynxRecordingInterface",
"Suite2pSegmentationInterface",
"AlphaOmegaRecordingInterface",
"AlphaOmegaRecordingInterface",
"DeepLabCutInterface",
"SLEAPInterface",
"FicTracDataInterface",
Expand All @@ -44,5 +43,6 @@
"BrukerTiffSinglePlaneConverter",
"BrukerTiffMultiPlaneConverter",
"MiniscopeConverter",
"CellExplorerRecordingInterface"
"CellExplorerRecordingInterface",
"WhiteMatterRecordingInterface"
]
4 changes: 2 additions & 2 deletions stories/inputs/interface_schemas/AlphaOmegaRecordingInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"AlphaOmegaRecordingInterface": {
"properties": {
"folder_path": {
"format": "directory-path",
"format": "path",
"type": "string",
"description": "Path to the folder of .mpx files."
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
},
"es_key": {
Expand Down
2 changes: 1 addition & 1 deletion stories/inputs/interface_schemas/AudioInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"properties": {
"file_paths": {
"items": {
"format": "file-path",
"format": "path",
"type": "string"
},
"type": "array"
Expand Down
4 changes: 2 additions & 2 deletions stories/inputs/interface_schemas/AxonaRecordingInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"AxonaRecordingInterface": {
"properties": {
"file_path": {
"format": "file-path",
"format": "path",
"type": "string",
"description": "Path to .bin file."
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
},
"es_key": {
Expand Down
4 changes: 2 additions & 2 deletions stories/inputs/interface_schemas/BiocamRecordingInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"BiocamRecordingInterface": {
"properties": {
"file_path": {
"format": "file-path",
"format": "path",
"type": "string",
"description": "Path to the .bwr file."
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
},
"es_key": {
Expand Down
6 changes: 3 additions & 3 deletions stories/inputs/interface_schemas/BlackrockRecordingInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
"BlackrockRecordingInterface": {
"properties": {
"file_path": {
"format": "file-path",
"format": "path",
"type": "string",
"description": "Path to the Blackrock file with suffix being .ns1, .ns2, .ns3, .ns4m .ns4, or .ns6."
},
"nsx_override": {
"anyOf": [
{
"format": "file-path",
"format": "path",
"type": "string"
},
{
Expand All @@ -21,7 +21,7 @@
"default": null
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
},
"es_key": {
Expand Down
34 changes: 30 additions & 4 deletions stories/inputs/interface_schemas/BlackrockSortingInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,43 @@
"BlackrockSortingInterface": {
"properties": {
"file_path": {
"format": "file-path",
"format": "path",
"type": "string",
"description": "Path to Blackrock .nev file."
},
"sampling_frequency": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"type": "number",
"description": "The sampling frequency for the sorting extractor. When the signal data is available (.ncs) those files will be"
"description": "The sampling frequency for the sorting extractor. When the signal data is available (.ncs) those files will be\nused to extract the frequency automatically. Otherwise, the sampling frequency needs to be specified for\nthis extractor to be initialized."
},
"nsx_to_load": {
"anyOf": [
{
"type": "integer"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "IDs of nsX file from which to load data, e.g., if set to 5 only data from the ns5 file are loaded.\nIf 'all', then all nsX will be loaded. If None, all nsX files will be loaded. If empty list, no nsX files will be loaded."
},
"verbose": {
"default": true,
"default": false,
"type": "boolean",
"description": "Enables verbosity"
}
Expand Down
6 changes: 3 additions & 3 deletions stories/inputs/interface_schemas/BrukerTiffMultiPlaneConverter.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
"BrukerTiffMultiPlaneConverter": {
"properties": {
"folder_path": {
"format": "directory-path",
"format": "path",
"type": "string",
"description": "The folder that contains the Bruker TIF image files (.ome.tif) and configuration files (.xml, .env)."
},
"plane_separation_type": {
"default": null,
"enum": [
"disjoint",
"contiguous"
Expand All @@ -22,7 +21,8 @@
}
},
"required": [
"folder_path"
"folder_path",
"plane_separation_type"
],
"type": "object",
"additionalProperties": false
Expand Down
4 changes: 2 additions & 2 deletions stories/inputs/interface_schemas/BrukerTiffMultiPlaneImagingInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"BrukerTiffMultiPlaneImagingInterface": {
"properties": {
"folder_path": {
"format": "directory-path",
"format": "path",
"type": "string",
"description": "The folder that contains the Bruker TIF image files (.ome.tif) and configuration files (.xml, .env)."
},
Expand All @@ -20,7 +20,7 @@
"default": null
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
}
},
Expand Down
2 changes: 1 addition & 1 deletion stories/inputs/interface_schemas/BrukerTiffSinglePlaneConverter.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"BrukerTiffSinglePlaneConverter": {
"properties": {
"folder_path": {
"format": "directory-path",
"format": "path",
"type": "string"
},
"verbose": {
Expand Down
4 changes: 2 additions & 2 deletions stories/inputs/interface_schemas/BrukerTiffSinglePlaneImagingInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"BrukerTiffSinglePlaneImagingInterface": {
"properties": {
"folder_path": {
"format": "directory-path",
"format": "path",
"type": "string",
"description": "The folder containing the Bruker TIF image files and configuration files."
},
Expand All @@ -20,7 +20,7 @@
"default": null
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
}
},
Expand Down
4 changes: 2 additions & 2 deletions stories/inputs/interface_schemas/CaimanSegmentationInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"CaimanSegmentationInterface": {
"properties": {
"file_path": {
"format": "file-path",
"format": "path",
"type": "string",
"description": "Path to .hdf5 file."
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
}
},
Expand Down
4 changes: 2 additions & 2 deletions stories/inputs/interface_schemas/CellExplorerRecordingInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"CellExplorerRecordingInterface": {
"properties": {
"folder_path": {
"format": "directory-path",
"format": "path",
"type": "string",
"description": "Folder containing the .session.mat file"
},
"verbose": {
"default": true,
"default": false,
"type": "boolean",
"description": "Whether to output verbose text."
},
Expand Down
4 changes: 2 additions & 2 deletions stories/inputs/interface_schemas/CellExplorerSortingInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
"CellExplorerSortingInterface": {
"properties": {
"file_path": {
"format": "file-path",
"format": "path",
"type": "string"
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
}
},
Expand Down
4 changes: 2 additions & 2 deletions stories/inputs/interface_schemas/CnmfeSegmentationInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
"CnmfeSegmentationInterface": {
"properties": {
"file_path": {
"format": "file-path",
"format": "path",
"type": "string"
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
}
},
Expand Down
27 changes: 19 additions & 8 deletions stories/inputs/interface_schemas/DeepLabCutInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,38 @@
"DeepLabCutInterface": {
"properties": {
"file_path": {
"format": "file-path",
"format": "path",
"type": "string",
"description": "Path to the .h5 file output by dlc."
"description": "Path to the file output by dlc (.h5 or .csv)."
},
"config_file_path": {
"format": "file-path",
"type": "string",
"description": "Path to .yml config file"
"anyOf": [
{
"format": "path",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Path to .yml config file."
},
"subject_name": {
"default": "ind1",
"type": "string"
},
"pose_estimation_metadata_key": {
"default": "PoseEstimationDeepLabCut",
"type": "string"
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
}
},
"required": [
"file_path",
"config_file_path"
"file_path"
],
"type": "object",
"additionalProperties": false
Expand Down
16 changes: 14 additions & 2 deletions stories/inputs/interface_schemas/EDFRecordingInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,29 @@
"EDFRecordingInterface": {
"properties": {
"file_path": {
"format": "file-path",
"format": "path",
"type": "string",
"description": "Path to the .edf file."
},
"verbose": {
"default": true,
"default": false,
"type": "boolean"
},
"es_key": {
"default": "ElectricalSeries",
"type": "string"
},
"channels_to_skip": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
Expand Down
17 changes: 12 additions & 5 deletions ...uts/interface_schemas/VideoInterface.json → ...rface_schemas/ExternalVideoInterface.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"required": [],
"properties": {
"VideoInterface": {
"ExternalVideoInterface": {
"properties": {
"file_paths": {
"items": {
"format": "file-path",
"format": "path",
"type": "string"
},
"type": "array"
Expand All @@ -14,9 +14,16 @@
"default": false,
"type": "boolean"
},
"metadata_key_name": {
"default": "Videos",
"type": "string"
"video_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
Expand Down
Loading
Loading