p3analysis.plot.backend package¶

Submodules¶

p3analysis.plot.backend.matplotlib module¶

Contains objects for interacting with plots produced using the matplotlib backend.

class p3analysis.plot.backend.matplotlib.CascadePlot(df, eff_column, size=None, fig=None, axes=None, **kwargs)¶

Bases: CascadePlot

Cascade plot object for matplotlib.

get_axes(subplot='eff')¶

Parameters:: subplot ({'eff', 'pp', 'plat'}) – The name of the requested subplot. The options correspond to the efficiency cascade, performance portability bar chart, and platform chart, respectively.
Returns:: The matplotlib.axes.Axes used for the specified subplot.
Return type:: matplotlib.axes.Axes

get_figure()¶

Returns:: The matplotlib.figure.Figure used for the plot.
Return type:: matplotlib.figure.Figure

save(filename)¶

Save the plot to the specified file.

Parameters:: filename (string)

class p3analysis.plot.backend.matplotlib.NavChart(pp, cd, eff=None, size=None, goal=None, fig=None, axes=None, **kwargs)¶

Bases: NavChart

Navigation chart object for matplotlib.

get_axes()¶

Returns:: The matplotlib.axes.Axes used for the chart.
Return type:: matplotlib.axes.Axes

get_figure()¶

Returns:: The matplotlib.figure.Figure used for the chart.
Return type:: matplotlib.figure.Figure

save(filename)¶

Save the plot to the specified file.

Parameters:: filename (string)

p3analysis.plot.backend.pgfplots module¶

Contains objects for interacting with plots produced using the pgfplots backend.

class p3analysis.plot.backend.pgfplots.CascadePlot(df, eff_column, size=None, stream=None, **kwargs)¶

Bases: CascadePlot

Cascade plot object for pgfplots.

save(filename)¶

Save the plot to the specified file.

Parameters:: filename (string)

class p3analysis.plot.backend.pgfplots.NavChart(pp, cd, eff=None, size=None, goal=None, stream=None, **kwargs)¶

Bases: NavChart

Navigation chart object for pgfplots.

save(filename)¶

Save the plot to the specified file.

Parameters:: filename (string)

Module contents¶

Contains backend-specific interfaces for customizing plots.

Tip

If you have any trouble customizing a plot, or the objects in this module do not provide access to the internals you are looking for, then please open an issue.

class p3analysis.plot.backend.CascadePlot(backend)¶

Bases: Plot

Base class for cascade plot objects.

class p3analysis.plot.backend.NavChart(backend)¶

Bases: Plot

Base class for navigation chart objects.

class p3analysis.plot.backend.Plot(backend)¶

Bases: object

Base class for plot objects.

get_backend()¶

Returns:: The name of the backend used to generate the plot.
Return type:: str