filter_comparison

seas.ica.filter_comparison(components: dict, downsample: int = 4, savepath: Optional[str] = None, filtered_path: Optional[str] = None, include_noise: bool = True, t_start: Optional[int] = None, t_stop: Optional[int] = None, apply_mean_filter: bool = True, n_rotations: int = 0)[source]

Create a filter comparison movie, displaying the original movie, artifacts removed, and the filtered movie side by side.

Parameters

  • components – The ICA components returned by ica.project.

  • downsample – The factor to downsample by before writing the video.

  • savepath – The path to save the video at (mp4).

  • filtered_path – The hdf5 path to save the filtered movie to.

  • include_noise – Whether noise components should be included in the filtered video.

  • t_start – The frame to start rebuilding the movie at. If none is provided, the rebuilt movie starts at the first frame.

  • t_stop – The frame to stop rebuilding the movie at. If none is provided, the rebuilt movie ends at the last frame.

  • filter_mean – Whether to filter the mean before readding.

  • n_rotations – The number of CCW rotations to apply before saving the video.

Returns

Nothing.