Drawing and Visualization

Functions for drawing operators defined on lattice and cluster models, primarily for debugging and visual inspection.

Visualization utilities for drawing lattice and cluster model operators on the screen.

These functions are added as methods of the pyqcm.lattice_model and related classes and are intended primarily for debugging and visual inspection of model operators.

draw_operator(self, op_name, show_labels=False, show_orb_labels=True, show_neighbors=False, values=False, offset=0.05, orb_offset=0.05, z_offset=0.0, alpha_inter=0.2, spin_scale=0.1, plt_ax=None)

Draws an operator defined on a lattice model to the screen (for debugging purposes)

Parameters:

  • op_name (str) – name of the operator

  • show_labels (bool) – if True, shows the labels of the cluster

  • show_neighbors (bool) – if True, shows the neighbors of the central cluster

  • values (bool) – if True, prints de values of the elements

  • offset (float) – offset between sites and labels

  • orb_offset (float) – offset between sites and orbital labels

  • z_offset (float) – offset between sites and labels for sites along the z axis

  • alpha_inter (float) – alpha value of the inter-cluster links

  • show_orb_labels (bool) – if True, shows the orbital index labels next to each site

  • spin_scale (float) – scale factor for the arrows representing spin polarization

  • plt_ax (matplotlib.axes.Axes) – optional matplotlib axis set, to be passed when one wants to collect a subplot of a larger set

draw_cluster_operator(self, sys, op_name, show_labels=True, values=False, spin_offset=0.15, plt_ax=None)

Draws an operator defined on a cluster model to the screen (for debugging purposes)

Parameters:

  • sys (int) – label of a system

  • op_name (str) – name of the operator

  • show_labels (bool) – if True, shows the labels of the cluster

  • values (bool) – if True, prints de values of the elements

  • spin_offset (float) – graphical offset between up and down spins

  • plt_ax (matplotlib.axes.Axes) – optional matplotlib axis set, to be passed when one wants to collect a subplot of a larger set