Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SigMF Collections #157

Merged
merged 6 commits into from
Sep 20, 2021
Merged

SigMF Collections #157

merged 6 commits into from
Sep 20, 2021

Conversation

bhilburn
Copy link
Contributor

This PR replaces #151 and implements the design discussed in that PR's thread.

Draft implementation of SigMF Collections, creating a new top-level object in a new file. This PR updates the SigMF spec with this feature, and also updates the canonical Antenna extension to use it.

@bhilburn bhilburn added this to the Release v1.0.0 milestone Sep 17, 2021
@bhilburn bhilburn self-assigned this Sep 17, 2021
@bhilburn bhilburn added this to PR Filed in v1.0.0 Release via automation Sep 17, 2021
Copy link
Member

@jacobagilbert jacobagilbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also think we should add the following to the global core namespace:

|`collection`|false|string|The name of the `collection` this file is part of (if applicable).|

This will allow unambiguous traversal from an arbitrary file to all other files in the same collection...though it does limit a file to be in a single collection (which I think is also a good idea). Possibly should even make this value mandatory for all streams?

sigmf-spec.md Show resolved Hide resolved
sigmf-spec.md Outdated Show resolved Hide resolved
sigmf-spec.md Outdated Show resolved Hide resolved
extensions/antenna.sigmf-ext.md Outdated Show resolved Hide resolved
extensions/antenna.sigmf-ext.md Outdated Show resolved Hide resolved
sigmf-spec.md Outdated Show resolved Hide resolved
sigmf-spec.md Outdated Show resolved Hide resolved
@bhilburn
Copy link
Contributor Author

@jacobagilbert - Updated the PR with your feedback. Regarding restricting recordings to only being part of one collection, I think we get that for "free", here, by the global collection object being a singular string. Thoughts?

@bhilburn bhilburn merged commit 1b6d957 into master Sep 20, 2021
v1.0.0 Release automation moved this from PR Filed to Done Sep 20, 2021
@jacobagilbert jacobagilbert deleted the collections-v2 branch June 2, 2022 15:02
@aromanielloNTIA
Copy link
Contributor

Are there currently plans to add support for SigMF Collections to the SigMF Python package?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants