agepy.spec.coincidence.plot_coinc_map
- plot_coinc_map(coincmap, xedges, yedges, figsize=None, cmap='YlOrRd', title=None, norm=None, vmin=1, vmax=None, num=None, xlabel='early electron kinetic energy', ylabel='late electron kinetic energy', interactive=False)
Plot a coincedence map and its projections on the x and y axes.
- Parameters:
- coincmap
numpy.ndarray 2d array of shape (m,n) containing the coincidence map. In most cases this will be the output of
numpy.histogram2d().- xedges
numpy.ndarray 1d array of shape (m+1) containing the bin edges of the x-axis.
- yedges
numpy.ndarray 1d array of shape (n+1) containing the bin edges of the y-axis.
- figsize
python:tuple,optional Figure size in inches. Default: None
- cmap
matplotlib.colors.Colormaporpython:strorpython:None,optional Colormap passed to
matplotlib.pyplot.pcolormesh(). Default: ‘YlOrRd’- title
python:str,optional Title of the figure. Default: None
- norm
python:strormatplotlib.colors.Normalizeorpython:None,optional Normalization passed to
matplotlib.pyplot.pcolormesh(). Default: None- vmin, vmax
python:float,optional Minimum and maximum value for the colormap passed to
matplotlib.pyplot.pcolormesh(). Default: 1, None- num: int or str or matplotlib.figure.Figure, optional
Figure identifier passed to
matplotlib.pyplot.figure().- xlabel, ylabel
python:str,optional Labels of the x and y axes. Default: “early electron kinetic energy”, “late electron kinetic energy”
- coincmap
- Returns:
- fig
matplotlib.figure.Figure Matplotlib Figure object.
- ax:
python:tupleofmatplotlib.axes.Axes Tuple of matplotlib Axes objects containing the coincidence map, the projection on the x-axis and the projection on the y-axis.
- fig