legume.viz.structure

legume.viz.structure(struct, Nx=100, Ny=100, Nz=50, cladding=False, cbar=True, cmap='Greys', gridspec=None, fig=None, figsize=(4, 8))

Plot permittivity for all cross sections of a photonic crystal

Parameters:
  • struct (GuidedModeExp or PlaneWaveExp) –
  • 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.
  • Nz (int, optional) – Number of sample points to use in z-direction. Default is 50.
  • cladding (bool, optional) – Whether or not the cladding should be plotted. Default is False.
  • cbar (bool, optional) – Whether or not a colorbar should be added to the plot. Default is False.
  • cmap (bool, optional) – Matplotlib colormap to use for plot Default is ‘Greys’.
  • gridspec (Matplotlib gridspec object, optional) – Gridspec to use for creating the plots. Default is None.
  • fig (Matplotlib figure object, optional) – Figure to use for creating the plots. Default is None.
  • figsize (Tuple, optional) – Size of Matplotlib figure to create. Default is (4,8).