shamrock.utils.plot Namespace Reference

Functions
	show_image_sequence (glob_str, render_gif=True, dpi=200, interval=50, repeat_delay=10, fig=None)

Variables
bool	_HAS_MATPLOTLIB = True
bool	_HAS_PIL = True

Detailed Description

Shamrock plot utility functions.

Function Documentation

show_image_sequence()

shamrock.utils.plot.show_image_sequence	(		glob_str,
			render_gif = True,
			dpi = 200,
			interval = 50,
			repeat_delay = 10,
			fig = None )

Create a matplotlib animation from a sequence of image files.

Available only if matplotlib and PIL are installed.

Parameters
----------
glob_str : str
    Glob pattern matching image files.
render_gif : bool, optional
    Whether to render the animation.
dpi : int, optional
    Dots per inch for the figure.
interval : int, optional
    Delay between frames in milliseconds.
repeat_delay : int, optional
    Delay before repeating the animation.

Raises
------
FileNotFoundError : if no images are found for the glob pattern

Returns
-------
matplotlib.animation.FuncAnimation or None
    Animation object on rank 0, otherwise None.

Definition at line 31 of file __init__.py.

Variable Documentation

_HAS_MATPLOTLIB

bool shamrock.utils.plot._HAS_MATPLOTLIB = True

protected

Definition at line 15 of file __init__.py.

_HAS_PIL

bool shamrock.utils.plot._HAS_PIL = True

protected

Definition at line 23 of file __init__.py.