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

Partial ProbeInterface file exported to JSON #36

Open
bparks13 opened this issue Aug 23, 2024 · 2 comments
Open

Partial ProbeInterface file exported to JSON #36

bparks13 opened this issue Aug 23, 2024 · 2 comments

Comments

@bparks13
Copy link
Member

When exporting the current configuration to a JSON file using the Save to JSON button, the resulting file is a partial ProbeInterface file. Only the currently enabled electrodes are listed in the file, which means that if someone exports a quad-shank 2.0 probe, there are only 384 electrodes exported instead of the expected 5120 electrodes. All electrodes can be exported by leveraging the "device_channel_indices" field, which can be set to -1 for all electrodes that are disabled. This allows for the entire set of electrodes, including locations and shapes, to be exported and thus imported to another ProbeInterface compliant application.

The "probe_planar_contours" is not a required field, but it would be a welcome addition to the file, providing the bounds of the probe that encapsulates the electrodes. Again, this matters most when importing to another ProbeInterface application, allowing the probe contours to be drawn around the electrodes.

To become fully compliant with the format specifications and the schema file the manufacturer should be added under the "annotations" field, and no additional fields are allowed which means that "num_adcs" might need to be removed.

I also noticed that there isn't a Load from JSON button, but this would be good to add if possible.

I'm happy to discuss if there are any particular reasons why the JSON file is the way it is, and I'm also happy to take a crack at implementing some of these features. Thank you!

@jsiegle
Copy link
Collaborator

jsiegle commented Aug 23, 2024

Thanks for looking into this, I just made those changes (except for adding the planar contours) in this commit: 3ac0188

Can you check out this JSON file and see if it looks reasonable? If so, we can work on the loading function.

@bparks13
Copy link
Member Author

Thanks for the update! This looks good, I was able to open it successfully and update the currently enabled electrodes. The planar contours would be a good addition, but are not necessary for the rest of the functionality.

I've attached a sample JSON file that was exported from our system, in case that's helpful for testing. Let me know if there's anything else I can do.

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

No branches or pull requests

2 participants