Merge pull request #1060 from NeurodataWithoutBorders/add-whitematter-recording-interface

Add WhiteMatterRecordingInterface

Author: bendichter

.gitignore

@@ -42,3 +42,5 @@ src/build
 
 # PyCharm
 .idea/
+
+ophys_testing_data/

src/supported_interfaces.json

@@ -29,11 +29,10 @@
     "PlexonRecordingInterface",
     "PlexonSortingInterface",
     "AxonaRecordingInterface",
-    "VideoInterface",
+    "ExternalVideoInterface",
     "NeuralynxRecordingInterface",
     "Suite2pSegmentationInterface",
     "AlphaOmegaRecordingInterface",
-    "AlphaOmegaRecordingInterface",
     "DeepLabCutInterface",
     "SLEAPInterface",
     "FicTracDataInterface",
@@ -44,5 +43,6 @@
     "BrukerTiffSinglePlaneConverter",
     "BrukerTiffMultiPlaneConverter",
     "MiniscopeConverter",
-    "CellExplorerRecordingInterface"
+    "CellExplorerRecordingInterface",
+    "WhiteMatterRecordingInterface"
 ]

stories/inputs/interface_schemas/AlphaOmegaRecordingInterface.json

@@ -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": {

stories/inputs/interface_schemas/AudioInterface.json

@@ -5,7 +5,7 @@
             "properties": {
                 "file_paths": {
                     "items": {
-                        "format": "file-path",
+                        "format": "path",
                         "type": "string"
                     },
                     "type": "array"

stories/inputs/interface_schemas/AxonaRecordingInterface.json

@@ -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": {

stories/inputs/interface_schemas/BiocamRecordingInterface.json

@@ -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": {

stories/inputs/interface_schemas/BlackrockRecordingInterface.json

@@ -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"
                         },
                         {
@@ -21,7 +21,7 @@
                     "default": null
                 },
                 "verbose": {
-                    "default": true,
+                    "default": false,
                     "type": "boolean"
                 },
                 "es_key": {

stories/inputs/interface_schemas/BlackrockSortingInterface.json

@@ -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"
                 }

stories/inputs/interface_schemas/BrukerTiffMultiPlaneConverter.json

@@ -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"
@@ -22,7 +21,8 @@
                 }
             },
             "required": [
-                "folder_path"
+                "folder_path",
+                "plane_separation_type"
             ],
             "type": "object",
             "additionalProperties": false

stories/inputs/interface_schemas/BrukerTiffMultiPlaneImagingInterface.json

@@ -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)."
                 },
@@ -20,7 +20,7 @@
                     "default": null
                 },
                 "verbose": {
-                    "default": true,
+                    "default": false,
                     "type": "boolean"
                 }
             },