ordered metadata; improved setup; better use cases in readme #116
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
The following squashed commit was approved for public release by **The Aerospace Corporation** on 2019-05-07. It is covered software release request #SW19-0024. Commits made by the *Digital Communications Implementation Department*. New features - method to read & write SigMF metadata files - method to read available captures - method to read samples from captures - method to get annotations - method to count samples - python3 module compatibility - examples added to README Fixes - python3 relative path fixes - bug in test_validation - bug in conftest that used old SigMF datatype (f32) - additional test in test_sigmffile - made compatible with docker containers - can now write multiple annotations for same sample start index Pylint code cleanup - removed unused imports - fixed indentation - fixed snake_case and too short variables - fixed missing error definition Other changes - Remaining core namespace keys were added as constants to SigMFFile class. - Sample count is automatically determined and set as a class data member when a data file is present.
This squashed commit is approved for public release by The Aerospace Corporation on 2020-08-19. Commits made by the Communication Software Implementation Department. This commit is an addendum to the prior PR#106 approved 2019-05-07. New Features * Ordered sigmf-meta so that the keys are in a more useful order upon manual inspection. * Use cases in `README.md`. Fixes * Improved version handling.
|
@Teque5 - Thanks so much for another great contribution from Aerospace! Triaging now and marking this for v0.0.2 |
|
@Teque5 - Many thanks to you and the Aerospace team! |
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.
This squashed commit is approved for public release by The Aerospace Corporation on 2020-08-19. Commits made by the Communication Software Implementation Department.
This commit is an addendum to the prior PR#106 approved 2019-05-07.
New Features
README.md.Fixes
Notes
When the metadata is written to a file it now looks like this so humans can read it with
globalfollowed bycapturesfollowed byannotations. Metadata below is created by the new example in theREADME.md.{ "global": { "core:author": "jane.doe@domain.org", "core:datatype": "cf32_le", "core:description": "All zero example file.", "core:sample_rate": 48000, "core:sha512": "18790c279e0ca614c2b57a215fecc23a6c3d2d308ce77f314378cb2d1b0f413acd3a9cd353aa6da86ec9f51916925c7210f7dfabc0ef726779f8d44f227f03b1", "core:version": "0.0.2" }, "captures": [ { "core:datetime": "2020-08-19T23:58:58.610246Z", "core:frequency": 915000000, "core:sample_start": 0 } ], "annotations": [ { "core:comment": "example annotation", "core:freq_lower_edge": 914995000.0, "core:freq_upper_edge": 915005000.0, "core:sample_count": 200, "core:sample_start": 100 } ] }