MCPcopy Create free account
hub / github.com/NanoComp/meep / plot2D

Function plot2D

python/visualization.py:948–1066  ·  view source on GitHub ↗
(
    sim: Simulation,
    ax: Optional[Axes] = None,
    output_plane: Optional[Volume] = None,
    fields: Optional = None,
    labels: bool = False,
    label_geometry: bool = False,
    eps_parameters: Optional[dict] = None,
    boundary_parameters: Optional[dict] = None,
    source_parameters: Optional[dict] = None,
    monitor_parameters: Optional[dict] = None,
    field_parameters: Optional[dict] = None,
    colorbar_parameters: Optional[dict] = None,
    frequency: Optional[float] = None,
    show_epsilon: bool = True,
    show_sources: bool = True,
    show_monitors: bool = True,
    show_boundary_layers: bool = True,
    nb: bool = False,
    **kwargs
)

Source from the content-addressed store, hash-verified

946
947
948def plot2D(
949 sim: Simulation,
950 ax: Optional[Axes] = None,
951 output_plane: Optional[Volume] = None,
952 fields: Optional = None,
953 labels: bool = False,
954 label_geometry: bool = False,
955 eps_parameters: Optional[dict] = None,
956 boundary_parameters: Optional[dict] = None,
957 source_parameters: Optional[dict] = None,
958 monitor_parameters: Optional[dict] = None,
959 field_parameters: Optional[dict] = None,
960 colorbar_parameters: Optional[dict] = None,
961 frequency: Optional[float] = None,
962 show_epsilon: bool = True,
963 show_sources: bool = True,
964 show_monitors: bool = True,
965 show_boundary_layers: bool = True,
966 nb: bool = False,
967 **kwargs
968) -> Axes:
969
970 plot_eps_flag = kwargs.get("plot_eps_flag")
971 if plot_eps_flag:
972 warnings.warn("plot_eps_flag is deprecated. Use show_epsilon instead.")
973 show_epsilon = plot_eps_flag
974
975 plot_sources_flag = kwargs.get("plot_sources_flag")
976 if plot_sources_flag:
977 warnings.warn("plot_sources_flag is deprecated. " "Use show_sources instead.")
978 show_sources = plot_sources_flag
979
980 plot_monitors_flag = kwargs.get("plot_monitors_flag")
981 if plot_monitors_flag:
982 warnings.warn("plot_monitors_flag is deprecated. Use show_monitors " "instead.")
983 show_monitors = plot_monitors_flag
984
985 plot_boundaries_flag = kwargs.get("plot_boundaries_flag")
986 if plot_boundaries_flag:
987 warnings.warn(
988 "plot_boundaries_flag is deprecated. Use " "show_boundary_layers instead."
989 )
990 show_boundary_layers = plot_monitors_flag
991
992 # Ensure a figure axis exists
993 if ax is None and mp.am_master():
994 from matplotlib import pyplot as plt
995
996 # nb = plt.get_backend() == 'module://ipympl.backend_nbagg'
997 ax = plt.gca()
998
999 # validate the output plane to ensure proper 2D coordinates
1000 sim_center, sim_size = get_2D_dimensions(sim, output_plane)
1001 output_plane = Volume(center=sim_center, size=sim_size)
1002
1003 if eps_parameters is not None and field_parameters is not None:
1004 if field_parameters.get("colorbar", False) and eps_parameters.get(
1005 "colorbar", False

Callers

nothing calls this directly

Calls 9

VolumeClass · 0.90
get_2D_dimensionsFunction · 0.85
plot_epsFunction · 0.85
plot_boundariesFunction · 0.85
plot_sourcesFunction · 0.85
plot_monitorsFunction · 0.85
plot_fieldsFunction · 0.85
getMethod · 0.80

Tested by

no test coverage detected