legume.viz.eps_xy

legume.viz.eps_xy(phc, z=0, Nx=100, Ny=100, ax=None, clim=None, cbar=False, cmap='Greys', cax=None, plot=True)

Plot permittivity cross section of a photonic crystal in an xy plane

Parameters:

  • phc (PhotCryst)

  • z (float, optional) – The z-coordinate of the xz plane. Default is 0.

  • Nx (int, optional) – Number of sample points to use in x-direction. Default is 100.

  • Ny (int, optional) – Number of sample points to use in y-direction. Default is 100.

  • ax (int, optional) – Matplotlib axis object to use for plot.

  • clim (List[float], optional) – Matplotlib color limit to use for plot. Default is None.

  • cbar (bool, optional) – Whether or not a colorbar should be added to the plot. Default is False.

  • cmap (string, optional) – Matplotlib colormap to use for plot Default is ‘Greys’.

  • cax (matplotlib axis object, optional) – Axis handle for the colorbar Default it None.

  • plot (bool, optional) – Whether or not the a plot should be generated. Useful for cases where only the array values are needed, e.g. for logging during optimization. Default is True.

Returns:

eps_r – Array containing permittivity values

Return type:

np.ndarray