`pygsti.report.figure`

Defines the ReportTable class

Module Contents

Classes

A plotly figure and related metadata that can be rendered in a variety of formats.

class pygsti.report.figure.ReportFigure(plotlyfig, colormap=None, python_value=None, **kwargs)

Bases: object

A plotly figure and related metadata that can be rendered in a variety of formats.

For use in pyGSTi reports.

Parameters

plotlyfigplotly.Figure: The plotly figure to encapsulate
colormapColorMap, optional: A pygsti color map object used for this figure.
python_valueobject, optional: A python object to be used as the Python-version of this figure (usually the data being plotted in some convenient format).
kwargsdict: Additional meta-data relevant to this figure

Create a table object

Parameters

plotlyfigplotly.Figure: The plotly figure to encapsulate
colormapColorMap, optional: A pygsti color map object used for this figure.
python_valueobject, optional: A python object to be used as the Python-version of this figure (usually the data being plotted in some convenient format).
kwargsdict: Additional meta-data relevant to this figure

plotlyfig

colormap

pythonvalue

metadata