swtloc.utils.show_N_images

swtloc.utils.show_N_images(images: List[numpy.ndarray], individual_titles: List[str], plot_title: Optional[str] = 'SWTLoc Plot', sup_title: Optional[str] = '', return_img: Optional[bool] = False) → Optional[numpy.ndarray][source]

Display n (<=4) images in a grid.

Parameters

  • images (List[np.ndarray]) – List of images to display

  • individual_titles (List[str]) – Title for each image to be displayed

  • plot_title (Optional[str]) – Plot Title. [default = ‘SWTLoc Plot’]

  • sup_title (Optional[str]) – Plot sub title. [default = ‘’]

  • return_img (Optional[bool]) – Whether to return the plotted figure or not. [default = False]

Raises

SWTValueError –

Returns

Plotted figure if the return_fig parameter was given as True

Return type

(matplotlib.figure.Figure)