nested_grid_plotter.extract_frames_from_embedded_html_animation#

nested_grid_plotter.extract_frames_from_embedded_html_animation(fpath: str | Path, target_path: str | Path | None = None, start_indices_at_one: bool = True) → None[source]#

Extract the embedded frames from an html animation created with matplotlib.

Parameters:

  • fpath (Union[str, Path]) – Path to the html file.

  • target_path (Optional[Union[str, Path]]) – Target path where to store the extracted frames. If None, a folder with the name of the html file is created at the location of the html file. If default is None.

  • start_indices_at_one (bool) – Whether to start indices at one or ay zero. The default is True, i.e., start at one.

Notes

The frame format is retrieved automatically.