Use NWBInspector when testing livescript tutorials #618
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add note about why dimension of SpatialSeries data is transposed wrt the type specification - Fix typos
- Add explanation of why arrays are transposed relative to the type documentation - Fix dimension order of AbstractFeatureSeries
ehennestad
commented
Nov 5, 2024
Comment on lines
+136
to
+144
| position_data = [linspace(0, 10, 50); linspace(0, 8, 50)]; % 2 x nT array | ||
| %% | ||
| % In <https://neurodatawithoutborders.github.io/matnwb/doc/+types/+core/SpatialSeries.html | ||
| % |SpatialSeries|> data, the first dimension is always time (in seconds), the | ||
| % second dimension represents the x, y position. <https://neurodatawithoutborders.github.io/matnwb/doc/+types/+core/SpatialSeries.html | ||
| % second dimension represents the x, y position. However, as described in the | ||
| % <https://neurodatawithoutborders.github.io/matnwb/tutorials/html/dimensionMapNoDataPipes.html | ||
| % dimensionMapNoDataPipes> tutorial, when a MATLAB array is exported to HDF5, | ||
| % the array is transposed. Therefore, in order to correctly export the data, in | ||
| % MATLAB the last dimension of an array should be time. <https://neurodatawithoutborders.github.io/matnwb/doc/+types/+core/SpatialSeries.html |
There was a problem hiding this comment.
@bendichter Can you confirm that this change to the text makes this section more consistent?
ehennestad
commented
Nov 5, 2024
Comment on lines
164
to
+173
| % Image data can be stored either in the HDF5 file or as an external image file. | ||
| % For this tutorial, we will use fake image data with shape of |('RGB', 'y', 'x', | ||
| % 'time') = (200, 50, 50, 3)|. As in all <https://neurodatawithoutborders.github.io/matnwb/doc/+types/+core/TimeSeries.html | ||
| % For this tutorial, we will use fake image data with shape of |('time', 'x', | ||
| % 'y', 'RGB') = (200, 50, 50, 3)|. As in all <https://neurodatawithoutborders.github.io/matnwb/doc/+types/+core/TimeSeries.html | ||
| % |*TimeSeries*|>, the first dimension is time. The second and third dimensions | ||
| % represent x and y. The fourth dimension represents the RGB value (length of | ||
| % 3) for color images. | ||
| % 3) for color images. *Please note*: As described in the <https://neurodatawithoutborders.github.io/matnwb/tutorials/html/dimensionMapNoDataPipes.html | ||
| % dimensionMapNoDataPipes> tutorial, when a MATLAB array is exported to HDF5, | ||
| % the array is transposed. Therefore, in order to correctly export the data, we | ||
| % will need to create a transposed array, where the dimensions are in reverse | ||
| % order compared to the type specification. |
There was a problem hiding this comment.
@bendichter Same here
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #618 +/- ##
==========================================
+ Coverage 90.80% 90.84% +0.04%
==========================================
Files 107 107
Lines 4774 4774
==========================================
+ Hits 4335 4337 +2
+ Misses 439 437 -2 ☔ View full report in Codecov by Sentry. |
- Simplifies the reading of nwb files using pynwb in TutorialTest
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #484
Motivation
More robust testing of NWB files created by tutorials
Checklist
fix #XXwhereXXis the issue number?