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

Consider having the ability to write metadata for a folder, not just single files #245

Open
icyveins7 opened this issue Sep 25, 2022 · 1 comment
Assignees

Comments

@icyveins7
Copy link

My colleagues and I have gotten used to writing our recording into 1-second duration files. There are several reasons for this, one being that is far easier to see at which time instant the recording fails (samples skipped, file not written etc.). The files are otherwise all identical in terms of recording frequency, sample rate, data type etc. Having metadata for a folder would be a welcome standard.

@jacobagilbert
Copy link
Member

I've thought about this a bit on and off, and there is a way you can do this now that should be fairly straightforward, though not SigMF Compliant or canonically endorsed by SigMF.

In the SigMF Meta Global Object there exists a relatively new field core:metadata_only which essentially states that this .sigmf-meta file is not tied directly to a specific dataset. For example, at deepsig we use this to distribute only the metadata resulting from processing IQ data.

You could conceptually apply this directly to what you are talking about doing by using this flag to indicate that this metadata applies to an entire folder, or write an extension containing a similar field extension_name:folder_metadata indicating as much.

We try to avoid noncompliance as much as possible, but sometimes it is necessary, and there are a number of endorsed non-compliant methodologies in the core specification. I'll leave this open for any further discussion about adding this idea to core or other approaches, but I think this introduces a lot of edge cases and complexity to officially support/endorse.

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

No branches or pull requests

2 participants