Skip to content

Automatically save plot_probe #197

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

Open
JoeZiminski opened this issue Mar 10, 2025 · 2 comments · May be fixed by #232
Open

Automatically save plot_probe #197

JoeZiminski opened this issue Mar 10, 2025 · 2 comments · May be fixed by #232
Labels
enhancement New feature or request

Comments

@JoeZiminski
Copy link
Member

In probeinterface, they have a nice plotting library and allow you to plot the probe.

It would be nice to:

  1. Expose a function that displays a plot of the probe (uses probeinterface plot_probe at the run level
  2. Automatically save this to the run folder when save_preprocessing is run

It is hard to decide whether to save this at the session level or the run level. The probes should be the same across all runs within a session. However, to add flexibility and avoid edge-cases, it makes sense to save this as a per-run output, even if it will duplicate a bit. However, a session.plot_probe() function should also be exposed to quickly plot the probe associated with the session.

The implementation will be something like:

  1. on _preprocess_run, add a function called 'save_probe_plot'. I am not actually sure how plot_probe will look when the recording is split per-shank, will need to investigate. The spikeinterface recording objects have a function called get_probe().
  2. on session, a function like plot_probe(). This will have to check all probes attached to all runs and ensure they are the same, then it can plot one of them.

The code organization will roughly match plot_preprocessed approach.

@JoeZiminski JoeZiminski added the enhancement New feature or request label Mar 10, 2025
@JoeZiminski
Copy link
Member Author

@chandrikarj thanks for the suggestions in #196, this is the issue related to the plotting. This issue will require going quite deep into the codebase. If you want to take a stab at it please let me know if you have any questions or anything is not clear.

@chandrikarj
Copy link
Contributor

Thanks @JoeZiminski, will have a go at it, possibly the first thing, or after tackling one of the other issues.

@hargunkaur286 hargunkaur286 linked a pull request Apr 2, 2025 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants