legume.viz.pol_bands

legume.viz.pol_bands(pol, Q=True, fraction=False, Q_clip=100000.0, cone=True, conecolor='#eeeeee', ax=None, figsize=(4, 5), Q_cmap='viridis', Q_min=100.0, Q_max=10000.0, fraction_cmap='coolwarm', markersize=6, markeredgecolor='w', markeredgewidth=1.5, k_units=False)

Plot polaritonic band structure from a polaritonic simulation

Note

The bands must be solved for and stored in the HopfieldPol object prior to calling this function.

If both Q and fraction are True, Q will be considered False.

Parameters:

  • pol (HopfieldPol)

  • Q (bool, optional) – Whether each point should be colored according to the quality factor. Default is True.

  • fraction (bool, optional) – Whether each point should be colored according to excitonic fraction. Default is False.

  • Q_clip (float, optional) – The clipping (vmax) value for the quality factor colormap. Default is 1e10.

  • cone (bool , optional) – Whether the the light cone region of the band structure should be shaded. Default is True.

  • conecolor (str, optional) – Color of the light cone region. Default is ‘#eeeeee’ (light grey).

  • ax (matplotlib axis object, optional) – Matplotlib axis object for plotting. If not provided, a new figure and axis are automatically created.

  • figsize (Tuple, optional) – Figure size for created figure. Default is (4,5).

  • Q_cmap (str or matplotlib colormap object, optional) – Colormap used for the quality factor. Default is ‘viridis’.

  • fraction_cmap (str or matplotlib colormap object, optional) – Colormap used for the exctionic fraction. Default is ‘coolwarm’.

  • markersize (float, optional) – Band marker size. Default is 6.

  • markeredgecolor (str, optional) – Band marker edge border color. Default is white.

  • markeredgewidth (float, optional) – Band marker edge border width. Default is 1.5.

  • k_units (bool, optional) – Whether x-coordinates are calculated from wavevector increments and have physical meaning (if True), or they are simply linearly spaced points (if False). Use True in order to plot photonic bands with wavevectors that represent actual paths in the Brillouin zone. Default is False, for backwards compataibility.

Returns:

ax – Axis object for the plot.

Return type:

matplotlib axis object