Skip to content

Improve mne.Report.add_ica with ica.plot_sources #13265

Open
@sappelhoff

Description

@sappelhoff

Describe the new feature or enhancement

Adding an ICA object to a report is a versatile and convenient method to screen data quality.

One aspect that I often find missing from the overview is a plot of the source timecourses, which can be visualized via:

I propose that we add an option to add an option to .add_ica to also plot the sources.

Describe your proposed implementation

In practice, my proposal would add a subsection to the ICA section called "sources".

It would consist of a "standard timecourses plot" like in the screenshot below:


Image


This plot would be interactive, and the arrow keys would allow to scroll

  • left / right (in time)
  • up / down (through sources)

The parameter that controls whether or not sources are plotted would allow to control:

  • how much overall time to show (defaults to not too much)
  • from when to when to show data (interacting with how much time overall to show)
  • how many sources to show per "scroll through"
  • how much time to show per "scroll through"
  • which sources to show (defaults to all, but can take indices)

Describe possible alternatives

The sources could be added to the Report in a non-interactive way.

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions