plotting#

This file contains the methods to be used to plot investigations

Functions

multi_plot(views[, width, height])

Creates a grid of plots based on the provided list of views

plot(view[, width, height])

Creates plot based on the provided view
cegalprizm.investigator.plotting.multi_plot(views: Sequence[Union[cegalprizm.investigator.views.predefined_view.PredefinedView, cegalprizm.investigator.views.predefined_view_tuple.PredefinedViewTuple]], width: int = 900, height: int = 600)#

Creates a grid of plots based on the provided list of views

This will display aa grid of images of a defined size based on the provided views.

Parameters

  • views (Sequence[Union[PredefinedView, PredefinedViewTuple]]) – A list of either views or tuples containing the label and view defining the plots

  • width (int, optional) – The width of the images to be displayed. Defaults to 900.

  • height (int, optional) – The height of the images to be displayed. Defaults to 600.

Raises

CegalHubError – if an unexpected error is reported by Hub

cegalprizm.investigator.plotting.plot(view: Union[cegalprizm.investigator.views.predefined_view.PredefinedView, cegalprizm.investigator.views.predefined_view_tuple.PredefinedViewTuple], width: int = 900, height: int = 600) → PIL.Image.Image#

Creates plot based on the provided view

This will display an image of a defined size based on the provided view.

Parameters

  • view (Union[PredefinedView, PredefinedViewTuple]) – Either the view or a tuple containing the label and view defining the plot

  • width (int, optional) – The width of the image to be displayed. Defaults to 900.

  • height (int, optional) – The height of the image to be displayed. Defaults to 600.

Raises

CegalHubError – if an unexpected error is reported by Hub

Returns

The generated plot image (if not displayed)

Return type

Image