qspec.simulate. ScatteringRate.plot_angular_distribution  (  x = None ,  n = 5 ,  theta = None ,  phi = None ,  mode = None ,  show = True ,  save = None  )[source]

Parameters:

xscalar

The frequency of light in an atoms rest frame (MHz). If None, the position of the first maximum is taken (self.x0[0][0]).

nint

2 ** n + 1 samples for 'theta' and 2 ** (n + 1) + 1 samples for 'phi' are drawn, giving a total of 2 ** (2n + 1) + 3 * 2 ** n + 1 points to draw.

thetandarray | Iterable

A custom array for theta. Overwrites 'n'.

phindarray | Iterable

A custom array for phi. Overwrites 'n'.

modestr

Either '3d' for a surface plot or anything else for a color-mesh plot.

showbool

Whether to show the plot.

savestr

The path where to save the plot. If None, the plot will not be saved.

Returns:

outNone

theta, phi and z. Optionally, a plot is drawn and saved.