qspec.simulate. Atom.scattering_rate  (  rho ,  theta = None ,  phi = None ,  as_density_matrix = True ,  i = None ,  j = None ,  axis = 1  )[source]

Scattering rate of the atom into the direction e_r = (sin(theta), cos(theta) * sin(phi), cos(theta) * cos(phi)) where the z-axis is the quantization axis, which is either (0, 0, 1) or the B-field axis.

Parameters:

rhoarray_like

The density matrix of the atom. Must have the same size as the atom along the specified 'axis' and 'axis' + 1.

thetaarray_like

The elevation angle of detection relative to the quantization axis.

phiarray_like

The azimuthal angle of detection relative to the quantization axis.

as_density_matrixbool

Whether 'rho' is a state vector or a density matrix.

iarray_like

The initially excited state indexes to consider for spontaneous decay. If None, all states are considered.

jarray_like

The final decayed state indexes to consider for spontaneous decay. If None, all states are considered.

axisint

The axis along which the population is aligned in 'rho'.

Returns:

outNone

The scattering rate of the atom given the population 'rho' (MHz or Events / s).

Raises:

ValueError

'rho' must have the same size as the atom along the specified 'axis'.