plot (method)

plot(self, fig=None, ax=None, display_magnet=True, is_add_arrow=False, is_show_fig=True)[source]

Plot the Hole in a matplotlib fig

Parameters
  • self (Hole) – A Hole object

  • fig – if None, open a new fig and plot, else add to the current one (Default value = None)

  • display_magnet (bool) – if True, plot the magnet inside the hole, if there is any (Default value = True)

  • is_add_arrow (bool) – To add an arrow for the magnetization

Returns

Return type

None