arpes.plotting.spatial.plot_spatial_reference#

arpes.plotting.spatial.plot_spatial_reference(reference_map, data_list, offset_list=None, annotation_list=None, out='', *, plot_refs=True)[source]#

Helpfully plots data against a reference scanning dataset.

This is essential to understand where data was taken and can be used early in the analysis phase in order to highlight the location of your datasets against core levels, etc.

Parameters:
  • reference_map – A scanning photoemission like dataset

  • data_list – A list of datasets you want to plot the relative locations of

  • offset_list – Optionally, offsets given as coordinate dicts

  • annotation_list – Optionally, text annotations for the data

  • out – Where to save the figure if we are outputting to disk

  • plot_refs – Whether to plot reference figures for each of the pieces of data in data_list