HDF5Base can identify empty objects
#330
Merged
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
willGraham01
force-pushed
the
hdf5-identify-empty-objects
branch
from
e12e1f0 to
681554f
Compare
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #330 +/- ##
===================================
Coverage 26% 26%
===================================
Files 69 69
Lines 3674 3699 +25
===================================
+ Hits 952 976 +24
- Misses 2722 2723 +1
☔ View full report in Codecov by Sentry. |
samcunliffe
approved these changes
Jun 5, 2023
| // the object. | ||
| return file_->isHdf5(filename_); | ||
| // return file_->isAccessible(filename_) && file_->isHdf5(filename_); | ||
| } | ||
|
|
||
| bool HDF5Base::flagged_MATLAB_empty(const std::string &object_path) const { |
There was a problem hiding this comment.
Maybe is_flagged_as_MATLAB_empty(object_path)?
I don't insist though.
| # Create test data to read in | ||
| consecutive_numbers = np.arange(0, 12, dtype=float) | ||
|
|
||
| # Create a group under root | ||
| read_in_test = file.require_group("read_in_test") |
There was a problem hiding this comment.
This, however, does need a comment because it's weird to me that require_group creates a group.
There was a problem hiding this comment.
That's h5py for you 😅
Co-authored-by: Sam Cunliffe <[email protected]>
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.
Context
Naturally, MATLAB does not save empty arrays or structs as objects with no elements or zero-size, instead it saves them as 2-by-1 arrays with 0's populating the data. This means that a simple comparison against the number of elements or members does not provide the correct information when attempting to determine whether an empty input has been passed.
MATLAB does however attach an attribute to any object that it marks as empty:
MATLAB_empty. Thisuint8is set to 1 if the object is indeed an empty array, so that is what we will use to distinguish.mxIsEmptyfunction).Details
Adds the
HDF5Base::flagged_MATLAB_emptymethod to replace themxIsEmptyfunction, which a number of our classes depend on when reading from the input file.Going forward, if the input generation is ever moved away from MATLAB too, a workaround will need to be decided to replace/handle
.hdf5files that are not created with MATLAB, as the analogue of this flag will not exist.Testing
tdms/tests/unit/hdf5_io/test_hdf5_base.cppadded with extensive tests for the newflagged_MATLAB_emptymethod..matand.hdf5unit test data has been updated with the necessary additions