desc.plotting.plot_coils

desc.plotting.plot_coils(coils, grid=None, ax=None, return_data=False, **kwargs)[source]

Create 3D plot of coil geometry.

Parameters:

  • coils (Coil, CoilSet) – Coil or coils to plot

  • grid (Grid, optional) – Grid to use for evaluating geometry

  • ax (matplotlib AxesSubplot, optional) – Axis to plot on return_data : bool

  • return_data (bool) – if True, return the data plotted as well as fig,ax

  • **kwargs (fig,ax and plotting properties) –

    Specify properties of the figure, axis, and plot appearance e.g.:

    plot_X(figsize=(4,6),label="your_label")

    Valid keyword arguments are:

    figsize: tuple of length 2, the size of the figure (to be passed to matplotlib) lw: float, linewidth of plotted coils ls: str, linestyle of plotted coils color: str, color of plotted coils cmap: str, colormap to be passed to matplotlib.cm.get_cmap()

Returns:

  • fig (matplotlib.figure.Figure) – Figure being plotted to

  • ax (matplotlib.axes.Axes or ndarray of Axes) – Axes being plotted to

  • plot_data (dict) – dictionary of the data plotted only returned if return_data=True each key is a flattened list of coords corresponding to each coil i..e if the coils given is [Coilset,Coilset,Coilset] each of len 3, plot_data[“X”] is length 9, with the first three corresponding to the x coordinates of the first Coilset plot_data keys:

    ”X”,”Y”,”Z” are the cartesian coordinates of the coil