Add more detailed device example to ophys tutorial

NeurodataWithoutBorders · Nov 27, 2024 · 725faf5 · 725faf5
1 parent 5ed025c
commit 725faf5
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 12 deletions.
diff --git a/tutorials/html/ophys.html b/tutorials/html/ophys.html
diff --git a/tutorials/ophys.mlx b/tutorials/ophys.mlx
diff --git a/tutorials/private/mcode/ophys.m b/tutorials/private/mcode/ophys.m
@@ -51,14 +51,28 @@
 % |*ImagingPlane*|>.
 % 
 % 
+% 
+% Create a <https://neurodatawithoutborders.github.io/matnwb/doc/+types/+core/Device.html 
+% |*Device*|> representing a two-photon microscope. The fields |description|, 
+% |manufacturer|, |model_number|, |model_name|, and |serial_number| are optional, 
+% but recommended. Then create an <https://neurodatawithoutborders.github.io/matnwb/doc/+types/+core/OpticalChannel.html 
+% |*OpticalChannel*|> and add both of these to the <https://neurodatawithoutborders.github.io/matnwb/doc/+types/+core/ImagingPlane.html 
+% |*ImagingPlane*|>|*.*|
+
+device = types.core.Device( ...
+    'description', 'My two-photon microscope', ...
+    'manufacturer', 'Loki Labs', ...
+    'model_number', 'ABC-123', ...
+    'model_name', 'Loki 1.0', ...
+    'serial_number', '1234567890');
+
+% Add device to nwb object
+nwb.general_devices.set('Device', device);
 
 optical_channel = types.core.OpticalChannel( ...
     'description', 'description', ...
     'emission_lambda', 500.);
 
-device = types.core.Device();
-nwb.general_devices.set('Device', device);
-
 imaging_plane_name = 'imaging_plane';
 imaging_plane = types.core.ImagingPlane( ...
     'optical_channel', optical_channel, ...