cirq.TwoQubitInteractionHeatmap

Visualizing interactions between neighboring qubits on a 2D grid.

Inherits From: Heatmap

cirq.TwoQubitInteractionHeatmap(
    value_map: Mapping[QubitTuple, SupportsFloat], **kwargs
)

Used in the notebooks

Used in the tutorials

value_map A map from a qubit tuple location to a value.
**kwargs Optional kwargs including coupler_margin: float, default = 0.03 coupler_width: float, default = 0.6

Methods

plot

View source

plot(
    ax: Optional[plt.Axes] = None, **kwargs
) -> Tuple[plt.Axes, mpl_collections.Collection]

Plots the heatmap on the given Axes.

Args
ax the Axes to plot on. If not given, a new figure is created, plotted on, and shown.
**kwargs The optional keyword arguments are used to temporarily override the values present in the heatmap config. See init for more details on the allowed arguments.

Returns
A 2-tuple (ax, collection). ax is the plt.Axes that is plotted on. collection is the collection of paths drawn and filled.

update_config

View source

update_config(
    **kwargs
) -> 'Heatmap'

Add/Modify **kwargs args passed during initialisation.